bartib/README.md

75 lines
1.1 KiB
Markdown
Raw Normal View History

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