docs: BUN_BE_BUN #2
Conversation
📝 WalkthroughWalkthroughUpdated README.md to make Node.js optional and add opencode installation instructions. The change clarifies that Node.js is not required when using opencode, while preserving existing npm and git-based installation methods. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@README.md`:
- Around line 25-27: Update the README note to remove the incorrect "no need
node/bun" claim and clearly state that Node.js (>=18.0.0) is
required/recommended for npm/pnpm/yarn installs and that Bun is a
supported/recommended alternative; clarify that the BUN_BE_BUN=1 env var is used
for Bun runtime detection in compiled binaries (not to eliminate Node/Bun
requirements). Also verify the command "opencode x cursor-opencode-auth" (or
replace it) by either documenting its usage/syntax or substituting a documented
install/run example (e.g., npm/pnpm/yarn or officially supported opencode
invocation) so users have a supported, documented command to follow.
| # Or run with opencode (no need node/bun) | ||
| BUN_BE_BUN=1 opencode x cursor-opencode-auth | ||
|
|
There was a problem hiding this comment.
🧩 Analysis chain
🌐 Web query:
opencode BUN_BE_BUN environment variable documentation
💡 Result:
Short answer — BUN_BE_BUN is a Bun runtime environment variable that, when set (usually to "1"), makes a single-file executable produced by bun build --compile behave like the bun CLI (runs Bun itself / exposes Bun commands instead of the embedded app). OpenCode’s code/tooling may set or check BUN_BE_BUN for Bun detection. Sources: Bun docs/blog (executable behavior) [1][2]; OpenCode environment list / repo notes (mentions BUN_BE_BUN set by bash tool for detection) [3][4].
Sources
- Bun docs — Single-file executable / Act as the Bun CLI.
- Bun blog / release notes describing BUN_BE_BUN.
- OpenCode CLI docs — environment variables list.
- OpenCode product spec / repo gist mentioning BUN_BE_BUN detection.
🌐 Web query:
opencode x cursor command syntax
💡 Result:
Use the Cursor CLI as your EDITOR and call OpenCode’s editor commands. Example steps:
- Install Cursor CLI (adds the cursor command). [1]
- Set EDITOR to Cursor with wait flag: export EDITOR="cursor --wait". [2][1]
- From the OpenCode TUI run the editor command (or use /editor): OpenCode will launch Cursor. Or run opencode in a terminal and use the editor keybinding/command. [2][3]
Example commands:
- Install/confirm cursor CLI per Cursor docs. [1]
- Set editor (Linux/macOS): export EDITOR="cursor --wait". [2]
- In TUI: /editor (or press the editor keybind) to open the file in Cursor. [2][3]
Sources:
[1] Cursor CLI docs.
[2] OpenCode TUI / Editor setup docs.
[3] OpenCode keybinds / editor integration docs.
🌐 Web query:
opencode tool requirements Node.js Bun
💡 Result:
Short answer — requirements and install options for OpenCode:
- Node.js: recommended/required Node.js ≥ 18.0.0 for npm/pnpm/yarn installs. [1][2]
- Bun: supported (often recommended for web/UI examples); Bun can be used to install/run packages and dev servers. [2][3]
- No heavy runtime beyond a modern terminal; OpenCode itself is a CLI (native binary/Go-built CLI published by the project) but distribution/install wrappers are provided via curl|bash, npm/pnpm/yarn, bun, Homebrew, paru (Arch), and Windows package managers (choco/winget/scoop). [1][2][4]
- Other basics: Git (for cloning), optional Docker for sandboxing, and API keys for any LLM providers you intend to use. [1][5]
Install entry points (examples): curl -fsSL https://opencode.ai/install | bash; npm install -g opencode-ai; bun install -g opencode-ai; brew/paru/choco/winget/scoop options. [1][2][4]
Sources: OpenCode docs/site and GitHub.
[1] https://dev.opencode.ai/ › (site)
[2] https://github.com/opencode-ai/opencode
[3] Example repo mentioning Bun recommended: https://github.com/chris-tse/opencode-web
[4] Install docs & package-manager options: https://opencode.ai/docs/ and related install pages
[5] Prereqs (Git, Docker, API keys): https://dev.opencode.ai/docs/
Incorrect dependency claim: Node.js IS required/recommended, not optional.
The line "no need node/bun" contradicts OpenCode's documented requirements. Node.js ≥ 18.0.0 is required/recommended for installation via npm/pnpm/yarn, and Bun is a supported and recommended option, not something you skip. The BUN_BE_BUN=1 environment variable is for Bun runtime detection in compiled binaries, not for eliminating Bun as a runtime option.
Correct the note to accurately reflect installation requirements. Additionally, the specific command opencode x cursor-opencode-auth lacks public documentation—verify its syntax and provide context for users unfamiliar with this invocation.
🤖 Prompt for AI Agents
In `@README.md` around lines 25 - 27, Update the README note to remove the
incorrect "no need node/bun" claim and clearly state that Node.js (>=18.0.0) is
required/recommended for npm/pnpm/yarn installs and that Bun is a
supported/recommended alternative; clarify that the BUN_BE_BUN=1 env var is used
for Bun runtime detection in compiled binaries (not to eliminate Node/Bun
requirements). Also verify the command "opencode x cursor-opencode-auth" (or
replace it) by either documenting its usage/syntax or substituting a documented
install/run example (e.g., npm/pnpm/yarn or officially supported opencode
invocation) so users have a supported, documented command to follow.
1 participant
do you know this secret
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.