npm init

パッケージと実行環境

書き方

npm init [-y] | npm init <initializer>

package.jsonを作ります。npm init <name>の形はまったく別で、create-<name>を取ってきて実行します。

よく使うオプション

オプション意味
-yaccept every default and write package.json at once
<initializer>download and run create-<initializer> instead
--scope=@mecreate a scoped package name
-w <dir>create a workspace package under that directory

npm init -y

writes a package.json with defaults, no questions

npm init vite@latest my-app

runs create-vite; nothing like plain npm init

npm init --scope=@me -y

names the package @me/whatever

何をどこに入れるかが問題です。このプロジェクトの中か、マシン全体かを先に決めてください。

読み方

  • 角括弧 [ ] は省いてよい部分です。
  • 三点 … は複数並べられるという意味です。
  • オプションは大文字小文字を区別します — -r と -R が別物のコマンドもあります。

よくある質問

Q. npm init は何をしますか。

package.jsonを作ります。npm init <name>の形はまったく別で、create-<name>を取ってきて実行します。

Q. どう打ちますか。

npm init [-y] | npm init <initializer> — 角括弧は省いてよい部分です。

Q. よく使うオプションはいくつですか。

ここにまとめたのは4個です。全部は man npm にあります。このコマンドはパッケージと実行環境の仲間です。

関連するコマンド

man ページ: man npm-init