Skip to content
This repository has been archived by the owner on Aug 11, 2022. It is now read-only.

Commit

Permalink
doc: add command aliases to their respective docs
Browse files Browse the repository at this point in the history
Credit: @watilde
PR-URL: #11748
Reviewed-By: @othiym23
  • Loading branch information
watilde authored and iarna committed Mar 10, 2016
1 parent 6fb0499 commit f0bf684
Show file tree
Hide file tree
Showing 10 changed files with 19 additions and 4 deletions.
2 changes: 2 additions & 0 deletions doc/cli/npm-adduser.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ npm-adduser(1) -- Add a registry user account

npm adduser [--registry=url] [--scope=@orgname] [--always-auth]

aliases: login, add-user

## DESCRIPTION

Create or verify a user named `<username>` in the specified registry, and
Expand Down
2 changes: 2 additions & 0 deletions doc/cli/npm-bugs.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ npm-bugs(1) -- Bugs for a package in a web browser maybe

npm bugs [<pkgname>]

aliases: issues

## DESCRIPTION

This command tries to guess at the likely location of a package's
Expand Down
2 changes: 2 additions & 0 deletions doc/cli/npm-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ npm-config(1) -- Manage the npm configuration files
npm get <key>
npm set <key> <value> [-g|--global]

aliases: c

## DESCRIPTION

npm gets its config settings from the command line, environment
Expand Down
2 changes: 2 additions & 0 deletions doc/cli/npm-dedupe.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ npm-dedupe(1) -- Reduce duplication
npm dedupe
npm ddp

aliases: find-dupes, ddp

## DESCRIPTION

Searches the local package tree and attempts to simplify the overall
Expand Down
2 changes: 2 additions & 0 deletions doc/cli/npm-dist-tag.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ npm-dist-tag(1) -- Modify package distribution tags
npm dist-tag rm <pkg> <tag>
npm dist-tag ls [<pkg>]

aliases: dist-tags

## DESCRIPTION

Add, remove, and enumerate distribution tags on a package:
Expand Down
4 changes: 2 additions & 2 deletions doc/cli/npm-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ after packing it up into a tarball (b).

By default, `npm install` will install all modules listed as dependencies
in `package.json(5)`.

With the `--production` flag (or when the `NODE_ENV` environment variable
is set to `production`), npm will not install modules listed in
`devDependencies`.
Expand Down Expand Up @@ -124,7 +124,7 @@ after packing it up into a tarball (b).
npm install node-tap --save-dev
npm install dtrace-provider --save-optional
npm install readable-stream --save --save-exact
npm install ansi-regex --save --save-bundle
npm install ansi-regex --save --save-bundle


**Note**: If there is a file or folder named `<name>` in the current
Expand Down
2 changes: 2 additions & 0 deletions doc/cli/npm-owner.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ npm-owner(1) -- Manage package owners
npm owner rm <user> [<@scope>/]<pkg>
npm owner ls [<@scope>/]<pkg>

aliases: author

## DESCRIPTION

Manage ownership of published packages.
Expand Down
2 changes: 1 addition & 1 deletion doc/cli/npm-search.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ npm-search(1) -- Search for packages

npm search [-l|--long] [search terms ...]

aliases: s, se
aliases: s, se, find

## DESCRIPTION

Expand Down
3 changes: 2 additions & 1 deletion doc/cli/npm-test.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ npm-test(1) -- Test a package
## SYNOPSIS

npm test [-- <args>]
npm tst [-- <args>]

aliases: t, tst

## DESCRIPTION

Expand Down
2 changes: 2 additions & 0 deletions doc/cli/npm-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ npm-update(1) -- Update a package

npm update [-g] [<pkg>...]

aliases: up, upgrade

## DESCRIPTION

This command will update all the packages listed to the latest version
Expand Down

0 comments on commit f0bf684

Please sign in to comment.