From e797455e933b696e7e3fc3f950ac1bb1dac2bad4 Mon Sep 17 00:00:00 2001 From: Kamil Mysliwiec Date: Thu, 25 May 2023 12:36:03 +0200 Subject: [PATCH] Update overview.md --- content/cli/overview.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/content/cli/overview.md b/content/cli/overview.md index 3514755bdd..2675cd5255 100644 --- a/content/cli/overview.md +++ b/content/cli/overview.md @@ -2,16 +2,6 @@ The [Nest CLI](https://github.com/nestjs/nest-cli) is a command-line interface tool that helps you to initialize, develop, and maintain your Nest applications. It assists in multiple ways, including scaffolding the project, serving it in development mode, and building and bundling the application for production distribution. It embodies best-practice architectural patterns to encourage well-structured apps. -#### Requirements - -Nest CLI requires a Node.js binary built with [internationalization support](https://nodejs.org/api/intl.html) (ICU), such as the official binaries from the [Node.js project page](https://nodejs.org/en/download). If you encounter errors related to ICU, check that your binary meets this requirement. - -```bash -node -p process.versions.icu -``` - -If the command prints `undefined`, your Node.js binary has no internationalization support. - #### Installation **Note**: In this guide we describe using [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) to install packages, including the Nest CLI. Other package managers may be used at your discretion. With npm, you have several options available for managing how your OS command line resolves the location of the `nest` CLI binary file. Here, we describe installing the `nest` binary globally using the `-g` option. This provides a measure of convenience, and is the approach we assume throughout the documentation. Note that installing **any** `npm` package globally leaves the responsibility of ensuring they're running the correct version up to the user. It also means that if you have different projects, each will run the **same** version of the CLI. A reasonable alternative is to use the [npx](https://github.com/npm/cli/blob/latest/docs/lib/content/commands/npx.md) program, built into the `npm` cli (or similar features with other package managers) to ensure that you run a **managed version** of the Nest CLI. We recommend you consult the [npx documentation](https://github.com/npm/cli/blob/latest/docs/lib/content/commands/npx.md) and/or your DevOps support staff for more information. @@ -106,3 +96,13 @@ See [usage](/cli/usages) for detailed descriptions for each command. | `start` | | Compiles and runs an application (or default project in a workspace). | | `add` | | Imports a library that has been packaged as a **nest library**, running its install schematic. | | `info` | `i` | Displays information about installed nest packages and other helpful system info. | + +#### Requirements + +Nest CLI requires a Node.js binary built with [internationalization support](https://nodejs.org/api/intl.html) (ICU), such as the official binaries from the [Node.js project page](https://nodejs.org/en/download). If you encounter errors related to ICU, check that your binary meets this requirement. + +```bash +node -p process.versions.icu +``` + +If the command prints `undefined`, your Node.js binary has no internationalization support.