ocm completion zsh

On this page

ocm completion zsh

Generate the autocompletion script for zsh

Synopsis

Generate the autocompletion script for the zsh shell.

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 in your current shell session:

source <(ocm completion zsh)

To load completions for every new session, execute once:

Linux:

ocm completion zsh > "${fpath[1]}/_ocm"

macOS:

ocm completion zsh > $(brew --prefix)/share/zsh/site-functions/_ocm

You will need to start a new shell for this setup to take effect.

ocm completion zsh [flags]

Options

  -h, --help              help for zsh
      --no-descriptions   disable completion descriptions

Options inherited from parent commands

      --config string        supply configuration by a given configuration file.
                             By default (without specifying custom locations with this flag), the file will be read from one of the well known locations:
                             1. The path specified in the OCM_CONFIG_PATH environment variable
                             2. The XDG_CONFIG_HOME directory (if set), or the default XDG home ($HOME/.config), or the user's home directory
                             - $XDG_CONFIG_HOME/ocm/config
                             - $XDG_CONFIG_HOME/.ocmconfig
                             - $HOME/.config/ocm/config
                             - $HOME/.config/.ocmconfig
                             - $HOME/.ocm/config
                             - $HOME/.ocmconfig
                             3. The current working directory:
                             - $PWD/ocm/config
                             - $PWD/.ocmconfig
                             4. The directory of the current executable:
                             - $EXE_DIR/ocm/config
                             - $EXE_DIR/.ocmconfig
                             Using the option, this configuration file be used instead of the lookup above.
      --logformat enum       set the log output format that is used to print individual logs
                                json: Output logs in JSON format, suitable for machine processing
                                text: Output logs in human-readable text format, suitable for console output
                             (must be one of [json text]) (default text)
      --loglevel enum        sets the logging level
                                debug: Show all logs including detailed debugging information
                                info:  Show informational messages and above
                                warn:  Show warnings and errors only (default)
                                error: Show errors only
                             (must be one of [debug error info warn]) (default info)
      --logoutput enum       set the log output destination
                                stdout: Write logs to standard output
                                stderr: Write logs to standard error, useful for separating logs from normal output
                             (must be one of [stderr stdout]) (default stderr)
      --temp-folder string   Specify a custom temporary folder path for filesystem operations.

SEE ALSO

  • ocm completion - Generate the autocompletion script for the specified shell
Prev
ocm completion powershell
Next
ocm download