nx/docs/generated/cli/init.md

1.5 KiB

title description
init - CLI command 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.

Usage

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
--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.