This plugin bring Nx autocompletion to Zsh.
-
β Dynamic command & option parsing Automatically discovers and updates completions from
nx --help
output -
π Intelligent caching = blazing fast completions Leverages Nxβs project graph cache and memoized command parsing
-
π§ Workspace-aware, always up-to-date Auto-syncs completions with your Nx version, project executors, and custom generators
-
π§© Deep integration with Nx executors Extracts and completes custom workspace commands, targets, and options
-
β¨ Smart autocompletion Supports arguments, flags, projects, targets, and generatorsβall in context
-
π¦ Version flexibility Works seamlessly across different Nx workspace versions
Install jq
dependency:
apt install jq
On MacOS you can install with:
brew install jq
Note:
jq
is a lightweight command-line JSON processor used to manipulate the workspace graph.
As an Oh My ZSH! custom plugin
Clone the repository into the custom plugins directory:
git clone git@github.com:jscutlery/nx-completion.git ~/.oh-my-zsh/custom/plugins/nx-completion
Then load it as a plugin in your .zshrc
:
plugins+=(nx-completion)
Clone this repository somewhere (~/.nx-completion
for example):
git clone git@github.com:jscutlery/nx-completion.git ~/.nx-completion
Then source it in your .zshrc
:
source ~/.nx-completion/nx-completion.plugin.zsh
When reinstalling or updating the nx-completion plugin, you may need to flush the zsh completion cache to ensure you're using the latest version.
The simplest way to clear the zsh completion cache:
# Clear zsh completion cache and rebuild
rm -rf ~/.zcompdump* && autoload -U compinit && compinit -D
Run the included script for automated cache clearing:
# Make executable and run
chmod +x clear-cache.zsh
./clear-cache.zsh
This repository includes a comprehensive test environment in the test/
directory with simplified project structures for easy testing and development.
test/
βββ .nx/workspace-data/project-graph.json # Main test graph (.nodes structure)
βββ nx.json # Nx workspace config
βββ project-graph-nested.json # Test graph (.graph.nodes structure)
βββ test-completion.zsh # Automated test script
βββ test-cache.zsh # Cache performance test script
βββ PERFORMANCE-TESTING.md # Real-world performance testing guide
βββ README.md # Test environment docs
# Run automated tests
cd test && ./test-completion.zsh
# Test caching performance
cd test && ./test-cache.zsh
# Interactive completion testing
cd test
source ../nx-completion.plugin.zsh
nx <TAB> # Test completions
# Performance testing guide
cd test && cat PERFORMANCE-TESTING.md
The test environment includes 5 projects (frontend-app, backend-api, shared-utils, ui-components, data-access) with realistic Nx configurations and supports testing both JSON structure formats.
This project is MIT licensed.