ef1f6748f8d41ac5db9174d2d2617fa512384110
[platform/upstream/nodejs.git] / deps / npm / man / man3 / npm-init.3
1 .\" Generated with Ronnjs 0.3.8
2 .\" http://github.com/kapouer/ronnjs/
3 .
4 .TH "INIT" "3" "November 2013" "" ""
5 .
6 .SH "NAME"
7 \fBinit\fR \-\- Interactively create a package\.json file
8 .
9 .SH "SYNOPSIS"
10 .
11 .nf
12 npm\.commands\.init(args, callback)
13 .
14 .fi
15 .
16 .SH "DESCRIPTION"
17 This will ask you a bunch of questions, and then write a package\.json for you\.
18 .
19 .P
20 It attempts to make reasonable guesses about what you want things to be set to,
21 and then writes a package\.json file with the options you\'ve selected\.
22 .
23 .P
24 If you already have a package\.json file, it\'ll read that first, and default to
25 the options in there\.
26 .
27 .P
28 It is strictly additive, so it does not delete options from your package\.json
29 without a really good reason to do so\.
30 .
31 .P
32 Since this function expects to be run on the command\-line, it doesn\'t work very
33 well as a programmatically\. The best option is to roll your own, and since
34 JavaScript makes it stupid simple to output formatted JSON, that is the
35 preferred method\. If you\'re sure you want to handle command\-line prompting,
36 then go ahead and use this programmatically\.
37 .
38 .SH "SEE ALSO"
39 npm help  package\.json