Partager via

Informations de référence sur l’interface de ligne de commande NuGet

  • Article

L’interface de ligne de commande NuGet (CLI), nuget.exe, fournit l’étendue complète de la fonctionnalité NuGet pour installer, créer, publier et gérer des packages sans apporter de modifications aux fichiers projet.

Pour utiliser une commande, ouvrez une fenêtre de commande ou un shell bash, puis exécutez nuget suivi de la commande et des options appropriées, telles que nuget help pack (pour afficher l'aide sur la commande package).

Cette documentation reflète la dernière version de l’interface CLI NuGet. Pour connaître les détails exacts de la version que vous utilisez, exécutez nuget help pour la commande souhaitée.

Pour savoir comment utiliser les commandes de base avec l’interface CLI nuget.exe, consultez Installer et utiliser des packages à l’aide de l’interface CLI nuget.exe.

Installation de nuget.exe

Installez toujours la dernière version de l’outil qui prend en charge votre configuration.

  • Vous pouvez télécharger la dernière version recommandée à l’adresse https://dist.nuget.org/win-x86-commandline/latest/nuget.exe.
  • Si l'outil CLI nuget.exe est déjà installé, vous pouvez le mettre à jour avec la dernière version à l'aide de la commande nuget update -self.
  • Pour des raisons de compatibilité avec les anciens systèmes d'intégration continue, une URL antérieure, https://nuget.org/nuget.exe fournit actuellement la version déconseillé 2.8.6 de l'outil CLI.

  1. Visitez nuget.org/downloads et téléchargez NuGet version 3.3 ou ultérieure.

    • La version 5.0 et ultérieure nécessite .NET Framework version 4.7.2 ou ultérieure.
    • La version 4.1.0 et ultérieure est requise pour publier des packages sur nuget.org.
    • La version 2.8.6 n’est pas compatible avec Mono.

  2. Chaque téléchargement est le fichier nuget.exe directement. Demandez à votre navigateur d’enregistrer le fichier dans un dossier de votre choix. Le fichier de téléchargement n'est pas un programme d'installation, vous ne verrez donc rien si vous exécutez le fichier directement à partir du navigateur.

  3. Pour utiliser l'outil CLI de n'importe où, ajoutez l'emplacement du dossier du fichier nuget.exe à votre variable d'environnement PATH.

Conseil

Pour rendre l’interface CLI NuGet disponible dans la console Gestionnaire de package dans Visual Studio, consultez Utilisation de l’interface CLI nuget.exe dans la console.

Disponibilité

Pour plus d’informations, consultez la disponibilité des caractéristiques.

  • Toutes les commandes sont disponibles sur Windows.
  • Toutes les commandes fonctionnent avec nuget.exe en cours d’exécution sur Mono, sauf si indiqué pour pack, restoreet update.
  • Les commandes pack, restore, delete, locals, et push sont également disponibles sur Mac et Linux via l’interface CLI dotnet.

Commandes et applicabilité

Commandes et applicabilité disponibles pour la création, la consommation de package et/ou la publication d’un package sur un hôte :

Commandes courantes Rôles applicables Version de NuGet Description
pack Création 2.7+ Crée un package NuGet à partir de .nuspec ou d’un fichier projet. Avec Mono, la création d'un paquet à partir d'un fichier de projet n'est pas prise en charge.
push Publication Tous Publie un package dans une source de packages.
config Tous Tous Obtient ou définit des valeurs de configuration NuGet.
help or ? Tous Tous Affiche des informations d'aide ou l'aide d'une commande.
locals Consommation 3.3+ Liste les emplacements des dossiers global-packages, http-cache et temp et efface le contenu de ces dossiers.
restore Consommation 2.7+ Restaure tous les packages référencés par le format de gestion des packages en cours d’utilisation. Lors de l’exécution sur Mono, la restauration de packages au format PackageReference n’est pas prise en charge.
setapikey Publication, consommation Tous Enregistre une clé API pour une source de package donnée lorsque cette source de package nécessite une clé pour l’accès.
spec Création Tous Génère un fichier .nuspec, à l’aide de jetons si vous générez le fichier à partir d’un projet Visual Studio.
Commandes secondaires Rôles applicables Version de NuGet Description
add Publication 3.3+ Ajoute un package à une source de package non HTTP à l’aide d’une disposition hiérarchique. Pour les sources HTTP, utilisez push.
delete Publication Tous Supprime ou dérépertorie un package d’une source de package.
init Création 3.3+ Ajoute des packages d’un dossier à une source de package à l’aide d’une disposition hiérarchique.
install Consommation Tous Installe un package dans le projet actuel, mais ne modifie pas les projets ni les fichiers de référence.
list Consommation, peut-être publication Tous Affiche les packages à partir d’une source donnée.
mirror Publication Déconseillé dans la version 3.2+ Met en miroir un package et ses dépendances d’une source vers un référentiel cible.
search Consommation 5.8+ Recherche une source donnée à l’aide de la chaîne de requête fournie.
sources Consommation, publication Tous Gère les sources de package dans les fichiers de configuration.
mise à jour Consommation Tous Met à jour les packages d'un projet avec les dernières versions disponibles. Non pris en charge lors de l’exécution sur Mono.

Différentes commandes utilisent différentes variables d’environnement.

Commandes CLI NuGet par rôles applicables :

Rôle Commandes
Consommation config, help, install, list, locals, restore, search, setapikey, sources, update
Création config, help, init, pack, spec
Publication add, config, delete, help, list, push, setapikey, sources

Les développeurs concernés uniquement par l’utilisation de packages, par exemple, n’ont besoin que de comprendre ce sous-ensemble de commandes NuGet.

Remarque

Les noms d’options de commande ne respectent pas la casse. Les options déconseillées ne sont pas incluses dans cette référence, telles que NoPrompt (remplacées par NonInteractive) et Verbose (remplacées par Verbosity).

Localisation

NuGet.exe les messages d’avancement, d’avertissement et d’erreur sont traduits dans les mêmes paramètres régionaux que Visual Studio. NuGet.exe est fourni sous la forme d’un seul exe et, en raison de considérations de taille, seuls les messages les plus couramment exposés sont traduits dans toutes les langues.