b6dc0d9e8e
Render links as links in command descriptions - in the terminal, links are listed as text - on the docs site, links are rendered as markdown links
28 lines
1.9 KiB
Markdown
28 lines
1.9 KiB
Markdown
---
|
|
title: 'init - CLI command'
|
|
description: 'Adds Nx to any type of workspace. It installs nx, creates an nx.json configuration file and optionally sets up remote caching. For more info, check https://nx.dev/recipes/adopting-nx.'
|
|
---
|
|
|
|
# init
|
|
|
|
Adds Nx to any type of workspace. It installs nx, creates an nx.json configuration file and optionally sets up remote caching. For more info, check [https://nx.dev/recipes/adopting-nx](/recipes/adopting-nx).
|
|
|
|
## Usage
|
|
|
|
```shell
|
|
nx init
|
|
```
|
|
|
|
Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`.
|
|
|
|
## Options
|
|
|
|
| Option | Type | Description |
|
|
| ------------------------ | ------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
| `--force` | boolean | Force the migration to continue and ignore custom webpack setup or uncommitted changes. Only for CRA projects. (Default: `false`) |
|
|
| `--help` | boolean | Show help. |
|
|
| `--interactive` | boolean | When false disables interactive input prompts for options. (Default: `true`) |
|
|
| `--nxCloud` | boolean | Set up distributed caching with Nx Cloud. |
|
|
| `--useDotNxInstallation` | boolean | Initialize an Nx workspace setup in the .nx directory of the current repository. (Default: `false`) |
|
|
| `--version` | boolean | Show version number. |
|