Skip to content

docs: document unsupported source investigations - #1070

Merged
ryoppippi merged 1 commit into
mainfrom
codex/antigravity-cli-integration
May 19, 2026
Merged

ryoppippi merged 1 commit into
mainfrom
codex/antigravity-cli-integration

Conversation

@ryoppippi

@ryoppippi ryoppippi commented May 19, 2026 •

Copy link
Copy Markdown
Member

Documents source support requirements and records investigated CLIs that are not currently supportable because their local data does not expose reliable token usage.

The new Source Support Q&A covers Antigravity CLI, Grok CLI, and Devin CLI, and links it from the guide sidebar and related guide pages.

@coderabbitai please review this documentation-only change.

Testing:

  • pnpm --filter docs format
  • pnpm --filter docs typecheck
  • pnpm --filter docs build

Summary by cubic

Adds a Source Support Q&A page that explains the local data needed for ccusage support and documents why Antigravity CLI, Grok CLI, and Devin CLI are not currently supported. Links the page from the guide sidebar, All Reports, and the Guide index.

Written for commit ab3b4d8. Summary will update on new commits. Review in cubic

Summary by CodeRabbit

Documentation

  • Added comprehensive Source Support Q&A guide explaining which data sources are supported and the key requirements for accurate token usage tracking, including timestamps, session identifiers, model names, and cost accounting
  • Clarified support status of specific coding agents and documented the limitations preventing current support
  • Updated documentation navigation and references to help users find source support information

Review Change Stack

Add a Source Support Q&A page that explains the local data requirements for ccusage support and records why Antigravity CLI, Grok CLI, and Devin CLI are not currently supportable.

This keeps investigated-but-unsupported sources documented without adding speculative parsers that would estimate token usage from incomplete local state.
@ryoppippi

Copy link
Copy Markdown
Member Author

@coderabbitai please review this documentation-only PR.

@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
ccusage-guide ab3b4d8 Commit Preview URL

Branch Preview URL
May 19 2026, 07:40 PM

@coderabbitai

coderabbitai Bot commented May 19, 2026 •

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 0a1e844d-6913-4785-a093-9e976c060f86

📥 Commits

Reviewing files that changed from the base of the PR and between 7e20024 and ab3b4d8.

📒 Files selected for processing (4)
  • docs/.vitepress/config.ts
  • docs/guide/all-reports.md
  • docs/guide/index.md
  • docs/guide/source-support-qa.md

📝 Walkthrough

Walkthrough

This PR adds a new Source Support Q&A guide page documenting what local usage data characteristics ccusage requires to generate token usage reports. The page is integrated into the documentation structure through VitePress sidebar navigation and referenced from existing guide pages to clarify why certain coding agents are unsupported.

Changes

Source Support Q&A Documentation

Layer / File(s) Summary
Source Support Q&A guide and navigation integration
docs/guide/source-support-qa.md, docs/.vitepress/config.ts, docs/guide/index.md, docs/guide/all-reports.md
New page specifies ccusage's requirements for "supportable" sources (timestamps, session/conversation identity, model identifiers, token/cost accounting, stable local formats). Explains why Antigravity, Grok, and Devin CLIs are unsupported due to missing or inaccessible local token/cost data. VitePress sidebar is updated with navigation entry. Cross-references are added to guide index and all-reports page.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

A new Q&A guide hops in place,
Clarifying sources with grace,
Navigation links lead the way,
Documentation grows today,
Supportable sources on display! 🐰✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately and concisely describes the main change: adding documentation about unsupported source investigations, which aligns with the core content of the new source-support-qa.md file and related documentation updates.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/antigravity-cli-integration

Warning

Review ran into problems

🔥 Problems

Git: Failed to clone repository. Please run the @coderabbitai full review command to re-trigger a full review. If the issue persists, set path_filters to include or exclude specific files.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai

coderabbitai Bot commented May 19, 2026

Copy link
Copy Markdown
🧩 Analysis chain

Let me fetch the PR details and changed files for a thorough review.


🏁 Script executed:

#!/bin/bash
# Get PR info and changed files
gh pr view 1070 --repo ryoppippi/ccusage --json title,body,files,additions,deletions

echo "---FILE DIFF---"
gh pr diff 1070 --repo ryoppippi/ccusage

Length of output: 1659


Let me try fetching the file contents directly.


🏁 Script executed:

#!/bin/bash
# Get the PR branch name
gh pr view 1070 --repo ryoppippi/ccusage --json headRefName,headRepository

echo "---FETCH FILES VIA API---"
# Try fetching file contents from the PR
gh api repos/ryoppippi/ccusage/pulls/1070/files --jq '.[].filename'

echo "---source-support-qa.md---"
gh api "repos/ryoppippi/ccusage/contents/docs/guide/source-support-qa.md?ref=refs/pull/1070/head" --jq '.content' | base64 -d

echo "---config.ts patch---"
gh api repos/ryoppippi/ccusage/pulls/1070/files --jq '.[] | select(.filename == "docs/.vitepress/config.ts") | .patch'

echo "---all-reports.md patch---"
gh api repos/ryoppippi/ccusage/pulls/1070/files --jq '.[] | select(.filename == "docs/guide/all-reports.md") | .patch'

echo "---index.md patch---"
gh api repos/ryoppippi/ccusage/pulls/1070/files --jq '.[] | select(.filename == "docs/guide/index.md") | .patch'

Length of output: 5423


Let me quickly check the docs conventions for frontmatter.


🏁 Script executed:

#!/bin/bash
# Check frontmatter usage in existing guide pages
echo "=== index.md head ==="
head -20 docs/guide/index.md

echo "=== all-reports.md head ==="
head -10 docs/guide/all-reports.md

echo "=== Check sidebar group label for where the new link was inserted ==="
grep -n -A2 -B2 "OpenClaw\|Source Support\|sources\|Sources\|integrations" docs/.vitepress/config.ts | head -50

Length of output: 2199


@ryoppippi The documentation is well-written and clearly structured. The use of VitePress :::details blocks to isolate each CLI investigation is a clean pattern, the framing is honest ("investigated but found X"), and the privacy advisory at the bottom of "Can These Be Added Later?" is a nice practical touch. No spelling, grammar, or broken-link issues found.

One minor suggestion:

Sidebar placement — The new entry sits inside the Data Sources sidebar group (alongside Claude Code, Gemini CLI, Kimi, OpenClaw, etc.), which groups supported source pages. A reader browsing that section for integration guides might find a "why some things are not supported" Q&A slightly out of place.

- { text: 'Source Support Q&A', link: '/guide/source-support-qa' },
  // inside "Data Sources" group

Two easy options:

  1. Move it into its own sidebar group, e.g.:
    {
      text: 'Contributing',
      items: [
        { text: 'Source Support Q&A', link: '/guide/source-support-qa' },
      ],
    },
  2. Keep it in "Data Sources" but adjust the label to something like 'Unsupported Sources' so the contrast is explicit in the nav.

That said, it's a small UX concern and the current placement is still findable — happy to defer to your judgment on it. The rest of the PR looks good to me.

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@pkg-pr-new

pkg-pr-new Bot commented May 19, 2026

Copy link
Copy Markdown

Open in StackBlitz

ccusage

npx https://pkg.pr.new/ryoppippi/ccusage@1070

@ccusage/ccusage-darwin-arm64

npx https://pkg.pr.new/ryoppippi/ccusage/@ccusage/ccusage-darwin-arm64@1070

@ccusage/ccusage-darwin-x64

npx https://pkg.pr.new/ryoppippi/ccusage/@ccusage/ccusage-darwin-x64@1070

@ccusage/ccusage-linux-arm64

npx https://pkg.pr.new/ryoppippi/ccusage/@ccusage/ccusage-linux-arm64@1070

@ccusage/ccusage-linux-x64

npx https://pkg.pr.new/ryoppippi/ccusage/@ccusage/ccusage-linux-x64@1070

@ccusage/ccusage-win32-arm64

npx https://pkg.pr.new/ryoppippi/ccusage/@ccusage/ccusage-win32-arm64@1070

@ccusage/ccusage-win32-x64

npx https://pkg.pr.new/ryoppippi/ccusage/@ccusage/ccusage-win32-x64@1070

commit: ab3b4d8

@github-actions

Copy link
Copy Markdown
Contributor

ccusage performance comparison

PR SHA: ab3b4d8fdabe
Base SHA: 7e200245fa60

This compares the Rust PR release binary against the configured base package on the same CI runner.

Package runner startup

Execution setup measures any pre-benchmark package materialization used by the execution benchmark. Bunx temp cache measures one bunx -p <url> ccusage --version run with an empty Bun install cache. Warm reuses that cache and reports the median of repeated runs.

Package SHA Execution setup Bunx temp cache Bunx warm median Warm samples
Base pkg.pr.new 7e200245fa60 678.9ms 591.7ms 33.6ms 3
PR pkg.pr.new ab3b4d8fdabe 546.2ms 530.0ms 32.5ms 3

Cached bunx execution performance

Runs the same large fixture through bunx -p <pkg.pr.new URL> ccusage after the Bun install cache has already been populated by the startup measurement. This separates cached package-runner execution from first-fetch package materialization.

Fixtures: Claude /home/runner/work/_temp/ccusage-large-fixture (1.01 GiB, 2,597 files), Codex /home/runner/work/_temp/ccusage-large-codex-fixture (1.01 GiB, 2,597 files)
Base package: 7e200245fa60; PR package: ab3b4d8fdabe. Both run through bunx -p <pkg.pr.new URL> ccusage using the warmed Bun install cache from package runner startup, measured by hyperfine with 0 warmups and 1 runs.

Command Input Base median PR median PR vs base Base throughput PR throughput
bunx -p <pkg> ccusage claude --offline --json 1.01 GiB 685.3ms 688.3ms 1.00x 1.47 GiB/s 1.46 GiB/s
bunx -p <pkg> ccusage codex --offline --json 1.01 GiB 834.3ms 824.2ms 1.01x 1.21 GiB/s 1.22 GiB/s

Package runtime diagnostics

Compares the PR package wrapper, the installed native optional dependency binary, and the workspace release binary on the same large fixture. This identifies whether slow package results come from JavaScript wrapper overhead, the published native binary build, or the Rust core itself.

Fixtures: Claude /home/runner/work/_temp/ccusage-large-fixture (1.01 GiB, 2,597 files), Codex /home/runner/work/_temp/ccusage-large-codex-fixture (1.01 GiB, 2,597 files)
All rows run --offline --json, measured by hyperfine with 0 warmups and 1 runs. This isolates wrapper overhead from the installed native optional dependency and the workspace release binary built on the runner.

Command Runtime Input Median Throughput Samples
claude --offline --json Package wrapper 1.01 GiB 678.4ms 1.48 GiB/s 1
claude --offline --json Installed native binary 1.01 GiB 655.7ms 1.54 GiB/s 1
claude --offline --json Workspace release binary 1.01 GiB 703.9ms 1.43 GiB/s 1
codex --offline --json Package wrapper 1.01 GiB 833.0ms 1.21 GiB/s 1
codex --offline --json Installed native binary 1.01 GiB 793.9ms 1.27 GiB/s 1
codex --offline --json Workspace release binary 1.01 GiB 806.4ms 1.25 GiB/s 1

Committed fixture performance

Committed small fixtures for stable PR-to-PR feedback and explicit Claude/Codex command coverage.

Fixtures: Claude apps/ccusage/test/fixtures/claude (0.00 MiB, 2 files), Codex apps/ccusage/test/fixtures/codex (0.00 MiB, 1 files)
Base runs the published ccusage package from pkg.pr.new, installed before measurement; PR runs rust/target/release/ccusage directly. Both run --offline --json, measured by hyperfine with 2 warmups and 7 runs.

Command Input Base median PR median PR vs base Base throughput PR throughput
claude daily --offline --json 0.00 MiB 30.4ms 4.6ms 6.65x 0.05 MiB/s 0.34 MiB/s
claude session --offline --json 0.00 MiB 30.1ms 4.5ms 6.63x 0.05 MiB/s 0.34 MiB/s
codex daily --offline --json 0.00 MiB 30.9ms 4.4ms 7.07x 0.03 MiB/s 0.20 MiB/s
codex session --offline --json 0.00 MiB 31.0ms 4.4ms 7.08x 0.03 MiB/s 0.20 MiB/s

Large real-world-shaped fixture performance

Generated fixtures shaped from aggregate local log statistics: thousands of JSONL files, many small sessions, and a long tail of larger sessions. No real prompts, paths, or outputs are stored in the fixtures.

Fixtures: Claude /home/runner/work/_temp/ccusage-large-fixture (1.01 GiB, 2,597 files), Codex /home/runner/work/_temp/ccusage-large-codex-fixture (1.01 GiB, 2,597 files)
Base runs the published ccusage package from pkg.pr.new, installed before measurement; PR runs rust/target/release/ccusage directly. Both run --offline --json, measured by hyperfine with 0 warmups and 1 runs.

Command Input Base median PR median PR vs base Base throughput PR throughput
claude --offline --json 1.01 GiB 689.2ms 708.4ms 0.97x 1.46 GiB/s 1.42 GiB/s
codex --offline --json 1.01 GiB 831.1ms 803.6ms 1.03x 1.21 GiB/s 1.25 GiB/s

Artifact size

Artifact Base PR Delta Ratio
packed ccusage-*.tgz 9.45 KiB 9.44 KiB -0.00 KiB 1.00x
installed native package binary 3288.24 KiB 3288.24 KiB +0.00 KiB 1.00x
Rust release binary rust/target/release/ccusage - 2955.68 KiB - -

Lower medians and smaller artifacts are better. CI runner noise still applies; use same-run ratios as directional PR feedback, not release guarantees.

@github-actions

Copy link
Copy Markdown
Contributor

ccusage performance comparison

PR SHA: ab3b4d8fdabe
Base SHA: 7e200245fa60

This compares the PR package against the configured base package on the same CI runner.

Package runner startup

Execution setup measures any pre-benchmark package materialization used by the execution benchmark. Bunx temp cache measures one bunx -p <url> ccusage --version run with an empty Bun install cache. Warm reuses that cache and reports the median of repeated runs.

Package SHA Execution setup Bunx temp cache Bunx warm median Warm samples
Base pkg.pr.new 7e200245fa60 1.011s 620.6ms 36.8ms 3
PR pkg.pr.new ab3b4d8fdabe 808.8ms 569.4ms 36.0ms 3

Cached bunx execution performance

Runs the same large fixture through bunx -p <pkg.pr.new URL> ccusage after the Bun install cache has already been populated by the startup measurement. This separates cached package-runner execution from first-fetch package materialization.

Fixtures: Claude /home/runner/work/_temp/ccusage-large-fixture (1.01 GiB, 2,597 files), Codex /home/runner/work/_temp/ccusage-large-codex-fixture (1.01 GiB, 2,597 files)
Base package: 7e200245fa60; PR package: ab3b4d8fdabe. Both run through bunx -p <pkg.pr.new URL> ccusage using the warmed Bun install cache from package runner startup, measured by hyperfine with 0 warmups and 1 runs.

Command Input Base median PR median PR vs base Base throughput PR throughput
bunx -p <pkg> ccusage claude --offline --json 1.01 GiB 695.9ms 698.9ms 1.00x 1.45 GiB/s 1.44 GiB/s
bunx -p <pkg> ccusage codex --offline --json 1.01 GiB 896.8ms 885.8ms 1.01x 1.12 GiB/s 1.14 GiB/s

Package runtime diagnostics

Compares the PR package wrapper, the installed native optional dependency binary, and the workspace release binary on the same large fixture. This identifies whether slow package results come from JavaScript wrapper overhead, the published native binary build, or the Rust core itself.

Fixtures: Claude /home/runner/work/_temp/ccusage-large-fixture (1.01 GiB, 2,597 files), Codex /home/runner/work/_temp/ccusage-large-codex-fixture (1.01 GiB, 2,597 files)
All rows run --offline --json, measured by hyperfine with 0 warmups and 1 runs. This isolates wrapper overhead from the installed native optional dependency and the workspace release binary built on the runner.

Command Runtime Input Median Throughput Samples
claude --offline --json Package wrapper 1.01 GiB 683.5ms 1.47 GiB/s 1
claude --offline --json Installed native binary 1.01 GiB 689.0ms 1.46 GiB/s 1
claude --offline --json Workspace release binary 1.01 GiB 729.8ms 1.38 GiB/s 1
codex --offline --json Package wrapper 1.01 GiB 878.6ms 1.15 GiB/s 1
codex --offline --json Installed native binary 1.01 GiB 837.8ms 1.20 GiB/s 1
codex --offline --json Workspace release binary 1.01 GiB 827.2ms 1.22 GiB/s 1

Committed fixture performance

Committed small fixtures for stable PR-to-PR feedback and explicit Claude/Codex command coverage.

Fixtures: Claude apps/ccusage/test/fixtures/claude (0.00 MiB, 2 files), Codex apps/ccusage/test/fixtures/codex (0.00 MiB, 1 files)
Base runs the published ccusage package from pkg.pr.new, installed before measurement; PR runs the published ccusage package from pkg.pr.new, installed before measurement. Both run --offline --json, measured by hyperfine with 2 warmups and 7 runs.

Command Input Base median PR median PR vs base Base throughput PR throughput
claude daily --offline --json 0.00 MiB 32.7ms 32.9ms 1.00x 0.05 MiB/s 0.05 MiB/s
claude session --offline --json 0.00 MiB 33.2ms 32.5ms 1.02x 0.05 MiB/s 0.05 MiB/s
codex daily --offline --json 0.00 MiB 32.2ms 32.1ms 1.00x 0.03 MiB/s 0.03 MiB/s
codex session --offline --json 0.00 MiB 32.5ms 32.1ms 1.01x 0.03 MiB/s 0.03 MiB/s

Large real-world-shaped fixture performance

Generated fixtures shaped from aggregate local log statistics: thousands of JSONL files, many small sessions, and a long tail of larger sessions. No real prompts, paths, or outputs are stored in the fixtures.

Fixtures: Claude /home/runner/work/_temp/ccusage-large-fixture (1.01 GiB, 2,597 files), Codex /home/runner/work/_temp/ccusage-large-codex-fixture (1.01 GiB, 2,597 files)
Base runs the published ccusage package from pkg.pr.new, installed before measurement; PR runs the published ccusage package from pkg.pr.new, installed before measurement. Both run --offline --json, measured by hyperfine with 0 warmups and 1 runs.

Command Input Base median PR median PR vs base Base throughput PR throughput
claude --offline --json 1.01 GiB 693.0ms 698.5ms 0.99x 1.45 GiB/s 1.44 GiB/s
codex --offline --json 1.01 GiB 864.6ms 869.3ms 0.99x 1.16 GiB/s 1.16 GiB/s

Artifact size

Artifact Base PR Delta Ratio
packed ccusage-*.tgz 9.45 KiB 9.44 KiB -0.00 KiB 1.00x
installed native package binary 3288.24 KiB 3288.24 KiB +0.00 KiB 1.00x
Rust release binary rust/target/release/ccusage - 2955.68 KiB - -

Lower medians and smaller artifacts are better. CI runner noise still applies; use same-run ratios as directional PR feedback, not release guarantees.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant