Skip to content

Commit 223d060

Browse files
authored
docs: document --cpu, --os and --libc flags in pnpm install --help (#12478)
These flags are already supported via rcOptionsTypes but were only documented on the website, not in the CLI help output. Close #12359
1 parent 83f06a6 commit 223d060

2 files changed

Lines changed: 18 additions & 0 deletions

File tree

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
"@pnpm/installing.commands": patch
3+
"pnpm": patch
4+
---
5+
6+
Document the `--cpu`, `--os` and `--libc` flags in the output of `pnpm install --help`. These flags were already supported but were only documented on the website [#12359](https://github.com/pnpm/pnpm/issues/12359).

installing/commands/src/install.ts

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -288,6 +288,18 @@ Install all optionalDependencies even when they don\'t satisfy the current envir
288288
description: 'Re-runs resolution: useful for printing out peer dependency issues',
289289
name: '--resolution-only',
290290
},
291+
{
292+
description: 'Override CPU architecture of native modules to install. Acceptable values are the same as the `cpu` field of `package.json` (from `process.arch`)',
293+
name: '--cpu <arch>',
294+
},
295+
{
296+
description: 'Override OS of native modules to install. Acceptable values are the same as the `os` field of `package.json` (from `process.platform`)',
297+
name: '--os <os>',
298+
},
299+
{
300+
description: 'Override libc of native modules to install. Acceptable values are the same as the `libc` field of `package.json`',
301+
name: '--libc <libc>',
302+
},
291303
...UNIVERSAL_OPTIONS,
292304
],
293305
},

0 commit comments

Comments
 (0)