summaryrefslogtreecommitdiff
path: root/deps/npm/doc/cli
diff options
context:
space:
mode:
authorisaacs <i@izs.me>2012-07-13 11:40:38 -0700
committerisaacs <i@izs.me>2012-07-13 12:08:17 -0700
commit9d4362403c10dd28b5644b947945f853cd354f28 (patch)
treec08bf8dd199ee4231a28bd2bb7d5e93c80b43123 /deps/npm/doc/cli
parentacbfc408880a12c32ccc9d69bca91aad4e93e879 (diff)
downloadnode-new-9d4362403c10dd28b5644b947945f853cd354f28.tar.gz
npm: upgrade to 1.1.41
Diffstat (limited to 'deps/npm/doc/cli')
-rw-r--r--deps/npm/doc/cli/config.md11
-rw-r--r--deps/npm/doc/cli/list.md20
-rw-r--r--deps/npm/doc/cli/version.md19
3 files changed, 38 insertions, 12 deletions
diff --git a/deps/npm/doc/cli/config.md b/deps/npm/doc/cli/config.md
index 537af5ca0e..7bd46cd43a 100644
--- a/deps/npm/doc/cli/config.md
+++ b/deps/npm/doc/cli/config.md
@@ -694,6 +694,17 @@ character to indicate reverse sort.
The shell to run for the `npm explore` command.
+### sign-git-tag
+
+* Default: false
+* Type: Boolean
+
+If set to true, then the `npm version` command will tag the version
+using `-s` to add a signature.
+
+Note that git requires you to have set up GPG keys in your git configs
+for this to work properly.
+
### strict-ssl
* Default: true
diff --git a/deps/npm/doc/cli/list.md b/deps/npm/doc/cli/list.md
index 93d86cd838..3dd709b62b 100644
--- a/deps/npm/doc/cli/list.md
+++ b/deps/npm/doc/cli/list.md
@@ -3,20 +3,26 @@ npm-ls(1) -- List installed packages
## SYNOPSIS
- npm list
- npm ls
- npm la
- npm ll
+ npm list [<pkg> ...]
+ npm ls [<pkg> ...]
+ npm la [<pkg> ...]
+ npm ll [<pkg> ...]
## DESCRIPTION
This command will print to stdout all the versions of packages that are
installed, as well as their dependencies, in a tree-structure.
-It does not take positional arguments, though you may set config flags
-like with any other command, such as `-g` to list global packages.
+Positional arguments are `name@version-range` identifiers, which will
+limit the results to only the paths to the packages named. Note that
+nested packages will *also* show the paths to the specified packages.
+For example, running `npm ls promzard` in npm's source tree will show:
-It will print out extraneous, missing, and invalid packages.
+ npm@@VERSION@ /path/to/npm
+ └─┬ init-package-json@0.0.4
+ └── promzard@0.1.5
+
+It will show print out extraneous, missing, and invalid packages.
When run as `ll` or `la`, it shows extended information by default.
diff --git a/deps/npm/doc/cli/version.md b/deps/npm/doc/cli/version.md
index 480c90d3b4..ca9b5fbfaa 100644
--- a/deps/npm/doc/cli/version.md
+++ b/deps/npm/doc/cli/version.md
@@ -3,7 +3,7 @@ npm-version(1) -- Bump a package version
## SYNOPSIS
- npm version <newversion> [--message commit-message]
+ npm version [<newversion> | major | minor | patch | build]
## DESCRIPTION
@@ -11,14 +11,23 @@ Run this in a package directory to bump the version and write the new
data back to the package.json file.
The `newversion` argument should be a valid semver string, *or* a valid
-second argument to semver.inc (one of "patch", "minor", or "major"). In
-the second case, the existing version will be incremented by that amount.
+second argument to semver.inc (one of "build", "patch", "minor", or
+"major"). In the second case, the existing version will be incremented
+by 1 in the specified field.
If run in a git repo, it will also create a version commit and tag, and
fail if the repo is not clean.
-If supplied with `--message` (shorthand: `-m`) command line option, npm
-will use it as a commit message when creating a version commit.
+If supplied with `--message` (shorthand: `-m`) config option, npm will
+use it as a commit message when creating a version commit. If the
+`message` config contains `%s` then that will be replaced with the
+resulting version number. For example:
+
+ npm version patch -m "Upgrade to %s for reasons"
+
+If the `sign-git-tag` config is set, then the tag will be signed using
+the `-s` flag to git. Note that you must have a default GPG key set up
+in your git config for this to work properly.
## SEE ALSO