⛵ boat
boat - A Basic Opinionated Activity Tracker, inspired by bartib.
Like its name implies, boat allows you to track the time you spend on everyday tasks.
It has mainly been designed to be easy to embed in custom bash scripts so that you can augment it with fuzzy-finding. That said, if you plan to use the CLI directly (without external scripts), it also benefits from a variety of handy aliases.
boat stores its data in a SQLite database file which is kept in the config directory by default (.config/boat/boat.db).
This repository contains only the code for the command line application.
It relies on boat-lib for core functions.
[!WARNING]
🚧 Work in ProgressThis cli is actively being developed. Since it's in its early stages, things will likely break often. Don't use it for now.
Contents
🤔 Why was this tool created?
The bartib cli is what inspired me to create boat.
It's a feature-full tool that I used for a while, but I found it quite limiting for my usage due to its lack of support for machine-readable output.
And that's it. All I wanted was an activity tracker that I could combine easily with jq and so I decided to make my own tool.
🛠️ Installation
The easiest way to install is through crates.io:
The other option is to build from source:
Install with a bundled version of SQLite
If you are on Windows or you do not have SQLite on your system, you can install boat with the bundled-sqlite feature.
This will increase the compilation time but guarantees a working out-of-the-box exprience.
When using cargo:
When building from source:
⚙️ Configuration
By default, boat will create a configuration file in one of the following dirs:
- 🐧 Linux:
/home/<user>/.config/boat/config.toml - 🪟 Windows:
C:\Users\<user>\AppData\Roaming\boat\config.toml - 🍎 macOS:
/Users/<user>/Library/Application Support/boat/config.toml
It will also store the SQLite database file boat.db in the same directory (unless specified otherwise in config):
= "/home/<user>/.config/boat/boat.db"
You can override the default configuration file path by setting the BOAT_CONFIG environment variable.
✨ Usage
If you have ever used bartib, then boat is going to feel very familiar.
Try boat help for a quick list of commands:
boat 0.6.0
Basic Opinionated Activity Tracker
Usage:
boat [OPTIONS] <COMMAND>
Commands:
new Create a new activity
start Start/resume an activity
cancel Cancel the current activity
pause Pause/stop the current activity
modify Modify an activity
delete Delete an activity
get Get the current activity
list List activities
help Print this message or the help of the given subcommand(s)
Options:
-v, --verbose... Increase logging verbosity
-q, --quiet... Decrease logging verbosity
-h, --help Print help
-V, --version Print version
[!TIP]
boatcomes bundled with many command aliases:
- new:
n,new,create- start:
s,st,start,sail,continue,resume- cancel:
c,can,cancel- pause:
p,pause,stop- modify:
m,mod,modify- delete:
d,del,delete,rm,rem,remove- get:
g,get- list:
l,ls,list- help:
h,help,-h,--helpPrefer using the full length command names in scripts as they are more explicit and unlikely to be changed (unlike shorter aliases).
I really wanted to have each command start with a different character so that I could assign a single-char alias to all of them. That explains why some of the commands do not use a more fitting keyword.
Like stop would have been a better command than pause but since it shares the same starting charcter as the start command, I could not use it.
Maybe I will drop this in the future, let's see.
I have included some fallback in case you type stop/remove instead of pause/delete 👀