codeburn/docs/providers
ozymandiashh 6be422ac52 feat(quota): show Codex limit resets in the Plan tab, hover card and CLI
The Plan tab row #724 added showed a count and an expiry. It now also shows how
many of those credits can be applied right now and when the most recent one
landed, which is what a user deciding whether to push through or throttle back
actually needs. The same sentence appears in the agent-tab quota hover card and
in `codeburn quota`.

One formatter produces it, mirrored line for line in Swift and TypeScript, down
to the compact-age rules — deliberately not RelativeDateTimeFormatter or
Intl.RelativeTimeFormat, because the two surfaces have to print the same
characters, and a locale-aware formatter would not. `codeburn quota` grows a
`notes` channel for provider facts that are not a window; only Codex sets it, so
every other provider's output is byte-identical to before.

The CLI reads the credits off the `rate_limit_reset_credits` block of the usage
response it already fetches and never calls the companion endpoint, so it prints
the count without the grant and expiry captions that only the per-credit list
carries.

Refs #725. No new polling loop and no new data source: this reads fields from a
response already fetched on the existing cadence.
2026-09-12 14:37:24 -07:00
..
antigravity.md fix(cache): version-suffix provider result caches 2026-08-22 01:36:15 +05:30
claude.md fix(claude): discover Claude Desktop/Cowork sessions in Windows MSIX installs 2026-07-24 00:30:30 +03:00
cline-cli.md feat(providers): add cline-cli provider for Cline CLI sessions 2026-08-04 02:45:16 +03:00
cline.md feat(providers): add cline-cli provider for Cline CLI sessions 2026-08-04 02:45:16 +03:00
codebuff.md docs: sync provider registry, test inventory, and Gemini page with the tree 2026-09-01 05:27:15 -07:00
codewhale.md Scope the root test script to tests/ so npm test runs from a clean install 2026-08-09 10:19:58 -05:00
codex.md feat(quota): show Codex limit resets in the Plan tab, hover card and CLI 2026-09-12 14:37:24 -07:00
copilot.md fix(copilot): keep the new host rungs to the menubar 2026-09-12 12:05:04 -07:00
crush.md Add Crush provider plus per-provider icon column in README (#286) 2026-05-09 20:47:56 -07:00
cursor-agent.md Add CONTRIBUTING.md, docs/architecture.md, and per-provider docs (#284) 2026-05-09 18:39:41 -07:00
cursor.md fix(cache): version-suffix provider result caches 2026-08-22 01:36:15 +05:30
devin.md fix(devin): add missing support for ATIF v1.7 (#570) 2026-06-28 19:00:51 +02:00
droid.md Add CONTRIBUTING.md, docs/architecture.md, and per-provider docs (#284) 2026-05-09 18:39:41 -07:00
dsh.md Fix interleaved DSH accounting and preserve inclusive output 2026-09-11 21:12:15 +08:00
forge.md feat(providers): add forge provider support (#401) 2026-05-26 03:36:57 -07:00
gemini.md docs: sync provider registry, test inventory, and Gemini page with the tree 2026-09-01 05:27:15 -07:00
goose.md Add CONTRIBUTING.md, docs/architecture.md, and per-provider docs (#284) 2026-05-09 18:39:41 -07:00
grok.md docs(grok): state the mixed-session drop and the global daily re-derivation plainly 2026-08-18 10:22:36 -07:00
hermes.md Scope the root test script to tests/ so npm test runs from a clean install 2026-08-09 10:19:58 -05:00
ibm-bob.md Add IBM Bob provider with workspace extraction (#316) 2026-05-11 20:54:13 -07:00
kilo-code.md Add Cline provider 2026-05-12 00:31:41 +03:00
kimi.md Add Kimi provider 2026-05-11 19:02:28 +03:00
kimicode.md kimicode: discover desktop-runtime sessions and fix menubar visibility 2026-07-23 21:31:25 +02:00
kiro.md fix(parser): flatten already-sliced previews and memoize canonical path walks 2026-08-16 01:49:10 -07:00
lingtai-tui.md Scope the root test script to tests/ so npm test runs from a clean install 2026-08-09 10:19:58 -05:00
mistral-vibe.md Fix one-shot rate detection for all non-Claude providers (#355) 2026-05-18 15:56:14 -07:00
mux.md feat(providers): add coder/mux as a datasource (#438) 2026-06-06 03:04:24 +02:00
NEW_PROVIDER.md chore: pin node via .nvmrc, add the new-provider checklist 2026-08-04 03:17:41 +03:00
omp.md Add CONTRIBUTING.md, docs/architecture.md, and per-provider docs (#284) 2026-05-09 18:39:41 -07:00
open-design.md docs: sync provider registry, test inventory, and Gemini page with the tree 2026-09-01 05:27:15 -07:00
openclaude.md feat(openclaude): OpenClaude CLI provider (#213) 2026-08-04 04:05:25 +03:00
openclaw.md Add CONTRIBUTING.md, docs/architecture.md, and per-provider docs (#284) 2026-05-09 18:39:41 -07:00
opencode.md Scope the root test script to tests/ so npm test runs from a clean install 2026-08-09 10:19:58 -05:00
pi.md fix(pi): classify native skill loads as Skill, not Read (#588) (#590) 2026-07-01 15:57:31 +02:00
quickdesk.md feat(quickdesk): Amazon Quick Desktop provider, parse ~/.quickwork sessions and metrics (#707) 2026-07-18 00:02:01 +03:00
qwen.md Add CONTRIBUTING.md, docs/architecture.md, and per-provider docs (#284) 2026-05-09 18:39:41 -07:00
README.md docs: sync provider registry, test inventory, and Gemini page with the tree 2026-09-01 05:27:15 -07:00
roo-code.md Add Cline provider 2026-05-12 00:31:41 +03:00
vercel-gateway.md fix(cursor): period-aligned lookback; add Vercel AI Gateway provider (#432) 2026-06-09 23:01:43 +02:00
vscode-cline-parser.md Merge main into feat/cline-provider to resolve conflicts 2026-05-16 05:58:10 -07:00
warp.md feat: add Warp provider adapter (#350) 2026-05-21 00:19:53 -07:00
zcode.md feat(providers): add ZCode (z.ai GLM-5.2) usage provider (#537) 2026-06-20 21:37:32 +02:00
zed.md release: 0.9.15 2026-07-02 06:19:14 +02:00
zerostack.md Add zerostack provider (#519) 2026-06-19 14:44:45 +02:00

Provider Docs

One file per provider integration. If you are fixing a bug or adding a feature scoped to a single provider, read the file for that provider first; it tells you which file to edit, where on disk the source data lives, and what edge cases the test suite already covers.

For the architectural picture, see ../architecture.md.

Provider Index

Eager (always loaded)

Provider Storage Source Test
Claude JSONL (no parser) src/providers/claude.ts none (covered indirectly)
Cline JSON src/providers/cline.ts tests/providers/cline.test.ts
Cline CLI JSON src/providers/cline-cli.ts tests/providers/cline-cli.test.ts
CodeWhale JSON src/providers/codewhale.ts tests/providers/codewhale.test.ts
Codebuff JSON src/providers/codebuff.ts tests/providers/codebuff.test.ts
Codex JSONL src/providers/codex.ts tests/providers/codex.test.ts
Copilot JSONL + SQLite (OTel) + Nitrite .db (JetBrains) src/providers/copilot.ts tests/providers/copilot.test.ts
Devin JSON + SQLite enrichment src/providers/devin.ts tests/providers/devin.test.ts
Droid JSONL src/providers/droid.ts tests/providers/droid.test.ts
DeepSeek Harness JSONL (zstd frames) src/providers/dsh.ts tests/providers/dsh.test.ts
Gemini JSON / JSONL src/providers/gemini.ts tests/providers/gemini.test.ts
Hermes Agent SQLite src/providers/hermes.ts tests/providers/hermes.test.ts
IBM Bob JSON src/providers/ibm-bob.ts tests/providers/ibm-bob.test.ts
KiloCode JSON src/providers/kilo-code.ts tests/providers/kilo-code.test.ts
Kiro JSON src/providers/kiro.ts tests/providers/kiro.test.ts
Kimi JSONL src/providers/kimi.ts tests/providers/kimi.test.ts
Kimi Code JSONL src/providers/kimicode.ts tests/providers/kimicode.test.ts
LingTai TUI JSONL src/providers/lingtai-tui.ts tests/providers/lingtai-tui.test.ts
Mistral Vibe JSON / JSONL src/providers/mistral-vibe.ts tests/providers/mistral-vibe.test.ts
Mux JSONL src/providers/mux.ts tests/providers/mux.test.ts
OpenClaw JSONL src/providers/openclaw.ts tests/providers/openclaw.test.ts
OpenClaude JSONL src/providers/openclaude.ts tests/providers/openclaude.test.ts
Open Design JSONL src/providers/open-design.ts tests/providers/open-design.test.ts
Pi JSONL src/providers/pi.ts tests/providers/pi.test.ts
OMP JSONL src/providers/pi.ts tests/providers/omp.test.ts
Qwen JSONL src/providers/qwen.ts none
Quick Desktop EMF JSONL + SQLite src/providers/quickdesk.ts tests/providers/quickdesk.test.ts
Roo Code JSON src/providers/roo-code.ts tests/providers/roo-code.test.ts
Zerostack JSON src/providers/zerostack.ts tests/providers/zerostack.test.ts
Grok Build JSON/JSONL src/providers/grok.ts tests/providers/grok.test.ts

Lazy (loaded on first call)

Provider Storage Source Test
Antigravity protobuf over RPC src/providers/antigravity.ts tests/providers/antigravity.test.ts
Crush SQLite (per-project) src/providers/crush.ts tests/providers/crush.test.ts
Forge SQLite src/providers/forge.ts tests/providers/forge.test.ts
Cursor SQLite src/providers/cursor.ts tests/providers/cursor.test.ts
Cursor Agent text / JSONL src/providers/cursor-agent.ts tests/providers/cursor-agent.test.ts
Goose SQLite src/providers/goose.ts none
OpenCode SQLite src/providers/opencode.ts tests/providers/opencode.test.ts
Warp SQLite src/providers/warp.ts tests/providers/warp.test.ts
Vercel AI Gateway REST API src/providers/vercel-gateway.ts tests/providers/vercel-gateway.test.ts
ZCode SQLite src/providers/zcode.ts tests/providers/zcode.test.ts
Zed SQLite src/providers/zed.ts tests/providers/zed.test.ts

Shared

Helper Used by Source
vscode-cline-parser cline, ibm-bob, kilo-code, roo-code src/providers/vscode-cline-parser.ts

File Format

Each provider doc has the same structure:

  1. One-line summary of what the provider integrates.
  2. Where it reads from on disk (or over RPC).
  3. Storage format and validation rules.
  4. Caching (which cache layer, if any).
  5. Deduplication key so you understand cross-provider dedup.
  6. Quirks that have bitten us before.
  7. When fixing a bug here as a checklist.

If you add a new provider, copy claude.md as a template and fill in your provider's specifics. Update this index, and prefer adding a real test fixture under tests/providers/.