feat: work on user experience

- use tables with pretty-printed output (tabular + yansi)
- add some more print messages
- start working on period select for list
- re-enable config cmd but not implemented yet
- remove `clap_verbosity_flag` for now as it seems to cause some issues
- update docs

Author: coko7

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "boat-cli"
-version = "0.1.0"
+version = "0.2.0"
 edition = "2024"
 description = "Basic Opinionated Activity Tracker, a command line interface inspired by bartib"
 repository = "https://github.com/coko7/boat"
@@ -18,7 +18,7 @@ path = "src/main.rs"
 clap = { version = "4.6.0", features = ["derive"] }
 env_logger = "0.11.9"
 log = "0.4.29"
-clap-verbosity-flag = "3.0.4"
+# clap-verbosity-flag = "3.0.4"
 anyhow = "1.0.102"
 directories = "6.0.0"
 serde = { version = "1.0.228", features = ["derive"] }
@@ -27,3 +27,5 @@ rusqlite = "0.39.0"
 chrono = { version = "0.4.44", features = ["serde"] }
 serde_json = "1.0.149"
 boat-lib = "0.3.1"
+tabular = { version = "0.2.0", features = ["ansi-cell"] }
+yansi = "1.0.1"

Cargo.toml

@@ -15,6 +15,12 @@ This is only the code for the command line application. It relies on [`boat-lib`
 > 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`](https://github.com/nikolassv/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](https://github.com/nikolassv/bartib/pull/26).
+That's it, I wanted an activity tracker that I could combine easily with [`jq`](https://github.com/jqlang/jq) and so I decided to make my own tool.
+
 ## Installation
 
 The easiest way to install is through [crates.io](https://crates.io/crates/boat-cli):
@@ -29,26 +35,43 @@ cd boat-cli
 cargo build --release
 ```
 
-## Commands
+## Usage
 
+To get a feel of how `boat` can be used, you can try `boat help` to get the list of commands:
 ```help
 Basic Opinionated Activity Tracker
 
-Usage: boat [OPTIONS] <COMMAND>
+Usage: boat <COMMAND>
 
 Commands:
   new     Create a new activity
   start   Start/resume an activity
-  pause   Manage configuration Pause/stop the current activity
+  config  Manage configuration
+  pause   Pause/stop the current activity
   modify  Modify an activity
   delete  Delete an activity
   get     Get the current activity
   list    List activities and tags
   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
+  -h, --help     Print help
+  -V, --version  Print version
+```
+
+If you want to invoke `boat` from your command-line directly, you can make use of a variety of shorter aliases:
+```help
+Commands:
+  new     n
+  start   s, st, sail
+  config  c, cfg, conf
+  pause   p
+  modify  m, mod
+  delete  d, del
+  get     g
+  list    l, ls
 ```
+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.

README.md

@@ -1,5 +1,7 @@
+use std::ops::RangeInclusive;
+
 use boat_lib::repository::Id;
-use clap::{ArgAction, Args, Parser, Subcommand};
+use clap::{ArgAction, Args, Parser, Subcommand, ValueEnum};
 
 #[derive(Parser)]
 #[command(
@@ -12,9 +14,9 @@ use clap::{ArgAction, Args, Parser, Subcommand};
 pub struct Cli {
     #[command(subcommand)]
     pub command: Commands,
-
-    #[command(flatten)]
-    pub verbose: clap_verbosity_flag::Verbosity,
+    //
+    // #[command(flatten)]
+    // pub verbose: clap_verbosity_flag::Verbosity,
 }
 
 #[derive(Subcommand)]
@@ -30,11 +32,11 @@ pub enum Commands {
     Start(SelectActivityArgs),
 
     /// Manage configuration
-    // #[command(alias = "c", alias = "cfg", alias = "conf")]
-    // Config {},
+    #[command(alias = "c", alias = "cfg", alias = "conf")]
+    Config {},
 
     /// Pause/stop the current activity
-    #[command(alias = "p")]
+    #[command(alias = "p", alias = "stop")]
     Pause,
 
     /// Modify an activity
@@ -73,27 +75,34 @@ pub enum Commands {
 #[derive(Args, Debug)]
 #[group(multiple = false)]
 pub struct ListActivityArgs {
-    #[arg(short = 'a', long = "all")]
-    pub show_all: bool,
-
-    #[arg(short = 'r', long = "recent")]
-    pub show_recent: bool,
-
-    #[arg(short = 'c', long = "current")]
-    pub show_current: bool,
-
-    #[arg(short = 't', long = "tags")]
-    pub show_tags: bool,
-
-    /// Output in pretty format
-    #[arg(short = 'p', long = "pretty")]
-    pub use_pretty_format: bool,
+    /// Only show activities matching a certain period
+    #[arg(short = 'p', long = "period", value_name = "PERIOD", default_value_t = Period::Today, value_enum)]
+    pub period: Period,
 
     /// Output in JSON
     #[arg(short = 'j', long = "json")]
     pub use_json_format: bool,
 }
 
+#[derive(ValueEnum, Clone, Debug)]
+pub enum Period {
+    #[value(name = "today", alias = "tod", alias = "td")]
+    Today,
+    #[value(name = "yesterday", alias = "yes", alias = "yd")]
+    Yesterday,
+    #[value(name = "week", alias = "wk")]
+    ThisWeek,
+    #[value(name = "last_week")]
+    LastWeek,
+    #[value(name = "month", alias = "mo")]
+    ThisMonth,
+    // #[value(name = "range")]
+    // DateRange {
+    //     #[arg(value_parser = range_parser)]
+    //     range: RangeInclusive<u32>,
+    // },
+}
+
 #[derive(Args, Debug)]
 #[group(multiple = false)]
 pub struct PrintActivityArgs {