node/deps/npm/man/man3/npm-init.3

33 lines
1008 B
Groff
Raw Normal View History

2014-09-25 05:41:07 +08:00
.TH "NPM" "" "September 2014" "" ""
.SH "NAME"
2014-09-25 05:41:07 +08:00
\fBnpm\fR
.SH SYNOPSIS
.P
.RS 2
.EX
npm\.commands\.init(args, callback)
2014-09-25 05:41:07 +08:00
.EE
.RE
.SH DESCRIPTION
.P
This will ask you a bunch of questions, and then write a package\.json for you\.
.P
It attempts to make reasonable guesses about what you want things to be set to,
2014-09-25 05:41:07 +08:00
and then writes a package\.json file with the options you've selected\.
.P
2014-09-25 05:41:07 +08:00
If you already have a package\.json file, it'll read that first, and default to
the options in there\.
.P
It is strictly additive, so it does not delete options from your package\.json
without a really good reason to do so\.
.P
2014-09-25 05:41:07 +08:00
Since this function expects to be run on the command\-line, it doesn't work very
well as a programmatically\. The best option is to roll your own, and since
JavaScript makes it stupid simple to output formatted JSON, that is the
2014-09-25 05:41:07 +08:00
preferred method\. If you're sure you want to handle command\-line prompting,
then go ahead and use this programmatically\.
2014-09-25 05:41:07 +08:00
.SH SEE ALSO
.P
2014-09-17 06:38:50 +08:00
npm help 5 package\.json
2014-09-25 05:41:07 +08:00