File Explorer

1.TH "NPM-VERSION" "1" "February 2026" "NPM@11.11.0" ""2.SH "NAME"3\fBnpm-version\fR - Bump a package version4.SS "Synopsis"5.P6.RS 27.nf8npm version \[lB]<newversion> | major | minor | patch | premajor | preminor | prepatch | prerelease | from-git\[rB]9 10alias: verison11.fi12.RE13.SS "Configuration"14.SS "\fBallow-same-version\fR"15.RS 016.IP \(bu 417Default: false18.IP \(bu 419Type: Boolean20.RE 021 22.P23Prevents throwing an error when \fBnpm version\fR is used to set the new version to the same value as the current version.24.SS "\fBcommit-hooks\fR"25.RS 026.IP \(bu 427Default: true28.IP \(bu 429Type: Boolean30.RE 031 32.P33Run git commit hooks when using the \fBnpm version\fR command.34.SS "\fBgit-tag-version\fR"35.RS 036.IP \(bu 437Default: true38.IP \(bu 439Type: Boolean40.RE 041 42.P43Tag the commit when using the \fBnpm version\fR command. Setting this to false results in no commit being made at all.44.SS "\fBjson\fR"45.RS 046.IP \(bu 447Default: false48.IP \(bu 449Type: Boolean50.RE 051 52.P53Whether or not to output JSON data, rather than the normal output.54.RS 055.IP \(bu 456In \fBnpm pkg set\fR it enables parsing set values with JSON.parse() before saving them to your \fBpackage.json\fR.57.RE 058 59.P60Not supported by all npm commands.61.SS "\fBpreid\fR"62.RS 063.IP \(bu 464Default: ""65.IP \(bu 466Type: String67.RE 068 69.P70The "prerelease identifier" to use as a prefix for the "prerelease" part of a semver. Like the \fBrc\fR in \fB1.2.0-rc.8\fR.71.SS "\fBsign-git-tag\fR"72.RS 073.IP \(bu 474Default: false75.IP \(bu 476Type: Boolean77.RE 078 79.P80If set to true, then the \fBnpm version\fR command will tag the version using \fB-s\fR to add a signature.81.P82Note that git requires you to have set up GPG keys in your git configs for this to work properly.83.SS "\fBsave\fR"84.RS 085.IP \(bu 486Default: \fBtrue\fR unless when using \fBnpm update\fR where it defaults to \fBfalse\fR87.IP \(bu 488Type: Boolean89.RE 090 91.P92Save installed packages to a \fBpackage.json\fR file as dependencies.93.P94When used with the \fBnpm rm\fR command, removes the dependency from \fBpackage.json\fR.95.P96Will also prevent writing to \fBpackage-lock.json\fR if set to \fBfalse\fR.97.SS "\fBworkspace\fR"98.RS 099.IP \(bu 4100Default:101.IP \(bu 4102Type: String (can be set multiple times)103.RE 0104 105.P106Enable 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.107.P108Valid values for the \fBworkspace\fR config are either:109.RS 0110.IP \(bu 4111Workspace names112.IP \(bu 4113Path to a workspace directory114.IP \(bu 4115Path to a parent workspace directory (will result in selecting all workspaces within that folder)116.RE 0117 118.P119When 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.120.P121This value is not exported to the environment for child processes.122.SS "\fBworkspaces\fR"123.RS 0124.IP \(bu 4125Default: null126.IP \(bu 4127Type: null or Boolean128.RE 0129 130.P131Set to true to run the command in the context of \fBall\fR configured workspaces.132.P133Explicitly setting this to false will cause commands like \fBinstall\fR to ignore workspaces altogether. When not set explicitly:134.RS 0135.IP \(bu 4136Commands 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.137.RE 0138 139.P140This value is not exported to the environment for child processes.141.SS "\fBworkspaces-update\fR"142.RS 0143.IP \(bu 4144Default: true145.IP \(bu 4146Type: Boolean147.RE 0148 149.P150If set to true, the npm cli will run an update after operations that may possibly change the workspaces installed to the \fBnode_modules\fR folder.151.SS "\fBinclude-workspace-root\fR"152.RS 0153.IP \(bu 4154Default: false155.IP \(bu 4156Type: Boolean157.RE 0158 159.P160Include the workspace root when workspaces are enabled for a command.161.P162When 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.163.P164This value is not exported to the environment for child processes.165.SS "\fBignore-scripts\fR"166.RS 0167.IP \(bu 4168Default: false169.IP \(bu 4170Type: Boolean171.RE 0172 173.P174If true, npm does not run scripts specified in package.json files.175.P176Note 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.177.SS "Description"178.P179Run this in a package directory to bump the version and write the new data back to \fBpackage.json\fR, \fBpackage-lock.json\fR, and, if present, \fBnpm-shrinkwrap.json\fR.180.P181The \fBnewversion\fR argument should be a valid semver string, a valid second argument to \fBsemver.inc\fR \fI\(lahttps://github.com/npm/node-semver#functions\(ra\fR (one of \fBpatch\fR, \fBminor\fR, \fBmajor\fR, \fBprepatch\fR, \fBpreminor\fR, \fBpremajor\fR, \fBprerelease\fR), or \fBfrom-git\fR. In the second case, the existing version will be incremented by 1 in the specified field. \fBfrom-git\fR will try to read the latest git tag, and use that as the new npm version.182.P183\fBNote:\fR If the current version is a prerelease version, \fBpatch\fR will simply remove the prerelease suffix without incrementing the patch version number. For example, \fB1.2.0-5\fR becomes \fB1.2.0\fR with \fBnpm version patch\fR, not \fB1.2.1\fR.184.P185If run in a git repo, it will also create a version commit and tag. This behavior is controlled by \fBgit-tag-version\fR (see below), and can be disabled on the command line by running \fBnpm --no-git-tag-version version\fR. It will fail if the working directory is not clean, unless the \fB-f\fR or \fB--force\fR flag is set.186.P187\fBNote:\fR Git integration requires a reasonably recent version of git (2.0.0 or later is recommended). If you encounter issues with git commands, ensure your git installation is up to date.188.P189If supplied with \fB-m\fR or \fB\[rs]fB--message\[rs]fR config\fR \fI\(la/using-npm/config#message\(ra\fR option, npm will use it as a commit message when creating a version commit. If the \fBmessage\fR config contains \fB%s\fR then that will be replaced with the resulting version number. For example:190.P191.RS 2192.nf193npm version patch -m "Upgrade to %s for reasons"194.fi195.RE196.P197If the \fB\[rs]fBsign-git-tag\[rs]fR config\fR \fI\(la/using-npm/config#sign-git-tag\(ra\fR is set, then the tag will be signed using the \fB-s\fR flag to git. Note that you must have a default GPG key set up in your git config for this to work properly. For example:198.P199.RS 2200.nf201$ npm config set sign-git-tag true202$ npm version patch203 204You need a passphrase to unlock the secret key for user: "isaacs (http://blog.izs.me/) <i@izs.me>"2052048-bit RSA key, ID 6C481CF6, created 2010-08-31206 207Enter passphrase:208.fi209.RE210.P211If \fBpreversion\fR, \fBversion\fR, or \fBpostversion\fR are in the \fBscripts\fR property of the package.json, they will be executed as part of running \fBnpm version\fR.212.P213The exact order of execution is as follows:214.RS 0215.IP 1. 4216Check to make sure the git working directory is clean before we get started. Your scripts may add files to the commit in future steps. This step is skipped if the \fB--force\fR flag is set.217.IP 2. 4218Run the \fBpreversion\fR script. These scripts have access to the old \fBversion\fR in package.json. A typical use would be running your full test suite before deploying. Any files you want added to the commit should be explicitly added using \fBgit add\fR.219.IP 3. 4220Bump \fBversion\fR in \fBpackage.json\fR as requested (\fBpatch\fR, \fBminor\fR, \fBmajor\fR, etc).221.IP 4. 4222Run the \fBversion\fR script. These scripts have access to the new \fBversion\fR in package.json (so they can incorporate it into file headers in generated files for example). Again, scripts should explicitly add generated files to the commit using \fBgit add\fR.223.IP 5. 4224Commit and tag.225.IP 6. 4226Run the \fBpostversion\fR script. Use it to clean up the file system or automatically push the commit and/or tag.227.RE 0228 229.P230Take the following example:231.P232.RS 2233.nf234{235  "scripts": {236    "preversion": "npm test",237    "version": "npm run build && git add -A dist",238    "postversion": "git push && git push --tags && rm -rf build/temp"239  }240}241.fi242.RE243.P244This runs all your tests and proceeds only if they pass. Then runs your \fBbuild\fR script, and adds everything in the \fBdist\fR directory to the commit. After the commit, it pushes the new commit and tag up to the server, and deletes the \fBbuild/temp\fR directory.245.SS "See Also"246.RS 0247.IP \(bu 4248npm help init249.IP \(bu 4250npm help run251.IP \(bu 4252npm help scripts253.IP \(bu 4254\fBpackage.json\fR \fI\(la/configuring-npm/package-json\(ra\fR255.IP \(bu 4256npm help config257.RE 0258