Skip to content

docs: remove unsupported claude x execution path#893

Open
jasonandjay wants to merge 1 commit intoryoppippi:mainfrom
jasonandjay:docs/remove-claude-x-install-path
Open

docs: remove unsupported claude x execution path#893
jasonandjay wants to merge 1 commit intoryoppippi:mainfrom
jasonandjay:docs/remove-claude-x-install-path

Conversation

@jasonandjay
Copy link

@jasonandjay jasonandjay commented Mar 16, 2026

Fixes #862

Summary

Remove BUN_BE_BUN=1 claude x ccusage from user-facing docs since it is not a valid/working execution path in Claude Code.

Changes

  • Removed claude x snippets from:
    • docs/guide/installation.md
    • docs/guide/getting-started.md
    • docs/guide/statusline.md
  • Removed the detailed Running with claude x section in installation docs
  • Updated intro copy in docs/guide/index.md to reference supported direct execution (bunx) only

Why

Keeps docs aligned with real CLI behavior and avoids onboarding confusion for new users.

Summary by CodeRabbit

  • Documentation
    • Simplified getting started and installation guides by removing legacy environment variable setup instructions.
    • Streamlined code examples in multiple guides to use more direct command invocations.
    • Updated configuration documentation for improved clarity and ease of use.

@coderabbitai
Copy link

coderabbitai bot commented Mar 16, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: fc750a44-383d-44e5-bc1e-92691361f667

📥 Commits

Reviewing files that changed from the base of the PR and between b81913f and bac6aa6.

📒 Files selected for processing (4)
  • docs/guide/getting-started.md
  • docs/guide/index.md
  • docs/guide/installation.md
  • docs/guide/statusline.md
💤 Files with no reviewable changes (3)
  • docs/guide/statusline.md
  • docs/guide/getting-started.md
  • docs/guide/installation.md

📝 Walkthrough

Walkthrough

The PR removes documentation for an incorrect installation method (BUN_BE_BUN=1 claude x) from multiple guide files, as this approach doesn't function with the Claude Code native binary. Documentation now focuses exclusively on functional alternatives (bunx, npx, pnpm dlx, deno).

Changes

Cohort / File(s) Summary
Claude x documentation removal
docs/guide/getting-started.md, docs/guide/index.md, docs/guide/installation.md, docs/guide/statusline.md
Removed code examples, configuration blocks, and explanatory sections documenting the non-functional BUN_BE_BUN=1 claude x ccusage invocation pattern across quick-start, bundle-size example, and statusline configuration documentation.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

Poem

🐰 Out with the broken, in with the true,
We hopped away from what didn't work through,
Now bunx hops forward, clear and just right,
Our docs shine brighter in documentation's light! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately and concisely describes the main change: removing documentation for the unsupported claude x execution path.
Linked Issues check ✅ Passed All code changes directly address the requirements in issue #862: removed all claude x documentation references and snippets from four documentation files.
Out of Scope Changes check ✅ Passed All changes are scoped to removing unsupported claude x documentation; no unrelated modifications detected.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
📝 Coding Plan
  • Generate coding plan for human review comments

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Tip

CodeRabbit can use TruffleHog to scan for secrets in your code with verification capabilities.

Add a TruffleHog config file (e.g. trufflehog-config.yml, trufflehog.yml) to your project to customize detectors and scanning behavior. The tool runs only when a config file is present.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: claude x ccusage installation method is incorrect and doesn't work

1 participant