Tui clock
This repository has been archived on 2024-10-16. You can view files and clone it, but cannot push or open issues or pull requests.
Find a file
Jimmy 228faf45c6
Merge pull request #3 from wezm/flash-timer
Blink timer when it finishes
2022-08-03 18:59:44 +08:00
assets add readme 2022-07-19 16:55:36 +08:00
src Blink timer when it finishes 2022-08-03 20:48:39 +10:00
.gitignore initial implement clock-tui 2022-07-19 13:25:30 +08:00
Cargo.lock update docs for color option 2022-07-20 12:53:55 +08:00
Cargo.toml update docs for color option 2022-07-20 12:53:55 +08:00
README.md update docs for color option 2022-07-20 12:53:55 +08:00

clock-tui (tclock)

A clock app in terminal. It support the following modes:

Clock

clock

Timer

timer

Stopwatch

stopwatch

Usage

Install

Install excutable by cargo:

$ cargo install clock-tui

Basic usage

$ tclock

Run this command to start a clock, and press q to exit.

$ tclock --help

Clock mode, this it the default mode

$ tclock clock

# Or just run
$ tclock

Run timer

# Start timer for 5 minutes
$ tclock timer -d 5m

The option -d or --duration to set time, for example 100s, 5m, 1h, etc.

You can press Space key to pause and resume the timer.

Run stopwatch

$ tclock stopwatch

You can press Space key to pause and resume the stopwatch.

Customize style

You can customize the styles.

Size

You can use -s or --size option to custome clock size, for example:

$ tclock -s 2

Color

You can use -c or --color to set clock forground color, for exmaple:

# color name, any one of: 
# Black, Red, Green, Yellow, Blue, Magenta, Cyan, Gray, DarkGray, LightRed,
# LightGreen, LightYellow, LightBlue, LightMagenta, LightCyan, White
$ tclock -c yellow

# or hex color
$ tclock -c '#e63946'

License

MIT License.