canvas completion

canvas completion¶

Generate shell completion scripts

Synopsis¶

Generate completion scripts for various shells.

To enable shell completion, follow these instructions:

Bash: $ canvas completion bash > /etc/bash_completion.d/canvas

# Or for current user only: $ canvas completion bash > ~/.local/share/bash-completion/completions/canvas $ source ~/.bashrc

Zsh: $ canvas completion zsh > "${fpath[1]}/_canvas"

# Or add to your .zshrc: $ canvas completion zsh > ~/.canvas-completion.zsh $ echo "source ~/.canvas-completion.zsh" >> ~/.zshrc $ source ~/.zshrc

Fish: $ canvas completion fish > ~/.config/fish/completions/canvas.fish $ source ~/.config/fish/config.fish

PowerShell: PS> canvas completion powershell > canvas.ps1 PS> . .\canvas.ps1

# Or add to your PowerShell profile: PS> canvas completion powershell >> $PROFILE

canvas completion [bash|zsh|fish|powershell] [flags]

Options¶

  -h, --help   help for completion

Options inherited from parent commands¶

      --as-user int       Masquerade as another user (admin feature, requires permission)
      --columns strings   Select specific columns to display (comma-separated)
      --config string     config file (default is $HOME/.canvas-cli/config.yaml)
      --dry-run           Print curl commands instead of executing requests
      --filter string     Filter results by text (case-insensitive substring match)
      --instance string   Canvas instance URL (overrides config)
      --limit int         Limit number of results for list operations (0 = unlimited)
      --no-cache          Disable caching of API responses
  -o, --output string     Output format: table, json, yaml, csv (default "table")
      --show-token        Show actual token in dry-run output (default: redacted)
      --sort string       Sort results by field (prefix with - for descending, e.g., -name)
  -v, --verbose           Enable verbose output

canvas completion