Logiciel - npm - Référence des commandes

npm install	Installe
npm

Syntaxe

npm install

npm install git-host:git-user/repo-name [-P|--save-prod|-D|--save-dev|-O|--save-optional] [-E|--save-exact] [-B|--save-bundle] [--no-save] [--dry-run]

npm install git remote url

npm install github:githubname/githubrepo[#commit-ish]

npm install gist:[githubname/]gistID[#commit-ish|#semver:semver]

npm install bitbucket:bitbucketname/bitbucketrepo[#commit-ish]

npm install gitlab:gitlabname/gitlabrepo[#commit-ish]

Paramètres

Nom	Description
@scope/]name	Ce paramètre permet de faire une installation de name@tag, où tag est la configuration de balise. Dans la plupart des cas, cela installera la version des modules marqués comme les plus récents dans le registre npm.
[@scope/]name@tag	Ce paramètre permet d'installer la version du paquet référencée par la balise spécifiée. Si la balise n'existe pas dans les données de registre pour ce paquet, cela échouera.
[@scope/]name@version	Ce paramètre permet d'installer la version spécifiée du paquet. Cela échouera si la version n'a pas été publiée dans le registre.
[@scope/]name@version range	Ce paramètre permet d'installer une version du paquet correspondant à l'intervalle de versions spécifiée. Cela suivra les mêmes règles de résolution des dépendances décrites dans package.json.
alias@npm:name	Ce paramètre permet d'installer un paquet sous un alias personnalisé. Permet plusieurs versions d'un paquet de même nom côte à côte, des noms d'importation plus pratiques pour les paquets avec des paquets par ailleurs longs et en utilisant des remplacements de git forks ou des paquets npm fourchus comme remplacements. Les alias ne fonctionnent que sur votre projet et ne renomme pas les paquets dans les dépendances transitives. Les alias doivent suivre les conventions de dénomination indiquées dans validate-npm-package-name.
folder	Ce paramètre permet d'installer le paquet dans le répertoire en tant que lien symbolique dans le projet en cours. Ses dépendances seront installées avant d'être liées. Si folder se trouve à l'intérieur de la racine de votre projet, ses dépendances peuvent être hissées au niveau supérieur node_modules comme elles le feraient pour d'autres types de dépendances.
git remote url	Ce paramètre permet d'installer le paquet à partir du fournisseur git hébergé, en le clonant avec git. Pour une URL à distance git complète, seule cette URL sera tentée.
scope	Ce paramètre optionnel permet d'indiquer que le paquet sera téléchargé à partir du registre associé à l'étendue spécifiée. Si aucun registre n'est associé à l'étendue donnée, le registre par défaut est utilisé. Si vous n'incluez pas le «@» dans votre nom de scope, le npm l'interprétera plutôt comme un dépôt GitHub.
tarball file	Ce paramètre permet d'installer un paquet se trouvant sur le système de fichiers. Remarque : si vous souhaitez simplement lier un répertoire dev à votre racine npm, vous pouvez le faire plus facilement en utilisant le lien npm.
tarball url	Ce paramètre permet de récupérer l'URL de l'archive tar, puis de l'installer. Afin de faire la distinction entre cette option et d'autres, le paramètre doit commencer par «http://» ou «https://».
-B	Ce paramètre permet d'indiquer que les dépendances enregistrées seront également ajoutées à votre liste `bundleDependencies`.
-D	Ce paramètre permet d'indiquer que le paquet apparaîtra dans vos `devDependencies`.
--dry-run	Ce paramètre permet de rapporter de la manière habituelle ce que l'installation aurait fait sans rien installer.
-E	Ce paramètre permet d'indiquer que les dépendances enregistrées seront configurées avec une version exacte plutôt que d'utiliser l'opérateur d'intervalle semver par défaut de npm.
-f	Ce paramètre permet de forcer npm à récupérer les ressources à distances même si une copie locale existe sur le disque.
--force	Ce paramètre permet de forcer npm à récupérer les ressources à distances même si une copie locale existe sur le disque.
-g	Ce paramètre permet d'obliger npm à installer le paquet globalement plutôt que localement.
--global	Ce paramètre permet d'obliger npm à installer le paquet globalement plutôt que localement.
--global-style	Ce paramètre permet d'obliger npm à installer le paquet dans votre dossier node_modules local avec la même disposition qu'il utilise avec le dossier global node_modules. Seules vos dépendances directes s'affichent dans node_modules et tout ce dont elles dépendent sera aplati dans leurs dossiers node_modules. Cela éliminera évidemment certains dédoublements.
--ignore-scripts	Ce paramètre permet d'empêcher npm d'exécuter les scripts définis dans package.json.
--legacy-bundling	Ce paramètre permet d'obliger npm à installer le paquet de telle sorte que les versions de npm antérieures à 1.4, telles que celle incluse avec le noeud 0.8, puissent installer le paquet. Cela élimine toute déduplication automatique.
--link	Ce paramètre permet d'obliger npm à lier les installations globales à l'espace local dans certains cas.
--no-audit	Ce paramètre permet de désactiver l'envoi de rapports d'audit aux registres configurés.
--no-bin-links	Ce paramètre permet d'empêcher npm de créer des liens symboliques pour les binaires que le paquet pourrait contenir.
--nodedir=/path/to/node/source	Ce paramètre permet à npm de trouver le code source du noeud afin que npm puisse compiler des modules natifs.
--no-fund	Ce paramètre permet de masquer le message affiché à la fin de chaque installation reconnaissant le nombre de dépendances à la recherche de financement.
--no-optional	Ce paramètre permet d'empêcher l'installation des dépendances facultatives.
--no-package-lock	Ce paramètre permet d'empêcher npm de créer un fichier package-lock.json. Si pendant l'exécution avec le npm, elle a package-lock de désactivé, elle n'élague pas automatiquement vos modules de noeud lors de l'installation.
--no-shrinkwrap	Ce paramètre permet d'indiquer qu'il faut ignorer le verrou de paquet ou un fichier shrinkwrap disponible et utiliser le package.json à la place.
-O	Ce paramètre permet d'indiquer que le paquet apparaîtra dans vos `optionalDependencies`.
--only={prod[uction]\|dev[elopment]}	Ce paramètre permet d'entraîner l'installation soit uniquement de devDependencies, soit uniquement de non-devDependencies, quel que soit NODE_ENV.
-P	Ce paramètre permet d'indiquer que le paquet apparaîtra dans vos `dependencies`. Il s'agit de la valeur par défaut sauf si «-D» ou «-O» sont présents.
--package-lock-only	Ce paramètre permet de ne pas mettra à jour que package-lock.json, au lieu de vérifier node_modules et de télécharger les dépendances.
--save-bundle	Ce paramètre permet d'indiquer que les dépendances enregistrées seront également ajoutées à votre liste `bundleDependencies`.
--save-dev	Ce paramètre permet d'indiquer que le paquet apparaîtra dans vos `devDependencies`.
--save-exact	Ce paramètre permet d'indiquer que les dépendances enregistrées seront configurées avec une version exacte plutôt que d'utiliser l'opérateur d'intervalle semver par défaut de npm.
--save-optional	Ce paramètre permet d'indiquer que le paquet apparaîtra dans vos `optionalDependencies`.
--save-prod	Ce paramètre permet d'indiquer que le paquet apparaîtra dans vos `dependencies`. Il s'agit de la valeur par défaut sauf si «-D» ou «-O» sont présents.
--tag	Ce paramètre permet d'indiquer si une balise avec le nom donné existe, alors la version balisée est préférée aux versions plus récentes. Ce paramètre est appliqué à toutes les cibles d'installation spécifiées.
bitbucket:bitbucketname/bitbucketrepo[#commit-ish]	Ce paramètre permet d'installer le paquet sur «https://bitbucket.org/bitbucketname/bitbucketrepo» en essayant de le cloner à l'aide de git.
gist:[githubname/]gistID[#commit-ish\|#semver:semver]	Ce paramètre permet d'installer le paquet sur «https://gist.github.com/gistID» en essayant de le cloner à l'aide de git. Le nom d'utilisateur GitHub associé à l'essentiel est facultatif et ne sera pas enregistré dans package.json.
github:githubname/githubrepo[#commit-ish]	Ce paramètre permet d'installer le paquet sur «https://github.com/githubname/githubrepo» en essayant de le cloner à l'aide de git.
gitlab:gitlabname/gitlabrepo[#commit-ish]	Ce paramètre permet d'installer le paquet sur «https://gitlab.com/gitlabname/gitlabrepo» en essayant de le cloner à l'aide de git.

Description

Cette commande permet d'installer un paquet.

Remarques

La commande npm install installe un paquet et tous les paquets dont il dépend. Si le paquet a un fichier package-lock ou shrinkwrap, l'installation des dépendances sera pilotée par cela, avec un npm-shrinkwrap.json ayant la priorité si les deux fichiers existent. Un paquet est : un dossier contenant un programme décrit par un fichier package.json, une archive tar contenant un gzip, une URL se résolvant, un name@version étant publié sur le registre, un name@tag (voir npm dist-tag) pointant vers quelque chose, un name ayant une balise latest satisfaisante ou une git remote url se résolvant. Même si vous ne publiez jamais votre paquet, vous pouvez toujours bénéficier de nombreux avantages de l'utilisation de npm si vous souhaitez simplement écrire un programme de noeud, et peut-être si vous voulez également pouvoir l'installer facilement ailleurs après l'avoir emballé dans une archive tar.
La commande npm install dans le répertoire du paquet sans paramètres permet d'installer les dépendances dans le dossier local node_modules. En mode global (c'est-à-dire avec -g ou --global ajouté à la commande), il installe le contexte du paquet actuel (c'est-à-dire le répertoire de travail actuel) en tant que paquet global. Par défaut, npm install installera tous les modules répertoriés comme dépendances dans package.json. Avec le drapeau --production (ou lorsque la variable d'environnement NODE_ENV est définie sur production), la commande npm n'installera pas les modules répertoriés dans devDependencies. Pour installer tous les modules répertoriés dans les dépendances et devDependencies lorsque la variable d'environnement NODE_ENV est définie sur production, vous pouvez utiliser --production=false. Le drapeau --production n'a aucune signification particulière lors de l'ajout d'une dépendance à un projet.
Limitations de l'algorithme d'installation de npm : Le npm refusera d'installer tout paquet avec un nom identique au paquet actuel. Cela peut être remplacé avec le paramètre --force, mais dans la plupart des cas, il peut simplement être résolu en modifiant le nom du paquet local. Il existe des cas extrêmes très rares et pathologiques où un cycle peut amener npm à essayer d'installer un arbre sans fin de paquets. Voici le cas le plus simple :

A → B → A' → B' → A → B → A' → B' → A → ...

où A est une version d'un paquet et A' est une version différente du même paquet. Étant donné que B dépend d'une version de A différente de celle se trouvant déjà dans l'arborescence, il doit installer une copie distincte. Il en va de même pour A', devant installer B'. Parce que B' dépend de la version originale de A, ayant été remplacée, le cycle tombe en régression infinie. Pour éviter cette situation, npm refuse catégoriquement d'installer toute name@version déjà présente n'importe où dans l'arborescence des ancêtres du dossier de paquet. Une solution plus correcte, mais plus complexe, consisterait à créer un lien symbolique entre la version existante et le nouvel emplacement.

Si après avoir exécuter la commande npm install, vous avez obtenir plein de message de vulnérabilité, vous pouvez toujours exécutez la commande suivante pour corriger ses vulnérabilités :

npm audit fix --force

Exemples

L'exemple suivant permet d'installer Yarn :

npm install -g yarn

L'exemple suivant permet d'installer Gulp.js :

npm install -g gulp-cli

L'exemple suivant permet d'installer Angular CLI :

npm install -g @angular/cli

Dernière mise à jour : Lundi, le 14 Décembre 2020

Section courante

A propos

Section administrative du site

npm install

Syntaxe

Paramètres

Description

Remarques

Exemples