Configuration Automation - Ping CLI

pingcli completion

Prints shell completion scripts

Synopsis

To load completions:

Bash:

$ source <(pingcli completion bash)
# To load completions for each session, execute once:
# Linux:
$ pingcli completion bash > /etc/bash_completion.d/pingcli
# macOS:
$ source <(pingcli completion zsh)

Zsh:

# If shell completion is not already enabled in your environment,
# you will need to enable it.  You can execute the following once:
$ echo "autoload -U compinit; compinit" >> ~/.zshrc
# To load completions for each session, execute once:
$ pingcli completion zsh > "${fpath[1]}/_pingcli"
# You will need to start a new shell for this setup to take effect.

fish:

$ pingcli completion fish | source
# To load completions for each session, execute once:
$ pingcli completion fish > ~/.config/fish/completions/pingcli.fish

PowerShell:

PS> pingcli completion powershell | Out-String | Invoke-Expression
# To load completions for every new session, run:
PS> pingcli completion powershell > pingcli.ps1
# and source this file from your PowerShell profile.
pingcli completion [SHELL]

Examples

  Generate a Bash completion script and load it into the current shell session.
    pingcli completion bash | source /dev/stdin

  Generate a Zsh completion script and save it for future sessions.
    pingcli completion zsh > "${fpath[1]}/_pingcli"

  Generate a Fish completion script and load it into the current shell session.
    pingcli completion fish | source

  Generate a PowerShell completion script and load it into the current session.
    pingcli completion powershell | Out-String | Invoke-Expression

Options inherited from parent commands

  -C, --config string           The relative or full path to a custom Ping CLI configuration file. (default $HOME/.pingcli/config.yaml)
  -D, --detailed-exitcode       Enable detailed exit code output. (default false) 0 - pingcli command succeeded with no errors or warnings. 1 - pingcli command failed with errors. 2 - pingcli command succeeded with warnings.
  -O, --output-format string    Specify the console output format. (default text) Options are: json, ndjson, ndjson-wrapped, text.
  -P, --profile string          The name of a configuration profile to use.
      --debug                   Enable debug output for error messages, including stack traces and transaction IDs. (default false)
      --log-file string         Write logs to a file at the given path. File logging is disabled when not set.
      --log-file-level string   Set the file log level. Options are: DEBUG, INFO, WARN, ERROR. (default DEBUG)
      --log-level string        Set the console log level. Options are: DEBUG, INFO, WARN, ERROR. (default WARN)
      --no-color                Disable text output in color. (default false)
      --query string            JMESPath expression to filter JSON output. Requires -O json, ndjson, or ndjson-wrapped. Example: --query 'data[?enabled].name'

More information

  • pingcli - A CLI tool for managing the configuration of Ping Identity products.