Skip to content

docs: remove unsupported claude x execution path #893

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jasonandjay wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: remove unsupported claude x execution path #893

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions docs/guide/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,6 @@ bunx ccusage
pnpm dlx ccusage
```

```bash [claude x]
BUN_BE_BUN=1 claude x ccusage
```

:::

Expand Down
2 changes: 1 addition & 1 deletion docs/guide/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ ccusage analyzes the local JSONL files that Claude Code automatically generates

### 🚀 Ultra-Small Bundle Size

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` or `BUN_BE_BUN=1 claude x 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 installation using `bunx ccusage` for instant access.

### 📊 Multiple Report Types

Expand Down
29 changes: 0 additions & 29 deletions docs/guide/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,6 @@ pnpm dlx ccusage
deno run -E -R=$HOME/.claude/projects/ -S=homedir -N='raw.githubusercontent.com:443' npm:ccusage@latest
```

```bash [claude x]
BUN_BE_BUN=1 claude x ccusage
```

:::

Expand All @@ -47,32 +44,6 @@ We strongly recommend using `bunx` instead of `npx` due to the massive speed dif
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.
:::

::: details Running with `claude x`

If you have the **native version** of Claude Code installed, you can run ccusage directly using the `claude x` command:

```bash
BUN_BE_BUN=1 claude x ccusage
```

**How it works:**

The native Claude Code binary is built with [Bun's standalone executable](https://bun.sh/docs/bundler/executables) feature. When you set `BUN_BE_BUN=1`, the Claude Code executable exposes the full Bun CLI capabilities instead of running its bundled entry point. This allows you to use `claude x` as a drop-in replacement for `bunx`.

**Requirements:**

- **Native Claude Code installation** (installed via `curl -fsSL https://claude.ai/install.sh | bash` or Homebrew/WinGet)
- This does **NOT** work with the npm version (`npm install -g @anthropic-ai/claude-code`)
- Run `claude doctor` to verify whether you have the native version installed

**Why use this?**

- No need to install Bun separately
- Uses the same Bun runtime bundled with Claude Code
- Convenient for Claude Code users who want to check their usage without additional tools

For more details, see the [Bun documentation on BUN_BE_BUN](https://bun.sh/docs/bundler/executables#act-as-the-bun-cli) and [Claude Code setup guide](https://code.claude.com/docs/en/setup).
:::

### Performance Comparison

Expand Down
12 changes: 0 additions & 12 deletions docs/guide/statusline.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,6 @@ Add this to your `~/.claude/settings.json` or `~/.config/claude/settings.json`:
}
```

```json [claude x]
{
"statusLine": {
"type": "command",
"command": "BUN_BE_BUN=1 claude x ccusage statusline",
"padding": 0
}
}
```

```json [npx]
{
Expand All @@ -52,9 +43,6 @@ Add this to your `~/.claude/settings.json` or `~/.config/claude/settings.json`:

:::

::: tip claude x option
The `claude x` option requires the native version of Claude Code (not the npm version). If you installed Claude Code via npm, use the `bun x` or `npx` options instead.
:::

By default, statusline uses **offline mode** with cached pricing data for optimal performance.

Expand Down