From 2c414a53dc95c75584398246beb34f7ddf181448 Mon Sep 17 00:00:00 2001 From: Paul Buetow Date: Tue, 3 Mar 2026 23:20:07 +0200 Subject: docs: refresh README and keep version at v0.4.0 --- README.md | 115 ++++++++++++++++++++++++++++------------------------ internal/version.go | 2 +- 2 files changed, 62 insertions(+), 55 deletions(-) diff --git a/README.md b/README.md index d5f2a59..ebd97bf 100644 --- a/README.md +++ b/README.md @@ -1,99 +1,106 @@ # timr -A simple command-line tool to track time spent on tasks. It has been primarily coded using Google Gemini CLI and Claude Code CLI. +`timr` is a terminal time-tracking tool that combines: -## About +- a stopwatch timer, +- worktime-style work log tracking, +- weekly reporting, +- and a Bubble Tea TUI. -`timr` is a minimalist stopwatch-style timer that runs in your terminal. It helps you track the time you spend on your work by allowing you to start, stop, and check the status of the timer. The timer's state is saved to your system, so you can pause your work and resume tracking later. - -It has been vibe coded! +Current version: `v0.4.0`. ## Installation -To build and install `timr`, you need to have Go installed on your system. The project uses [Mage](https://magefile.org/) for building. +Requirements: + +- Go (current project targets Go 1.24+) +- [Mage](https://magefile.org/) (optional, recommended) -### Using Mage (Recommended) +Build with Mage: ```bash -# Install mage if you haven't already go install github.com/magefile/mage@latest - -# Build the project mage build ``` -### Direct Go Build - -Alternatively, you can build directly with Go: +Or build directly: ```bash go build -o timr ./cmd/timr ``` -This will create a `timr` executable in the current directory. To make it accessible from anywhere, you can move it to a directory in your system's `PATH`, such as `/usr/local/bin`: +## CLI Overview + +`timr` now uses Cobra and supports global flags: ```bash -sudo mv timr /usr/local/bin/ +timr --version +timr --config /path/to/config.json ``` -## Usage - -`timr` provides the following commands: +Top-level command groups: -* `timr start`: Starts the timer. If the timer was previously stopped, it will resume from where it left off. -* `timr stop` or `timr pause`: Stops or pauses the timer. The elapsed time will be saved. -* `timr cont` or `timr continue`: Continues the stopped timer. -* `timr status`: Shows the current status of the timer (running or stopped) and the total elapsed time. -* `timr status raw`: Shows the current elapsed time in seconds, in a raw format. -* `timr status rawm`: Shows the current elapsed time in minutes, in a raw format. -* `timr reset`: Resets the timer. This will set the elapsed time to zero. -* `timr track `: Saves the current elapsed time with a description and resets the timer. -* `timr live [-f|--font ]`: Shows a live, full-screen timer with keyboard controls and optional font selection. -* `timr prompt`: Shows a compact status for shell prompt integration. +- `timr timer ...` +- `timr work ...` +- `timr tui` -## Live Mode +### `timer` Commands -The live mode provides an interactive, full-screen timer display with the following features: +```bash +timr timer start +timr timer stop +timr timer continue +timr timer reset +timr timer status [--raw|--raw-minutes] +timr timer prompt +timr timer track +timr timer live [-f|--font ] +``` -### Keyboard Controls +### `work` Commands -* `s`: Start/Stop the timer -* `r`: Reset the timer to zero -* `f`: Cycle through different display fonts -* `q` or `Ctrl+C`: Quit live mode +```bash +timr work login [-c|--category ] [--at