docs: emphasize bunx usage and ultra-small bundle size advantage#242
docs: emphasize bunx usage and ultra-small bundle size advantage#242
Conversation
- Add bunx as the primary recommended installation method - Highlight the small bundle size advantage with inline badge - Add deno run option with security flags - Mark local installation as optional since bundle is small - Add tip about bunx speed advantage over npx - Add feature bullet point about ultra-small bundle size
- Add section explaining why installation is not needed - Reorder runtime options to put bunx first as recommended - Add tip about bunx speed advantage - Add info about deno security benefits - Mark global installation as optional - Emphasize ultra-small bundle size advantage
- Add dedicated section for bundle size advantage - Mention running directly with bunx without installation - Position it as the first key feature to emphasize importance
WalkthroughDocumentation for the Changes
Sequence Diagram(s)sequenceDiagram
User->>ccusage: Executes via bunx/npx/deno
ccusage-->>User: Runs instantly (no install needed)
Possibly related PRs
Poem
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!
This pull request significantly enhances the user onboarding experience by clarifying and emphasizing the recommended ways to use the tool. My changes aim to make the performance benefits of bunx and the convenience of the tool's small bundle size immediately apparent to new and existing users, streamlining the quick start process and highlighting key differentiators.
Highlights
- Emphasize
bunxand Optional Installation: I've updated the documentation to strongly recommendbunxfor running the tool due to its speed advantages overnpx. Additionally, I've highlighted that local installation is entirely optional, thanks to the tool's extremely small bundle size, encouraging direct execution. - Showcase Ultra-Small Bundle Size: I've added a new feature bullet and dedicated sections in the documentation to emphasize the tool's ultra-small bundle size. This includes an inline badge in the README and a detailed explanation of its benefits (e.g., near-instant startup, minimal overhead, no global pollution).
- Improved Installation Guidance: I've restructured the installation guides to prioritize
bunxand provide a clearer understanding of different execution methods, including Deno for security-conscious users. A performance comparison table has been added to illustrate the speed differences between various runtimes.
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 is currently in preview and 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 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: |
Deploying with
|
| Status | Name | Latest Commit | Updated (UTC) |
|---|---|---|---|
| ✅ Deployment successful! View logs |
ccusage-guide | 7942510 | Jul 03 2025, 03:17 PM |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (5)
docs/guide/index.md (1)
44-47: Add missing comma & tighten wording for smoother flowStatic-analysis correctly flagged a missing comma before the non-restrictive clause. While touching the sentence, we can also shave a couple of extra words.
-Unlike other CLI tools, we pay extreme attention to bundle size. ccusage achieves an incredibly small footprint even without minification, which means you can run it directly without installation using `bunx ccusage` for instant access. +Unlike other CLI tools, we pay extreme attention to bundle size. ccusage achieves an incredibly small footprint even without minification, which means you can run it directly, without installing, via `bunx ccusage` for instant access.README.md (2)
16-18: Provide descriptive alt text for accessibility complianceThe screenshot
<img>is missing analtattribute, making it invisible to screen-reader users.-<img src="https://cdn.jsdelivr.net/gh/ryoppippi/ccusage@main/docs/public/screenshot.png"> +<img src="https://cdn.jsdelivr.net/gh/ryoppippi/ccusage@main/docs/public/screenshot.png" alt="ccusage daily usage report screenshot">
25-36: Minor consistency tweak: keep comment style uniformIn the quick-start snippet the bunx section is annotated with a comment, but the npx/deno lines are not. Either drop the first comment or add similar comments to all three blocks to avoid the perception that the remainder is “commented out”.
Example:
-# Using npx +npx # using npx(or simply delete the
# Using bunx …header).docs/guide/installation.md (2)
7-13: Grammar polish: article agreement & parallelismSmall wording tweaks improve readability and keep the bullet list parallel.
-Thanks to ccusage's incredibly small bundle size, you don't need to install it globally. Unlike other CLI tools, we pay extreme attention to bundle size optimization, achieving an impressively small footprint even without minification. This means: +Thanks to ccusage's incredibly small bundle size, you don't need to install it globally. Unlike other CLI tools, we pay extreme attention to bundle-size optimisation, achieving an impressively small footprint even without minification. This means: -- ✅ Near-instant startup times -- ✅ Minimal download overhead -- ✅ Always use the latest version -- ✅ No global pollution of your system +- ✅ Near-instant startup times +- ✅ Minimal download overhead +- ✅ Always running the latest version +- ✅ No global pollution of your system
20-26: Label clarity inside code-groupThe code-group label
bunx (Recommended)looks good, but for symmetry thenpxblock could readnpx (Slower)or similar, or you could drop the parenthetical from both. This avoids implicitly favouring one runtime in the label itself when the “Speed Recommendation” tip already explains it.No code change shown; just wording advice.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
README.md(2 hunks)docs/guide/index.md(1 hunks)docs/guide/installation.md(2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`docs/**/*.md`: Always place screenshots immediately after the main heading (H1)...
docs/**/*.md: Always place screenshots immediately after the main heading (H1) in documentation pages
Use relative paths like/screenshot.pngfor images stored in/docs/public/
Always include descriptive alt text for accessibility in screenshots
📄 Source: CodeRabbit Inference Engine (CLAUDE.md)
List of files the instruction was applied to:
docs/guide/index.mddocs/guide/installation.md
🪛 LanguageTool
docs/guide/index.md
[uncategorized] ~46-~46: Possible missing comma found.
Context: ...h means you can run it directly without installation using bunx ccusage for instant access...
(AI_HYDRA_LEO_MISSING_COMMA)
README.md
[style] ~86-~86: Using many exclamation marks might seem excessive (in this case: 4 exclamation marks for a text that’s 2354 characters long)
Context: ...credibly small even without minification! ## Documentation Full documentation i...
(EN_EXCESSIVE_EXCLAMATION)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Workers Builds: ccusage-guide
There was a problem hiding this comment.
Code Review
This pull request significantly improves the documentation by emphasizing the use of bunx and the tool's small bundle size. The changes in README.md and the documentation site make the installation instructions clearer and more user-friendly. My review focuses on further improving the clarity and cross-platform compatibility of the newly added deno command examples. I've suggested adding more context and platform-specific notes to ensure all users can follow the instructions easily.
| # Using npx | ||
| npx ccusage@latest | ||
|
|
||
| # Using deno (with security flags) |
There was a problem hiding this comment.
The use of $HOME in the deno command is not cross-platform. On Windows, the equivalent environment variable is typically %USERPROFILE%. To avoid confusion and ensure the command works for Windows users, it would be helpful to clarify this in the comment.
| # Using deno (with security flags) | |
| # Using deno (with security flags; on Windows, use %USERPROFILE% for $HOME) |
| ``` | ||
|
|
||
| ### Local Installation | ||
| > 💡 **Tip**: We recommend using `bunx` instead of `npx` for a massive speed improvement! |
There was a problem hiding this comment.
The deno command is quite complex due to its security flags. While the installation.md guide provides a great explanation, users reading only the README might be confused. It would be beneficial to link to the more detailed guide for users who want to understand the different runtimes and security options.
Consider expanding the tip to include a link to the installation guide. A relative link is fine for GitHub, but an absolute URL to the deployed documentation site would be even better if available.
| > 💡 **Tip**: We recommend using `bunx` instead of `npx` for a massive speed improvement! | |
| > 💡 **Tip**: We recommend using `bunx` instead of `npx` for a massive speed improvement! For more details on runtimes, including security considerations for Deno, see the [Installation Guide](docs/guide/installation.md). |
| ::: info Deno Security | ||
| Consider using `deno run` if you want additional security controls. Deno allows you to specify exact permissions, making it safer to run tools you haven't audited. | ||
| ::: |
There was a problem hiding this comment.
This is a great explanation of Deno's security benefits. However, the deno command example in this document uses $HOME, which is not standard on Windows (where %USERPROFILE% is common). To ensure the instructions are clear for all platforms, it would be helpful to add a note about this for Windows users.
| ::: info Deno Security | |
| Consider using `deno run` if you want additional security controls. Deno allows you to specify exact permissions, making it safer to run tools you haven't audited. | |
| ::: | |
| ::: info Deno Security | |
| Consider using `deno run` if you want additional security controls. Deno allows you to specify exact permissions, making it safer to run tools you haven't audited. | |
| **Note for Windows users:** You may need to replace `$HOME` in the command with `%USERPROFILE%`. | |
| ::: |
1 participant
Summary
Changes
README.md
Documentation Site
Context
Based on the creator's tweets about ccusage:
This PR makes these advantages more visible to users discovering ccusage.
Summary by CodeRabbit
bunx,npx, anddeno, recommendingbunxfor speed.