From 3668ae7f706881d81bf69d6a76f60f93e3639d28 Mon Sep 17 00:00:00 2001 From: teernisse Date: Mon, 23 Feb 2026 10:09:26 -0500 Subject: [PATCH] docs: improve installation guide with PATH setup README changes: - Add go install github.com/...@latest as primary install method - Add git clone instructions as alternative - Add PATH setup instructions for bash/zsh and fish shells - Fix cache database filename (sessions.db -> metrics_v2.db) CLAUDE.md: - Fix cache database filename to match actual implementation New users on fresh Go installations often miss that ~/go/bin needs to be in PATH. This was causing "command not found" errors after successful installation. Co-Authored-By: Claude Opus 4.5 --- CLAUDE.md | 2 +- README.md | 22 ++++++++++++++++++---- 2 files changed, 19 insertions(+), 5 deletions(-) diff --git a/CLAUDE.md b/CLAUDE.md index 0560399..781aa07 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -66,7 +66,7 @@ Tests live alongside the code they test (`*_test.go`). The parser has both unit - **Parsing strategy**: User/system entries use byte-level extraction for speed; only assistant entries get full JSON parse (they carry token/cost data). - **Deduplication**: Messages are keyed by message ID; the final state wins (handles edits/retries). -- **Cache**: SQLite at `~/.cache/cburn/sessions.db`. Mtime+size diffing means unchanged files aren't reparsed. +- **Cache**: SQLite at `~/.cache/cburn/metrics_v2.db`. Mtime+size diffing means unchanged files aren't reparsed. - **TUI async loading**: Data loads via goroutines posting `tea.Msg`; the UI remains responsive during parse. - **Pricing**: Hardcoded in `internal/config/pricing.go` with user overrides in config TOML. Model names are normalized (date suffixes stripped). diff --git a/README.md b/README.md index 63973c2..08da621 100644 --- a/README.md +++ b/README.md @@ -5,15 +5,29 @@ A CLI and TUI dashboard for analyzing Claude Code usage metrics. Parses JSONL se ## Installation ```bash -# Build from source -make build +go install github.com/theirongolddev/cburn@latest +``` -# Install to ~/go/bin +Or build from source: + +```bash +git clone https://github.com/theirongolddev/cburn.git +cd cburn make install ``` Requires Go 1.24+. +**Note:** Ensure `~/go/bin` is in your PATH: + +```bash +# bash/zsh: add to ~/.bashrc or ~/.zshrc +export PATH="$HOME/go/bin:$PATH" + +# fish: add to ~/.config/fish/config.fish +fish_add_path ~/go/bin +``` + ## Quick Start ```bash @@ -145,7 +159,7 @@ To get your session key: ## Caching -Session data is cached in SQLite at `~/.cache/cburn/sessions.db`. The cache uses mtime-based diffing - unchanged files are not reparsed. +Session data is cached in SQLite at `~/.cache/cburn/metrics_v2.db`. The cache uses mtime-based diffing - unchanged files are not reparsed. Force a full reparse with `--no-cache`.