/snap/node/11782/lib/node_modules/npm/docs/content/commands
NameSizeModeActions
npm-access.md36640644editdlrm
npm-adduser.md18470644editdlrm
npm-audit.md156560644editdlrm
npm-bugs.md29960644editdlrm
npm-cache.md29620644editdlrm
npm-ci.md91250644editdlrm
npm-completion.md9090644editdlrm
npm-config.md40930644editdlrm
npm-dedupe.md88950644editdlrm
npm-deprecate.md17410644editdlrm
npm-diff.md91090644editdlrm
npm-dist-tag.md51810644editdlrm
npm-docs.md29740644editdlrm
npm-doctor.md50570644editdlrm
npm-edit.md10910644editdlrm
npm-exec.md114010644editdlrm
npm-explain.md27950644editdlrm
npm-explore.md10060644editdlrm
npm-find-dupes.md67970644editdlrm
npm-fund.md36730644editdlrm
npm-help-search.md7560644editdlrm
npm-help.md10040644editdlrm
npm-hook.md23940644editdlrm
npm-init.md98550644editdlrm
npm-install-ci-test.md74340644editdlrm
npm-install-test.md98140644editdlrm
npm-install.md249840644editdlrm
npm-link.md117420644editdlrm
npm-login.md21710644editdlrm
npm-logout.md17490644editdlrm
npm-ls.md85470644editdlrm
npm-org.md19750644editdlrm
npm-outdated.md57790644editdlrm
npm-owner.md30930644editdlrm
npm-pack.md34480644editdlrm
npm-ping.md7690644editdlrm
npm-pkg.md81290644editdlrm
npm-prefix.md12110644editdlrm
npm-profile.md31020644editdlrm
npm-prune.md57450644editdlrm
npm-publish.md76220644editdlrm
npm-query.md69580644editdlrm
npm-rebuild.md50010644editdlrm
npm-repo.md27540644editdlrm
npm-restart.md14730644editdlrm
npm-root.md10970644editdlrm
npm-run-script.md75610644editdlrm
npm-sbom.md83370644editdlrm
npm-search.md34640644editdlrm
npm-shrinkwrap.md9230644editdlrm
npm-star.md17130644editdlrm
npm-stars.md7430644editdlrm
npm-start.md16670644editdlrm
npm-stop.md13410644editdlrm
npm-team.md40900644editdlrm
npm-test.md12340644editdlrm
npm-token.md28930644editdlrm
npm-uninstall.md44470644editdlrm
npm-unpublish.md44910644editdlrm
npm-unstar.md15740644editdlrm
npm-update.md118710644editdlrm
npm-version.md69020644editdlrm
npm-view.md56120644editdlrm
npm-whoami.md8000644editdlrm
npm.md56700644editdlrm
npx.md58950644editdlrm
Edit: /snap/node/11782/lib/node_modules/npm/docs/content/commands/npm-uninstall.md (4447B)
--- title: npm-uninstall section: 1 description: Remove a package --- ### Synopsis ```bash npm uninstall [<@scope>/]... aliases: unlink, remove, rm, r, un ``` ### Description This uninstalls a package, completely removing everything npm installed on its behalf. It also removes the package from the `dependencies`, `devDependencies`, `optionalDependencies`, and `peerDependencies` objects in your `package.json`. Further, if you have an `npm-shrinkwrap.json` or `package-lock.json`, npm will update those files as well. `--no-save` will tell npm not to remove the package from your `package.json`, `npm-shrinkwrap.json`, or `package-lock.json` files. `--save` or `-S` will tell npm to remove the package from your `package.json`, `npm-shrinkwrap.json`, and `package-lock.json` files. This is the default, but you may need to use this if you have for instance `save=false` in your `npmrc` file In global mode (ie, with `-g` or `--global` appended to the command), it uninstalls the current package context as a global package. `--no-save` is ignored in this case. Scope is optional and follows the usual rules for [`scope`](/using-npm/scope). ### Examples ```bash npm uninstall sax ``` `sax` will no longer be in your `package.json`, `npm-shrinkwrap.json`, or `package-lock.json` files. ```bash npm uninstall lodash --no-save ``` `lodash` will not be removed from your `package.json`, `npm-shrinkwrap.json`, or `package-lock.json` files. ### Configuration #### `save` * Default: `true` unless when using `npm update` where it defaults to `false` * Type: Boolean Save installed packages to a `package.json` file as dependencies. When used with the `npm rm` command, removes the dependency from `package.json`. Will also prevent writing to `package-lock.json` if set to `false`. #### `global` * Default: false * Type: Boolean Operates in "global" mode, so that packages are installed into the `prefix` folder instead of the current working directory. See [folders](/configuring-npm/folders) for more on the differences in behavior. * packages are installed into the `{prefix}/lib/node_modules` folder, instead of the current working directory. * bin files are linked to `{prefix}/bin` * man pages are linked to `{prefix}/share/man` #### `workspace` * Default: * Type: String (can be set multiple times) 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. Valid values for the `workspace` config are either: * Workspace names * Path to a workspace directory * Path to a parent workspace directory (will result in selecting all workspaces within that folder) 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. This value is not exported to the environment for child processes. #### `workspaces` * Default: null * Type: null or Boolean Set to true to run the command in the context of **all** configured workspaces. Explicitly setting this to false will cause commands like `install` to ignore workspaces altogether. When not set explicitly: - Commands that operate on the `node_modules` tree (install, update, etc.) will link workspaces into the `node_modules` folder. - Commands that do other things (test, exec, publish, etc.) will operate on the root project, _unless_ one or more workspaces are specified in the `workspace` config. This value is not exported to the environment for child processes. #### `include-workspace-root` * Default: false * Type: Boolean Include the workspace root when workspaces are enabled for a command. When false, specifying individual workspaces via the `workspace` config, or all workspaces via the `workspaces` flag, will cause npm to operate only on the specified workspaces, and not on the root project. This value is not exported to the environment for child processes. #### `install-links` * Default: false * Type: Boolean When set file: protocol dependencies will be packed and installed as regular dependencies instead of creating a symlink. This option has no effect on workspaces. ### See Also * [npm prune](/commands/npm-prune) * [npm install](/commands/npm-install) * [npm folders](/configuring-npm/folders) * [npm config](/commands/npm-config) * [npmrc](/configuring-npm/npmrc)