Referencia de la CLI de NuGet

  • Artículo

La interfaz de la línea de comandos (CLI) de NuGet, nuget.exe, 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 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 ayuda en el comando del paquete).

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

Instale siempre la versión más reciente de la herramienta que admita la configuración.

  • Puede descargar la versión recomendada más reciente en https://dist.nuget.org/win-x86-commandline/latest/nuget.exe.
  • Si ya tiene instalada la herramienta de la CLI de nuget.exe, puede actualizar la herramienta a la versión más reciente con el comando nuget update -self.
  • A efectos de compatibilidad con sistemas de integración continua anteriores, una dirección URL anterior, https://nuget.org/nuget.exe ofrece actualmente la versión 2.8.6 en desuso de la herramienta CLI.

  1. Visite nuget.org/downloads y descargue NuGet versión 3.3 o posterior.

    • La versión 5.0 y posteriores requieren .NET Framework versión 4.7.2 o posterior.
    • Se requiere la versión 4.1.0 y posteriores para publicar paquetes en nuget.org.
    • La versión 2.8.6 no es compatible con Mono.

  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 de descarga no es un instalador, por lo que no verá nada si lo ejecuta directamente desde el explorador.

  3. Agregue la carpeta donde colocó el archivo nuget.exe a la variable de entorno de RUTA DE ACCESO para usar la herramienta CLI desde cualquier lugar.

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 ejecuta en Mono, excepto donde se indica para pack, restore y update.
  • Los comandos pack, restore, delete, locals y push también están disponibles en Mac y Linux a través de la CLI de dotnet.

Comandos y aplicabilidad

Comandos disponibles y aplicabilidad a la creación de paquetes, consumo de paquetes o 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 .nuspec o un archivo de proyecto. 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 valores de configuración de NuGet.
help or ? All All Muestra información de ayuda para el comando.
locals Consumo 3.3 y versiones posteriores 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 mediante 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 genera el archivo a partir de un proyecto de Visual Studio.
Comandos secundarios Roles aplicables Versión de NuGet Descripción
agregar Publicación 3.3 y versiones posteriores Agrega un paquete a un origen de paquete que no es HTTP mediante el diseño jerárquico. Para orígenes HTTP, use push.
eliminación Publicación All Elimina o quita de la lista un paquete de un origen de paquete.
init Creación 3.3 y versiones posteriores 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 paquetes de un origen determinado.
mirror Publicación En desuso en 3.2 y versiones posteriores Refleja un paquete y sus dependencias de un origen en un repositorio de destino.
search Consumo 5.8 y versiones posteriores Busca en un origen determinado mediante la cadena de consulta proporcionada.
sources Consumo, publicación All Administra orígenes de paquetes en archivos de configuración.
update Consumo All 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.

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 con el consumo de paquetes, por ejemplo, solo necesitan comprender ese subconjunto de comandos 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 (reemplazada por Verbosity).

Localización

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