Reference k NuGet CLINuGet CLI reference

Rozhraní příkazového řádku NuGet (CLI), nuget.exeposkytuje kompletní rozsah funkcí NuGet pro instalaci, vytváření, publikování a správu balíčků bez provedení změn v souborech projektu.The NuGet Command Line Interface (CLI), nuget.exe, provides the full extent of NuGet functionality to install, create, publish, and manage packages without making any changes to project files.

Chcete-li použít libovolný příkaz, otevřete okno příkazového řádku nebo prostředí bash nuget a potom spusťte příkaz a příslušné možnosti, nuget help pack například (pro zobrazení pomocníka v příkazu Pack).To use any command, open a command window or bash shell, then run nuget followed by the command and appropriate options, such as nuget help pack (to view help on the pack command).

Tato dokumentace odráží nejnovější verzi rozhraní příkazového řádku NuGet.This documentation reflects the latest version of the NuGet CLI. Přesné podrobnosti o libovolné verzi, kterou používáte, získáte spuštěním nuget help příkazu pro požadovaný příkaz.For exact details for any given version that you're using, run nuget help for the desired command.

Informace o použití základních příkazů s rozhraním nuget.exe příkazového řádku najdete v tématu instalace a použití balíčků pomocí rozhraní příkazového řádku NuGet. exe.To learn how to use basic commands with the nuget.exe CLI, see Install and use packages using the nuget.exe CLI.

Instalace NuGet. exeInstalling nuget.exe

WindowsWindows

Poznámka

NuGet. exe 5,0 a novější vyžaduje spuštění .NET Framework 4.7.2 nebo novějším.NuGet.exe 5.0 and later require .NET Framework 4.7.2 or later to execute.

  1. Přejděte na NuGet.org/downloads a vyberte NuGet 3,3 nebo vyšší (2.8.6 není kompatibilní s mono).Visit nuget.org/downloads and select NuGet 3.3 or higher (2.8.6 is not compatible with Mono). Nejnovější verze se vždycky doporučuje a k publikování balíčků do nuget.org se vyžaduje 4.1.0 +.The latest version is always recommended, and 4.1.0+ is required to publish packages to nuget.org.
  2. Každé stažení je nuget.exe soubor přímo.Each download is the nuget.exe file directly. Řekněte prohlížeči, aby soubor uložil do složky podle vašeho výběru.Instruct your browser to save the file to a folder of your choice. Soubor není instalační program. Pokud ji spustíte přímo z prohlížeče, nezobrazí se žádná.The file is not an installer; you won't see anything if you run it directly from the browser.
  3. Přidejte složku, do které jste umístili nuget.exe do proměnné prostředí PATH pro použití nástroje CLI odkudkoli.Add the folder where you placed nuget.exe to your PATH environment variable to use the CLI tool from anywhere.

macOS/LinuxmacOS/Linux

V případě distribuce operačního systému se může chování mírně lišit.Behaviors may vary slightly by OS distribution.

  1. Nainstalujte mono 4.4.2 nebo novější.Install Mono 4.4.2 or later.

  2. Na příkazovém řádku prostředí spusťte následující příkaz:Execute the following command at a shell prompt:

    # Download the latest stable `nuget.exe` to `/usr/local/bin`
    sudo curl -o /usr/local/bin/nuget.exe https://dist.nuget.org/win-x86-commandline/latest/nuget.exe
    
  3. Vytvořte alias přidáním následujícího skriptu do příslušného souboru pro váš operační systém (obvykle ~/.bash_aliases nebo ~/.bash_profile):Create an alias by adding the following script to the appropriate file for your OS (typically ~/.bash_aliases or ~/.bash_profile):

    # Create as alias for nuget
    alias nuget="mono /usr/local/bin/nuget.exe"
    
  4. Znovu načtěte prostředí.Reload the shell. Otestujte instalaci zadáním nuget bez parametrů.Test the installation by entering nuget with no parameters. Měla by se zobrazit Help CLI NuGet.NuGet CLI help should display.

Tip

Chcete-li zpřístupnit rozhraní NuGet v rámci konzoly Správce balíčků v sadě Visual Studio, přečtěte si téma použití rozhraní příkazového řádku NuGet. exe v konzolenástroje.To make the NuGet CLI available within the Package Manager Console in Visual Studio, see Using the nuget.exe CLI in the console.

DostupnostAvailability

Přesné podrobnosti najdete v tématu Dostupnost funkce .See feature availability for exact details.

  • Všechny příkazy jsou k dispozici ve Windows.All commands are available on Windows.
  • Všechny příkazy pracují s NuGet. exe běžícím na mono s výjimkou packpřípadů restore, kde updatejsou uvedeny pro, a.All commands work with nuget.exe running on Mono except where indicated for pack, restore, and update.
  • packPříkazy, restore, ,delete ajsoupush také k dispozici v systémech Mac a Linux prostřednictvím rozhraní příkazového řádku dotnet locals.The pack, restore, delete, locals, and push commands are also available on Mac and Linux through the dotnet CLI.

Příkazy a použitelnostCommands and applicability

Dostupné příkazy a použitelnost při vytváření balíčků, spotřebě balíčků nebo publikování balíčku na hostitele:Available commands and applicability to package creation, package consumption, and/or publishing a package to a host:

Běžné příkazyCommon Commands Příslušné roleApplicable Roles Verze NuGetNuGet Version PopisDescription
packpack VytvořenaCreation 2.7+2.7+ Vytvoří balíček NuGet ze .nuspec souboru nebo projektu.Creates a NuGet package from a .nuspec or project file. Při spuštění na mono se nepodporuje vytváření balíčku ze souboru projektu.When running on Mono, creating a package from a project file is not supported.
pushpush PublikováníPublishing VšechnyAll Publikuje balíček do zdroje balíčku.Publishes a package to a package source.
configconfig VšechnyAll VšechnyAll Získá nebo nastaví hodnoty konfigurace NuGet.Gets or sets NuGet configuration values.
help or ?help or ? VšechnyAll VšechnyAll Zobrazí nápovědu nebo nápovědu k příkazu.Displays help information or help for a command.
localslocals VyužitíConsumption 3.3+3.3+ Zobrazí seznam umístění globálních balíčků, HTTP cachea dočasných složek a vymaže obsah těchto složek.Lists locations of the global-packages, http-cache, and temp folders and clears the contents of those folders.
restorerestore VyužitíConsumption 2.7+2.7+ Obnoví všechny balíčky, na které odkazuje formát správy balíčků, který se používá.Restores all packages referenced by the package management format in use. Při spuštění na mono se nepodporuje obnovení balíčků pomocí formátu PackageReference.When running on Mono, restoring packages using the PackageReference format is not supported.
setapikeysetapikey Publikování, spotřebaPublishing, Consumption VšechnyAll Uloží klíč rozhraní API pro daný zdroj balíčku, když tento zdroj balíčku vyžaduje klíč pro přístup.Saves an API key for a given package source when that package source requires a key for access.
specspec VytvořenaCreation VšechnyAll Vygeneruje .nuspec soubor pomocí tokenů při generování souboru z projektu sady Visual Studio.Generates a .nuspec file, using tokens if generating the file from a Visual Studio project.
Sekundární příkazySecondary Commands Příslušné roleApplicable Roles Verze NuGetNuGet Version PopisDescription
addadd PublikováníPublishing 3.3+3.3+ Přidá balíček do zdroje balíčků jiného typu než HTTP pomocí hierarchického rozložení.Adds a package to a non-HTTP package source using hierarchical layout. Pro zdroje HTTP použijte push.For HTTP sources, use push.
deletedelete PublikováníPublishing VšechnyAll Odebere nebo zruší výpis balíčku ze zdroje balíčku.Removes or unlists a package from a package source.
initinit VytvořenaCreation 3.3+3.3+ Přidá balíčky ze složky do zdroje balíčku pomocí hierarchického rozložení.Adds packages from a folder to a package source using hierarchical layout.
installinstall VyužitíConsumption VšechnyAll Nainstaluje balíček do aktuálního projektu, ale neupraví projekty ani referenční soubory.Installs a package into the current project but does not modify projects or reference files.
listlist Spotřeba, možná publikováníConsumption, perhaps Publishing VšechnyAll Zobrazí balíčky z daného zdroje.Displays packages from a given source.
mirrormirror PublikováníPublishing Zastaralé v 3.2 +Deprecated in 3.2+ Zrcadlí balíček a jeho závislosti ze zdroje do cílového úložiště.Mirrors a package and its dependencies from a source to a target repository.
sourcessources Spotřeba, publikováníConsumption, Publishing VšechnyAll Spravuje zdroje balíčků v konfiguračních souborech.Manages package sources in configuration files.
updateupdate VyužitíConsumption VšechnyAll Aktualizuje balíčky projektu na nejnovější dostupné verze.Updates a project's packages to the latest available versions. Nepodporováno při spuštění v mono.Not supported when running on Mono.

Různé příkazy využívají různé proměnné prostředí.Different commands make use of various Environment variables.

Příkazy NuGet CLI podle použitelných rolí:NuGet CLI commands by applicable roles:

RoleRole PříkazyCommands
VyužitíConsumption config, help, install, list, locals, restore, setapikey, sources, updateconfig, help, install, list, locals, restore, setapikey, sources, update
VytvořenaCreation config, help, init, pack, specconfig, help, init, pack, spec
PublikováníPublishing add, config, delete, help, list, push, setapikey, sourcesadd, config, delete, help, list, push, setapikey, sources

Vývojáři, kteří mají obavy jenom s využitím balíčků, potřebují pochopit jenom tuto podmnožinu příkazů NuGet.Developers concerned only with consuming packages, for example, need only understand that subset of NuGet commands.

Poznámka

V názvech možností příkazu se nerozlišují malá a velká písmena.Command option names are case-insensitive. Nepoužívané možnosti NoPrompt nejsou zahrnuté do tohoto odkazu, jako je například ( NonInteractivenahrazeno Verbosity) a Verbose (nahrazeno).Options that are deprecated are not included in this reference, such as NoPrompt (replaced by NonInteractive) and Verbose (replaced by Verbosity).