Skip to content

Commit c76160f

Browse files
committed
npm: align package readme/description with project docs
1 parent 48ab437 commit c76160f

File tree

2 files changed

+78
-7
lines changed

2 files changed

+78
-7
lines changed

npm/tu/README.md

Lines changed: 76 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,86 @@
1-
# tokenusage
1+
# tokenusage (`tu`)
22

3-
NPM distribution for [`tokenusage`](https://github.com/hanbu97/tokenusage).
3+
Blazing-fast Rust token usage tracker for **Claude Code** and **Codex**.
4+
5+
- Unified report across Claude + Codex
6+
- Fast parallel scan + cache
7+
- CLI table, TUI, GUI (`iced` + `tiny-skia`)
8+
- Live monitor with progress bars
9+
10+
Repository: [github.com/hanbu97/tokenusage](https://github.com/hanbu97/tokenusage)
11+
Crate: [crates.io/crates/tokenusage](https://crates.io/crates/tokenusage)
412

513
## Install
614

715
```bash
8-
npm i -g tokenusage
16+
npm install -g tokenusage
17+
```
18+
19+
## Quick Start
20+
21+
```bash
22+
# Daily report (default)
23+
tu
24+
25+
# Source-specific
26+
tu codex
27+
tu claude
28+
29+
# Date filter
30+
tu --since 2026-02-01 --until 2026-02-28
31+
32+
# Weekly / monthly
33+
tu weekly --start-of-week monday
34+
tu monthly
35+
36+
# Live monitor
37+
tu live
38+
tu live codex
39+
tu live claude
40+
41+
# GUI dashboard
42+
tu gui
943
```
1044

11-
## Usage
45+
## Screenshots
46+
47+
![CLI demo](https://raw.githubusercontent.com/hanbu97/tokenusage/main/docs/images/cli-demo.png)
48+
![GUI demo](https://raw.githubusercontent.com/hanbu97/tokenusage/main/docs/images/gui-demo.png)
49+
50+
## Why `tu`
51+
52+
- Real-world benchmark vs `ccusage` on local Codex logs:
53+
- About **34.5x faster (cold)** and **131.1x faster (warm)**
54+
- Rust-native startup, parallel parsing, incremental cache reuse
55+
56+
## Data Sources (default)
57+
58+
- Claude:
59+
- `~/.config/claude/projects`
60+
- `~/.claude/projects`
61+
- Codex:
62+
- `~/.codex/sessions`
63+
- `~/.config/codex/sessions`
64+
65+
You can override with:
66+
67+
- `--claude-projects-dir <PATH>` (repeatable)
68+
- `--codex-sessions-dir <PATH>` (repeatable)
69+
70+
## Config
71+
72+
Default config search:
73+
74+
1. `./.tu/tu.json`
75+
2. `~/.config/tu/tu.json`
76+
3. `~/.config/tokenusage/tokenusage.json`
77+
78+
Explicit config:
1279

1380
```bash
14-
tu --help
81+
tu --config /path/to/tu.json
1582
```
83+
84+
## License
85+
86+
MIT

npm/tu/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "tokenusage",
3-
"version": "0.1.0",
4-
"description": "Blazing-fast Rust token usage tracker for Codex and Claude Code.",
3+
"version": "0.1.1",
4+
"description": "Blazing-fast Rust token usage tracker for Claude Code and Codex, with unified reports, live monitoring, and CLI/TUI/GUI.",
55
"license": "MIT",
66
"repository": {
77
"type": "git",

0 commit comments

Comments
 (0)