Skip to content

completion

Generate shell completion scripts for NDCLI. Tab completion helps you discover commands, flags, and arguments quickly.

ShellCommand
Bashndcli completion bash
Zshndcli completion zsh
Fishndcli completion fish
PowerShellndcli completion powershell

Generate the autocompletion script for Bash.

Terminal window
ndcli completion bash

Add to your ~/.bashrc:

Terminal window
source <(ndcli completion bash)

Or save to the completions directory:

Terminal window
ndcli completion bash > /etc/bash_completion.d/ndcli
  • Requires bash-completion package
  • Changes take effect in new shell sessions
  • Run source ~/.bashrc to apply immediately

Generate the autocompletion script for Zsh.

Terminal window
ndcli completion zsh

Add to your ~/.zshrc:

Terminal window
source <(ndcli completion zsh)

Or save to your completions directory:

Terminal window
ndcli completion zsh > "${fpath[1]}/_ndcli"

Ensure compinit is initialized. Add to ~/.zshrc before sourcing completions:

Terminal window
autoload -Uz compinit && compinit

Generate the autocompletion script for Fish shell.

Terminal window
ndcli completion fish

Add to your ~/.config/fish/config.fish:

Terminal window
ndcli completion fish | source

Or save to completions directory:

Terminal window
ndcli completion fish > ~/.config/fish/completions/ndcli.fish

Generate the autocompletion script for PowerShell.

Terminal window
ndcli completion powershell

Add to your PowerShell profile ($PROFILE):

Terminal window
ndcli completion powershell | Out-String | Invoke-Expression

To load for every session, add the above line to your profile:

Terminal window
notepad $PROFILE

Once installed, tab completion provides:

Terminal window
ndcli <TAB>
Terminal window
ndcli device <TAB>
Terminal window
ndcli device list --<TAB>
Terminal window
ndcli device list --status <TAB>
ndcli device list --format <TAB>

  1. Restart your shell - New completion scripts need a fresh shell
  2. Check if script is loaded - Verify the source command is in your rc file
  3. Check bash-completion - Ensure bash-completion package is installed

If completions are slow, they may be fetching data from the API. Consider:

  • Checking network connectivity
  • Ensuring you’re authenticated (ndcli auth show)

Regenerate completions after NDCLI updates:

Terminal window
ndcli completion bash > ~/.local/share/bash-completion/completions/ndcli
ndcli completion zsh > "${fpath[1]}/_ndcli"
ndcli completion fish > ~/.config/fish/completions/ndcli.fish