Installation

ccusage can be installed and used in several ways depending on your preferences and use case.

Quick Start (Recommended)

The fastest way to try ccusage is to run it directly without installation:

npx

npx ccusage@latest

bunx

bunx ccusage

pnpm

pnpm dlx ccusage

deno

deno run -E -R=$HOME/.claude/projects/ -S=homedir -N='raw.githubusercontent.com:443' npm:ccusage@latest

This approach:

• ✅ Always uses the latest version
• ✅ No global installation required
• ✅ Works across different systems
• ✅ Perfect for occasional use

Global Installation

If you use ccusage frequently, install it globally:

npm

npm install -g ccusage

bun

bun install -g ccusage

yarn

yarn global add ccusage

pnpm

pnpm add -g ccusage

After global installation, run commands directly:

ccusage daily
ccusage monthly --breakdown
ccusage blocks --live

Development Installation

For development or contributing to ccusage:

# Clone the repository
git clone https://github.com/ryoppippi/ccusage.git
cd ccusage

# Install dependencies
bun install

# Run directly from source
bun run start daily
bun run start monthly --json

Development Scripts

# Run tests
bun run test

# Type checking
bun typecheck

# Build distribution
bun run build

# Lint and format
bun run format

Runtime Requirements

Node.js

• Minimum: Node.js 20.x
• Recommended: Node.js 20.x or later
• LTS versions are fully supported

Bun (Alternative)

• Minimum: Bun 1.2+
• Recommended: Latest stable release
• Often faster than Node.js for ccusage

Deno

Deno 2.0+ is fully supported with proper permissions:

deno run \
  -E \
  -R=$HOME/.claude/projects/ \
  -S=homedir \
  -N='raw.githubusercontent.com:443' \
  npm:ccusage@latest

Verification

After installation, verify ccusage is working:

# Check version
ccusage --version

# Run help command
ccusage --help

# Test with daily report
ccusage daily

Updating

Direct Execution (npx/bunx)

Always gets the latest version automatically.

Global Installation

# Update with npm
npm update -g ccusage

# Update with bun
bun update -g ccusage

Check Current Version

ccusage --version

Uninstalling

Global Installation

npm

npm uninstall -g ccusage

bun

bun remove -g ccusage

yarn

yarn global remove ccusage

pnpm

pnpm remove -g ccusage

Development Installation

# Remove cloned repository
rm -rf ccusage/

Troubleshooting Installation

Permission Errors

If you get permission errors during global installation:

npm

# Use npx instead of global install
npx ccusage@latest

# Or configure npm to use a different directory
npm config set prefix ~/.npm-global
export PATH=~/.npm-global/bin:$PATH

Node Version Managers

# Use nvm (recommended)
nvm install node
npm install -g ccusage

# Or use fnm
fnm install node
npm install -g ccusage

Network Issues

If installation fails due to network issues:

# Try with different registry
npm install -g ccusage --registry https://registry.npmjs.org

# Or use bunx for offline-capable runs
bunx ccusage

Version Conflicts

If you have multiple versions installed:

# Check which version is being used
which ccusage
ccusage --version

# Uninstall and reinstall
npm uninstall -g ccusage
npm install -g ccusage@latest

Next Steps

After installation, check out:

• Getting Started Guide - Your first usage report
• Configuration - Customize ccusage behavior
• Daily Reports - Understand daily usage patterns