Skip to main content

Count AI coding-agent tokens per git branch and report them on GitHub PRs

Project description

tokenchecker

Count AI coding-agent tokens per git branch — across sessions and machines — and post the totals as a comment on the GitHub PR when it opens.

Supported agents (parsed from their local logs, no API keys needed):

Tool Data source Branch attribution
Claude Code ~/.claude/projects/<project>/*.jsonl (per-message usage) exact — gitBranch recorded per message
Codex CLI ~/.codex/sessions/Y/M/D/*.jsonl (token_count events) branch recorded in session metadata
Gemini CLI ~/.gemini/tmp/<sha256(cwd)>/chats/*.json (per-message tokens) inferred from your repo's HEAD reflog at message time
Cursor state.vscdb (per-message tokenCount in bubble records) inferred from HEAD reflog at message time

Single-file, stdlib-only Python 3.9+. macOS and Linux (Cursor paths auto-detected on macOS; override with env vars elsewhere).

How it works

 your laptop                         origin (GitHub)                PR
┌─────────────────────┐             ┌──────────────────────┐
│ claude / codex /    │  git push   │ refs/token-usage/    │  GitHub Action:
│ gemini / cursor logs│ ──────────► │   laptop-a1b2c3d4    │  fetch refs/token-usage/*
│        │            │ (pre-push   │   desktop-e5f6a7b8   │  aggregate head branch
│        ▼            │  hook runs  │   coworker-c9d0e1f2  │  upsert PR comment
│ tokenchecker sync   │  `sync`)    └──────────────────────┘
└─────────────────────┘
  1. tokenchecker collect scans the local logs of all four tools, keeps only records whose working directory (or remote URL) matches the current repo, normalizes them into deduplicatable records (input / cache_read / cache_write / output / total + branch + timestamp + machine), and stores them under .git/tokenchecker/.
  2. tokenchecker push publishes the machine's records to a custom git ref refs/token-usage/<machine-id> on origin. Each machine owns exactly one ref, so there are never conflicts, and no external storage is needed. Records are idempotent — re-collecting and re-pushing never double-counts.
  3. A pre-push git hook runs sync (= collect + push) automatically, so usage data reaches origin together with the branch you're about to open a PR for.
  4. On pull_request (opened / synchronize / reopened) the GitHub Action fetches all refs/token-usage/* refs, aggregates every machine's records for the head branch, and creates/updates a single sticky PR comment.

Setup

Global (recommended): once per machine

pipx install tokenchecker        # or: uv tool install tokenchecker
# or, straight from git (works for private forks too):
#   pipx install git+https://github.com/ZohaibAhmed/tokenchecker
# or, no package manager at all — the script is a single stdlib-only file:
#   python3 tokenchecker.py install --global   (from a checkout)

tokenchecker install --global

This copies the script to ~/.tokenchecker/, adds a tokenchecker CLI wrapper at ~/.tokenchecker/bin/, and sets git's global core.hooksPath to a directory of dispatcher hooks that chain to each repository's own .git/hooks/* first, then record token usage on pre-push. Every repo on the machine is covered automatically — no per-repo, per-clone setup.

  • Opt a repo out: git config tokenchecker.enabled false
  • Repos that set core.hooksPath themselves (e.g. husky) bypass the global hooks — add the sync line to their hook system or use the per-repo install there.
  • If you already had a global core.hooksPath, the installer refuses to clobber it and prints the one line to add to your existing pre-push hook.
  • Hook runs are quiet when there is nothing new; you only see output when records are actually collected or pushed.

PR comments still need two committed files per repository (CI can't read your laptop): run python3 ~/.tokenchecker/tokenchecker.py install in the repo once and commit scripts/tokenchecker.py + .github/workflows/token-usage.yml.

Per repository (alternative)

# one time, by anyone: vendor the tool + workflow into the repo
curl -fsSL https://raw.githubusercontent.com/<you>/tokenchecker/main/tokenchecker.py \
  -o /tmp/tokenchecker.py            # or copy it from this repo
python3 /tmp/tokenchecker.py install # run from inside the target repo
git add scripts/tokenchecker.py .github/workflows/token-usage.yml
git commit -m "add tokenchecker"

# every contributor, once per clone (installs their local pre-push hook):
python3 scripts/tokenchecker.py install

install is idempotent. It:

  • vendors the script at scripts/tokenchecker.py (committed, used by CI and teammates)
  • appends a guarded block to .git/hooks/pre-push (local; preserves existing hooks)
  • writes .github/workflows/token-usage.yml (committed)
  • with --claude-hook, also adds a Claude Code SessionEnd hook to .claude/settings.json so usage syncs when a Claude session ends, not just on push

Commands

python3 scripts/tokenchecker.py sync                 # collect + publish (what the hook runs)
python3 scripts/tokenchecker.py collect --dry-run    # preview per-branch usage, write nothing
python3 scripts/tokenchecker.py status               # when did it last run, what's synced where
python3 scripts/tokenchecker.py report               # all branches, all machines
python3 scripts/tokenchecker.py report --branch feature/x --markdown  # PR-comment format
python3 scripts/tokenchecker.py report --json        # raw records

Seeing it run

  • On every git push the hook prints two lines in your terminal:
    tokenchecker: collected 7 records (claude-code=4, codex=1, gemini=1, cursor=1); 0 new; store has 6
    tokenchecker: pushed 6 records to origin refs/token-usage/laptop-a1b2c3d4
    
  • status shows the machine id, the local store, a timestamped log of recent collect/push runs (kept in .git/tokenchecker/log), every synced machine ref with its last-push time, and which refs exist on origin.
  • In CI, the Action run appears in the PR's Checks tab; the rendered report is printed in the job log and on the run's Summary page, in addition to the PR comment itself.

Useful flags: --since N (lookback days, default 90), --remote NAME (default origin), --repo PATH (default: cwd).

The PR comment

## 🤖 AI token usage for `feature/x`

| Tool        | Model            | Sessions | Msgs | Input | Cache read | Cache write | Output | Total |
| claude-code | claude-fable-5   |        2 |    3 |   211 |      2,000 |         100 |     74 | 2,385 |
| codex       | gpt-5.5          |        1 |    1 |   500 |        400 |           0 |    100 | 1,000 |
| ...

Cache reads are reported separately from fresh input tokens (they're billed differently and dominate agent usage), and the per-machine breakdown is in a collapsible section.

Semantics & accuracy notes

  • Dedup: every record has a stable id (message id / session id / bubble id). Streaming snapshots, re-collection, and multi-machine overlap all collapse to the max-total record, so numbers never double-count.
  • Codex reports a cumulative counter per session; tokenchecker takes the session's final counter (one record per session), attributed to the branch the session started on.
  • Gemini / Cursor don't record the branch, so tokenchecker replays your repo's HEAD reflog to determine which branch was checked out at each message's timestamp. This is accurate unless you rewrite history, and reflog entries expire after ~90 days (git's default) — matching the default --since 90 window.
  • Cursor exposes inputTokens/outputTokens per message locally but no cache split. Older Cursor conversations (before it started persisting tokenCount) report 0.
  • Tokens spent on a machine only reach the PR after that machine pushes (any push — the hook publishes usage for all branches, not just the pushed one) or runs sync manually.
  • Forks: contributors pushing from forks publish refs/token-usage/* to their fork, which the base repo's Action can't see. Same-repo branches are fully supported.

Env overrides

TOKENCHECKER_MACHINE_ID, TOKENCHECKER_CLAUDE_DIR, TOKENCHECKER_CODEX_DIR, TOKENCHECKER_GEMINI_DIR, TOKENCHECKER_CURSOR_GLOBAL_DB, TOKENCHECKER_CURSOR_WS_DIR. Setting TOKENCHECKER_SKIP=1 disables the pre-push hook (used internally to prevent recursion).

Cleaning up

Usage refs are plain git refs; delete them with git push origin --delete refs/token-usage/<machine-id> and remove .git/tokenchecker/ locally. Nothing else is stored anywhere.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tokenchecker-0.1.0.tar.gz (19.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tokenchecker-0.1.0-py3-none-any.whl (20.6 kB view details)

Uploaded Python 3

File details

Details for the file tokenchecker-0.1.0.tar.gz.

File metadata

  • Download URL: tokenchecker-0.1.0.tar.gz
  • Upload date:
  • Size: 19.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for tokenchecker-0.1.0.tar.gz
Algorithm Hash digest
SHA256 7977f951834309944ad941ce14b4bcd7fd2fba4463156668966aba82da8e41cd
MD5 149ca629206e3a7efffb70ad452e11c3
BLAKE2b-256 18bcd60471d7f585a12f8f5731d61a48e0d9b035cf30856ebd411f46fe0e2ca4

See more details on using hashes here.

Provenance

The following attestation bundles were made for tokenchecker-0.1.0.tar.gz:

Publisher: release.yml on ZohaibAhmed/tokenchecker

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file tokenchecker-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: tokenchecker-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 20.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for tokenchecker-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6b4b6b9ec8e37022820f28e90f4a44bbd39e2fb6774dbd22d89381e2b60ac5be
MD5 34128d0dd642d1ddf3899e02cfed82d2
BLAKE2b-256 ed05da0fcdae227ed8e9dbb9d08b83bad47d02d7cbffe8c6d52b17b394a7bf11

See more details on using hashes here.

Provenance

The following attestation bundles were made for tokenchecker-0.1.0-py3-none-any.whl:

Publisher: release.yml on ZohaibAhmed/tokenchecker

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page