docs: convert command guidance to bun invocation - #1233
Merged
Conversation
code-yeongyu
force-pushed
the
chore/bun-invocation-guidance
branch
from
August 31, 2026 08:13
9cdba9f to
636a3af
Compare
code-yeongyu
force-pushed
the
chore/bun-invocation-guidance
branch
from
August 31, 2026 08:39
636a3af to
a99450d
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
The fleet standard is Bun-only for JavaScript/TypeScript command invocation. Agent and developer documentation was guiding agents toward npm/npx/node commands, including package-scoped Vitest commands, which conflicts with that standard. This PR updates documentation command guidance only; Vitest remains the test framework.
Conversion table
npm run <script>bun run <script>npm testbun run testnpm --prefix <dir> test -- <args>bun run --cwd <dir> test <args>npm --prefix <dir> run <script>bun run --cwd <dir> <script>npm --prefix <dir> exec vitest -- <args>bunx --cwd <dir> vitest <args>npx <cli>bunx <cli>node scripts/<file>.mjs/.jsbun scripts/<file>.mjs/.jsnpm installbun installContributor-facing npm install examples in README.md/CONTRIBUTING.md remain available with Bun alternatives alongside them, as requested.
node --testguidance was not converted because Bun node:test compatibility is not proven; those references remain intentionally inventoried exceptions. No package.json, lockfile, workflow, source, CHANGELOG.md, or changes.md files were changed.Spot verification (remote mengmotaMac)
All commands were run remotely with
ssh mengmotaMac 'cd ~/local-workspaces/senpi && ...'; no tests/builds were run on the local machine.bun run --cwd packages/coding-agent test test/compaction/overflow-retry-bound.test.tsbun run check:ts-importsnode scripts/check-ts-relative-imports.mjsbun run check:model-datanpm --prefix packages/ai run check:model-data)Generated model data is valid.Follow-up inventory: untouched npm internals
These are intentionally not changed in this documentation-only PR and should be handled as a separate runtime/CI migration proposal:
npm run,npm --prefix,npm install,npm version, ornode scripts/...; notable examples include rootcheck,test,refresh-lock, version/publish scripts, coding-agentbuild:binary, and packageprepublishOnlychains..github/workflows/ci.yml,perf-trend.yml,npm-audit.yml,issue-analysis.yml,native-prebuilds.yml,changelog-gate.yml,releasability.yml,publish-npm.yml,build-binaries.yml, andpublish-model-catalog.ymlstill contain npm/npx/node invocations. These were explicitly out of scope.node --testguidance: intentional exceptions remain inAGENTS.mdandpackages/tui/AGENTS.mdfor the TUI/scripts node:test runners.Scope verification
git diff --name-onlycontains Markdown files only.git diff --checkpasses.node --testrunner notes remain as inventory exceptions.Summary by cubic
Updates documentation command guidance from npm/npx/node to Bun (
bun,bunx) so agent and developer docs match the fleet-standard Bun-only invocation. Vitest remains the test framework; this is a docs-only change.npm run,npm test,npm --prefix,npx,node scripts/..., and install guidance (npm install,npm install -g,npm --package-lock-only,npm ci) tobun run,bun run --cwd,bunx,bun scripts/...,bun add -g,bun install --lockfile-only, andbun install --frozen-lockfile.npm installexamples in root and packageREADME.mdfiles andCONTRIBUTING.mdwith Bun alternatives alongside.node --testguidance in TUI/scripts docs unchanged because Bunnode:testcompatibility is not proven.Written for commit a99450d. Summary will update on new commits.