docs: document persistent cache behavior

This commit is contained in:
Sharada Mohanty 2026-04-20 17:55:37 +02:00
parent 140e50b702
commit eb3737f756
2 changed files with 27 additions and 0 deletions

View file

@ -2,6 +2,14 @@
## Unreleased
### Added
- **Persistent parse cache for all providers.** Repeated CLI runs now reuse parsed source summaries across fresh processes instead of reparsing raw logs every time.
- **`--no-cache` on parse-backed commands.** `report`, `today`, `month`, `status`, `export`, `optimize`, and `compare` can bypass cached entries for that run and rebuild them from raw logs.
- **`Updating cache` stderr progress.** Non-JSON cold or partial cache rebuilds now show progress while CodeBurn refreshes changed sources.
### Changed
- **Cursor now uses the shared parse cache.** The provider-specific Cursor cache path is gone; SQLite-backed provider data now flows through the same persistent cache layer as the other providers.
## 0.8.0 - 2026-04-19
### Added

View file

@ -80,6 +80,25 @@ codeburn today --format json | jq '.overview.cost'
For the lighter `status --format json` (today + month totals only) or file-based exports (`export -f json`), see above.
## Cache behavior
CodeBurn now keeps a persistent parse cache under `~/.cache/codeburn/source-cache-v1/`.
It applies to every provider. Unchanged sources load from cache across fresh CLI runs,
while changed sources are refreshed on demand so rolling windows like `today` stay current
as new log entries land.
Use `--no-cache` on any command that reads session data to ignore cached entries for that
run and rebuild them from raw logs:
```bash
codeburn today --no-cache
codeburn report --period all --no-cache
codeburn export --no-cache
```
When a non-JSON command needs to rebuild part of the cache, CodeBurn shows an
`Updating cache` progress bar on stderr. JSON output stays clean on stdout.
## Providers
CodeBurn auto-detects which AI coding tools you use. If multiple providers have session data on disk, press `p` in the dashboard to toggle between them.