agentusage 0.1.4

Local-first agent usage tracking
agentusage-0.1.4 is not a library.

agentusage

CI Latest release License

Local-first usage reports for AI coding agents.

agentusage reads local agent history, normalizes it into SQLite or PostgreSQL, and reports tokens, cost, models, clients, cache usage, code changes, and Copilot AI credits. Your usage data stays on your machine unless you explicitly configure a PostgreSQL server.

Project status: early access. Provider adapters and report fields are still expanding. Feedback and fixtures are welcome.

Roadmap

  • Add Google Antigravity CLI usage support.
  • Expand the local web server into a fully interactive dashboard with richer filtering, provider detail views, and responsive usage exploration.
  • Add a config.toml onboarding flow for discovering and configuring multiple agent sources in one place.

Highlights

  • Daily, weekly, monthly, yearly, and arbitrary date-range reports.
  • Input, output, reasoning, cache-read, cache-write, and total-token breakdowns.
  • Model and client attribution, including CLI, IDE, Desktop, and Copilot usage.
  • Project/workspace, tool-call, and language breakdowns where provider data is available.
  • SQLite by default, with optional PostgreSQL storage.
  • Idempotent ingestion, raw-event preservation, and incremental processing.
  • Copilot CLI and VS Code Copilot model, token, and AI-credit tracking.
  • Telemetry hooks with stdin, positional payload, spool-only, and daemon modes.
  • macOS, Linux, and Windows release binaries.

Installation

If Rust is installed, the simplest option is:

cargo install --git https://github.com/binzhango/agentusage --locked --bins
agentusage --version

This installs both agentusage and the au alias into Cargo's binary directory, usually ~/.cargo/bin. For a local checkout, use cargo install --path . --locked --bins.

Download the archive for your platform from the latest GitHub release, extract it, and put the agentusage binary on your PATH.

Example for Apple Silicon macOS:

curl -fL -o agentusage.tar.gz \
  https://github.com/binzhango/agentusage/releases/latest/download/agentusage-macos-aarch64.tar.gz
tar -xzf agentusage.tar.gz
sudo install -m 0755 agentusage /usr/local/bin/agentusage
sudo install -m 0755 au /usr/local/bin/au
agentusage --version
au --version

au is an executable alias for agentusage; both commands support the same dashboard, server, report, and telemetry subcommands.

Available release targets:

Platform Archive
macOS Apple Silicon agentusage-macos-aarch64.tar.gz
Linux ARM64 agentusage-linux-aarch64.tar.gz
Linux x86_64 agentusage-linux-x86_64.tar.gz
Windows x86_64 agentusage-windows-x86_64.zip

Release archives include SHA256SUMS. Verify the checksum before installing in a production environment.

Quick start

agentusage dashboard

agentusage dashboard opens the interactive terminal dashboard. It shows Codex, Claude Code, OpenCode, and Copilot usage together. Use w to cycle Today, 7 days, 30 days, and all-time windows, r to refresh, and q to quit. The dashboard requires an interactive terminal.

Running agentusage without a subcommand prints help. The local browser dashboard is available with:

agentusage server
agentusage server --open

The server listens on 127.0.0.1:8787 by default and serves the dashboard UI and JSON API without exposing usage data to the network. Use --host and --port to change the bind address when needed.

On first use, the CLI checks for an initialized database. If none exists, it asks whether to initialize SQLite, use PostgreSQL, or continue with the JSONL fallback. Non-interactive invocations do not silently initialize a database.

Reports

Detailed reports are available under agentusage command. The original period commands remain supported as compatibility aliases. All report commands accept --provider.

# Today
agentusage command daily --provider codex
agentusage command daily --provider claude_code
agentusage command daily --provider opencode
agentusage command daily --provider copilot

# Compatibility alias
agentusage daily --provider codex

# Specific date
agentusage daily --provider codex --date 2026-07-19

# Week, month, and year
agentusage weekly --provider codex
agentusage monthly --provider copilot --month 2026-07
agentusage yearly --provider claude_code --year 2026

# Inclusive date range
agentusage range --provider copilot \
  --from 2026-07-01 --to 2026-07-19

The server API is available at /api/providers and /api/summary?provider=codex&window=today. Supported windows are today, 7d, 30d, and all.

Reports include:

  • requests, prompts, sessions, lines added, and lines removed;
  • input, output, reasoning, cache-read, cache-write, and total tokens;
  • estimated cost and cache-hit rate when pricing data is available;
  • model and client breakdowns;
  • project/workspace breakdowns when provider metadata includes a working directory;
  • tool-call and language breakdowns for imported provider telemetry;
  • Copilot AI credits and native AI-unit values when the source provides them.

Codex can read an alternate rollout-log directory:

agentusage daily --provider codex --sessions-dir /path/to/codex/sessions

Supported providers

Provider Local source Report details
codex Codex rollout JSONL Tokens, models, cache, cost, sessions, and code changes
claude_code Claude Code session JSONL Tokens, models, sessions, and desktop quota signals
opencode OpenCode session JSONL Tokens, models, sessions, and cost fields
copilot Copilot CLI databases and VS Code chat JSONL/logs CLI/IDE attribution, tokens, models, and AI credits

For VS Code Copilot, an entry such as MAI-Code-1-Flash • 1.6 credits is reported with its resolved model and exact copilotCredits value when that metadata is present locally.

Storage and configuration

Provider reports use separate SQLite databases by default:

~/.local/state/agentusage/codex.db
~/.local/state/agentusage/claude_code.db
~/.local/state/agentusage/opencode.db
~/.local/state/agentusage/copilot.db

Telemetry hooks and the daemon use:

~/.local/state/agentusage/telemetry.db

Set XDG_STATE_HOME to change the state directory:

XDG_STATE_HOME="$HOME/.local/state" agentusage daily --provider codex

PostgreSQL is available through AGENTUSAGE_POSTGRES_URL. When no initialized provider SQLite database exists, the first-run prompt can select PostgreSQL:

export AGENTUSAGE_POSTGRES_URL='postgresql://user:password@localhost/agentusage'
agentusage monthly --provider copilot

The project does not use an OPENUSAGE_* database variable.

Telemetry hooks and daemon

Pass a hook payload positionally:

agentusage telemetry hook codex \
  '{"turn_id":"turn-1","usage":{"input_tokens":10,"output_tokens":4}}' \
  --verbose

Or pipe the payload through stdin:

printf '%s' '{"event":"message","usage":{"input_tokens":10}}' \
  | agentusage telemetry hook claude_code --verbose

Supported hook sources are codex, claude_code, and opencode. Useful options include:

  • --account-id to preserve an account dimension;
  • --db-path to use a custom telemetry database;
  • --spool-only to write to the local spool without immediate ingestion;
  • --verbose to print the event and deduplication result.

Start the daemon with the default or a custom database:

agentusage telemetry daemon
agentusage telemetry daemon --db-path /path/to/telemetry.db

Command reference

agentusage --help
agentusage dashboard --help
agentusage server --help
agentusage command --help
agentusage command daily --help
agentusage daily --help
agentusage weekly --help
agentusage monthly --help
agentusage yearly --help
agentusage range --help
agentusage telemetry --help

Running agentusage without a subcommand prints this help. Use agentusage dashboard for the terminal UI and agentusage server for the browser UI.

Privacy and data safety

agentusage is designed to operate locally. It reads provider files and stores normalized events in local databases; it does not require a hosted account or send usage data to a project-controlled service. Treat local usage databases, raw events, and PostgreSQL credentials as sensitive data.

Development

Contributor checks are documented in docs/DEVELOPMENT.md. Automatic versioning, crates.io publishing, platform builds, and GitHub releases are documented in docs/RELEASING.md.

Release history is maintained in CHANGELOG.md.

The Rust source is rooted in this repository. The local reference checkout is excluded from Rust packages, GitHub Actions, and release archives.

Contributing

Bug reports and pull requests are welcome. When adding or changing a provider:

  1. Include a sanitized fixture or regression test when possible.
  2. Preserve idempotent ingestion and backward-compatible storage behavior.
  3. Run the checks in docs/DEVELOPMENT.md.
  4. Do not commit provider credentials, raw private transcripts, or local databases.

License

agentusage is available under the MIT License.