ccusage Docs
The docs package is a VitePress site under docs/.
Commands
pnpm --filter docs dev
pnpm --filter docs build
pnpm --filter docs preview
pnpm --filter docs format
pnpm --filter docs typecheck
The docs build copies apps/ccusage/config-schema.json to docs/public/config-schema.json before running VitePress.
Structure
README.mdandapps/ccusage/README.md- package entrypoints for supported sources, common commands, features, and installation examplesdocs/guide/- user guides and tutorialsdocs/public/- screenshots, static assets, and generated config schemadocs/.vitepress/- VitePress configuration and theme customization
Content Rules
- When adding or changing a user-facing agent, command, option, report mode, or example, audit and update the root
README.md,apps/ccusage/README.md, relevantdocs/guide/pages, related cross-links, and VitePress navigation before finishing. - Prefer the unified command form in new or edited docs:
ccusage codex ...,ccusage opencode ...,ccusage amp ..., andccusage pi .... - Standalone wrapper commands such as
ccusage-codex,ccusage-opencode,ccusage-amp, andccusage-pihave been removed. Do not promote or reintroduce them in docs. - Place screenshots immediately after the page H1 when a guide has a primary screenshot.
- Use relative image paths such as
/screenshot.pngfor files indocs/public/. - Always include descriptive alt text for screenshots and images.
- Lead with visual context when a guide has an established screenshot pattern.
- Cross-link related guides and JSON output documentation where useful.
- For markdown code blocks that ESLint should skip, put
<!-- eslint-skip -->before the block.
Known screenshot-led guides include:
docs/guide/index.mddocs/guide/daily-reports.mddocs/guide/live-monitoring.md