1NPM-REBUILD(1)                                                  NPM-REBUILD(1)
2
3
4

NAME

6       npm-rebuild - Rebuild a package
7
8   Synopsis
9         npm rebuild [[<@scope>/]<name>[@<version>] ...]
10
11         alias: rb
12
13   Description
14       This  command  runs the npm build command on the matched folders.  This
15       is useful when you install a new version of node,  and  must  recompile
16       all  your  C++  addons with the new binary.  It is also useful when in‐
17       stalling with --ignore-scripts and --no-bin-links, to explicitly choose
18       which packages to build and/or link bins.
19
20       If  one  or more package names (and optionally version ranges) are pro‐
21       vided, then only packages with a name and version matching one  of  the
22       specifiers will be rebuilt.
23
24   Configuration
25       <!--  AUTOGENERATED  CONFIG  DESCRIPTIONS  START --> <!-- automatically
26       generated, do not edit manually --> <!--  see  lib/utils/config/defini‐
27       tions.js -->
28
29   global
30       • Default: false
31
32       • Type: Boolean
33
34
35       Operates in "global" mode, so that packages are installed into the pre‐
36       fix folder instead of the current working directory. See npm help fold‐
37       ers for more on the differences in behavior.
38
39       • packages are installed into the {prefix}/lib/node_modules folder, in‐
40         stead of the current working directory.
41
42       • bin files are linked to {prefix}/bin
43
44       • man pages are linked to {prefix}/share/man
45
46       <!-- automatically  generated,  do  not  edit  manually  -->  <!--  see
47       lib/utils/config/definitions.js -->
48
49
50   bin-links
51       • Default: true
52
53       • Type: Boolean
54
55
56       Tells npm to create symlinks (or .cmd shims on Windows) for package ex‐
57       ecutables.
58
59       Set to false to have it not do this. This can be used  to  work  around
60       the  fact that some file systems don't support symlinks, even on osten‐
61       sibly Unix systems.  <!-- automatically generated, do not edit manually
62       --> <!-- see lib/utils/config/definitions.js -->
63
64
65   ignore-scripts
66       • Default: false
67
68       • Type: Boolean
69
70
71       If true, npm does not run scripts specified in package.json files.
72
73       Note that commands explicitly intended to run a particular script, such
74       as npm start, npm stop, npm restart, npm test, and npm run-script  will
75       still run their intended script if ignore-scripts is set, but they will
76       not run any pre- or post-scripts.  <!-- automatically generated, do not
77       edit manually --> <!-- see lib/utils/config/definitions.js -->
78
79
80   workspace
81       • Default:
82
83       • Type: String (can be set multiple times)
84
85
86       Enable running a command in the context of the configured workspaces of
87       the current project while filtering by running only the workspaces  de‐
88       fined by this configuration option.
89
90       Valid values for the workspace config are either:
91
92       • Workspace names
93
94       • Path to a workspace directory
95
96       • Path to a parent workspace directory (will result to selecting all of
97         the nested workspaces)
98
99
100       When set for the npm init command, this may be set to the folder  of  a
101       workspace  which does not yet exist, to create the folder and set it up
102       as a brand new workspace within the project.
103
104       This value is not exported to  the  environment  for  child  processes.
105       <!--  automatically  generated,  do  not  edit  manually  -->  <!-- see
106       lib/utils/config/definitions.js -->
107
108
109   workspaces
110       • Default: false
111
112       • Type: Boolean
113
114
115       Enable  running  a  command  in  the  context  of  all  the  configured
116       workspaces.
117
118       This  value  is  not  exported  to the environment for child processes.
119       <!-- automatically  generated,  do  not  edit  manually  -->  <!--  see
120       lib/utils/config/definitions.js -->
121
122       <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
123
124
125   See Also
126       • npm help install
127
128
129
130
131                                 October 2021                   NPM-REBUILD(1)