⛵ boat

boat - A Basic Opinionated Activity Tracker, inspired by bartib.

This is only the code for the command line application. It relies on boat-lib for core functions.

Warning

🚧 Work in Progress

This cli is actively being developed. Since it's in its early stages, things will likely break often. Don't use it for now.

🤔 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. That's it, I wanted 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:

cargo install boat-cli

The other option is to build from source:

git clone https://github.com/coko7/boat-cli.git
cd boat-cli
cargo build --release

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:

cargo install boat-cli --features bundled-sqlite

When building from source:

git clone https://github.com/coko7/boat-cli.git
cd boat-cli
cargo build --release --features bundled-sqlite

⚙️ 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 keep the SQLite database file boat.db in the same directory (unless specified otherwise in config):

database_path = "/home/<user>/.config/boat/boat.db"

You can override the default configuration file path by setting the BOAT_CONFIG environment variable.

✨ Usage

To get a feel of how boat can be used, you can try boat help to get the list of commands:

boat 0.2.1

Basic Opinionated Activity Tracker

Usage:
boat <COMMAND>

Commands:
  new     Create a new activity
  start   Start/resume an activity
  pause   Pause/stop the current activity
  modify  Modify an activity
  delete  Delete an activity
  get     Get the current activity
  list    List boat objects
  help    Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version

Made by @coko7 <contact@coko7.fr>

If you want to invoke boat from your command-line directly, you can make use of a variety of shorter aliases:

Commands:
  new     n
  start   s, st, sail
  config  c, cfg, conf
  pause   p
  modify  m, mod
  delete  d, del
  get     g
  list    l, ls
  help    h, -h, --help

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.