@cryptotaxi247 / documentation-1
Code Commits Issues Pulls Sessions CI/CD
@reggi/path-to-regexp
@reggi/path-to-regexp dependabot/npm_and_yarn/main/copy-to-clipboard-4.0.2 dependabot/npm_and_yarn/main/eslint-10.4.0 dependabot/npm_and_yarn/main/npmcli/eslint-config-7.0.0 dependabot/npm_and_yarn/main/proc-log-7.0.0 dependabot/npm_and_yarn/npm_and_yarn-826852524d dependabot/npm_and_yarn/npm_and_yarn-ab9a7f4bc2 deprecate-totp-2fa dhei/classic-tokens gat-bypass-2fa-docs jpg619/fix-accessibility-content-flow jpg619/version-bump-tar-2 kartykp/gat-bypass-2fa-docs kartykp/upgrade-path-to-regex main maitxn/version-bump-tar patch-1 reggi/cache-based-on-version reggi/dev-engines reggi/fix-transform-prettier reggi/overrides update-search-sensitivity
mdx 177 lines 6.62 KB
Raw
1 ---
2 title: npm-run-script
3 section: 1
4 description: Run arbitrary package scripts
5 github_repo: npm/cli
6 github_branch: release/v7
7 github_path: docs/content/commands/npm-run-script.md
8 redirect_from:
9 - /cli-documentation/v7/cli-commands/npm-run-script
10 - /cli-documentation/v7/cli-commands/run-script
11 - /cli-documentation/v7/commands/npm-run-script
12 - /cli-documentation/v7/commands/run-script
13 - /cli-documentation/v7/npm-run-script
14 - /cli-documentation/v7/run-script
15 - /cli/v7/cli-commands/npm-run-script
16 - /cli/v7/cli-commands/run-script
17 - /cli/v7/commands/run-script
18 - /cli/v7/npm-run-script
19 - /cli/v7/run-script
20 ---
21
22 ### Synopsis
23
24 ```bash
25 npm run-script <command> [--if-present] [--silent] [-- <args>]
26 npm run-script <command> [--workspace=<workspace-name>]
27 npm run-script <command> [--workspaces]
28
29 aliases: run, rum, urn
30 ```
31
32 ### Description
33
34 This runs an arbitrary command from a package's `"scripts"` object. If no `"command"` is provided, it will list the available scripts.
35
36 `run[-script]` is used by the test, start, restart, and stop commands, but can be called directly, as well. When the scripts in the package are printed out, they're separated into lifecycle (test, start, restart) and directly-run scripts.
37
38 Any positional arguments are passed to the specified script. Use `--` to pass `-`-prefixed flags and options which would otherwise be parsed by npm.
39
40 For example:
41
42 ```bash
43 npm run test -- --grep="pattern"
44 ```
45
46 The arguments will only be passed to the script specified after `npm run` and not to any `pre` or `post` script.
47
48 The `env` script is a special built-in command that can be used to list environment variables that will be available to the script at runtime. If an "env" command is defined in your package, it will take precedence over the built-in.
49
50 In addition to the shell's pre-existing `PATH`, `npm run` adds `node_modules/.bin` to the `PATH` provided to scripts. Any binaries provided by locally-installed dependencies can be used without the `node_modules/.bin` prefix. For example, if there is a `devDependency` on `tap` in your package, you should write:
51
52 ```bash
53 "scripts": {"test": "tap test/*.js"}
54 ```
55
56 instead of
57
58 ```bash
59 "scripts": {"test": "node_modules/.bin/tap test/*.js"}
60 ```
61
62 The actual shell your script is run within is platform dependent. By default, on Unix-like systems it is the `/bin/sh` command, on Windows it is `cmd.exe`. The actual shell referred to by `/bin/sh` also depends on the system. You can customize the shell with the `script-shell` configuration.
63
64 Scripts are run from the root of the package folder, regardless of what the current working directory is when `npm run` is called. If you want your script to use different behavior based on what subdirectory you're in, you can use the `INIT_CWD` environment variable, which holds the full path you were in when you ran `npm run`.
65
66 `npm run` sets the `NODE` environment variable to the `node` executable with which `npm` is executed.
67
68 If you try to run a script without having a `node_modules` directory and it fails, you will be given a warning to run `npm install`, just in case you've forgotten.
69
70 ### Workspaces support
71
72 You may use the `workspace` or `workspaces` configs in order to run an arbitrary command from a package's `"scripts"` object in the context of the specified workspaces. If no `"command"` is provided, it will list the available scripts for each of these configured workspaces.
73
74 Given a project with configured workspaces, e.g:
75
76 ```
77 .
78 +-- package.json
79 `-- packages
80 +-- a
81 | `-- package.json
82 +-- b
83 | `-- package.json
84 `-- c
85 `-- package.json
86 ```
87
88 Assuming the workspace configuration is properly set up at the root level `package.json` file. e.g:
89
90 ```
91 {
92 "workspaces": [ "./packages/*" ]
93 }
94 ```
95
96 And that each of the configured workspaces has a configured `test` script, we can run tests in all of them using the `workspaces` config:
97
98 ```
99 npm test --workspaces
100 ```
101
102 #### Filtering workspaces
103
104 It's also possible to run a script in a single workspace using the `workspace` config along with a name or directory path:
105
106 ```
107 npm test --workspace=a
108 ```
109
110 The `workspace` config can also be specified multiple times in order to run a specific script in the context of multiple workspaces. When defining values for the `workspace` config in the command line, it also possible to use `-w` as a shorthand, e.g:
111
112 ```
113 npm test -w a -w b
114 ```
115
116 This last command will run `test` in both `./packages/a` and `./packages/b` packages.
117
118 ### Configuration
119
120 #### `workspace`
121
122 - Default:
123 - Type: String (can be set multiple times)
124
125 Enable 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.
126
127 Valid values for the `workspace` config are either:
128
129 - Workspace names
130 - Path to a workspace directory
131 - Path to a parent workspace directory (will result to selecting all of the nested workspaces)
132
133 When set for the `npm init` 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.
134
135 This value is not exported to the environment for child processes.
136
137 #### `workspaces`
138
139 - Default: false
140 - Type: Boolean
141
142 Enable running a command in the context of **all** the configured workspaces.
143
144 This value is not exported to the environment for child processes.
145
146 #### `if-present`
147
148 - Default: false
149 - Type: Boolean
150
151 If true, npm will not exit with an error code when `run-script` is invoked for a script that isn't defined in the `scripts` section of `package.json`. This option can be used when it's desirable to optionally run a script when it's present and fail if the script fails. This is useful, for example, when running scripts that may only apply for some builds in an otherwise generic CI setup.
152
153 #### `ignore-scripts`
154
155 - Default: false
156 - Type: Boolean
157
158 If true, npm does not run scripts specified in package.json files.
159
160 Note that commands explicitly intended to run a particular script, such as `npm start`, `npm stop`, `npm restart`, `npm test`, and `npm run-script` will still run their intended script if `ignore-scripts` is set, but they will _not_ run any pre- or post-scripts.
161
162 #### `script-shell`
163
164 - Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows
165 - Type: null or String
166
167 The shell to use for scripts run with the `npm exec`, `npm run` and `npm init <pkg>` commands.
168
169 ### See Also
170
171 - [npm scripts](/cli/v7/using-npm/scripts)
172 - [npm test](/cli/v7/commands/npm-test)
173 - [npm start](/cli/v7/commands/npm-start)
174 - [npm restart](/cli/v7/commands/npm-restart)
175 - [npm stop](/cli/v7/commands/npm-stop)
176 - [npm config](/cli/v7/commands/npm-config)
177 - [npm workspaces](/cli/v7/using-npm/workspaces)