Referencia de la CLI de NuGet

  • Artículo
  • 4 minutos para leer

La interfaz de la línea de comandos (CLI) de NuGet, , proporciona toda la extensión de la funcionalidad de NuGet para instalar, crear, publicar y administrar paquetes sin realizar ningún cambio en los archivos nuget.exe del proyecto.

Para usar cualquier comando, abra una ventana de comandos o un shell de Bash y, a continuación, ejecute seguido del comando y las opciones adecuadas, como (para ver la ayuda en nugetnuget help pack el comando pack).

Esta documentación refleja la versión más reciente de la CLI NuGet. Para obtener detalles exactos de cualquier versión determinada que use, ejecute nuget help para el comando deseado.

Para obtener información sobre cómo usar comandos básicos con la CLI de nuget.exe, consulte nuget.exe.

Instalación de nuget.exe

Windows

Nota

NuGet.exe 5.0 y las versiones posteriores requieren .NET Framework 4.7.2 o versiones posteriores para ejecutarse.

  1. Visite nuget.org/downloads y seleccione NuGet 3.3 o posterior (2.8.6 no es compatible con Mono). Siempre se recomienda la última versión, y 4.1.0+ es la versión necesaria para publicar paquetes en nuget.org.
  2. Cada descarga es el archivo nuget.exe directamente. Indique al explorador que guarde el archivo en una carpeta de su elección. El archivo no es un instalador; no verá nada si lo ejecuta directamente desde el explorador.
  3. Agregue la carpeta donde colocó nuget.exe a la variable de entorno de RUTA DE ACCESO para usar la herramienta CLI desde cualquier lugar.

macOS/Linux

Los comportamientos pueden variar ligeramente según la distribución del sistema operativo.

  1. Instale Mono 4.4.2 o versiones posteriores.

  2. Ejecute los comandos siguientes en un símbolo del sistema del shell:

    # 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. Cree un alias mediante la adición del script siguiente al archivo apropiado del sistema operativo (normalmente ~/.bash_aliases o ~/.bash_profile):

    # Create as alias for nuget
alias nuget="mono /usr/local/bin/nuget.exe"

  4. Recargue el shell. Para probar la instalación, escriba nuget sin parámetros. Debe aparecer la Ayuda de la CLI de NuGet.

Sugerencia

Para que la CLI NuGet esté disponible en la consola de Administrador de paquetes en Visual Studio, consulte Uso de la CLI nuget.exe en la consolade .

Disponibilidad

Consulte la disponibilidad de características para obtener detalles exactos.

  • Todos los comandos están disponibles en Windows.
  • Todos los comandos funcionan con nuget.exe se ejecutan en Mono, excepto donde se indica para packrestore , y update .
  • Los comandos , , , y también están disponibles pack en Mac y Linux a través de la CLI de restoredeletelocalspush dotnet.

Comandos y aplicabilidad

Comandos disponibles y aplicabilidad para la creación de paquetes, el consumo de paquetes o la publicación de un paquete en un host:

Comandos comunes Roles aplicables Versión de NuGet Descripción
pack Creación 2.7+ Crea un NuGet a partir de un .nuspec archivo de proyecto o . Cuando se ejecuta en Mono, no se admite la creación de un paquete a partir de un archivo de proyecto.
push Publicación All Publica un paquete en un origen de paquete.
config All All Obtiene o establece NuGet valores de configuración.
help or ? All All Muestra información de ayuda o ayuda para un comando.
locals Consumo 3.3+ Enumera las ubicaciones de las carpetas global-packages, http-cachey temp, y borra el contenido de esas carpetas.
restore Consumo 2.7+ Restaura todos los paquetes a los que hace referencia el formato de administración de paquetes en uso. Cuando se ejecuta en Mono, no se admite la restauración de paquetes con el formato PackageReference.
setapikey Publicación, Consumo All Guarda una clave de API para un origen de paquete determinado cuando ese origen de paquete requiere una clave para el acceso.
spec Creación All Genera un archivo .nuspec mediante tokens si se genera el archivo desde un Visual Studio proyecto.
Comandos secundarios Roles aplicables Versión de NuGet Descripción
add Publicación 3.3+ Agrega un paquete a un origen de paquete que no es HTTP mediante el diseño jerárquico. En el caso de los orígenes HTTP, use insertar.
delete Publicación All Quita o quita de la lista un paquete de un origen de paquete.
init Creación 3.3+ Agrega paquetes de una carpeta a un origen de paquete mediante el diseño jerárquico.
install Consumo All Instala un paquete en el proyecto actual, pero no modifica proyectos ni archivos de referencia.
list Consumo, quizás publicación All Muestra los paquetes de un origen determinado.
mirror Publicación En desuso en la versión 3.2+ Refleja un paquete y sus dependencias de un origen a un repositorio de destino.
search Consumo 5.8+ Busca un origen determinado mediante la cadena de consulta proporcionada.
sources Consumo, publicación Todo Administra los orígenes de paquetes en los archivos de configuración.
update Consumo Todo Actualiza los paquetes de un proyecto a las versiones más recientes disponibles. No se admite cuando se ejecuta en Mono.

Los distintos comandos usan varias variables de entorno.

NuGet comandos de la CLI por roles aplicables:

Rol Comandos:
Consumo config, help, install, list, locals, restore, search, setapikey, sources, update
Creación config, help, init, pack, spec
Publicación add, config, delete, help, list, push, setapikey, sources

Por ejemplo, los desarrolladores que solo se preocupaban por consumir paquetes solo necesitan comprender ese subconjunto de NuGet comandos.

Nota

Los nombres de las opciones de comando no tienen en cuenta mayúsculas de minúsculas. Las opciones que están en desuso no se incluyen en esta referencia, como NoPrompt (reemplazadas por NonInteractive ) y Verbose (reemplazadas por Verbosity ).