You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+69-14Lines changed: 69 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,7 +31,18 @@ It relies on [`boat-lib`](https://github.com/coko7/boat-lib) for core functions.
31
31
-[Install with a bundled version of SQLite](#install-with-a-bundled-version-of-sqlite)
32
32
-[⚙️ Configuration](#%EF%B8%8F-configuration)
33
33
-[✨ Usage](#-usage)
34
-
-[🔮 Alternatives to boat](-alternatives-to-boat)
34
+
-[New](#new)
35
+
-[Start](#start)
36
+
-[Cancel](#cancel)
37
+
-[Pause](#pause)
38
+
-[Modify](#modify)
39
+
-[Edit](#edit)
40
+
-[Delete](#delete)
41
+
-[Get](#get)
42
+
-[List](#list)
43
+
-[Report](#report)
44
+
-[Init](#init)
45
+
-[🔮 Alternatives to boat](#-alternatives-to-boat)
35
46
-[🧠 (mostly) Brain made](#-mostly-brain-made)
36
47
37
48
## 🚀 Demo
@@ -190,7 +201,9 @@ Maybe I will drop this in the future, let's see.
190
201
191
202
_I have included some fallback in case you type `stop`/`remove` instead of `pause`/`delete` 👀_
192
203
193
-
### New
204
+
<detailsid="new">
205
+
206
+
<summary>New</summary>
194
207
195
208
You can use the `new` command to create a new activity, with an optional **description** and **tags** (comma-separated list). If you want to start the activity immediately, you can include the `-s`/`--start-now` flag:
196
209
@@ -240,7 +253,11 @@ Options:
240
253
-h, --help Print help
241
254
```
242
255
243
-
### Start
256
+
</details>
257
+
258
+
<detailsid="start">
259
+
260
+
<summary>Start</summary>
244
261
245
262
The `start` command may be used to start tracking time for an existing activity.
246
263
It expects an **activity handle** which may be either:
@@ -287,7 +304,11 @@ Options:
287
304
-h, --help Print help
288
305
```
289
306
290
-
### Cancel
307
+
</details>
308
+
309
+
<detailsid="cancel">
310
+
311
+
<summary>Cancel</summary>
291
312
292
313
If you started an activity by mistake, you can use the `cancel` command to quickly revert it.
293
314
You can control the confirmation behavior with the `-c`/`--confirm` and `-C`/`--no-confirm` flags or the `confirm` option in the config file.
@@ -307,7 +328,11 @@ Options:
307
328
-h, --help Print help
308
329
```
309
330
310
-
### Pause
331
+
</details>
332
+
333
+
<detailsid="pause">
334
+
335
+
<summary>Pause</summary>
311
336
312
337
To stop tracking time for the current activity, you can use the `pause` command:
313
338
@@ -329,7 +354,11 @@ Options:
329
354
-h, --help Print help
330
355
```
331
356
332
-
### Modify
357
+
</details>
358
+
359
+
<detailsid="modify">
360
+
361
+
<summary>Modify</summary>
333
362
334
363
You can modify the **name**, **description**, and **tags** of an existing activity with the `modify` command:
335
364
@@ -364,7 +393,11 @@ Options:
364
393
-h, --help Print help
365
394
```
366
395
367
-
### Edit
396
+
</details>
397
+
398
+
<detailsid="edit">
399
+
400
+
<summary>Edit</summary>
368
401
369
402
If you want to make adjustments to the activity logs (start/end tracking times), you can make use of the `edit` command. Calling the `edit` command will open the list of logs in CSV format in your default `$EDITOR`. You can tweak the `start`/`end` times for multiple logs in there.
370
403
After saving the file and quitting the file, you will be able to preview the changes to be applied and either proceed with the update or discard it.
@@ -438,7 +471,11 @@ Options:
438
471
-h, --help Print help
439
472
```
440
473
441
-
### Delete
474
+
</details>
475
+
476
+
<detailsid="delete">
477
+
478
+
<summary>Delete</summary>
442
479
443
480
You may delete an activity with the `delete` command. This will **permanently delete the activity and all its logs**, so be careful with it.
444
481
@@ -477,7 +514,11 @@ Options:
477
514
-h, --help Print help
478
515
```
479
516
480
-
### Get
517
+
</details>
518
+
519
+
<detailsid="get">
520
+
521
+
<summary>Get</summary>
481
522
482
523
Acquiring information about the current activity is really simple. All you need to do is to use the `get` command:
483
524
@@ -518,7 +559,11 @@ Options:
518
559
-h, --help Print help
519
560
```
520
561
521
-
### List
562
+
</details>
563
+
564
+
<detailsid="list">
565
+
566
+
<summary>List</summary>
522
567
523
568
The `list` command can be used to get an overview of all the activities you have been tracking.
524
569
It comes with a lot of options to filter and group the results. You can also output the list in JSON format for further processing in scripts.
@@ -557,7 +602,11 @@ Options:
557
602
-h, --help Print help
558
603
```
559
604
560
-
### Report
605
+
</details>
606
+
607
+
<detailsid="report">
608
+
609
+
<summary>Report</summary>
561
610
562
611
The `report` command can be used to get a summary of the total time spent on your activities.
563
612
It uses the same filtering options as the `list` command but **does not support grouping yet.**
@@ -579,7 +628,11 @@ Options:
579
628
-h, --help Print help
580
629
```
581
630
582
-
### Init
631
+
</details>
632
+
633
+
<detailsid="init">
634
+
635
+
<summary>Init</summary>
583
636
584
637
If, at anytime, you need to get a copy of the default configuration file, you can make use of the `init` command and the full TOML representation will be printed in your terminal for you to copy-paste:
585
638
@@ -625,12 +678,14 @@ Options:
625
678
-h, --help Print help
626
679
```
627
680
681
+
</details>
682
+
628
683
## 🔮 Alternatives to boat
629
684
630
685
Hey. I made `boat` to solve my own very specific problems but I don't expect it to be a perfect fit for everyone. If you are looking for similar tools, I got you:
631
686
632
-
-[`bartib`](https://github.com/nikolassv/bartib)
633
-
-[`zeit`](https://github.com/mrusme/zeit)
687
+
-[`bartib`](https://github.com/nikolassv/bartib): A simple timetracker for the command line. It saves a log of all tracked activities as a plaintext file and allows you to create flexible reports.
688
+
-[`zeit`](https://github.com/mrusme/zeit): Zeit, erfassen. A command line tool for tracking time.
0 commit comments