summaryrefslogtreecommitdiff
path: root/deps/npm/docs/content/cli-commands/npm-logout.md
diff options
context:
space:
mode:
Diffstat (limited to 'deps/npm/docs/content/cli-commands/npm-logout.md')
-rwxr-xr-xdeps/npm/docs/content/cli-commands/npm-logout.md54
1 files changed, 54 insertions, 0 deletions
diff --git a/deps/npm/docs/content/cli-commands/npm-logout.md b/deps/npm/docs/content/cli-commands/npm-logout.md
new file mode 100755
index 0000000000..41858ead96
--- /dev/null
+++ b/deps/npm/docs/content/cli-commands/npm-logout.md
@@ -0,0 +1,54 @@
+---
+section: cli-commands
+title: npm-logout
+description: Log out of the registry
+---
+
+# npm-logout
+
+## Log out of the registry
+
+### Synopsis
+
+```bash
+npm logout [--registry=<url>] [--scope=<@scope>]
+```
+
+### Description
+
+When logged into a registry that supports token-based authentication, tell the
+server to end this token's session. This will invalidate the token everywhere
+you're using it, not just for the current environment.
+
+When logged into a legacy registry that uses username and password authentication, this will
+clear the credentials in your user configuration. In this case, it will _only_ affect
+the current environment.
+
+If `--scope` is provided, this will find the credentials for the registry
+connected to that scope, if set.
+
+### Configuration
+
+#### registry
+
+Default: https://registry.npmjs.org/
+
+The base URL of the npm package registry. If `scope` is also specified,
+it takes precedence.
+
+#### scope
+
+Default: The scope of your current project, if any, otherwise none.
+
+If specified, you will be logged out of the specified scope. See [`npm-scope`](npm-scope).
+
+```bash
+npm logout --scope=@myco
+```
+
+### See Also
+
+* [npm adduser](/cli-commands/npm-adduser)
+* [npm registry](/using-npm/registry)
+* [npm config](/cli-commands/npm-config)
+* [npm whoami](/cli-commands/npm-whoami)