NuGet CLI リファレンス

  • [アーティクル]

NuGet のコマンド ライン インターフェイス (CLI) である nuget.exe では、プロジェクト ファイルを変更することなく、パッケージをインストール、作成、公開、および管理するための NuGet 機能がすべて提供されます。

コマンドを使用するには、コマンド ウィンドウまたは bash シェルを開き、nuget を実行します。これには、コマンドや適切なオプションを付与します (たとえば、nuget help pack でパック コマンドのヘルプを表示)。

このドキュメントでは、最新バージョンの NuGet CLI が反映されています。 使用している特定のバージョンの正確な詳細については、目的のコマンドに対して nuget help を実行します。

nuget.exe CLI で基本的なコマンドを使用する方法を学習するには、nuget.exe CLI を使用したパッケージのインストールと使用に関するページを参照してください。

nuget.exe のインストール

常に、構成をサポートする最新バージョンのツールをインストールしてください。

  • 最新の推奨バージョンは、https://dist.nuget.org/win-x86-commandline/latest/nuget.exe でダウンロードできます。
  • 既に nuget.exe CLI ツールがインストールされている場合は、次のコマンドを使用して最新バージョンに更新できます: nuget update -self
  • 古い継続的インテグレーション システムとの互換性を維持するために、以前の URL (https://nuget.org/nuget.exe) では現在、非推奨のバージョン 2.8.6 CLI ツールが提供されています。

  1. nuget.org/downloads にアクセスし、NuGet バージョン 3.3 以降をダウンロードします。

    • バージョン 5.0 以降には、.NET Framework バージョン 4.7.2 以降が必要です。
    • nuget.org にパッケージを発行するには、バージョン 4.1.0 以降が必要です。
    • バージョン 2.8.6 は Mono と互換性がありません。

  2. 各ダウンロードは、直接 nuget.exe ファイルです。 ブラウザーで任意のフォルダーにファイルを保存します。 ダウンロード ファイルがインストーラーではないため、ブラウザーから直接実行しても何も表示されません。

  3. CLI ツールをどこからでも使えるようにするには、nuget.exe ファイルのフォルダーの場所を PATH 環境変数に追加します。

ヒント

Visual Studio のパッケージ マネージャー コンソールで NuGet CLI を使用できるようにするには、「コンソールでの nuget.exe CLI の使用」を参照してください。

可用性

正確な詳細については、「機能の可用性」をご覧ください。

  • すべてのコマンドは Windows で使用できます。
  • すべてのコマンドは、Mono で実行される nuget.exe で動作します。ただし、pack、restore、update で指定されている場合を除きます。
  • pack、restore、delete、locals、push コマンドは、Mac および Linux でも、dotnet CLI で使用できます。

コマンドと適用性

パッケージの作成、パッケージの使用、ホストへのパッケージの発行に使用できるコマンドと適用性:

一般的なコマンド 該当するロール NuGet のバージョン 説明
pack 作成 2.7+ NuGet パッケージを .nuspec またはプロジェクト ファイルから作成します。 Mono で実行する場合は、プロジェクト ファイルからのパッケージの作成はサポートされていません。
push 発行 すべて パッケージをパッケージ ソースに発行します。
config すべて すべて NuGet 構成値を取得または設定します。
help or ? すべて すべて ヘルプ情報またはコマンドのヘルプを出力します。
locals 従量課金 3.3+ global-packages、http-cache および temp フォルダーの場所を一覧表示し、それらのフォルダーの内容をクリアします。
復元 (restore) 従量課金 2.7+ 使用中のパッケージ管理形式で参照されているすべてのパッケージを復元します。 Mono で実行する場合、PackageReference 形式を使用したパッケージの復元はサポートされません。
setapikey 発行、消費 すべて 特定のパッケージ ソースにアクセスするためのキーが必要な場合に、特定のパッケージ ソースの API キーを保存します。
spec 作成 すべて Visual Studio プロジェクトからファイルを生成する場合は、トークンを使用して .nuspec ファイルを生成します。
セカンダリ コマンド 該当するロール NuGet のバージョン 説明
add 発行 3.3+ 階層レイアウトを使用して、HTTP 以外のパッケージ ソースにパッケージを追加します。 HTTP ソースの場合は、プッシュを使用 します。
delete 発行 すべて パッケージ ソースから、パッケージを削除または一覧から登録解除します。
init 作成 3.3+ 階層レイアウトを使用して、フォルダーからパッケージ ソースにパッケージを追加します。
install 従量課金 すべて 現在のプロジェクトにパッケージをインストールしますが、プロジェクトや参照ファイルは変更しません。
list 消費 (発行の場合あり) すべて 所定のソースのパッケージのリストを表示します。
mirror 発行 3.2 以降で非推奨 パッケージとその依存関係を、ソースからターゲット リポジトリにミラー化します。
検索 従量課金 5.8+ 指定されたクエリ文字列で特定のソースを検索します。
sources 消費、発行 すべて 構成ファイル内のパッケージ ソースを管理します。
update 従量課金 すべて プロジェクトのパッケージを、利用できる最も新しいバージョンに更新します。 Mono で実行する場合はサポートされません。

別々のコマンドが、さまざまな環境変数を利用します。

該当するロール別の NuGet CLI コマンド:

ロール コマンド
従量課金 config、help、install、list、locals、restore、search、setapikey、sources、update
作成 config、help、init、pack、spec
発行 add、config、delete、help、list、push、setapikey、sources

たとえば、パッケージの使用のみに関係する開発者は、NuGet コマンドのサブセットのみを理解する必要があります。

Note

コマンド オプション名では、大文字と小文字が区別されません。 NoPrompt (NonInteractive で置き換えられた)、Verbose (Verbosity で置き換えられた) など非推奨のオプションは、このリファレンスには含まれません。

ローカリゼーション

NuGet.exe の進行状況、警告メッセージ、およびエラー メッセージは、Visual Studio と同じロケールに変換されます。 NuGet.exe は単一の exe として渡され、サイズに関する考慮事項により、最も一般的に表示されるメッセージのみがすべての言語に翻訳されています。