Référence des commandes CLI de NestJS

nest new

Crée un nouveau projet Nest (mode standard).

$ nest new <name> [options]
$ nest n <name> [options]

Description

Crée et initialise un nouveau projet Nest. Invite à choisir un gestionnaire de paquets.

Crée un dossier avec le nom donné <name>
Remplit le dossier avec des fichiers de configuration
Crée des sous-dossiers pour le code source (/src) et les tests de bout en bout (/test)
Remplit les sous-dossiers avec des fichiers par défaut pour les composants d’application et les tests

Arguments

Argument	Description
`<name>`	Le nom du nouveau projet

Options

Option	Description
`--dry-run`	Signale les changements qui seraient effectués, mais ne modifie pas le système de fichiers. Alias : `-d`
`--skip-git`	Ignore l’initialisation du dépôt git. Alias : `-g`
`--skip-install`	Ignore l’installation des paquets. Alias : `-s`
`--package-manager [package-manager]`	Spécifie le gestionnaire de paquets. Utilisez `npm`, `yarn` ou `pnpm`. Le gestionnaire de paquets doit être installé globalement. Alias : `-p`
`--language [language]`	Spécifie le langage de programmation (`TS` ou `JS`). Alias : `-l`
`--collection [collectionName]`	Spécifie la collection de schématiques. Utilisez le nom du paquet du paquet npm installé contenant le schématique. Alias : `-c`
`--strict`	Démarre le projet avec les drapeaux du compilateur TypeScript suivants activés : `strictNullChecks`, `noImplicitAny`, `strictBindCallApply`, `forceConsistentCasingInFileNames`, `noFallthroughCasesInSwitch`

nest generate

Génère et/ou modifie des fichiers basés sur une schématique.

$ nest generate <schematic> <name> [options]
$ nest g <schematic> <name> [options]

Arguments

Argument	Description
`<schematic>`	Le schématique ou `collection:schematic` à générer. Consultez le tableau ci-dessous pour les schématiques disponibles.
`<name>`	Le nom du composant généré.

Schématiques

Nom	Alias	Description
`app`		Génère une nouvelle application dans un monorepo (convertissant en monorepo si c’est une structure standard).
`library`	`lib`	Génère une nouvelle bibliothèque dans un monorepo (convertissant en monorepo si c’est une structure standard).
`class`	`cl`	Génère une nouvelle classe.
`controller`	`co`	Génère une déclaration de contrôleur.
`decorator`	`d`	Génère un décorateur personnalisé.
`filter`	`f`	Génère une déclaration de filtre.
`gateway`	`ga`	Génère une déclaration de passerelle.
`guard`	`gu`	Génère une déclaration de garde.
`interface`	`itf`	Génère une interface.
`interceptor`	`itc`	Génère une déclaration d’intercepteur.
`middleware`	`mi`	Génère une déclaration de middleware.
`module`	`mo`	Génère une déclaration de module.
`pipe`	`pi`	Génère une déclaration de pipe.
`provider`	`pr`	Génère une déclaration de fournisseur.
`resolver`	`r`	Génère une déclaration de résolveur.
`resource`	`res`	Génère une nouvelle ressource CRUD. Consultez le générateur CRUD (resource) pour plus de détails. (TS seulement)
`service`	`s`	Génère une déclaration de service.

Options

Option	Description
`--dry-run`	Signale les changements qui seraient effectués, mais ne modifie pas le système de fichiers. Alias : `-d`
`--project [project]`	Projet auquel l’élément doit être ajouté. Alias : `-p`
`--flat`	Ne pas générer de dossier pour l’élément.
`--collection [collectionName]`	Spécifie la collection de schématiques. Utilisez le nom du paquet du paquet npm installé contenant le schématique. Alias : `-c`
`--spec`	Force la génération de fichiers spec (par défaut)
`--no-spec`	Désactive la génération de fichiers spec

nest build

Compile une application ou un espace de travail dans un dossier de sortie.

De plus, la commande build est responsable de :

mapper les chemins (si des alias de chemin sont utilisés) via tsconfig-paths
annoter les DTOs avec des décorateurs OpenAPI (si le plugin CLI @nestjs/swagger est activé)
annoter les DTOs avec des décorateurs GraphQL (si le plugin CLI @nestjs/graphql est activé)

$ nest build <name> [options]

Arguments

Argument	Description
`<name>`	Le nom du projet à compiler.

Options

Option	Description
`--path [path]`	Chemin vers le fichier `tsconfig`. Alias `-p`
`--config [path]`	Chemin vers le fichier de configuration `nest-cli`. Alias `-c`
`--watch`	Exécute en mode surveillance (live-reload). Si vous utilisez `tsc` pour la compilation, vous pouvez taper `rs` pour redémarrer l’application (lorsque l’option `manualRestart` est définie sur `true`). Alias `-w`
`--builder [name]`	Spécifie le créateur à utiliser pour la compilation (`tsc`, `swc` ou `webpack`). Alias `-b`
`--webpack`	Utilisez webpack pour la compilation (déprécié : utilisez `--builder webpack` à la place).
`--webpackPath`	Chemin vers la configuration webpack.
`--tsc`	Force l’utilisation de `tsc` pour la compilation.

nest start

Compile et exécute une application (ou un projet par défaut dans un espace de travail).

$ nest start <name> [options]

Arguments

Argument	Description
`<name>`	Le nom du projet à exécuter.

Options

Option	Description
`--path [path]`	Chemin vers le fichier `tsconfig`. Alias `-p`
`--config [path]`	Chemin vers le fichier de configuration `nest-cli`. Alias `-c`
`--watch`	Exécute en mode surveillance (live-reload) Alias `-w`
`--builder [name]`	Spécifiez le créateur à utiliser pour la compilation (`tsc`, `swc`, ou `webpack`). Alias `-b`
`--preserveWatchOutput`	Conserve la sortie de la console obsolète en mode surveillance au lieu de vider l’écran. (mode de surveillance `tsc` uniquement)
`--watchAssets`	Exécute en mode surveillance (live-reload), en surveillant les fichiers non-TS (assets). Consultez [Assets] pour plus de détails.
`--debug [hostport]`	Exécute en mode débogage (avec l’option —inspect) Alias `-d`
`--webpack`	Utilisez webpack pour la compilation. (déprécié : utilisez `--builder webpack` à la place)
`--webpackPath`	Chemin vers la configuration webpack.
`--tsc`	Force l’utilisation de `tsc` pour la compilation.

nest add

Importe une bibliothèque qui a été conditionnée en tant que bibliothèque nest, en exécutant son schématique d’installation.

$ nest add <name> [options]

Arguments

Argument	Description
`<name>`	Le nom de la bibliothèque à importer.

nest info

Affiche des informations sur les paquets nest installés et d’autres informations système utiles. Par exemple :

$ nest info

 _   _             _      ___  _____  _____  _     _____
| | | |           | |    |  _ \_   _|/ ____|| |   |  __ \
| |_| |_   _     | |    | |_) || | | (___ | |_  | |  | |
|  _  | | | |    | |    |  _ < | |  \___ \| __| | |  | |
| | | | |_| |   _| |    | |_) || |_ ____) | |_  | |__| |
|_| |_|\__, | |__| |   |____/_____|_____/ \__| |_____/
       __/ |
      |___/

[Informations système]
Version OS : macOS High Sierra
Version NodeJS : v16.18.0
[Informations Nest]
version microservices : 10.0.0
version websockets : 10.0.0
version testing : 10.0.0
version common : 10.0.0
version core : 10.0.0