tokely 0.5.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Jean P.D. Meijer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,157 @@
+# tokely
+
+`tokely` is a Node.js CLI that scans local Claude Code, Codex, Cursor, Gemini CLI, Open Code, and Pi Coding Agent usage data and generates a contribution-style heatmap for the rolling past year.
+
+## Requirements
+
+- Node.js `>=22`
+
+## Run with npm
+
+Use it without installing:
+
+```bash
+npx tokely
+```
+
+Install it globally:
+
+```bash
+npm install -g tokely
+tokely
+```
+
+## Usage
+
+```bash
+tokely [--all] [--claude] [--codex] [--cursor] [--gemini] [--opencode] [--pi] [--dark] [--format png|svg|json] [--output ./heatmap-last-year.png]
+```
+
+By default, the CLI:
+
+- scans all supported providers
+- writes `./heatmap-last-year.png`
+- infers the date window as the rolling last year ending today
+
+## Options
+
+- `--claude`: include only Claude Code data
+- `--codex`: include only Codex data
+- `--cursor`: include only Cursor data
+- `--gemini`: include only Gemini CLI data
+- `--opencode`: include only Open Code data
+- `--pi`: include only Pi Coding Agent data
+- `--all`: merge all providers into one combined graph
+- `--dark`: render the image with the dark theme
+- `-f, --format <png|svg|json>`: choose the output format
+- `-o, --output <path>`: write output to a custom path
+- `-h, --help`: print the help text
+
+## Examples
+
+Generate the default PNG:
+
+```bash
+npx tokely
+```
+
+Write an SVG:
+
+```bash
+npx tokely --format svg --output ./out/heatmap.svg
+```
+
+Write JSON for custom rendering:
+
+```bash
+npx tokely --format json --output ./out/heatmap.json
+```
+
+Render only Codex usage:
+
+```bash
+npx tokely --codex
+```
+
+Render only Cursor usage:
+
+```bash
+npx tokely --cursor
+```
+
+Render only Gemini CLI usage:
+
+```bash
+npx tokely --gemini
+```
+
+Render only Pi Coding Agent usage:
+
+```bash
+npx tokely --pi
+```
+
+Render one merged graph across all providers:
+
+```bash
+npx tokely --all
+```
+
+When provider flags are present, `tokely` only loads those providers and only prints availability for those providers.
+
+Render a dark-theme SVG:
+
+```bash
+npx tokely --dark --format svg --output ./out/heatmap-dark.svg
+```
+
+## Output behavior
+
+- If `--format` is omitted, the format is inferred from the `--output` extension when possible.
+- If `--output` is omitted, the default filename becomes `heatmap-last-year.<ext>`, `heatmap-last-year_<providers>.<ext>` for explicit provider flags, or `heatmap-last-year_all.<ext>` for `--all`.
+- Supported extensions are `.png`, `.svg`, and `.json`.
+- If neither `--format` nor a recognized output extension is provided, PNG is used.
+
+## Data locations
+
+- Claude Code: `$CLAUDE_CONFIG_DIR/*/projects` or `~/.config/claude/projects`, `~/.claude/projects`
+- Older Claude Code layouts: falls back to `$CLAUDE_CONFIG_DIR/stats-cache.json`, `~/.config/claude/stats-cache.json`, or `~/.claude/stats-cache.json` for days not present in project logs
+- Earliest Claude Code activity fallback: uses `$CLAUDE_CONFIG_DIR/history.jsonl`, `~/.config/claude/history.jsonl`, or `~/.claude/history.jsonl` to mark activity-only days when token totals are unavailable
+- Codex: `$CODEX_HOME/sessions` or `~/.codex/sessions`
+- Cursor: reads `cursorAuth/accessToken` and `cursorAuth/refreshToken` from `$CURSOR_STATE_DB_PATH`, `$CURSOR_CONFIG_DIR/User/globalStorage/state.vscdb`, `~/Library/Application Support/Cursor/User/globalStorage/state.vscdb` (macOS), `%APPDATA%/Cursor/User/globalStorage/state.vscdb` (Windows), or `~/.config/Cursor/User/globalStorage/state.vscdb` (Linux), then loads usage from Cursor's CSV export endpoint
+- Gemini CLI: `$GEMINI_CONFIG_DIR/tmp/**/chats/session-*.json` or `~/.gemini/tmp/**/chats/session-*.json`
+- Open Code: prefers `$OPENCODE_DATA_DIR/opencode.db` or `~/.local/share/opencode/opencode.db`, and falls back to `$OPENCODE_DATA_DIR/storage/message` or `~/.local/share/opencode/storage/message`
+- Pi Coding Agent: `$PI_CODING_AGENT_DIR/sessions` or `~/.pi/agent/sessions`
+
+When Claude Code falls back to `stats-cache.json`, the daily input/output/cache split is reconstructed from Claude's cached model totals because the older layout does not keep per-request usage logs.
+When Claude Code falls back to `history.jsonl`, those days are rendered as activity-only cells and do not affect the token totals shown in the header.
+
+## Exit behavior
+
+- If no provider flags are passed, `tokely` renders every provider with available data.
+- If `--all` is passed, `tokely` loads all providers and renders one combined graph with merged totals, streaks, and model rankings.
+- Pi Coding Agent usage is derived from assistant messages in Pi session logs, grouped by the model that handled each turn.
+- If provider flags are passed and a requested provider has no data, the command exits with an error.
+- If no provider has data, the command exits with an error.
+
+## Environment variables
+
+- `TOKELY_FILE_PROCESS_CONCURRENCY`: positive integer file-processing limit for Claude Code and Codex JSONL files. Default: `16`.
+- `TOKELY_MAX_JSONL_RECORD_BYTES`: byte cap for Claude Code and Codex JSONL records, OpenCode JSON documents, and OpenCode SQLite `message.data` payloads. Default: `67108864` (`64 MB`).
+
+## JSONL record handling
+
+- Claude Code and Codex JSONL files are streamed through the same bounded record splitter; `tokely` does not materialize whole files in memory.
+- Oversized Claude Code JSONL records fail the file with a clear error that names the file, line number, byte cap, and `TOKELY_MAX_JSONL_RECORD_BYTES`.
+- OpenCode prefers the current SQLite store (`opencode.db`) and falls back to the legacy file-backed message layout.
+- OpenCode legacy JSON message files are read through a bounded JSON document reader before `JSON.parse`.
+- OpenCode SQLite `message.data` payloads use the same byte cap before `JSON.parse`.
+- Oversized OpenCode JSON documents and SQLite message payloads fail clearly with the source path or row label, byte cap, and `TOKELY_MAX_JSONL_RECORD_BYTES`.
+- Only Codex `turn_context` and `event_msg` `token_count` records are parsed for usage aggregation.
+- Oversized irrelevant Codex records are skipped and reported in a warning summary.
+- Oversized relevant Codex records fail the file with a clear error that names the file, line number, byte cap, and `TOKELY_MAX_JSONL_RECORD_BYTES`.
+- Pi Coding Agent session logs are streamed and only assistant messages are parsed for usage aggregation.
+
+## License
+
+MIT