Skip to content

docs(pm): add the missing flags to the bun install and bun add flag references - #38839

Open
robobun wants to merge 1 commit into
mainfrom
farm/ce63f248/install-snippet-flags
Open

docs(pm): add the missing flags to the bun install and bun add flag references#38839
robobun wants to merge 1 commit into
mainfrom
farm/ce63f248/install-snippet-flags

Conversation

@robobun

@robobun robobun commented Aug 15, 2026

Copy link
Copy Markdown
Collaborator

Problem

  • docs/snippets/cli/install.mdx, the flag reference rendered on the bun install page, does not list --linker, --minimum-release-age, --cpu, --os or --catalog. All five are printed by bun install --help (SHARED_TAIL_PARAMS and INSTALL_PARAMS in src/install/PackageManager/CommandLineArguments.rs) and work.
  • docs/snippets/cli/add.mdx has the same gap for --linker, --minimum-release-age, --cpu and --os (it already documents --catalog).
  • The link and patch snippets already carry --linker, --cpu and --os, so the two pages where these flags matter most were the ones missing them.

Fix

Background

  • docs/snippets/cli/*.mdx are included at the top of the matching docs/pm/cli/*.mdx pages and are the per-command flag tables; the prose sections for the linker, minimum release age and --cpu/--os further down the install page already existed, only the table was incomplete.

…eferences

bun install --help lists --linker, --minimum-release-age, --cpu, --os and
--catalog, and bun add --help lists all but --catalog (which add.mdx
already documents); the flag reference snippets did not mention them.
@coderabbitai

coderabbitai Bot commented Aug 15, 2026

Copy link
Copy Markdown
Contributor

Warning

Review limit reached

@robobun, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 16 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: bce1de76-f5e2-456b-beb3-83d49875027c

📥 Commits

Reviewing files that changed from the base of the PR and between 7adb357 and 4d3679a.

📒 Files selected for processing (2)
  • docs/snippets/cli/add.mdx
  • docs/snippets/cli/install.mdx

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

@robobun

robobun commented Aug 15, 2026

Copy link
Copy Markdown
Collaborator Author
Updated 7:56 PM PT - Aug 14th, 2026

@robobun, your commit 4d3679a59b6791f6361ca7cd143d19ffbfb043b9 passed in Build #97185! 🎉


🧪   To try this PR locally:

bunx bun-pr 38839

That installs a local version of the PR into your bun-38839 executable, so you can run:

bun-38839 --bun

@robobun

robobun commented Aug 15, 2026

Copy link
Copy Markdown
Collaborator Author

Status: ready for review. Docs only.

Each added flag was checked against bun install --help and bun add --help on current main; wording follows the existing link / patch snippets. Companion to #38836 (the bun audit --help gap from the same docs pass); #38759 covers the --network-concurrency default in these same snippets and does not overlap with the lines added here.

@claude claude Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM — docs-only addition of already-shipped CLI flags to the flag reference tables.

What was reviewed:

  • Verified all five flags (--linker, --minimum-release-age, --cpu, --os, --catalog) exist in SHARED_TAIL_PARAMS / INSTALL_PARAMS / ADD_PARAMS in CommandLineArguments.rs and are accepted by both subcommands.
  • Confirmed the descriptions match the --help strings and the wording already used in docs/snippets/cli/link.mdx.
  • Checked the --catalog entry for bun install — it is defined in INSTALL_PARAMS (not just ADD_PARAMS), so documenting it there is correct.
Extended reasoning...

Overview

This PR adds missing ParamField entries to two docs snippets (docs/snippets/cli/install.mdx and docs/snippets/cli/add.mdx) for CLI flags that already exist and work but weren't listed in the per-command flag tables: --linker, --minimum-release-age, --cpu, --os, and (for install) --catalog. No code is touched.

Security risks

None. Pure documentation change to .mdx snippet files.

Level of scrutiny

Low. This is mechanical docs backfill. I cross-checked each added flag against src/install/PackageManager/CommandLineArguments.rs:

  • SHARED_TAIL_PARAMS (lines 117–126) defines --linker, --minimum-release-age, --cpu, --os and is included in both INSTALL_PARAMS (via line 168) and ADD_PARAMS (via SHARED_PARAMS at line 132/232).
  • --catalog is defined separately in both INSTALL_PARAMS (line 154) and ADD_PARAMS (line 251), so adding it to the install snippet is correct.
  • The description text matches the --help strings and is byte-identical to the entries already in docs/snippets/cli/link.mdx (the stated source for the wording).

Other factors

CI build #97185 passed. No prior human review comments to address. The MDX structure follows the existing ParamField / ### section pattern used throughout the file and in sibling snippets (the new Platform Targeting section header mirrors link.mdx). The PR description accurately notes placement avoids conflict with two other open PRs touching adjacent lines.

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants