Referencia de la CLI de NuGet

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

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

Esta documentación refleja la versión más reciente de la CLI de 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 Instalar y usar paquetes mediante la CLI de 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 de NuGet esté disponible en la consola del Administrador de paquetes en Visual Studio, consulte Uso de la CLI de nuget.exe en la consola.

Disponibilidad

Consulte disponibilidad de características para obtener detalles exactos.

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

Comandos y aplicabilidad

Comandos y aplicabilidad disponibles 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 paquete 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 Todo Publica un paquete en un origen de paquete.
config All All Obtiene o establece valores de configuración de NuGet.
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-cache y 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 Todo 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 Todo Genera un .nuspec archivo con tokens si genera el archivo desde un proyecto de Visual Studio.
Comandos secundarios Roles aplicables Versión de NuGet Descripción
add Publicación 3.3+ Agrega un paquete a un origen de paquete no HTTP mediante el diseño jerárquico. En el caso de los orígenes HTTP, use push.
delete Publicación Todo Quita o anula la lista de 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 Todo Instala un paquete en el proyecto actual, pero no modifica los proyectos ni los archivos de referencia.
list Consumo, quizás publicación Todo 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 en un repositorio de destino.
search Consumo 5.8+ Busca en 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 Novedades 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.

Comandos de la CLI de NuGet por roles aplicables:

Role 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

Los desarrolladores interesados solo en el consumo de paquetes, por ejemplo, solo necesitan comprender ese subconjunto de comandos de NuGet.

Nota:

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

Localización

NuGet.exe los mensajes de progreso, advertencia y error se traducen en las mismas configuraciones regionales que Visual Studio. NuGet.exe se distribuye como un único exe y, debido a consideraciones de tamaño, solo los mensajes más expuestos se traducen en todos los idiomas.