Skip to content

Commit 2f8eb24

Browse files
authored
docs(core): add docs for tui options in nx.json (#31459)
This PR adds the missing `tui` property in `nx.json` on this page: https://nx.dev/reference/nx-json <img width="884" alt="Screenshot 2025-06-04 at 1 10 04 PM" src="https://github.com/user-attachments/assets/d7edb8dd-7b1a-4e3e-a738-4eb0dbb1feba" /> Preview: https://nx-dev-git-docs-add-tui-option-nrwl.vercel.app/reference/nx-json
1 parent 9715da7 commit 2f8eb24

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

docs/shared/reference/nx-json.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,11 @@ The following is an expanded example showing all options. Your `nx.json` will li
6565
"buildable": true
6666
}
6767
},
68-
"extends": "nx/presets/npm.json"
68+
"extends": "nx/presets/npm.json",
69+
"tui": {
70+
"enabled": true,
71+
"autoExit": true
72+
}
6973
}
7074
```
7175

@@ -425,7 +429,8 @@ Some important changes in Nx 21:
425429
- The `release.version.generatorOptions` object has been removed, with its properties moved to the top level of `release.version`
426430
- `packageRoot` has been replaced by the more flexible `manifestRootsToUpdate` array
427431
- Ecosystem-specific options like `skipLockFileUpdate` are now under `versionActionsOptions`
428-
- `preserveLocalDependencyProtocols` (also now at the top level)now defaults to `true` (previously `false` when it was a generatorOption)
432+
- `preserveLocalDependencyProtocols` (also now at the top level) now defaults to `true` (previously `false` when it was a generatorOption)
433+
- `tui` object has been added to control the new [Terminal UI](/recipes/running-tasks/terminal-ui)
429434

430435
### Changelog
431436

@@ -606,3 +611,19 @@ Valid values for `maxCacheSize` can be specified in bytes, kilobytes (KB), megab
606611
```
607612

608613
Regardless of the `maxCacheSize` setting, Nx will remove cache entries that have not been accessed in the last 7 days.
614+
615+
## TUI
616+
617+
The `tui` property in `nx.json` configures the [Terminal UI](/recipes/running-tasks/terminal-ui). It allows you to enable or disable the TUI and configure its behavior.
618+
619+
```json {% fileName="nx.json" %}
620+
{
621+
"tui": {
622+
// Enable the Nx TUI
623+
"enabled": true,
624+
// Automatically exit the TUI when completed
625+
// Use a number to specify the seconds to keep the TUI open for after completion
626+
"autoExit": true
627+
}
628+
}
629+
```

0 commit comments

Comments
 (0)