Referenční dokumentace rozhraní příkazového řádku NuGetNuGet CLI reference

NuGet rozhraní příkazového řádku (CLI), nuget.exe, umožňuje plném rozsahu funkcí NuGet k instalaci, vytvářet, publikovat a spravovat balíčky 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.

Pokud chcete použít jakýkoli příkaz, otevřete okno příkazového řádku nebo prostředí bash a potom spusťte nuget následovaný příkazu a vhodné možnosti, například nuget help pack (Chcete-li zobrazit nápovědu k 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 je promítnuto nejnovější verzi rozhraní příkazového řádku NuGet.This documentation reflects the latest version of the NuGet CLI. Kterém najdete přesné informace pro danou verzi, který používáte, spusťte nuget help požadovaného příkazu.For exact details for any given version that you're using, run nuget help for the desired command.

Instalace nuget.exeInstalling nuget.exe

WindowsWindows

  1. Navštivte nuget.org/downloads a vyberte NuGet 3.3 nebo novější (2.8.6 přílohy není kompatibilní s Mono).Visit nuget.org/downloads and select NuGet 3.3 or higher (2.8.6 is not compatible with Mono). Doporučujeme vždy na nejnovější verzi a 4.1.0+ je potřeba publikovat balíčky nuget.org.The latest version is always recommended, and 4.1.0+ is required to publish packages to nuget.org.
  2. Každý soubor ke stažení je nuget.exe přímo soubor.Each download is the nuget.exe file directly. Dáte pokyn, aby prohlížeč k uložení souboru do složky podle vašeho výběru.Instruct your browser to save the file to a folder of your choice. Soubor je není příslušný instalační program; vám nic neuvidí, je-li spustit přímo z prohlížeče.The file is not an installer; you won't see anything if you run it directly from the browser.
  3. Přidat složku, kam jste umístili nuget.exe do proměnné prostředí PATH použít nástroj příkazového řádku z libovolného místa.Add the folder where you placed nuget.exe to your PATH environment variable to use the CLI tool from anywhere.

macOS/LinuxmacOS/Linux

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

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

  2. Spuštěním následujícího příkazu v příkazovém řádku shell: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řit alias, přidejte následující skript k příslušnému 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čte prostředí.Reload the shell. Otestujte instalaci tak, že zadáte nuget bez parametrů.Test the installation by entering nuget with no parameters. Zobrazit nápovědu příkazového řádku NuGet.NuGet CLI help should display.

Tip

Chcete-li k dispozici v rámci konzoly Správce balíčků NuGet rozhraní příkazového řádku v sadě Visual Studio, naleznete v tématu pomocí nuget.exe rozhraní příkazového řádku v konzole.To make the NuGet CLI available within the Package Manager Console in Visual Studio, see Using the nuget.exe CLI in the console.

DostupnostAvailability

Zobrazit dostupnost funkcí najdete přesné informace.See feature availability for exact details.

  • Všechny příkazy jsou k dispozici na Windows.All commands are available on Windows.
  • Všechny příkazy pracovat nuget.exe systémem Mono, pokud není uvedeno pro jinak pack, restore, a update.All commands work with nuget.exe running on Mono except where indicated for pack, restore, and update.
  • pack, restore, delete, locals, A push příkazy jsou dostupné i na Mac a Linux přes rozhraní příkazového řádku dotnet.The pack, restore, delete, locals, and push commands are also available on Mac and Linux through the dotnet CLI.

Příkazy a použitelnost.Commands and applicability

Dostupné příkazy a použitelnost pro vytvoření balíčku, využití balíčků a 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řeníCreation 2.7+2.7+ Vytvoří balíček NuGet .nuspec nebo soubor projektu.Creates a NuGet package from a .nuspec or project file. Při spouštění v Mono, vytvoření balíčku ze souboru projektu se nepodporuje.When running on Mono, creating a package from a project file is not supported.
pushpush PublikováníPublishing VšechnyAll Publikuje balíček ke zdroji balíčku.Publishes a package to a package source.
configconfig VšechnyAll VšechnyAll Získá nebo nastaví NuGet konfigurační hodnoty.Gets or sets NuGet configuration values.
help or ?help or ? VšechnyAll VšechnyAll Zobrazí nápovědu informace a nápovědu pro příkaz.Displays help information or help for a command.
localslocals SpotřebaConsumption 3.3+3.3+ Uvádí umístění global-packages, http-cache, a temp složky 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 SpotřebaConsumption 2.7+2.7+ Obnoví všechny balíčky, které odkazuje formát správy balíčků, které používá.Restores all packages referenced by the package management format in use. Při spouštění v Mono, obnovení balíčků pomocí PackageReference formátu není podporováno.When running on Mono, restoring packages using the PackageReference format is not supported.
setapikeysetapikey Publikování, spotřebyPublishing, Consumption VšechnyAll Uloží klíč rozhraní API pro zdroj daného balíčku zdroje tohoto balíčku vyžaduje klíče pro přístup.Saves an API key for a given package source when that package source requires a key for access.
specspec VytvořeníCreation VšechnyAll Generuje .nuspec soubor, pokud soubor se generuje z projektu sady Visual Studio pomocí tokenů.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 ke zdroji balíčku jiným protokolem než HTTP pomocí hierarchickém rozložení.Adds a package to a non-HTTP package source using hierarchical layout. Pro HTTP zdroji, použijte nabízených.For HTTP sources, use push.
deletedelete PublikováníPublishing VšechnyAll Odebere nebo unlists balíčku ze zdroje balíčku.Removes or unlists a package from a package source.
initinit VytvořeníCreation 3.3+3.3+ Přidá balíčky ze složky ke zdroji balíčku pomocí hierarchickém rozložení.Adds packages from a folder to a package source using hierarchical layout.
installinstall SpotřebaConsumption VšechnyAll Nainstaluje balíček do aktuálního projektu, ale projekty nebo neodkazuje na soubory.Installs a package into the current project but does not modify projects or reference files.
listlist Využití, například 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+ Odráží balíček a jeho závislé položky 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 SpotřebaConsumption VšechnyAll Projektu balíčky aktualizací na nejnovější dostupné verze.Updates a project's packages to the latest available versions. Nejsou podporovány při spouštění v Mono.Not supported when running on Mono.

Ujistěte se, různé příkazy pomocí různých proměnné prostředí.Different commands make use of various Environment variables.

Příkazy rozhraní příkazového řádku NuGet příslušné role:NuGet CLI commands by applicable roles:

RoleRole PříkazyCommands
SpotřebaConsumption config, help, install, list, locals, restore, setapikey, sources, updateconfig, help, install, list, locals, restore, setapikey, sources, update
VytvořeníCreation 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 týká pouze využívání balíčků, například potřebovat jenom pochopit tuto dílčí příkazy pro balíčky NuGet.Developers concerned only with consuming packages, for example, need only understand that subset of NuGet commands.

Poznámka

Názvy možností příkazu jsou malá a velká písmena.Command option names are case-insensitive. Možnosti, které jsou zastaralé nejsou součástí tohoto odkazu, například NoPrompt (nahrazuje NonInteractive) a Verbose (nahrazuje Verbosity).Options that are deprecated are not included in this reference, such as NoPrompt (replaced by NonInteractive) and Verbose (replaced by Verbosity).