Skip to content

docs: document --cpu, --os and --libc flags in pnpm install --help#12478

Merged
zkochan merged 1 commit into
pnpm:mainfrom
subaru-hello:docs/install-help-arch-flags
Jun 17, 2026
Merged

docs: document --cpu, --os and --libc flags in pnpm install --help#12478
zkochan merged 1 commit into
pnpm:mainfrom
subaru-hello:docs/install-help-arch-flags

Conversation

@subaru-hello

@subaru-hello subaru-hello commented Jun 17, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Contributor

What

Add --cpu, --os and --libc to the options listed in pnpm install --help.

Why

These flags were added in #9745 and already work (they're registered in rcOptionsTypes), but were only documented on the website, not in the CLI help. Wording matches the website docs.

Closes #12359

Summary by CodeRabbit

  • Documentation
    • Added documentation for the --cpu, --os, and --libc flags in the install command help output. These flags allow users to override native module installation options.

@subaru-hello
docs: document --cpu, --os and --libc flags in pnpm install --help
a735e29 
These flags are already supported via rcOptionsTypes but were only
documented on the website, not in the CLI help output.

Close pnpm#12359
@subaru-hello subaru-hello requested a review from zkochan as a code owner June 17, 2026 14:21
@welcome

welcome Bot commented Jun 17, 2026

Copy link
Copy Markdown

💖 Thanks for opening this pull request! 💖
Please be patient and we will get back to you as soon as we can.

@coderabbitai

coderabbitai Bot commented Jun 17, 2026 •
edited
Loading

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: c6270f0d-557f-479d-9cad-820fd2eb03fc

📥 Commits

Reviewing files that changed from the base of the PR and between c18cbd4 and a735e29.

📒 Files selected for processing (2)
  • .changeset/install-help-arch-flags.md
  • installing/commands/src/install.ts
📝 Walkthrough

Walkthrough

Three CLI options (--cpu, --os, --libc) are added to the help() output of the pnpm install command in install.ts. These options already existed functionally; this change makes them visible via pnpm install --help. A changeset entry records the patch for @pnpm/installing.commands and pnpm.

Changes

Install help flag documentation

Layer / File(s) Summary
Help output entries and changeset
installing/commands/src/install.ts, .changeset/install-help-arch-flags.md		 Three option blocks (--cpu <arch>, --os <os>, --libc <libc>) added to the help() function describing native module target overrides; changeset marks both packages as patched.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Assessment against linked issues

Objective Addressed Explanation
Include --cpu, --libc, and --os flags in pnpm i --help output [#12359] ✅

Suggested labels

product: pnpm

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

ESLint install failed. For unrecoverable errors, disable the tool in CodeRabbit configuration.

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.

@zkochan zkochan merged commit 223d060 into pnpm:main Jun 17, 2026
22 of 25 checks passed
@welcome

welcome Bot commented Jun 17, 2026

Copy link
Copy Markdown

Congrats on merging your first pull request! 🎉🎉🎉

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

Reviewers

@zkochan zkochan zkochan approved these changes
@coderabbitai coderabbitai[bot] coderabbitai[bot] approved these changes

Assignees

No one assigned

Labels

product: pnpm@11

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Include --cpu, --libc and --os in pnpm i --help output

2 participants

@subaru-hello @zkochan