Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/npm/cli.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorisaacs <i@izs.me>2013-07-11 12:25:45 +0400
committerisaacs <i@izs.me>2013-07-11 12:25:45 +0400
commit420db7dd7c4a16a069391fc280d9065631a678ca (patch)
tree61fe6442fae2ef224df981b19362ae1dc9e0bd7e /doc/api/npm-ls.md
parentc8596f30af057039934457694ac955224fa8b247 (diff)
doc: organize into sections
Diffstat (limited to 'doc/api/npm-ls.md')
-rw-r--r--doc/api/npm-ls.md56
1 files changed, 56 insertions, 0 deletions
diff --git a/doc/api/npm-ls.md b/doc/api/npm-ls.md
new file mode 100644
index 000000000..ed890ff14
--- /dev/null
+++ b/doc/api/npm-ls.md
@@ -0,0 +1,56 @@
+npm-ls(3) -- List installed packages
+======================================
+
+## SYNOPSIS
+
+ npm.commands.ls(args, [silent,] callback)
+
+## 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 will also
+return that data using the callback.
+
+This command does not take any arguments, but args must be defined.
+Beyond that, if any arguments are passed in, npm will politely warn that it
+does not take positional arguments, though you may set config flags
+like with any other command, such as `global` to list global packages.
+
+It will print out extraneous, missing, and invalid packages.
+
+If the silent parameter is set to true, nothing will be output to the screen,
+but the data will still be returned.
+
+Callback is provided an error if one occurred, the full data about which
+packages are installed and which dependencies they will receive, and a
+"lite" data object which just shows which versions are installed where.
+Note that the full data object is a circular structure, so care must be
+taken if it is serialized to JSON.
+
+## CONFIGURATION
+
+### long
+
+* Default: false
+* Type: Boolean
+
+Show extended information.
+
+### parseable
+
+* Default: false
+* Type: Boolean
+
+Show parseable output instead of tree view.
+
+### global
+
+* Default: false
+* Type: Boolean
+
+List packages in the global install prefix instead of in the current
+project.
+
+Note, if parseable is set or long isn't set, then duplicates will be trimmed.
+This means that if a submodule a same dependency as a parent module, then the
+dependency will only be output once.