213 lines
6.4 KiB
HTML
213 lines
6.4 KiB
HTML
|
<html><head>
|
|||
|
|
<title>npm-init</title>
|
|||
|
|
<style>
|
|||
|
|
body {
|
|||
|
|
background-color: #ffffff;
|
|||
|
|
color: #24292e;
|
|||
|
|
|
|||
|
|
margin: 0;
|
|||
|
|
|
|||
|
|
line-height: 1.5;
|
|||
|
|
|
|||
|
|
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji";
|
|||
|
|
}
|
|||
|
|
#rainbar {
|
|||
|
|
height: 10px;
|
|||
|
|
background-image: linear-gradient(139deg, #fb8817, #ff4b01, #c12127, #e02aff);
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
a {
|
|||
|
|
text-decoration: none;
|
|||
|
|
color: #0366d6;
|
|||
|
|
}
|
|||
|
|
a:hover {
|
|||
|
|
text-decoration: underline;
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
pre {
|
|||
|
|
margin: 1em 0px;
|
|||
|
|
padding: 1em;
|
|||
|
|
border: solid 1px #e1e4e8;
|
|||
|
|
border-radius: 6px;
|
|||
|
|
|
|||
|
|
display: block;
|
|||
|
|
overflow: auto;
|
|||
|
|
|
|||
|
|
white-space: pre;
|
|||
|
|
|
|||
|
|
background-color: #f6f8fa;
|
|||
|
|
color: #393a34;
|
|||
|
|
}
|
|||
|
|
code {
|
|||
|
|
font-family: SFMono-Regular, Consolas, "Liberation Mono", Menlo, Courier, monospace;
|
|||
|
|
font-size: 85%;
|
|||
|
|
padding: 0.2em 0.4em;
|
|||
|
|
background-color: #f6f8fa;
|
|||
|
|
color: #393a34;
|
|||
|
|
}
|
|||
|
|
pre > code {
|
|||
|
|
padding: 0;
|
|||
|
|
background-color: inherit;
|
|||
|
|
color: inherit;
|
|||
|
|
}
|
|||
|
|
h1, h2, h3 {
|
|||
|
|
font-weight: 600;
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
#logobar {
|
|||
|
|
background-color: #333333;
|
|||
|
|
margin: 0 auto;
|
|||
|
|
padding: 1em 4em;
|
|||
|
|
}
|
|||
|
|
#logobar .logo {
|
|||
|
|
float: left;
|
|||
|
|
}
|
|||
|
|
#logobar .title {
|
|||
|
|
font-weight: 600;
|
|||
|
|
color: #dddddd;
|
|||
|
|
float: left;
|
|||
|
|
margin: 5px 0 0 1em;
|
|||
|
|
}
|
|||
|
|
#logobar:after {
|
|||
|
|
content: "";
|
|||
|
|
display: block;
|
|||
|
|
clear: both;
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
#content {
|
|||
|
|
margin: 0 auto;
|
|||
|
|
padding: 0 4em;
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
#table_of_contents > h2 {
|
|||
|
|
font-size: 1.17em;
|
|||
|
|
}
|
|||
|
|
#table_of_contents ul:first-child {
|
|||
|
|
border: solid 1px #e1e4e8;
|
|||
|
|
border-radius: 6px;
|
|||
|
|
padding: 1em;
|
|||
|
|
background-color: #f6f8fa;
|
|||
|
|
color: #393a34;
|
|||
|
|
}
|
|||
|
|
#table_of_contents ul {
|
|||
|
|
list-style-type: none;
|
|||
|
|
padding-left: 1.5em;
|
|||
|
|
}
|
|||
|
|
#table_of_contents li {
|
|||
|
|
font-size: 0.9em;
|
|||
|
|
}
|
|||
|
|
#table_of_contents li a {
|
|||
|
|
color: #000000;
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
header.title {
|
|||
|
|
border-bottom: solid 1px #e1e4e8;
|
|||
|
|
}
|
|||
|
|
header.title > h1 {
|
|||
|
|
margin-bottom: 0.25em;
|
|||
|
|
}
|
|||
|
|
header.title > .description {
|
|||
|
|
display: block;
|
|||
|
|
margin-bottom: 0.5em;
|
|||
|
|
line-height: 1;
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
footer#edit {
|
|||
|
|
border-top: solid 1px #e1e4e8;
|
|||
|
|
margin: 3em 0 4em 0;
|
|||
|
|
padding-top: 2em;
|
|||
|
|
}
|
|||
|
|
</style>
|
|||
|
|
</head>
|
|||
|
|
<body>
|
|||
|
|
<div id="banner">
|
|||
|
|
<div id="rainbar"></div>
|
|||
|
|
<div id="logobar">
|
|||
|
|
<svg class="logo" role="img" height="32" width="32" viewBox="0 0 700 700">
|
|||
|
|
<polygon fill="#cb0000" points="0,700 700,700 700,0 0,0"></polygon>
|
|||
|
|
<polygon fill="#ffffff" points="150,550 350,550 350,250 450,250 450,550 550,550 550,150 150,150"></polygon>
|
|||
|
|
</svg>
|
|||
|
|
<div class="title">
|
|||
|
|
npm command-line interface
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<section id="content">
|
|||
|
|
<header class="title">
|
|||
|
|
<h1 id="npm-init">npm-init</h1>
|
|||
|
|
<span class="description">create a package.json file</span>
|
|||
|
|
</header>
|
|||
|
|
|
|||
|
|
<section id="table_of_contents">
|
|||
|
|
<h2 id="table-of-contents">Table of contents</h2>
|
|||
|
|
<div id="_table_of_contents"><ul><li><a href="#synopsis">Synopsis</a></li><li><a href="#description">Description</a></li><li><a href="#examples">Examples</a></li><li><a href="#see-also">See Also</a></li></ul></div>
|
|||
|
|
</section>
|
|||
|
|
|
|||
|
|
<div id="_content"><h3 id="synopsis">Synopsis</h3>
|
|||
|
|
<pre lang="bash"><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>
|
|||
|
|
<h3 id="description">Description</h3>
|
|||
|
|
<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>npx</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>
|
|||
|
|
<h3 id="examples">Examples</h3>
|
|||
|
|
<p>Create a new React-based project using
|
|||
|
|
<a href="https://npm.im/create-react-app"><code>create-react-app</code></a>:</p>
|
|||
|
|
<pre lang="bash"><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 lang="bash"><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 lang="bash"><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 lang="bash"><code>$ npm init -y
|
|||
|
|
</code></pre>
|
|||
|
|
<h3 id="see-also">See Also</h3>
|
|||
|
|
<ul>
|
|||
|
|
<li><a href="http://npm.im/init-package-json">init-package-json module</a></li>
|
|||
|
|
<li><a href="../configuring-npm/package-json.html">package.json</a></li>
|
|||
|
|
<li><a href="../commands/npm-version.html">npm version</a></li>
|
|||
|
|
<li><a href="../using-npm/scope.html">npm scope</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<footer id="edit">
|
|||
|
|
<a href="https://github.com/npm/cli/edit/latest/docs/content/commands/npm-init.md">
|
|||
|
|
<svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;">
|
|||
|
|
<path fill-rule="evenodd" d="M11.013 1.427a1.75 1.75 0 012.474 0l1.086 1.086a1.75 1.75 0 010 2.474l-8.61 8.61c-.21.21-.47.364-.756.445l-3.251.93a.75.75 0 01-.927-.928l.929-3.25a1.75 1.75 0 01.445-.758l8.61-8.61zm1.414 1.06a.25.25 0 00-.354 0L10.811 3.75l1.439 1.44 1.263-1.263a.25.25 0 000-.354l-1.086-1.086zM11.189 6.25L9.75 4.81l-6.286 6.287a.25.25 0 00-.064.108l-.558 1.953 1.953-.558a.249.249 0 00.108-.064l6.286-6.286z"></path>
|
|||
|
|
</svg>
|
|||
|
|
Edit this page on GitHub
|
|||
|
|
</a>
|
|||
|
|
</footer>
|
|||
|
|
</section>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</body></html>
|