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 <noreply@anthropic.com>
This commit is contained in:
@@ -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).
|
- **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).
|
- **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.
|
- **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).
|
- **Pricing**: Hardcoded in `internal/config/pricing.go` with user overrides in config TOML. Model names are normalized (date suffixes stripped).
|
||||||
|
|
||||||
|
|||||||
22
README.md
22
README.md
@@ -5,15 +5,29 @@ A CLI and TUI dashboard for analyzing Claude Code usage metrics. Parses JSONL se
|
|||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Build from source
|
go install github.com/theirongolddev/cburn@latest
|
||||||
make build
|
```
|
||||||
|
|
||||||
# Install to ~/go/bin
|
Or build from source:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://github.com/theirongolddev/cburn.git
|
||||||
|
cd cburn
|
||||||
make install
|
make install
|
||||||
```
|
```
|
||||||
|
|
||||||
Requires Go 1.24+.
|
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
|
## Quick Start
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
@@ -145,7 +159,7 @@ To get your session key:
|
|||||||
|
|
||||||
## Caching
|
## 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`.
|
Force a full reparse with `--no-cache`.
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user