TOKENHAWK DOCS / v1

Know what your
agents consume.

Tokenhawk is a local, live token-usage monitor for Claude Code, Codex, Gemini CLI, Antigravity CLI (agy), Pi, and OpenCode. It turns the metadata already stored on your machine into an interactive terminal dashboard, time-windowed spend reporting, billing reconciliation, compact status output, and exportable records.

Private by designTokenhawk never stores or exports prompts, responses, tool arguments, credentials, or transcript content.
01

Quick start

Install the latest compiled release on macOS or Linux:

Terminal
$ /bin/sh -c "$(curl -fsSL https://tokenhawk.dev/install.sh)"
$ tokenhawk

The installer detects your operating system and architecture, verifies the release checksum, and installs to ~/.local/bin. If needed, add that directory to your PATH.

Choose a version or install directory

Terminal
$ TOKENHAWK_VERSION=0.4.4 sh -c "$(curl -fsSL https://tokenhawk.dev/install.sh)"
$ TOKENHAWK_INSTALL_DIR="$HOME/bin" sh -c "$(curl -fsSL https://tokenhawk.dev/install.sh)"

Install with Go

If you already have Go 1.26 or newer, you can install Tokenhawk directly from the module root:

Terminal
$ go install github.com/polera/tokenhawk@latest

If the command is not found afterward, add $(go env GOPATH)/bin to your PATH.

Build from source

Building from source requires Go 1.26 or newer.

Terminal
$ git clone https://github.com/polera/tokenhawk.git
$ cd tokenhawk
$ go build -o tokenhawk .
$ ./tokenhawk

Run Tokenhawk in a dedicated terminal tab or window. Missing provider directories are allowed, so there is no setup required for tools you do not use.

Keep Tokenhawk current

When the interactive dashboard starts in a terminal, Tokenhawk checks GitHub Releases at most once every 24 hours. If a newer release is available, you can install it immediately or defer the prompt for 24 hours. Run the upgrade directly at any time:

Terminal
$ tokenhawk upgrade

The upgrade downloads the archive for your operating system and architecture, verifies its SHA-256 checksum against the release manifest, and replaces the current executable. After accepting an upgrade from the startup prompt, restart Tokenhawk to continue.

02

Privacy model

Tokenhawk’s session monitoring operates entirely on your machine. It reads provider session metadata from normal local stores and writes a rebuildable SQLite index beneath your operating system’s user-cache directory.

Tokenhawk reads
  • Session and model identifiers
  • Token category counts
  • Session timestamps and status
  • Project metadata and reported cost
Tokenhawk never reads
  • Prompts or responses
  • Tool arguments
  • Stored provider credentials
  • Transcript content

Provider transcript files remain untouched. OpenCode’s SQLite database is opened read-only, including its live WAL data. AGY account and quota fields are ignored. Source paths are omitted from exports unless you explicitly pass --include-source.

Optional billing syncAnthropic billing reconciliation makes read-only requests to the Anthropic Admin API only when ANTHROPIC_ADMIN_KEY is set. The key is read from the environment and is never written to Tokenhawk’s configuration or index.
03

Dashboard

The dashboard separates active, inactive, and all sessions, with a fourth view for spend across a time window and a fifth for Anthropic billing reconciliation. At medium and wide terminal sizes each session row shows provider, project/session, agent counts, model, input, cached input, output, normalized input-to-output ratio, reasoning tokens, total tokens, cost, and update time.

Tokenhawk all-sessions dashboard showing six providers and five navigation views
All sessions view with six providers, cross-provider usage, and cache warnings.

Keyboard controls

KeyAction
1 2 3Active, inactive, and all sessions
4Open spend reporting
5Compare local Claude estimates with Anthropic billing
iToggle active and inactive lists
j k / arrows / page keysNavigate sessions or scroll a spend report
pCycle provider filter
sSort by update time, tokens, or cost
/Filter by project or model metadata
tCycle the time window in a spend view
dType a time window in a spend view
EnterOpen session detail and resume command
e / xExport visible sessions as JSON / CSV
qQuit

Low-cache warning

A session is highlighted when it has at least 100,000 input tokens and less than an 80% cached-input ratio. Detail view identifies low-cache parent and subagent workloads independently.

04

Spend reporting

Press 4 to aggregate tokens and cost over a time window. The view shows totals and input-to-output ratios, then breaks the same sessions down by provider, model, and the 14 most recent UTC days. Estimated model rows show the uncached input, cached input, cache-write, and output quantities alongside the effective catalog rates used to calculate their cost. If the window contains older days, the view reports how many are omitted. Provider and search filters also narrow this view; e and x export exactly the sessions it covers.

Tokenhawk spend report showing reported and estimated cost grouped by provider, model, and UTC day
Spend view with synthetic provider usage and Anthropic billing grouped by provider, model, and last-update day.

If a reporting window crosses a price change, Tokenhawk shows a separate calculation for each effective rate period. Claude’s five-minute and one-hour cache writes are priced separately, and Gemini reasoning tokens are included in its billed output quantity.

Press t to cycle through the last 24 hours, last 7 days, last 30 days, month to date, and all time. Press d to enter a custom window, or launch Tokenhawk directly into one:

Terminal
$ tokenhawk --since 30d
$ tokenhawk --since 2026-07-01

Accepted time windows

Windows accept RFC 3339 timestamps, YYYY-MM-DD dates, relative offsets such as 90m, 24h, 7d, 2w, 3mo, and 1y, compound Go durations such as 1h30m, and the keywords today, yesterday, wtd, mtd, ytd, and all. Relative windows continue rolling while Tokenhawk is open.

How daily spend is attributedProvider stores expose one running total per session, not a timestamped usage ledger. Tokenhawk assigns a session’s complete usage to the day it was last updated, so sessions spanning multiple days are not split across them.
05

Billing reconciliation

Organization administrators can set an Anthropic Admin API key to import authoritative Claude billing from the Usage and Cost Admin API and compare it with Tokenhawk’s local list-price estimates:

Terminal
$ export ANTHROPIC_ADMIN_KEY='sk-ant-admin...'
$ tokenhawk

The first interactive run imports 31 UTC days by default. While Tokenhawk remains open, it refreshes the current and previous UTC day every five minutes. Press 5 to compare estimated and billed cost by exact model and UTC day, including the dollar residual and percentage drift.

Tokenhawk reconciliation report comparing local Claude estimates with Anthropic billing by model and UTC day
Reconciliation view with synthetic local estimates, reported billing, residuals, and drift.

In the Spend view, a successfully covered UTC day uses the imported Anthropic cost and suppresses the overlapping local Claude estimate. Reported and estimated dollars remain visibly separate when both occur in the window.

Organization-wide dataThe Anthropic report has no local session or project ID. Reported billing is not assigned to individual sessions, is excluded while a search is active, and cannot be reconciled when another provider is selected.

Coverage and limits

The Admin API is available to organization administrators, not individual accounts. Pro and Max subscription use has no authoritative per-model billed spend to import. Priority Tier charges and usage routed through Bedrock, Vertex, Foundry, or Claude Platform on AWS are not reported by this endpoint and remain estimates unless their billing provider is integrated separately.

06

Provider data

By default, Tokenhawk discovers usage data in these locations:

ProviderDefault sourceCost
Claude Code~/.claude/projects/**/*.jsonlAPI-equivalent estimate
Codex$CODEX_HOME/sessions/**/*.jsonl and archivesAPI-equivalent estimate
Gemini CLI~/.gemini/tmp/*/chats/session-*.jsonAPI-equivalent estimate
Antigravity CLI (agy)~/.gemini/antigravity-cli/conversations/*.dbUnderlying model estimate
Pi${PI_CODING_AGENT_SESSION_DIR:-~/.pi/agent/sessions}/**/*.jsonlProvider-reported
OpenCode${XDG_DATA_HOME:-~/.local/share}/opencode/opencode.dbProvider-reported

Use the corresponding directory flags or the configuration file to point Tokenhawk at nonstandard roots. Run with --rebuild after changing source locations.

07

Live status inside agent sessions

The compact renderer always selects one session; it never combines usage from multiple sessions. Claude and AGY native hooks supply exact session identifiers. Wrappers select the active, most recently updated session for the current project directory.

TOKENHAWKcodexin 11.80Mcache 96.6%out 76.4k$4.28002/4 agents

Claude Code status line

Add this to ~/.claude/settings.json, merging it with any existing settings:

JSON
{
  "statusLine": {
    "type": "command",
    "command": "tokenhawk statusline claude",
    "refreshInterval": 2,
    "padding": 0
  }
}

The command consumes Claude’s status JSON from standard input and does not add anything to model context.

Antigravity CLI status line

Add this to ~/.gemini/antigravity-cli/settings.json, merging it with any existing settings:

JSON
{
  "statusLine": {
    "type": "command",
    "command": "tokenhawk statusline agy",
    "enabled": true,
    "stack_with_default": true
  }
}

AGY supplies the conversation ID, workspace, active model, and cumulative input and output. Tokenhawk stores that usage snapshot and renders it inside AGY. Because AGY exposes cumulative input and output but only current cache counters, cached input is recorded as the best available lower bound. Existing conversations are discovered, but show no token totals until resumed after the status line is configured.

Universal tmux wrapper

The universal wrapper requires tmux. Outside tmux it creates a temporary dedicated session. Inside tmux it temporarily replaces the right-side status and restores the previous settings when the client exits.

Terminal
$ tokenhawk wrap codex --cd /path/to/project
$ tokenhawk wrap gemini --model gemini-2.5-pro
$ tokenhawk wrap agy --conversation SESSION_ID
$ tokenhawk wrap pi --model anthropic/claude-sonnet-4-5
$ tokenhawk wrap opencode /path/to/project

All remaining arguments are forwarded unchanged to the selected client. You can also use tokenhawk wrap claude if you prefer the universal wrapper.

Direct renderer

Terminal
$ tokenhawk status --provider codex --project "$PWD"
$ tokenhawk status --provider claude --session SESSION_ID --format json
$ tokenhawk status --provider gemini --project "$PWD" --format ansi

The renderer incrementally scans provider stores by default. Add --no-scan when another Tokenhawk process already maintains the index. Set NO_COLOR=1 to turn ANSI output into plain text.

08

Headless export

Export all matching sessions without opening the TUI:

Terminal
$ tokenhawk export --format json --output usage.json
$ tokenhawk export --format csv --output usage.csv \
    --provider codex --since 2026-07-01
$ tokenhawk export --format csv --output month.csv --since mtd

Filters include --provider, --model, --project, --status, --since, and --until. Both time bounds accept the forms listed under spend reporting. A bare YYYY-MM-DD used with --until includes that entire day.

  • JSON contains nested per-model and subagent usage.
  • CSV contains tagged session/model and subagent/model rows, including total and one-hour cache-write counts, cost, and running status.
  • Local source paths stay excluded unless --include-source is set.
09

Configuration

Tokenhawk loads tokenhawk/config.toml beneath your operating system’s user-config directory. Every field is optional and command-line flags take precedence.

TOML
claude_dir = "~/.claude/projects"
codex_dir = "~/.codex"
gemini_dir = "~/.gemini/tmp"
agy_dir = "~/.gemini/antigravity-cli"
pi_dir = "~/.pi/agent/sessions"
opencode_db = "~/.local/share/opencode/opencode.db"
active_window = "5m"
refresh = "2s"
db_path = "~/.cache/tokenhawk/index.db"
pricing_file = "~/.config/tokenhawk/pricing.json"
anthropic_cost_lookback_days = 31
include_source = false
After changing source rootsRun tokenhawk --rebuild. Pricing catalog and override changes are fingerprinted and automatically trigger a one-time rebuild.
10

Pricing

Claude, Codex, Gemini, and recognized models used through AGY are estimates of public API list-price equivalents, not subscription charges, invoices, free-tier consumption, discounts, credits, or taxes. AGY labels are normalized before exact lookup and use the underlying Gemini or Claude catalog rate. Pi and OpenCode record calculated costs themselves; Tokenhawk labels those values reported and preserves them.

The bundled, effective-dated catalog prices only exact, known model IDs. The spend view identifies the rate and effective date behind each estimated model cost, while unknown models remain unpriced instead of inheriting a guessed family rate. Anthropic Admin API billing, when configured, is also labeled reported.

Override a rate

JSON
{
  "version": "company-rates-1",
  "rates": [{
    "provider": "codex",
    "model": "my-exact-model-id",
    "effective_from": "2026-01-01",
    "input_per_million": 1.0,
    "cached_input_per_million": 0.1,
    "cache_creation_per_million": 1.0,
    "cache_creation_1h_per_million": 2.0,
    "output_per_million": 8.0
  }]
}
11

Commands & flags

CommandPurpose
tokenhawkOpen the interactive terminal dashboard
tokenhawk statusRender one selected session as plain, ANSI, tmux, or JSON
tokenhawk statusline claude|agyConsume a native provider status payload and render one session
tokenhawk wrap <provider>Run a supported client with a tmux status bar
tokenhawk exportWrite matching sessions as JSON or CSV
tokenhawk upgradeCheck for, verify, and install the latest release
tokenhawk versionPrint the installed version

Shared selection and storage flags

--providerFilter to claude, codex, gemini, agy, pi, or opencode.
--modelFilter by model metadata.
--projectFilter or select by project path.
--statusFilter active or inactive sessions.
--sinceOpen the TUI on a spend window, or set an export’s inclusive lower time bound.
--untilSet an export’s inclusive upper time bound.
--sessionSelect an exact session ID for status output.
--configLoad a specific configuration file.
--dbUse a specific index database.
--agy-dirUse a specific Antigravity CLI data directory.
--pricing-fileLoad a specific pricing override JSON file.
--anthropic-cost-lookback-daysSet the UTC-day history imported on the first Anthropic billing sync.
--rebuildReset and rebuild the local index.
--refreshSet the local provider scan and session reconciliation interval.
--active-windowSet how recently a session must update to be active.
12

Troubleshooting

Tokenhawk is installed but the command is missing.

Make sure ~/.local/bin (or your custom TOKENHAWK_INSTALL_DIR) is on your shell’s PATH, then open a new terminal.

A provider does not appear.

Confirm the provider has created at least one local session and that its source path matches the defaults above. For a custom location, set the corresponding config field or CLI flag and run tokenhawk --rebuild.

The wrapper cannot start.

tokenhawk wrap requires tmux and the selected provider client to be installed and available on your PATH.

A cost is marked unpriced.

The model identifier does not exactly match a bundled price. Add an exact identifier through a pricing override file instead of relying on a guessed family rate.

Anthropic billing does not appear.

Billing sync requires an organization Admin API key in ANTHROPIC_ADMIN_KEY. It is unavailable to individual Pro and Max accounts. Check the TUI footer for an API warning, and clear search or non-Claude provider filters when reconciling.

How do I disable ANSI color?

Set NO_COLOR=1. ANSI status-line output will render as plain text.

Ready to watch your sessions? Install Tokenhawk