diff options
Diffstat (limited to 'deps/node/deps/npm/html/doc/cli/npm-init.html')
| -rw-r--r-- | deps/node/deps/npm/html/doc/cli/npm-init.html | 65 |
1 files changed, 65 insertions, 0 deletions
diff --git a/deps/node/deps/npm/html/doc/cli/npm-init.html b/deps/node/deps/npm/html/doc/cli/npm-init.html new file mode 100644 index 00000000..073263cb --- /dev/null +++ b/deps/node/deps/npm/html/doc/cli/npm-init.html @@ -0,0 +1,65 @@ +<!doctype html> +<html> + <title>npm-init</title> + <meta charset="utf-8"> + <link rel="stylesheet" type="text/css" href="../../static/style.css"> + <link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-init.html"> + <script async=true src="../../static/toc.js"></script> + + <body> + <div id="wrapper"> + +<h1><a href="../cli/npm-init.html">npm-init</a></h1> <p>create a package.json file</p> +<h2 id="synopsis">SYNOPSIS</h2> +<pre><code>npm init [--force|-f|--yes|-y|--scope] +npm init <@scope> (same as `npx <@scope>/create`) +npm init [<@scope>/]<name> (same as `npx [<@scope>/]create-<name>`)</code></pre><h2 id="examples">EXAMPLES</h2> +<p>Create a new React-based project using <a href="https://npm.im/create-react-app"><code>create-react-app</code></a>:</p> +<pre><code>$ npm init react-app ./my-react-app</code></pre><p>Create a new <code>esm</code>-compatible package using <a href="https://npm.im/create-esm"><code>create-esm</code></a>:</p> +<pre><code>$ mkdir my-esm-lib && cd my-esm-lib +$ npm init esm --yes</code></pre><p>Generate a plain old package.json using legacy init:</p> +<pre><code>$ mkdir my-npm-pkg && cd my-npm-pkg +$ git init +$ npm init</code></pre><p>Generate it without having it ask any questions:</p> +<pre><code>$ npm init -y</code></pre><h2 id="description">DESCRIPTION</h2> +<p><code>npm init <initializer></code> can be used to set up a new or existing npm package.</p> +<p><code>initializer</code> in this case is an npm package named <code>create-<initializer></code>, which +will be installed by <a href="https://npm.im/npx"><code><a href="../cli/npx.html">npx(1)</a></code></a>, and then have its main bin +executed -- presumably creating or updating <code>package.json</code> and running any other +initialization-related operations.</p> +<p>The init command is transformed to a corresponding <code>npx</code> operation as follows:</p> +<ul> +<li><code>npm init foo</code> -> <code>npx create-foo</code></li> +<li><code>npm init @usr/foo</code> -> <code>npx @usr/create-foo</code></li> +<li><code>npm init @usr</code> -> <code>npx @usr/create</code></li> +</ul> +<p>Any additional options will be passed directly to the command, so <code>npm init foo +--hello</code> will map to <code>npx create-foo --hello</code>.</p> +<p>If the initializer is omitted (by just calling <code>npm init</code>), init will fall back +to legacy init behavior. It will ask you a bunch of questions, and then write a +package.json for you. It will attempt to make reasonable guesses based on +existing fields, dependencies, and options selected. It is strictly additive, so +it will keep any fields and values that were already set. You can also use +<code>-y</code>/<code>--yes</code> to skip the questionnaire altogether. If you pass <code>--scope</code>, it +will create a scoped package.</p> +<h2 id="see-also">SEE ALSO</h2> +<ul> +<li><a href="https://github.com/isaacs/init-package-json">https://github.com/isaacs/init-package-json</a></li> +<li><a href="../files/package.json.html">package.json(5)</a></li> +<li><a href="../cli/npm-version.html">npm-version(1)</a></li> +<li><a href="../misc/npm-scope.html">npm-scope(7)</a></li> +</ul> + +</div> + +<table border=0 cellspacing=0 cellpadding=0 id=npmlogo> +<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr> +<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr> +<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr> +<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr> +<tr><td style="width:10px;height:10px;background:#fff"> </td></tr> +<tr><td style="width:60px;height:10px;background:rgb(237,127,127)" colspan=6> </td><td colspan=10 style="width:10px;height:10px;background:rgb(237,127,127)"> </td></tr> +<tr><td colspan=5 style="width:50px;height:10px;background:#fff"> </td><td style="width:40px;height:10px;background:rgb(237,127,127)" colspan=4> </td><td style="width:90px;height:10px;background:#fff" colspan=9> </td></tr> +</table> +<p id="footer">npm-init — npm@6.7.0</p> + |