bartib/README.md

75 lines
1.1 KiB
Markdown
Raw Normal View History

2021-05-10 22:08:04 +02:00
# Bartib
2021-07-12 22:22:21 +02:00
Bartib is a time tracker for the command line. It safes a journal of all tracked activities in a plaintext file.
2021-05-10 22:08:04 +02:00
## Build
Build it with cargo:
```
cargo build --release
```
## The `.bartib` file
2021-07-12 22:22:21 +02:00
Bartib safes a journal of all tracked activities in a plaintext file. The file can either be specified via the `-f / --file` cli option or as a `BARTIB_FILE` environment variable.
2021-05-10 22:08:04 +02:00
## Commands
### Help
Print help information:
2021-05-10 22:08:04 +02:00
```
bartib -h
```
2021-07-12 22:22:21 +02:00
### Start a new activity
2021-05-10 22:08:04 +02:00
2021-07-12 22:22:21 +02:00
Start a new activity with a short description and an associated project:
2021-05-10 22:08:04 +02:00
```
2021-07-12 22:22:21 +02:00
bartib start -p "The name of the associated project" -d "A description of the activity"
2021-05-10 22:08:04 +02:00
```
2021-07-12 22:22:21 +02:00
This will also stop all currently running activities.
2021-07-12 22:22:21 +02:00
### Stop a running activity
2021-07-12 22:22:21 +02:00
Stops the currently running activity:
```
bartib stop
```
2021-07-12 22:22:21 +02:00
### List all currently running activities
2021-05-10 22:08:04 +02:00
```
bartib current
```
2021-07-12 22:22:21 +02:00
### List activities
2021-07-12 22:22:21 +02:00
All activities:
```
bartib list
```
2021-07-12 22:22:21 +02:00
Do not group activities by date:
```
bartib list --no_grouping
```
2021-07-12 22:22:21 +02:00
List activities in a given time range:
```
bartib list --from 2021-03-01 --to 2021-11-01
```
2021-07-12 22:22:21 +02:00
List activities on a given day:
```
bartib list --date 2021-05-17
```