Skip to content
This repository was archived by the owner on Feb 19, 2026. It is now read-only.

Commit e5c9a5a

Browse files
authored
Document cross platform options (#130)
1 parent db6ebe7 commit e5c9a5a

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@ prebuild-install [options]
3737
--runtime -r runtime (Node runtime [node, napi or electron] to build or install for, default is node)
3838
--path -p path (make a prebuild-install here)
3939
--token -T gh-token (github token for private repos)
40+
--arch arch (target CPU architecture, see Node OS module docs, default is current arch)
41+
--platform platform (target platform, see Node OS module docs, default is current platform)
4042
--tag-prefix <prefix> (github tag prefix, default is "v")
4143
--build-from-source (skip prebuild download)
4244
--verbose (log verbosely)
@@ -46,8 +48,8 @@ prebuild-install [options]
4648
```
4749

4850
When `prebuild-install` is run via an `npm` script, options
49-
`--build-from-source`, `--debug` and `--download`, may be passed through via
50-
arguments given to the `npm` command.
51+
`--build-from-source`, `--debug`, `--download`, `--target`, `--runtime`, `--arch` and `--platform` may be passed through via
52+
arguments given to the `npm` command. Alternatively you can set environment variables `npm_config_platform`, `npm_config_arch`, `npm_config_target` and `npm_config_runtime`.
5153

5254
### Private Repositories
5355

help.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ prebuild-install [options]
55
--runtime -r runtime (Node runtime [node or electron] to build or install for, default is node)
66
--path -p path (make a prebuild-install here)
77
--token -T gh-token (github token for private repos)
8+
--arch arch (target CPU architecture, see Node OS module docs, default is current arch)
9+
--platform platform (target platform, see Node OS module docs, default is current platform)
810
--tag-prefix <prefix> (github tag prefix, default is "v")
911
--force (always use prebuilt binaries when available)
1012
--build-from-source (skip prebuild download)

0 commit comments

Comments
 (0)