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
+47-14Lines changed: 47 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,7 @@ 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">
194
205
195
206
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
207
@@ -240,7 +251,9 @@ Options:
240
251
-h, --help Print help
241
252
```
242
253
243
-
### Start
254
+
</details>
255
+
256
+
<detailsid="start">
244
257
245
258
The `start` command may be used to start tracking time for an existing activity.
246
259
It expects an **activity handle** which may be either:
@@ -287,7 +300,9 @@ Options:
287
300
-h, --help Print help
288
301
```
289
302
290
-
### Cancel
303
+
</details>
304
+
305
+
<detailsid="cancel">
291
306
292
307
If you started an activity by mistake, you can use the `cancel` command to quickly revert it.
293
308
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 +322,9 @@ Options:
307
322
-h, --help Print help
308
323
```
309
324
310
-
### Pause
325
+
</details>
326
+
327
+
<detailsid="pause">
311
328
312
329
To stop tracking time for the current activity, you can use the `pause` command:
313
330
@@ -329,7 +346,9 @@ Options:
329
346
-h, --help Print help
330
347
```
331
348
332
-
### Modify
349
+
</details>
350
+
351
+
<detailsid="modify">
333
352
334
353
You can modify the **name**, **description**, and **tags** of an existing activity with the `modify` command:
335
354
@@ -364,7 +383,9 @@ Options:
364
383
-h, --help Print help
365
384
```
366
385
367
-
### Edit
386
+
</details>
387
+
388
+
<detailsid="edit">
368
389
369
390
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
391
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 +459,9 @@ Options:
438
459
-h, --help Print help
439
460
```
440
461
441
-
### Delete
462
+
</details>
463
+
464
+
<detailsid="delete">
442
465
443
466
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
467
@@ -477,7 +500,9 @@ Options:
477
500
-h, --help Print help
478
501
```
479
502
480
-
### Get
503
+
</details>
504
+
505
+
<detailsid="get">
481
506
482
507
Acquiring information about the current activity is really simple. All you need to do is to use the `get` command:
483
508
@@ -518,7 +543,9 @@ Options:
518
543
-h, --help Print help
519
544
```
520
545
521
-
### List
546
+
</details>
547
+
548
+
<detailsid="list">
522
549
523
550
The `list` command can be used to get an overview of all the activities you have been tracking.
524
551
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 +584,9 @@ Options:
557
584
-h, --help Print help
558
585
```
559
586
560
-
### Report
587
+
</details>
588
+
589
+
<detailsid="report">
561
590
562
591
The `report` command can be used to get a summary of the total time spent on your activities.
563
592
It uses the same filtering options as the `list` command but **does not support grouping yet.**
@@ -579,7 +608,9 @@ Options:
579
608
-h, --help Print help
580
609
```
581
610
582
-
### Init
611
+
</details>
612
+
613
+
<detailsid="init">
583
614
584
615
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
616
@@ -625,12 +656,14 @@ Options:
625
656
-h, --help Print help
626
657
```
627
658
659
+
</details>
660
+
628
661
## 🔮 Alternatives to boat
629
662
630
663
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
664
632
-
-[`bartib`](https://github.com/nikolassv/bartib)
633
-
-[`zeit`](https://github.com/mrusme/zeit)
665
+
-[`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.
666
+
-[`zeit`](https://github.com/mrusme/zeit): Zeit, erfassen. A command line tool for tracking time.
0 commit comments