diff options
author | Juan Caicedo <retiredcanadianpoet@gmail.com> | 2015-10-23 23:23:13 +0300 |
---|---|---|
committer | Forrest L Norvell <forrest@npmjs.com> | 2015-11-03 08:57:22 +0300 |
commit | d623783488aa5ee22fd3498cbffb4819cbd36f47 (patch) | |
tree | a19503542baa17f604ff55caa9c7b4fbfaf38367 /doc | |
parent | cb929312d56c80fc9611f1546a0197362835cd39 (diff) |
doc: update npm-start.md
Fixes #9460, specifying the default command run by "npm start" and the
fact that you can pass it arguments.
PR-URL: https://github.com/npm/npm/pull/10097
Diffstat (limited to 'doc')
-rw-r--r-- | doc/cli/npm-start.md | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/doc/cli/npm-start.md b/doc/cli/npm-start.md index 759de221f..94c468c29 100644 --- a/doc/cli/npm-start.md +++ b/doc/cli/npm-start.md @@ -7,7 +7,13 @@ npm-start(1) -- Start a package ## DESCRIPTION -This runs a package's "start" script, if one was provided. +This runs an arbitrary command specified in the package's `"start"` property of +its `"scripts"` object. If no `"start"` property is specified on the +`"scripts"` object, it will run `node server.js`. + +As of [`npm@2.0.0`](http://blog.npmjs.org/post/98131109725/npm-2-0-0), you can +use custom arguments when executing scripts. Refer to npm-run-script(1) for +more details. ## SEE ALSO |