CLI Consumption

CLI Consumption measures how AI coding CLIs use models, tokens, tools, conversations, and turns. It runs locally, can consolidate copied data from several machines, and can send metadata-only snapshots to a central collector.

It never stores prompts, responses, tool arguments, credentials, or raw provider events. Local token counters are usage metadata, not billing records. Read the privacy boundary before sharing a database or report.

Quick start

CLI Consumption requires Python 3.12 or newer and uses uv. Supporting 3.12–3.14 keeps the package usable on more existing development and CI images without changing its architecture; the compatibility matrix exercises all three versions.

From a checkout, collect every supported CLI detected on the machine and generate a self-contained dashboard:

uv sync --all-extras
uv run cli-consumption collect --provider all
uv run cli-consumption export --output reports

Open reports/dashboard.html locally. It makes no network requests. Detailed normalized CSV tables are generated only when --csv is passed.

To collect a single CLI, use its provider name. For example, with Codex:

uv run cli-consumption collect --provider codex --database usage.sqlite

From PyPI, no permanent installation is required:

uv tool run cli-consumption collect --provider all
uv tool run cli-consumption export --output reports

The default installation covers local collection, SQLite storage, and exports. Install only the optional runtime capabilities you use: cli-consumption[sync] for the sync client, cli-consumption[server] for the collector service, and cli-consumption[postgres] for PostgreSQL. Extras can be combined, for example cli-consumption[server,postgres] on a central collector.

To run the latest unreleased GitHub source:

uv tool run --from git+https://github.com/Guillaume-Lombardo/cli-consumption \
  cli-consumption providers

Supported CLIs

--provider all detects the supported data stores found in their default locations. Use the provider name below with --provider to select one CLI explicitly.

Provider formats are internal and can change without notice. The detailed extraction rules and qualification versions are documented in Provider support.

Collect copied data

--source [LABEL=]PATH points to a provider home directory and can be repeated. With --provider all, each path is inspected and unmatched sources are rejected. With one provider selected, each path must contain that provider's expected store.

For example, consolidate trusted copies of Codex data from several machines:

uv run cli-consumption collect --provider codex \
  --source desktop=/data/codex/desktop \
  --source laptop=/data/codex/laptop \
  --source server=/data/codex/server \
  --database usage.sqlite

Copy only the required provider data. For Codex, copy the sessions/ directory but never auth.json or other credentials. Globally identical conversation IDs are deduplicated, and the most complete copy wins.

Map original working-directory prefixes to stable project labels with repeated --project NAME=PATH_PREFIX options. The longest matching prefix wins:

uv run cli-consumption collect --provider codex \
  --source desktop=/data/codex/desktop \
  --project cli-consumption=/home/me/dev/cli-consumption

Plandex auto-detection checks /plandex-server. For any other trusted offline copy of a self-hosted server data directory, pass the path explicitly:

uv run cli-consumption collect --provider plandex \
  --source server=/srv/plandex-server --database usage.sqlite

Explore and share reports

The dashboard can filter by time, provider, machine, project, and model. It reports activity, token composition, cache efficiency, latency and duration distributions, technical throughput, context pressure, work-item reliability, configuration cohorts, compactions, subagent delegation, and ingestion quality. Availability varies by provider, as summarized in the table above.

Generate a more shareable dashboard by pseudonymizing labels, grouping tool names, rounding timestamps to days, and hiding small cohort rows:

uv run cli-consumption export --output shared-report --share-safe

Share-safe reports still disclose aggregate work patterns and remain private operational data. A technically completed turn is not a measure of task quality or productivity.

Limit an export to conversations whose activity overlaps a half-open UTC window:

uv run cli-consumption export --output reports \
  --since 2026-08-01 --until 2026-08-31

Dates denote UTC calendar boundaries; timestamps must include a timezone. An included conversation is exported with its complete child graph rather than partially redacted to the window. CSV rows are streamed in stable primary-key order. Spreadsheet formula prefixes in text cells are neutralized with a leading apostrophe; CSV remains a detailed operational-data export, not a share-safe format.

SQLite and PostgreSQL

A file path selects SQLite. A SQLAlchemy URL selects PostgreSQL:

uv run cli-consumption collect --provider all --database usage.sqlite
uv run cli-consumption collect --provider all \
  --database postgresql+psycopg://usage@localhost/cli_consumption

Pass credentials through environment variables or a secret manager rather than shell history. CLI_CONSUMPTION_DATABASE can provide the database setting.

Database schemas are upgraded automatically when a command opens them. Existing unversioned databases that exactly match a published schema are adopted before the upgrade; unknown or modified schemas are refused. Back up production databases before upgrading and do not run mixed application versions against one database while a migration is in progress. See the migration decision for rollback and compatibility rules.

Preview retention before deleting normalized metadata:

uv run cli-consumption retention --keep-days 90 --database usage.sqlite
uv run cli-consumption retention --keep-days 90 --database usage.sqlite --apply

The first command is a dry run. --apply deletes old conversations and their child rows, old subagent relationships, and old ingestion-run records.

Central collector API

Copied files are simplest for personal or air-gapped use. For recurring collection across machines, start the metadata-only API:

export CLI_CONSUMPTION_API_TOKEN="$(your-secret-provider)"
uv run cli-consumption serve \
  --database postgresql+psycopg://usage@localhost/cli_consumption \
  --host 0.0.0.0

Then send all locally detected snapshots from another machine:

export CLI_CONSUMPTION_API_TOKEN="$(your-secret-provider)"
uv run cli-consumption sync --provider all \
  --endpoint https://usage.example.test

The application refuses to bind beyond localhost without a token. Production deployments also need TLS and standard operational controls. See Architecture for the trade-offs.

Snapshots use strict schema version 1. The collector rejects request bodies larger than 32 MiB and snapshots containing more than 250,000 normalized records. A sync client checks /api/v1/capabilities before sending when the endpoint exposes it. Upgrade the server before clients whenever supported snapshot schemas change.

Provider diagnostics

providers reads the central adapter registry. Its machine-readable mode checks local default stores and emits deterministic JSON:

uv run cli-consumption providers --json

Each provider reports one of no-data, detected, compatible, degraded, or unsupported-schema. Diagnostics parse enough metadata to assess compatibility but do not persist it and never include paths, identifiers, record contents, counts, or parser errors in their output.

Commands

Run uv run cli-consumption COMMAND --help for all options.

Development

uv sync --all-extras --all-groups
uv run pre-commit install
uv run pre-commit run --all-files
uv run ruff format --check .
uv run ruff check .
uv run ty check
uv run pytest --cov --cov-report=term-missing
uv build

Development uses short-lived branches and squash-merged pull requests into protected main. Read CONTRIBUTING.md and AGENTS.md before changing the project.

License

Licensed under the Apache License 2.0.