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
+71-14Lines changed: 71 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,11 @@ 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
+
Below is a breakdown of all the available commands and their options:
205
+
206
+
<detailsid="new">
207
+
208
+
<summary>New</summary>
194
209
195
210
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
211
@@ -240,7 +255,11 @@ Options:
240
255
-h, --help Print help
241
256
```
242
257
243
-
### Start
258
+
</details>
259
+
260
+
<detailsid="start">
261
+
262
+
<summary>Start</summary>
244
263
245
264
The `start` command may be used to start tracking time for an existing activity.
246
265
It expects an **activity handle** which may be either:
@@ -287,7 +306,11 @@ Options:
287
306
-h, --help Print help
288
307
```
289
308
290
-
### Cancel
309
+
</details>
310
+
311
+
<detailsid="cancel">
312
+
313
+
<summary>Cancel</summary>
291
314
292
315
If you started an activity by mistake, you can use the `cancel` command to quickly revert it.
293
316
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 +330,11 @@ Options:
307
330
-h, --help Print help
308
331
```
309
332
310
-
### Pause
333
+
</details>
334
+
335
+
<detailsid="pause">
336
+
337
+
<summary>Pause</summary>
311
338
312
339
To stop tracking time for the current activity, you can use the `pause` command:
313
340
@@ -329,7 +356,11 @@ Options:
329
356
-h, --help Print help
330
357
```
331
358
332
-
### Modify
359
+
</details>
360
+
361
+
<detailsid="modify">
362
+
363
+
<summary>Modify</summary>
333
364
334
365
You can modify the **name**, **description**, and **tags** of an existing activity with the `modify` command:
335
366
@@ -364,7 +395,11 @@ Options:
364
395
-h, --help Print help
365
396
```
366
397
367
-
### Edit
398
+
</details>
399
+
400
+
<detailsid="edit">
401
+
402
+
<summary>Edit</summary>
368
403
369
404
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
405
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 +473,11 @@ Options:
438
473
-h, --help Print help
439
474
```
440
475
441
-
### Delete
476
+
</details>
477
+
478
+
<detailsid="delete">
479
+
480
+
<summary>Delete</summary>
442
481
443
482
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
483
@@ -477,7 +516,11 @@ Options:
477
516
-h, --help Print help
478
517
```
479
518
480
-
### Get
519
+
</details>
520
+
521
+
<detailsid="get">
522
+
523
+
<summary>Get</summary>
481
524
482
525
Acquiring information about the current activity is really simple. All you need to do is to use the `get` command:
483
526
@@ -518,7 +561,11 @@ Options:
518
561
-h, --help Print help
519
562
```
520
563
521
-
### List
564
+
</details>
565
+
566
+
<detailsid="list">
567
+
568
+
<summary>List</summary>
522
569
523
570
The `list` command can be used to get an overview of all the activities you have been tracking.
524
571
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 +604,11 @@ Options:
557
604
-h, --help Print help
558
605
```
559
606
560
-
### Report
607
+
</details>
608
+
609
+
<detailsid="report">
610
+
611
+
<summary>Report</summary>
561
612
562
613
The `report` command can be used to get a summary of the total time spent on your activities.
563
614
It uses the same filtering options as the `list` command but **does not support grouping yet.**
@@ -579,7 +630,11 @@ Options:
579
630
-h, --help Print help
580
631
```
581
632
582
-
### Init
633
+
</details>
634
+
635
+
<detailsid="init">
636
+
637
+
<summary>Init</summary>
583
638
584
639
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
640
@@ -625,12 +680,14 @@ Options:
625
680
-h, --help Print help
626
681
```
627
682
683
+
</details>
684
+
628
685
## 🔮 Alternatives to boat
629
686
630
687
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
688
632
-
-[`bartib`](https://github.com/nikolassv/bartib)
633
-
-[`zeit`](https://github.com/mrusme/zeit)
689
+
-[`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.
690
+
-[`zeit`](https://github.com/mrusme/zeit): Zeit, erfassen. A command line tool for tracking time.
0 commit comments