node/deps/npm/doc/misc/npm-index.md

420 lines
4.8 KiB
Markdown
Raw Normal View History

2013-07-12 23:55:57 +08:00
npm-index(7) -- Index of all npm documentation
==============================================
2014-09-17 06:38:50 +08:00
### README(1)
2013-07-12 23:55:57 +08:00
a JavaScript package manager
2013-07-12 23:55:57 +08:00
2014-09-17 06:38:50 +08:00
## Command Line Documentation
2013-07-12 23:55:57 +08:00
2014-09-17 06:38:50 +08:00
Using npm on the command line
### npm(1)
2013-07-12 23:55:57 +08:00
node package manager
2014-09-17 06:38:50 +08:00
### npm-adduser(1)
2013-07-12 23:55:57 +08:00
Add a registry user account
2014-09-17 06:38:50 +08:00
### npm-bin(1)
2013-07-12 23:55:57 +08:00
Display npm bin folder
2014-09-17 06:38:50 +08:00
### npm-bugs(1)
2013-07-12 23:55:57 +08:00
Bugs for a package in a web browser maybe
2014-09-17 06:38:50 +08:00
### npm-build(1)
2013-07-12 23:55:57 +08:00
Build a package
2014-09-17 06:38:50 +08:00
### npm-bundle(1)
2013-07-12 23:55:57 +08:00
REMOVED
2014-09-17 06:38:50 +08:00
### npm-cache(1)
2013-07-12 23:55:57 +08:00
Manipulates packages cache
2014-09-17 06:38:50 +08:00
### npm-completion(1)
2013-07-12 23:55:57 +08:00
Tab Completion for npm
2014-09-17 06:38:50 +08:00
### npm-config(1)
2013-07-12 23:55:57 +08:00
Manage the npm configuration files
2014-09-17 06:38:50 +08:00
### npm-dedupe(1)
2013-07-12 23:55:57 +08:00
Reduce duplication
2014-09-17 06:38:50 +08:00
### npm-deprecate(1)
2013-07-12 23:55:57 +08:00
Deprecate a version of a package
2014-09-17 06:38:50 +08:00
### npm-docs(1)
2013-07-12 23:55:57 +08:00
Docs for a package in a web browser maybe
2014-09-17 06:38:50 +08:00
### npm-edit(1)
2013-07-12 23:55:57 +08:00
Edit an installed package
2014-09-17 06:38:50 +08:00
### npm-explore(1)
2013-07-12 23:55:57 +08:00
Browse an installed package
2014-09-17 06:38:50 +08:00
### npm-help-search(1)
2013-07-12 23:55:57 +08:00
Search npm help documentation
2014-09-17 06:38:50 +08:00
### npm-help(1)
2013-07-12 23:55:57 +08:00
Get help on npm
2014-09-17 06:38:50 +08:00
### npm-init(1)
2013-07-12 23:55:57 +08:00
Interactively create a package.json file
2014-09-17 06:38:50 +08:00
### npm-install(1)
2013-07-12 23:55:57 +08:00
Install a package
2014-09-17 06:38:50 +08:00
### npm-link(1)
2013-07-12 23:55:57 +08:00
Symlink a package folder
2014-09-17 06:38:50 +08:00
### npm-ls(1)
2013-07-12 23:55:57 +08:00
List installed packages
2014-09-17 06:38:50 +08:00
### npm-outdated(1)
2013-07-12 23:55:57 +08:00
Check for outdated packages
2014-09-17 06:38:50 +08:00
### npm-owner(1)
2013-07-12 23:55:57 +08:00
Manage package owners
2014-09-17 06:38:50 +08:00
### npm-pack(1)
2013-07-12 23:55:57 +08:00
Create a tarball from a package
2014-09-17 06:38:50 +08:00
### npm-prefix(1)
2013-07-12 23:55:57 +08:00
Display prefix
2014-09-17 06:38:50 +08:00
### npm-prune(1)
2013-07-12 23:55:57 +08:00
Remove extraneous packages
2014-09-17 06:38:50 +08:00
### npm-publish(1)
2013-07-12 23:55:57 +08:00
Publish a package
2014-09-17 06:38:50 +08:00
### npm-rebuild(1)
2013-07-12 23:55:57 +08:00
Rebuild a package
2014-09-17 06:38:50 +08:00
### npm-repo(1)
2014-01-07 09:02:07 +08:00
Open package repository page in the browser
2014-09-17 06:38:50 +08:00
### npm-restart(1)
2013-07-12 23:55:57 +08:00
Restart a package
2013-07-12 23:55:57 +08:00
2014-09-17 06:38:50 +08:00
### npm-rm(1)
2013-07-12 23:55:57 +08:00
Remove a package
2014-09-17 06:38:50 +08:00
### npm-root(1)
2013-07-12 23:55:57 +08:00
Display npm root
2014-09-17 06:38:50 +08:00
### npm-run-script(1)
2013-07-12 23:55:57 +08:00
Run arbitrary package scripts
2014-09-17 06:38:50 +08:00
### npm-search(1)
2013-07-12 23:55:57 +08:00
Search for packages
2014-09-17 06:38:50 +08:00
### npm-shrinkwrap(1)
2013-07-12 23:55:57 +08:00
Lock down dependency versions
2014-09-17 06:38:50 +08:00
### npm-star(1)
2013-07-12 23:55:57 +08:00
Mark your favorite packages
2014-09-17 06:38:50 +08:00
### npm-stars(1)
2013-07-12 23:55:57 +08:00
View packages marked as favorites
2014-09-17 06:38:50 +08:00
### npm-start(1)
2013-07-12 23:55:57 +08:00
Start a package
2014-09-17 06:38:50 +08:00
### npm-stop(1)
2013-07-12 23:55:57 +08:00
Stop a package
2014-09-17 06:38:50 +08:00
### npm-tag(1)
2013-07-12 23:55:57 +08:00
Tag a published version
2014-09-17 06:38:50 +08:00
### npm-test(1)
2013-07-12 23:55:57 +08:00
Test a package
2014-09-17 06:38:50 +08:00
### npm-uninstall(1)
2013-07-12 23:55:57 +08:00
Remove a package
2014-09-17 06:38:50 +08:00
### npm-unpublish(1)
2013-07-12 23:55:57 +08:00
Remove a package from the registry
2014-09-17 06:38:50 +08:00
### npm-update(1)
2013-07-12 23:55:57 +08:00
Update a package
2014-09-17 06:38:50 +08:00
### npm-version(1)
2013-07-12 23:55:57 +08:00
Bump a package version
2014-09-17 06:38:50 +08:00
### npm-view(1)
2013-07-12 23:55:57 +08:00
View registry info
2014-09-17 06:38:50 +08:00
### npm-whoami(1)
2013-07-12 23:55:57 +08:00
Display npm username
2014-09-17 06:38:50 +08:00
## API Documentation
Using npm in your Node programs
2013-07-12 23:55:57 +08:00
2014-09-17 06:38:50 +08:00
### npm(3)
2013-07-12 23:55:57 +08:00
node package manager
2014-09-17 06:38:50 +08:00
### npm-bin(3)
2013-07-12 23:55:57 +08:00
Display npm bin folder
2014-09-17 06:38:50 +08:00
### npm-bugs(3)
2013-07-12 23:55:57 +08:00
Bugs for a package in a web browser maybe
2014-09-17 06:38:50 +08:00
### npm-cache(3)
2014-06-06 06:18:15 +08:00
manage the npm cache programmatically
2014-09-17 06:38:50 +08:00
### npm-commands(3)
2013-07-12 23:55:57 +08:00
npm commands
2014-09-17 06:38:50 +08:00
### npm-config(3)
2013-07-12 23:55:57 +08:00
Manage the npm configuration files
2014-09-17 06:38:50 +08:00
### npm-deprecate(3)
2013-07-12 23:55:57 +08:00
Deprecate a version of a package
2014-09-17 06:38:50 +08:00
### npm-docs(3)
2013-07-12 23:55:57 +08:00
Docs for a package in a web browser maybe
2014-09-17 06:38:50 +08:00
### npm-edit(3)
2013-07-12 23:55:57 +08:00
Edit an installed package
2014-09-17 06:38:50 +08:00
### npm-explore(3)
2013-07-12 23:55:57 +08:00
Browse an installed package
2014-09-17 06:38:50 +08:00
### npm-help-search(3)
2013-07-12 23:55:57 +08:00
Search the help pages
2014-09-17 06:38:50 +08:00
### npm-init(3)
2013-07-12 23:55:57 +08:00
Interactively create a package.json file
2014-09-17 06:38:50 +08:00
### npm-install(3)
2013-07-12 23:55:57 +08:00
install a package programmatically
2014-09-17 06:38:50 +08:00
### npm-link(3)
2013-07-12 23:55:57 +08:00
Symlink a package folder
2014-09-17 06:38:50 +08:00
### npm-load(3)
2013-07-12 23:55:57 +08:00
Load config settings
2014-09-17 06:38:50 +08:00
### npm-ls(3)
2013-07-12 23:55:57 +08:00
List installed packages
2014-09-17 06:38:50 +08:00
### npm-outdated(3)
2013-07-12 23:55:57 +08:00
Check for outdated packages
2014-09-17 06:38:50 +08:00
### npm-owner(3)
2013-07-12 23:55:57 +08:00
Manage package owners
2014-09-17 06:38:50 +08:00
### npm-pack(3)
2013-07-12 23:55:57 +08:00
Create a tarball from a package
2014-09-17 06:38:50 +08:00
### npm-prefix(3)
2013-07-12 23:55:57 +08:00
Display prefix
2014-09-17 06:38:50 +08:00
### npm-prune(3)
2013-07-12 23:55:57 +08:00
Remove extraneous packages
2014-09-17 06:38:50 +08:00
### npm-publish(3)
2013-07-12 23:55:57 +08:00
Publish a package
2014-09-17 06:38:50 +08:00
### npm-rebuild(3)
2013-07-12 23:55:57 +08:00
Rebuild a package
2014-09-17 06:38:50 +08:00
### npm-repo(3)
2014-01-07 09:02:07 +08:00
Open package repository page in the browser
2014-09-17 06:38:50 +08:00
### npm-restart(3)
2013-07-12 23:55:57 +08:00
Restart a package
2013-07-12 23:55:57 +08:00
2014-09-17 06:38:50 +08:00
### npm-root(3)
2013-07-12 23:55:57 +08:00
Display npm root
2014-09-17 06:38:50 +08:00
### npm-run-script(3)
2013-07-12 23:55:57 +08:00
Run arbitrary package scripts
2014-09-17 06:38:50 +08:00
### npm-search(3)
2013-07-12 23:55:57 +08:00
Search for packages
2014-09-17 06:38:50 +08:00
### npm-shrinkwrap(3)
2013-07-12 23:55:57 +08:00
programmatically generate package shrinkwrap file
2014-09-17 06:38:50 +08:00
### npm-start(3)
2013-07-12 23:55:57 +08:00
Start a package
2014-09-17 06:38:50 +08:00
### npm-stop(3)
2013-07-12 23:55:57 +08:00
Stop a package
2014-09-17 06:38:50 +08:00
### npm-tag(3)
2013-07-12 23:55:57 +08:00
Tag a published version
2014-09-17 06:38:50 +08:00
### npm-test(3)
2013-07-12 23:55:57 +08:00
Test a package
2014-09-17 06:38:50 +08:00
### npm-uninstall(3)
2013-07-12 23:55:57 +08:00
uninstall a package programmatically
2014-09-17 06:38:50 +08:00
### npm-unpublish(3)
2013-07-12 23:55:57 +08:00
Remove a package from the registry
2014-09-17 06:38:50 +08:00
### npm-update(3)
2013-07-12 23:55:57 +08:00
Update a package
2014-09-17 06:38:50 +08:00
### npm-version(3)
2013-07-12 23:55:57 +08:00
Bump a package version
2014-09-17 06:38:50 +08:00
### npm-view(3)
2013-07-12 23:55:57 +08:00
View registry info
2014-09-17 06:38:50 +08:00
### npm-whoami(3)
2013-07-12 23:55:57 +08:00
Display npm username
2014-09-17 06:38:50 +08:00
## Files
2013-07-12 23:55:57 +08:00
2014-09-17 06:38:50 +08:00
File system structures npm uses
### npm-folders(5)
2013-07-12 23:55:57 +08:00
Folder Structures Used by npm
2014-09-17 06:38:50 +08:00
### npmrc(5)
2013-07-12 23:55:57 +08:00
The npm config files
2014-09-17 06:38:50 +08:00
### package.json(5)
2013-07-12 23:55:57 +08:00
Specifics of npm's package.json handling
2014-09-17 06:38:50 +08:00
## Misc
Various other bits and bobs
2013-07-12 23:55:57 +08:00
2014-09-17 06:38:50 +08:00
### npm-coding-style(7)
2013-07-12 23:55:57 +08:00
npm's "funny" coding style
2014-09-17 06:38:50 +08:00
### npm-config(7)
2013-07-12 23:55:57 +08:00
More than you probably want to know about npm configuration
2014-09-17 06:38:50 +08:00
### npm-developers(7)
2013-07-12 23:55:57 +08:00
Developer Guide
2014-09-17 06:38:50 +08:00
### npm-disputes(7)
2013-07-12 23:55:57 +08:00
Handling Module Name Disputes
2014-09-17 06:38:50 +08:00
### npm-faq(7)
2013-07-12 23:55:57 +08:00
Frequently Asked Questions
2014-09-17 06:38:50 +08:00
### npm-index(7)
2013-07-12 23:55:57 +08:00
Index of all npm documentation
2014-09-17 06:38:50 +08:00
### npm-registry(7)
2013-07-12 23:55:57 +08:00
The JavaScript Package Registry
2014-09-25 05:41:07 +08:00
### npm-scope(7)
Scoped packages
2014-09-17 06:38:50 +08:00
### npm-scripts(7)
2013-07-12 23:55:57 +08:00
How npm handles the "scripts" field
2014-09-17 06:38:50 +08:00
### removing-npm(7)
2013-07-12 23:55:57 +08:00
Cleaning the Slate
2014-09-17 06:38:50 +08:00
### semver(7)
2013-07-12 23:55:57 +08:00
The semantic versioner for npm