You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 105a10f
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: README.md
+14-2Lines changed: 14 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,13 +22,24 @@
22
22
23
23
### Quick Start (Recommended)
24
24
25
-
Run directly without installation:
25
+
Thanks to ccusage's incredibly small bundle size ([](https://packagephobia.com/result?p=ccusage)), you can run it directly without installation:
26
26
27
27
```bash
28
+
# Using bunx (recommended for speed)
29
+
bunx ccusage
30
+
31
+
# Using npx
28
32
npx ccusage@latest
33
+
34
+
# Using deno (with security flags)
35
+
deno run -E -R=$HOME/.claude/projects/ -S=homedir -N='raw.githubusercontent.com:443' npm:ccusage@latest
29
36
```
30
37
31
-
### Local Installation
38
+
> 💡 **Tip**: We recommend using `bunx` instead of `npx` for a massive speed improvement!
39
+
40
+
### Local Installation (Optional)
41
+
42
+
Since ccusage has such a small bundle size, installation is entirely optional:
ccusage automatically colors the output based on the terminal's capabilities. If you want to disable colors, you can use the `--no-color` flag. Or you can use the `--color` flag to force colors on.
Copy file name to clipboardExpand all lines: docs/guide/index.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,6 +41,10 @@ graph LR
41
41
42
42
## Key Features
43
43
44
+
### 🚀 Ultra-Small Bundle Size
45
+
46
+
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.
47
+
44
48
### 📊 Multiple Report Types
45
49
46
50
-**Daily Reports** - Usage aggregated by calendar date
Copy file name to clipboardExpand all lines: docs/guide/installation.md
+33-12Lines changed: 33 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,18 +2,27 @@
2
2
3
3
ccusage can be installed and used in several ways depending on your preferences and use case.
4
4
5
+
## Why No Installation Needed?
6
+
7
+
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:
8
+
9
+
- ✅ Near-instant startup times
10
+
- ✅ Minimal download overhead
11
+
- ✅ Always use the latest version
12
+
- ✅ No global pollution of your system
13
+
5
14
## Quick Start (Recommended)
6
15
7
-
The fastest way to try ccusage is to run it directly without installation:
16
+
The fastest way to use ccusage is to run it directly:
8
17
9
18
::: code-group
10
19
11
-
```bash [npx]
12
-
npx ccusage@latest
20
+
```bash [bunx (Recommended)]
21
+
bunx ccusage
13
22
```
14
23
15
-
```bash [bunx]
16
-
bunx ccusage
24
+
```bash [npx]
25
+
npx ccusage@latest
17
26
```
18
27
19
28
```bash [pnpm]
@@ -26,16 +35,28 @@ deno run -E -R=$HOME/.claude/projects/ -S=homedir -N='raw.githubusercontent.com:
26
35
27
36
:::
28
37
29
-
This approach:
38
+
::: tip Speed Recommendation
39
+
We strongly recommend using `bunx` instead of `npx` due to the massive speed difference. Bunx caches packages more efficiently, resulting in near-instant startup times after the first run.
40
+
:::
41
+
42
+
::: info Deno Security
43
+
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.
44
+
:::
45
+
46
+
### Performance Comparison
47
+
48
+
Here's why runtime choice matters:
30
49
31
-
- ✅ Always uses the latest version
32
-
- ✅ No global installation required
33
-
- ✅ Works across different systems
34
-
- ✅ Perfect for occasional use
50
+
| Runtime | First Run | Subsequent Runs | Notes |
51
+
|---------|-----------|-----------------|-------|
52
+
| bunx | Fast |**Instant**| Best overall choice |
53
+
| npx | Slow | Moderate | Widely available |
54
+
| pnpm dlx | Fast | Fast | Good alternative |
55
+
| deno | Moderate | Fast | Best for security |
35
56
36
-
## Global Installation
57
+
## Global Installation (Optional)
37
58
38
-
If you use ccusage frequently, install it globally:
59
+
While not necessary due to our small bundle size, you can still install ccusage globally if you prefer:
Copy file name to clipboardExpand all lines: docs/guide/related-projects.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,6 +7,7 @@ Projects that use ccusage internally or extend its functionality:
7
7
-[claude-usage-tracker-for-mac](https://github.com/penicillin0/claude-usage-tracker-for-mac) - macOS menu bar app for tracking Claude usage
8
8
-[ClaudeCode_Dashboard](https://github.com/m-sigepon/ClaudeCode_Dashboard) - Web dashboard with charts and visualizations
9
9
-[Ccusage App](https://github.com/EthanBarlo/ccusage-app) - Native application to display ccusage data in graphs and visualizations
10
+
-[CCOwl](https://github.com/sivchari/ccowl) - A cross-platform status bar application that monitors Claude Code usage in real-time.
0 commit comments