CheatNx Monorepo build system
Light · Postcard
102 × 152 mm · PDF
Dark · Postcard
102 × 152 mm · PDF
Ink saver · Postcard
102 × 152 mm · PDF
Light · A4 landscape
297 × 210 mm · PDF
Dark · A4 landscape
297 × 210 mm · PDF
Ink saver · A4 landscape
297 × 210 mm · PDF
Light · A3 landscape
420 × 297 mm · PDF
Dark · A3 landscape
420 × 297 mm · PDF
Ink saver · A3 landscape
420 × 297 mm · PDF
Start here
npx nx <target> <project>
Run one task
nx run-many -t build
Run in all projects
nx affected -t test
Only what changed
nx graphSee the project graph
nx show projects
List projects
nx g <plugin>:<generator>
Scaffold code
nx resetClear cache and daemon
nx <target> <project> --skipNxCache
Bypass the cache
Concepts
- Project graph projects + deps
- Task graph what to run
- Cache hit: replay
- Run parallel
Run tasks
nx run <project>:<target>
Run one target
nx <target> <project>
Shorthand for run
nx run <p>:<t>:<config>
Use a configuration
nx <target> <project> -c <config>
Set configuration by flag
nx run-many -t <target>
Run a target everywhere
nx run-many -t <t1> <t2>
Run several targets
nx run-many -t <target> -p <a> <b>
Limit to projects
nx run-many -t <target> -p
"tag:<tag>"
Select projects by tag
nx run-many -t <target> --exclude <p>
Skip projects
nx affected -t <target>
Only affected projects
nx affected -t <target> --base=<ref>
--head=<ref>
Compare two refs
nx affected -t <target> --uncommitted
Include local edits
nx affected -t <target> --explain=stdout
Why was it affected
--parallel=<n>
Max concurrent tasks (default 3)
--parallel=false
Run one task at a time
--nxBailStop after first failure
--outputStyle=<style>
tui, stream, static, summary
--graphShow the task graph, no run
nx watch --all -- <cmd>
Rerun a command on change
Inspect
nx graphOpen the project graph
nx graph --focus=<project>
One project and neighbours
nx graph --affected
Highlight affected
nx graph --view=tasks --targets=<t>
Task graph view
nx graph --file=<out>.json
Write graph to file
nx show projects
List projects
nx show projects --withTarget=<t>
Projects with a target
nx show projects --type=<app|lib|e2e>
Filter by type
nx show projects --affected
Only affected ones
nx show project <project>
Resolved project config
nx show target inputs <project>:<t>
What feeds the hash
nx show target outputs <project>:<t>
What gets cached
nx listInstalled plugins
nx list <plugin>
Plugin generators and executors
Generate and set up
nx g <plugin>:<generator> <name>
Run a generator
nx g <plugin>:<generator> --dry-run
Preview file changes
nx g @nx/js:library <name>
New library
nx add <package>
Install and set up a plugin
nx initAdd Nx to an existing repo
nx syncRun sync generators
nx sync:checkFail if out of sync (CI)
nx format:writeFormat affected files
nx format:checkCheck formatting (CI)
nx migrate latest
Plan an upgrade
nx migrate --runMigrations
Apply migrations.json
nx migrate latest --createCommits
Commit per migration
Cache and daemon
nx resetClear cache, daemon, graph data
nx reset --onlyCache
Clear only local cache
nx reset --onlyDaemon
Restart the daemon
--skipNxCacheBypass local cache for a run
--skipRemoteCache
Bypass remote cache
NX_DAEMON=falseDisable daemon for a run
nx connectConnect to Nx Cloud
Config files
project.json: targets
Per-project task definitions
project.json: tags
Labels for tag: selectors
targets.<t>.executor
What the task runs
targets.<t>.command
Plain shell command
targets.<t>.dependsOn
Tasks that run first
"^build" in dependsOn
Same target in dependencies
targets.<t>.inputs
Files and vars that affect hash
targets.<t>.outputs
Paths to cache
targets.<t>.cache: true
Make a target cacheable
targets.<t>.configurations
Named option sets
nx.json: targetDefaults
Shared target settings
nx.json: namedInputs
Reusable input groups
nx.json: plugins
Inferred targets from tools
nx.json: defaultBase
Base branch for affected
nx.json: nxCloudId
Remote cache workspace
Recipes
{ "defaultBase": "main", "targetDefaults": { "build": { "dependsOn": ["^build"], "cache": true, "outputs": ["{projectRoot}/dist"] }, "test": { "cache": true } }}nx affected -t lint test build --base=origin/main# shallow clones hide history:# fetch full history (fetch-depth: 0)nx migrate latestnpm installnx migrate --runMigrations# review diff, then delete migrations.jsonnx show target inputs <project>:buildnx build <project> --skipNxCachenx reset
