Skip to content

Tab completion (optional)

Tab-completion for crm in bash, zsh, fish, or PowerShell.

The REPL already tab-completes — nothing to install

This page is about completing crm ... at your OS shell prompt. The interactive crm repl has its own built-in Tab-completion (commands, flags, profile names, entity names, and attribute names after --select) that needs no setup — see how-to: completion.

crm completion install --shell zsh

This writes the completion script under ~/.crm/completion/ and prints one line to add to your shell startup file. It never edits the file for you — copy the printed line yourself, then restart your shell:

  • zsh → ~/.zshrc: source ~/.crm/completion/crm.zsh
  • bash → ~/.bashrc: source ~/.crm/completion/crm.bash
  • fish → ~/.config/fish/config.fish: source ~/.crm/completion/crm.fish
  • PowerShell → $PROFILE: . ~/.crm/completion/crm.ps1 (requires --shell powershell — it can't be autodetected)

--shell defaults to autodetecting $SHELL. A later crm self-update regenerates the cached script automatically. See how-to: completion for --path, show, and the "why a cached file, not eval" note.

Entity-set names complete from the metadata cache

Positional entity-set arguments — crm entity get <TAB>, crm query odata <TAB>, etc. — complete from the on-disk metadata cache. This is a local read with no network call (completion must stay instant), so the names appear only once that cache is warm. It fills the first time crm resolves entity names against a profile; to populate it up front, run any command once with --cache-metadata (e.g. crm --cache-metadata metadata entities). Until then, entity-set completion returns nothing rather than going to the server.