File Explorer

1---2title: npm-uninstall3section: 14description: Remove a package5---6 7### Synopsis8 9```bash10npm uninstall [<@scope>/]<pkg>...11 12aliases: unlink, remove, rm, r, un13```14 15### Description16 17This uninstalls a package, completely removing everything npm installed on its behalf.18 19It also removes the package from the `dependencies`, `devDependencies`,20`optionalDependencies`, and `peerDependencies` objects in your `package.json`.21 22Further, if you have an `npm-shrinkwrap.json` or `package-lock.json`, npm will update those files as well.23 24`--no-save` will tell npm not to remove the package from your `package.json`, `npm-shrinkwrap.json`, or `package-lock.json` files.25 26`--save` or `-S` will tell npm to remove the package from your `package.json`, `npm-shrinkwrap.json`, and `package-lock.json` files.27This is the default, but you may need to use this if you have for instance `save=false` in your `npmrc` file28 29In global mode (ie, with `-g` or `--global` appended to the command), it uninstalls the current package context as a global package.30`--no-save` is ignored in this case.31 32Scope is optional and follows the usual rules for [`scope`](/using-npm/scope).33 34### Examples35 36```bash37npm uninstall sax38```39 40`sax` will no longer be in your `package.json`, `npm-shrinkwrap.json`, or `package-lock.json` files.41 42```bash43npm uninstall lodash --no-save44```45 46`lodash` will not be removed from your `package.json`,47`npm-shrinkwrap.json`, or `package-lock.json` files.48 49### Configuration50 51#### `save`52 53* Default: `true` unless when using `npm update` where it defaults to `false`54* Type: Boolean55 56Save installed packages to a `package.json` file as dependencies.57 58When used with the `npm rm` command, removes the dependency from59`package.json`.60 61Will also prevent writing to `package-lock.json` if set to `false`.62 63 64 65#### `global`66 67* Default: false68* Type: Boolean69 70Operates in "global" mode, so that packages are installed into the `prefix`71folder instead of the current working directory. See72[folders](/configuring-npm/folders) for more on the differences in behavior.73 74* packages are installed into the `{prefix}/lib/node_modules` folder, instead75  of the current working directory.76* bin files are linked to `{prefix}/bin`77* man pages are linked to `{prefix}/share/man`78 79 80 81#### `workspace`82 83* Default:84* Type: String (can be set multiple times)85 86Enable running a command in the context of the configured workspaces of the87current project while filtering by running only the workspaces defined by88this configuration option.89 90Valid values for the `workspace` config are either:91 92* Workspace names93* Path to a workspace directory94* Path to a parent workspace directory (will result in selecting all95  workspaces within that folder)96 97When set for the `npm init` command, this may be set to the folder of a98workspace which does not yet exist, to create the folder and set it up as a99brand new workspace within the project.100 101This value is not exported to the environment for child processes.102 103#### `workspaces`104 105* Default: null106* Type: null or Boolean107 108Set to true to run the command in the context of **all** configured109workspaces.110 111Explicitly setting this to false will cause commands like `install` to112ignore workspaces altogether. When not set explicitly:113 114- Commands that operate on the `node_modules` tree (install, update, etc.)115will link workspaces into the `node_modules` folder. - Commands that do116other things (test, exec, publish, etc.) will operate on the root project,117_unless_ one or more workspaces are specified in the `workspace` config.118 119This value is not exported to the environment for child processes.120 121#### `include-workspace-root`122 123* Default: false124* Type: Boolean125 126Include the workspace root when workspaces are enabled for a command.127 128When false, specifying individual workspaces via the `workspace` config, or129all workspaces via the `workspaces` flag, will cause npm to operate only on130the specified workspaces, and not on the root project.131 132This value is not exported to the environment for child processes.133 134#### `install-links`135 136* Default: false137* Type: Boolean138 139When set file: protocol dependencies will be packed and installed as regular140dependencies instead of creating a symlink. This option has no effect on141workspaces.142 143 144 145### See Also146 147* [npm prune](/commands/npm-prune)148* [npm install](/commands/npm-install)149* [npm folders](/configuring-npm/folders)150* [npm config](/commands/npm-config)151* [npmrc](/configuring-npm/npmrc)152