Skip to content

Commit 32cd66d

Browse files
ticpuclaude
andcommitted
docs: add screenshots and update README with recent features
- Add status-line.png and config.png to docs/images/ - Remove emojis from feature list for cleaner documentation - Document OAuth authentication replacing Firefox cookies - Add configurable update channels (stable/latest) - Note auto-creation of settings.json during install Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 374e547 commit 32cd66d

File tree

3 files changed

+18
-12
lines changed

3 files changed

+18
-12
lines changed

README.md

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,27 @@
22

33
Ultra-fast Rust implementation of Claude Code usage statusline.
44

5+
![Status Line Example](docs/images/status-line.png)
6+
57
## Description
68

79
High-performance statusline for Claude Code that displays real-time usage metrics, billing blocks, and burn rates. Written in Rust for sub-millisecond response times with intelligent caching.
810

911
## Features
1012

11-
-**Ultra-fast performance** - 15x faster than Node.js implementation (8ms vs 120ms warm)
12-
- 📊 **Live API integration** - Real-time 5-hour and 7-day utilization from claude.ai API
13-
- 🔼 **Update notifications** - Checks npm registry for Claude Code updates (30-min cache)
14-
- 🕑 **Time remaining** - Shows time left in billing block with clock emoji easter egg
15-
- ⚙️ **Interactive configuration** - Menu-based UI to enable/disable statusline elements
16-
- 🖥️ **Interactive mode** - Works as standalone tool or piped statusline
17-
- 🦊 **Firefox cookie extraction** - Automatic authentication using Firefox profile
18-
- 💰 **Accurate cost tracking** - Fetches daily pricing from LiteLLM, supports tiered pricing
19-
- 🔄 **Smart caching** - XDG_RUNTIME_DIR-based caching with 24-hour pricing cache
20-
- 🎯 **5-hour block tracking** - Matches Claude's billing cycles exactly
21-
- 🧮 **Deduplication** - Prevents double-counting duplicate JSONL entries
22-
- 🔥 **Burn rate monitoring** - Real-time cost per hour with visual indicators
13+
- **Ultra-fast performance** - 15x faster than Node.js implementation (8ms vs 120ms warm)
14+
- **Live API integration** - Real-time 5-hour and 7-day utilization via Claude Code OAuth
15+
- **Update notifications** - Checks for Claude Code updates with configurable channels (stable/latest)
16+
- **Time remaining** - Shows time left in billing block with clock emoji easter egg
17+
- **Interactive configuration** - Menu-based UI to enable/disable statusline elements
18+
- **Interactive mode** - Works as standalone tool or piped statusline
19+
- **OAuth authentication** - Uses Claude Code's native OAuth tokens from ~/.claude/.credentials.json
20+
- **Accurate cost tracking** - Fetches daily pricing from LiteLLM, supports tiered pricing
21+
- **Smart caching** - XDG_RUNTIME_DIR-based caching with 24-hour pricing cache
22+
- **5-hour block tracking** - Matches Claude's billing cycles exactly
23+
- **Deduplication** - Prevents double-counting duplicate JSONL entries
24+
- **Burn rate monitoring** - Real-time cost per hour with visual indicators
25+
- **Auto-install** - Creates ~/.claude/settings.json if missing during install
2326

2427
## Inspiration
2528

@@ -71,8 +74,11 @@ Configure which elements to display:
7174
ccusage-statusline-rs config
7275
```
7376

77+
![Configuration Menu](docs/images/config.png)
78+
7479
This opens an interactive menu where you can:
7580
- Enable/disable individual elements (Model, Block cost, Time remaining, etc.)
81+
- Choose update notification channel (stable/latest/off)
7682
- Configuration persists in `~/.claude/ccusage-statusline-config.json`
7783

7884
### Manual Configuration (Not Recommended)

docs/images/config.png

25 KB
Loading

docs/images/status-line.png

16.3 KB
Loading

0 commit comments

Comments
 (0)