Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sectore/timr
TUI app to organize your time
https://github.com/sectore/timr
rust tui
Last synced: 27 days ago
JSON representation
TUI app to organize your time
- Host: GitHub
- URL: https://github.com/sectore/timr
- Owner: sectore
- License: mit
- Created: 2024-11-27T17:16:56.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-12-12T08:00:38.000Z (about 1 month ago)
- Last Synced: 2024-12-12T08:30:08.330Z (about 1 month ago)
- Topics: rust, tui
- Language: Rust
- Homepage:
- Size: 80.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ratatui - tim:r - A TUI for organizing your time: Pomodoro, Countdown, Timer. (π» Apps / π Productivity and Utilities)
README
# tim:r
**Pronounced `/ΛtΚΙͺmΙ/` or `/ΛtaΙͺmΙr/`.**
> [!WARNING]
> _Still WIP_
# About
`tim:r` is a TUI app to help you to organize one of the most important thing you have in live: `time`!
- `[t]imer` Check the time on anything you are you doing.
- `[c]ountdown` Use it for your workout, yoga session, meditation, handstand or whatever.
- `[p]omodoro` Organize your working time to be focused all the time by following the [Pomodoro Technique](https://en.wikipedia.org/wiki/Pomodoro_Technique).
It's built with [`ratatui`](https://ratatui.rs/) ([Rust](https://www.rust-lang.org/))
# Screens
_soon_
# Args
```sh
Usage: timr [OPTIONS]
Options:
-c, --countdown Countdown time to start from. Format: 'ss', 'mm:ss', or 'hh:mm:ss' [default: 10:00]
-w, --work Work time to count down from. Format: 'ss', 'mm:ss', or 'hh:mm:ss' [default: 25:00]
-p, --pause Pause time to count down from. Format: 'ss', 'mm:ss', or 'hh:mm:ss' [default: 5:00]
-h, --help Print help
```
# Build from source
## Requirements
### Nix (recommend)
`cd` into root directory.
[`direnv`](https://direnv.net) users run `direnv allow` once to install dependencies. Others run `nix develop`.
### Non Nix user
- [`Rust`](https://www.rust-lang.org/learn/get-started)
- [`Clippy`](https://github.com/rust-lang/rust-clippy)
- [`rustfmt`](https://github.com/rust-lang/rustfmt)
- [`just`](https://just.systems)
### Commands to `run`, `lint`, `format` etc.
```sh
just --list
Available recipes:
build # build app
b # alias for `build`
default
format # format files
f # alias for `format`
lint # lint
l # alias for `lint`
run # run app
r # alias for `run`
test # run tests
t # alias for `test`
```
### Build
- Linux
```sh
nix build
```
- Windows (cross-compilation)
```sh
nix build .#windows
```
# Misc.
## Logs
In `debug` mode only.
```sh
tail -f ~/.local/state/timr/logs/timr.log
```