npm publish
npm publishは、Node.jsプロジェクトをnpmレジストリに公開するコマンドです。
エイリアスなし
解説
Node.jsプロジェクトをnpmレジストリに公開します。
このコマンドで公開すると他の開発者がパッケージをインストールして利用できるようになります。
通常はnpmのパブリックレジストリに公開されますが、プライベートレジストリを使用することも可能です。
構文
- （構文）
- npm publish [＜圧縮ファイル＞|＜フォルダ＞] [--tag ＜tag＞] [--access ＜public|restricted＞]
- ＜圧縮ファイル＞
- 公開するパッケージの圧縮ファイル（.tgz形式）
- ＜フォルダ＞:
- 公開するパッケージが含まれるフォルダ（プロジェクトのルートディレクトリ）
| オプション | 説明 |
|---|---|
| --tag タグ | パッケージに付けるタグを指定する （デフォルトはlatest） |
| --access アクセスレベル | スコープ付きパッケージのアクセスレベルを指定する ・restricted：スコープ付きパッケージ（デフォルト） ・public：スコープなしのパッケージ |
| --dry-run | 実際には公開せず、何が行われるかを確認する |
| --opt パス | 二要素認証が有効な場合に必要なワンタイムパスワードを指定する |
| -h | コマンドのヘルプを表示する |
サンプル
パッケージを公開する
npm publish
プロジェクトのルートディレクトリで実行してください。package.jsonに基づいてパッケージが公開されます。
タグを指定して公開する
npm publish --tag hoge
タグ「hoge」としてパッケージを公開します。
プライベートパッケージの公開
npm publish --access restricted
スコープ付きパッケージをプライベートとして公開されます。
備考
- パッケージ名とバージョンはnpmレジストリ内で一意にする必要があります。
（既に存在する名前やバージョンは公開できません。） - 一度公開したパッケージは、npm unpublishコマンドで取り消すことができます。
（ただし、npm unpublishの使用は非推奨とされています。）
