File Explorer

1.TH "NPM-REBUILD" "1" "February 2026" "NPM@11.11.0" ""2.SH "NAME"3\fBnpm-rebuild\fR - Rebuild a package4.SS "Synopsis"5.P6.RS 27.nf8npm rebuild \[lB]<package-spec>\[rB] ...\[rB]9 10alias: rb11.fi12.RE13.SS "Description"14.P15This command does the following:16.RS 017.IP 1. 418Execute lifecycle scripts (\fBpreinstall\fR, \fBinstall\fR, \fBpostinstall\fR, \fBprepare\fR)19.IP 2. 420Links bins depending on whether bin links are enabled21.RE 022 23.P24This command is particularly useful in scenarios including but not limited to:25.RS 026.IP 1. 427Installing a new version of \fBnode.js\fR, where you need to recompile all your C++ add-ons with the updated binary.28.IP 2. 429Installing with \fB--ignore-scripts\fR and \fB--no-bin-links\fR, to explicitly choose which packages to build and/or link bins.30.RE 031 32.P33If one or more package specs are provided, then only packages with a name and version matching one of the specifiers will be rebuilt.34.P35Usually, you should not need to run \fBnpm rebuild\fR as it is already done for you as part of npm install (unless you suppressed these steps with \fB--ignore-scripts\fR or \fB--no-bin-links\fR).36.P37If there is a \fBbinding.gyp\fR file in the root of your package, then npm will use a default install hook:38.P39.RS 240.nf41"scripts": {42    "install": "node-gyp rebuild"43}44.fi45.RE46.P47This default behavior is suppressed if the \fBpackage.json\fR has its own \fBinstall\fR or \fBpreinstall\fR scripts. It is also suppressed if the package specifies \fB"gypfile": false\fR48.SS "Configuration"49.SS "\fBglobal\fR"50.RS 051.IP \(bu 452Default: false53.IP \(bu 454Type: Boolean55.RE 056 57.P58Operates in "global" mode, so that packages are installed into the \fBprefix\fR folder instead of the current working directory. See npm help folders for more on the differences in behavior.59.RS 060.IP \(bu 461packages are installed into the \fB{prefix}/lib/node_modules\fR folder, instead of the current working directory.62.IP \(bu 463bin files are linked to \fB{prefix}/bin\fR64.IP \(bu 465man pages are linked to \fB{prefix}/share/man\fR66.RE 067 68.SS "\fBbin-links\fR"69.RS 070.IP \(bu 471Default: true72.IP \(bu 473Type: Boolean74.RE 075 76.P77Tells npm to create symlinks (or \fB.cmd\fR shims on Windows) for package executables.78.P79Set to false to have it not do this. This can be used to work around the fact that some file systems don't support symlinks, even on ostensibly Unix systems.80.SS "\fBforeground-scripts\fR"81.RS 082.IP \(bu 483Default: \fBfalse\fR unless when using \fBnpm pack\fR or \fBnpm publish\fR where it defaults to \fBtrue\fR84.IP \(bu 485Type: Boolean86.RE 087 88.P89Run all build scripts (ie, \fBpreinstall\fR, \fBinstall\fR, and \fBpostinstall\fR) scripts for installed packages in the foreground process, sharing standard input, output, and error with the main npm process.90.P91Note that this will generally make installs run slower, and be much noisier, but can be useful for debugging.92.SS "\fBignore-scripts\fR"93.RS 094.IP \(bu 495Default: false96.IP \(bu 497Type: Boolean98.RE 099 100.P101If true, npm does not run scripts specified in package.json files.102.P103Note that commands explicitly intended to run a particular script, such as \fBnpm start\fR, \fBnpm stop\fR, \fBnpm restart\fR, \fBnpm test\fR, and \fBnpm run\fR will still run their intended script if \fBignore-scripts\fR is set, but they will \fInot\fR run any pre- or post-scripts.104.SS "\fBworkspace\fR"105.RS 0106.IP \(bu 4107Default:108.IP \(bu 4109Type: String (can be set multiple times)110.RE 0111 112.P113Enable running a command in the context of the configured workspaces of the current project while filtering by running only the workspaces defined by this configuration option.114.P115Valid values for the \fBworkspace\fR config are either:116.RS 0117.IP \(bu 4118Workspace names119.IP \(bu 4120Path to a workspace directory121.IP \(bu 4122Path to a parent workspace directory (will result in selecting all workspaces within that folder)123.RE 0124 125.P126When set for the \fBnpm init\fR command, this may be set to the folder of a workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project.127.P128This value is not exported to the environment for child processes.129.SS "\fBworkspaces\fR"130.RS 0131.IP \(bu 4132Default: null133.IP \(bu 4134Type: null or Boolean135.RE 0136 137.P138Set to true to run the command in the context of \fBall\fR configured workspaces.139.P140Explicitly setting this to false will cause commands like \fBinstall\fR to ignore workspaces altogether. When not set explicitly:141.RS 0142.IP \(bu 4143Commands that operate on the \fBnode_modules\fR tree (install, update, etc.) will link workspaces into the \fBnode_modules\fR folder. - Commands that do other things (test, exec, publish, etc.) will operate on the root project, \fIunless\fR one or more workspaces are specified in the \fBworkspace\fR config.144.RE 0145 146.P147This value is not exported to the environment for child processes.148.SS "\fBinclude-workspace-root\fR"149.RS 0150.IP \(bu 4151Default: false152.IP \(bu 4153Type: Boolean154.RE 0155 156.P157Include the workspace root when workspaces are enabled for a command.158.P159When false, specifying individual workspaces via the \fBworkspace\fR config, or all workspaces via the \fBworkspaces\fR flag, will cause npm to operate only on the specified workspaces, and not on the root project.160.P161This value is not exported to the environment for child processes.162.SS "\fBinstall-links\fR"163.RS 0164.IP \(bu 4165Default: false166.IP \(bu 4167Type: Boolean168.RE 0169 170.P171When set file: protocol dependencies will be packed and installed as regular dependencies instead of creating a symlink. This option has no effect on workspaces.172.SS "See Also"173.RS 0174.IP \(bu 4175npm help "package spec"176.IP \(bu 4177npm help install178.RE 0179