docs: add comprehensive documentation for weekly command #404
Conversation
- Add weekly reports to introduction page feature list - Create dedicated weekly-reports.md guide page with full command documentation - Update homepage to include weekly reports feature card - Add weekly reports to getting started next steps - Update navigation sidebar to include weekly reports link The weekly command was added in #378 but documentation was missing. This adds complete documentation covering all features and options.
|
Caution Review failedThe pull request is closed. WalkthroughA new "Weekly Reports" feature is introduced in the documentation. This includes updates to sidebars, feature lists, and guides to reference and describe weekly reporting capabilities. A comprehensive new guide page explains how to use the Changes
Sequence Diagram(s)sequenceDiagram
User->>Docs Sidebar: Selects "Weekly Reports"
Docs Sidebar->>Weekly Reports Guide: Navigates to /guide/weekly-reports
User->>Weekly Reports Guide: Reads usage, options, and examples
User->>CLI: Runs `ccusage weekly` command
CLI->>User: Displays weekly usage summary and breakdowns
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~4 minutes Possibly related PRs
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (5)
✨ Finishing Touches
🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @ryoppippi, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
I've added comprehensive documentation for the weekly command, which provides aggregated Claude Code usage by week. This includes a new dedicated guide page detailing its usage, various command options, example outputs, and practical use cases. Additionally, I've integrated this new documentation into the existing site navigation, feature lists, and getting started guides to ensure discoverability and ease of access for users.
Highlights
- New Documentation Page: A dedicated weekly-reports.md guide page has been added, providing in-depth documentation for the ccusage weekly command.
- Comprehensive Command Options: The new page details various options for the weekly command, including start-of-week, date filtering (--since, --until), sort order (--order), model breakdown (--breakdown), JSON output (--json), project analysis (--instances, --project), cost calculation modes (--mode), and offline mode (--offline).
- Documentation Site Integration: The new weekly reports documentation is seamlessly integrated into the existing documentation site by updating the VitePress navigation sidebar, adding it to the homepage's feature cards, including it in the introduction page's feature list, and adding it to the "Next Steps" section in the getting started guide.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments or fill out our survey to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
commit: |
There was a problem hiding this comment.
Code Review
This pull request adds comprehensive documentation for the new weekly command. The changes are well-structured and add valuable information for users. I've identified a significant inaccuracy where the documentation mentions command options (--instances, --project) that are not actually supported by the weekly command. I've also left a minor suggestion to improve file formatting consistency. After addressing these points, the documentation will be in great shape.
| ### Project Analysis | ||
|
|
||
| Group weekly usage by project: | ||
|
|
||
| ```bash | ||
| # Show weekly usage per project | ||
| ccusage weekly --instances | ||
|
|
||
| # Filter to specific project | ||
| ccusage weekly --project my-project | ||
| ``` |
There was a problem hiding this comment.
The weekly command does not support project-based analysis with --instances or --project flags. This functionality is part of the daily command, and this section seems to have been copied from its documentation.
This inaccuracy also appears in:
- The "Team Reporting" use case (lines 213-216)
- The "Project Tracking" tip (line 223)
To prevent user confusion, please remove this section and the other references to project filtering from this document.
| - [Daily Reports](/guide/daily-reports) - Day-by-day analysis | ||
| - [Monthly Reports](/guide/monthly-reports) - Monthly aggregates | ||
| - [Session Reports](/guide/session-reports) - Per-conversation analysis | ||
| - [Blocks Reports](/guide/blocks-reports) - 5-hour billing windows No newline at end of file |
There was a problem hiding this comment.
This file is missing a final newline character. It's a common convention to end files with a newline to prevent issues with some command-line tools (like cat) and to maintain consistency across the project's files.
| - [Blocks Reports](/guide/blocks-reports) - 5-hour billing windows | |
| - [Blocks Reports](/guide/blocks-reports) - 5-hour billing windows | |
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
ccusage-guide | 86aacea | Commit Preview URL Branch Preview URL |
Aug 03 2025, 05:42 PM |
Summary
Changes
weekly-reports.mdguide page with:Related
Screenshots
The new documentation page follows the same structure as other report documentation pages (daily, monthly, session, blocks) for consistency.
Summary by CodeRabbit