Why use the Nx CLI?
The Nx CLI isn't like most command lines that accomplishes a predefined task. Nx can be configured to work with different tools and even different languages.
Nx allows you to break up your codebase into different projects. The Nx CLI provides commands to operate and manage the different parts of the codebase. These commands fall into three categories:
- Acting on code (Build, Test, Serve)
- Modifying code
- Understanding the codebase
nx help command to see a full list of commands in the Nx CLI.
Acting on Code
nx run command executes a target on a single project. For convenience, you can also
nx [target] [project] which is an alias to
nx run [project]:[target].
nx run my-js-app:build nx build my-js-app
Nx also automatically caches the output of running targets so re-running the same target on the same project source code will be instant.
nx build is only an abstraction over what it means to "build" projects rather than tied to a certain
implementation. For instance, if you have a
project.json file defining
an executor, that executor will be invoked. If you don't specify an
executor for the build target,
nx build my-react-app will invoke the
build npm script in the project's folder. Every
argument you pass into
run will be forwarded to the executor or the npm script.
Along with running a target on a single project, Nx provides some commands to run the same target across multiple projects.
nx run-many command runs the same target name across a list of projects.
nx run-many --target=build --projects=app1,app2 nx run-many --target=test --all # Runs all projects that have a test target, use this sparingly.
nx affected command isolates the set projects that may have changed in behavior and
runs a target across them. This is more efficient than running all projects every time.
nx affected --target=build
nx generate command generates and modifies code.
nx generate @nrwl/js:lib my-lib nx generate @nrwl/react:lib shared-button nx generate @nrwl/react:storybook-configuration shared-button # Configures storybook for a UI library
nx generate is only an abstraction over generating code.
nx generate can generate anything you
want via generators. Generators can be installed as part of a
plugin or developed locally within an Nx workspace to fit the needs of your organization.
A workspace generator is a custom generator for your
nx generate workspace-generator my-generator generates a workspace generator which can be run with
nx workspace-generator command. This can be useful to allow your
organization to consistently generate projects according to your own standards.
nx workspace-generator my-generator
Upgrading a package is not always as simple as bumping the version in
nx migrate command facilitates not only managing package versions but also runs
migrations specified by package maintainers. See
the full guide to updating Nx.
nx migrate latest # Updates the version of Nx in `package.json` and schedules migrations to be run nx migrate --run-migrations # Runs the migrations scheduled by the previous command.
Understanding the codebase
Nx creates and maintains a project graph between projects based on import statements in your code and uses that information to run executors only on the affected projects in a codebase. A visual version of the project project graph is also available to help developers understand the architecture of the codebase.
nx graph command displays this project graph in a web browser for you to
Note: In older versions of Nx, the project graph was launched with
nx dep-graph. For backward compatibility, that command is aliased to
nx graph nx graph --watch # Updates the browser as code is changed nx affected:graph # Highlights projects which may have changed in behavior
nx list command lists the currently installed Nx plugins and other available plugins.
nx list command can list the generators and executors that are available for a plugin.
List installed plugins:
nx list nx list @nrwl/react # Lists capabilities in the @nrwl/react plugin
Common Environment Variables
There are some environment variables that you can set to log additional information from Nx.
- Setting NX_VERBOSE_LOGGING=true will print debug information useful for troubleshooting.
- Setting NX_PERF_LOGGING=true will print debug information useful for profiling executors and Nx itself.
- Setting NX_TASKS_RUNNER_DYNAMIC_OUTPUT=false will use non-dynamic terminal output strategy (what you see in CI), even when you terminal can support the dynamic version.