clock-tui 0.4.0

A clock app in terminal
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127

# clock-tui (tclock)

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

## Clock

![clock](/assets/demo-clock-mode.gif)

## Timer

![timer](/assets/demo-timer-mode.gif)

## Stopwatch

![stopwatch](/assets/demo-stopwatch-mode.gif)

## Countdown

![countdown](/assets/demo-countdown-mode.gif)

# Usage

## Install

Install excutable by `cargo`:

```shell
$ cargo install clock-tui
```

## Basic usage

```shell
$ tclock
```
Run this command to start a clock, and press `q` to exit.

You can always use `-h` or `--help` to show help message, for exmaple

```shell
$ tclock --help

# or
$ tclock clock -h
```

## Clock mode, this it the default mode

```shell
$ tclock clock

# Or just run
$ tclock
```

For more details, run `tclock clock -h` to show usage.

## Run timer

```shell
# 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.

The timer mode also accept additional command to run when the timer ends, for example:

```
tclock timer -d 25m -e terminal-notifier -title tclock -message "'Time is up!'"
```

Here we use [terminal-notifier](https://github.com/julienXX/terminal-notifier) to fire a notification when time is up.

For more details, run `tclock timer -h` to show usage.

## Run stopwatch

```shell
$ tclock stopwatch
```

For more details, run `tclock stopwatch -h` to show usage.

## Run countdown

```shell
$ tclock countdown --time 2023-01-01 --title 'New Year 2023'`
```

You can use `-t` or `--time` to specify time, for example: `2023-01-01`, `20:00`, `'2022-12-25 20:00:00'` or `2022-12-25T20:00:00-04:00`.

You can use `-r` or `--reverse` to run in count-up mode, it counts up duration since the specific time.

For more details, run `tclock countdown -h` to show usage.

## Customize style

You can customize the styles.

### Size

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

```shell
$ tclock -s 2
```

### Color

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

```shell
# 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, refer to [LICENSE](./LICENSE) for detail.