modzy completion

Generate an autocompletion script

$ modzy completion [command] generates the autocompletion script for modzy for the specified shell.

Command within Completion Command Group

Description

bash

Generate the autocompletion script for bash

fish

Generate the autocompletion script for fish

powershell

Generate the autocompletion script for powershell

zsh

Generate the autocompletion script for zsh

Flags
-h, --help help for completion

Usage

Bash command

$ modzy competion bash generates the autocompletion script for the bash shell.

This script depends on the bash-completion package. If it is not installed already, you can install it via your OS's package manager.

To load completions in your current shell session:

$ source <(modzy completion bash)

To load completions for every new session, execute once:

Linux:
  $ modzy completion bash > /etc/bash_completion.d/modzy
MacOS:
  $ modzy completion bash > /usr/local/etc/bash_completion.d/modzy

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

Flags specific to the jobs cancel command

Flag

Type

Description

-h, --help

Help for bash

--no-descriptions

Disable completion descriptions

Fish command

$ modzy completion fish generates the autocompletion script for the fish shell.

To load completions in your current shell session:

$ modzy completion fish | source

To load completions for every new session, execute once:

$ modzy completion fish > ~/.config/fish/completions/modzy.fish

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

Flags specific to the completions fish command

Flag

Type

Description

-h, --help

Help for fish

--no-descriptions

Disable completion descriptions

Powershell command

$ modzy completion powershell generate the autocompletion script for powershell.

To load completions in your current shell session:

C:\> modzy completion powershell | Out-String | Invoke-Expression

To load completions for every new session, add the output of the above command to your powershell profile.

Flags specific to the completion powershell command

Flag

Type

Description

-h, --help

Help for powershell

--no-descriptions

Disable completion descriptions

Zsh command

$ modzy completion zsh generates 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 for every new session, execute once:

# Linux:
$ modzy completion zsh > "${fpath[1]}/_modzy"
# macOS:
$ modzy completion zsh > /usr/local/share/zsh/site-functions/_modzy

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

Flags specific to the completion zsh command

Flag

Type

Description

-h, --help

Help for zsh

--no-descriptions

string

Disable completion descriptions


Did this page help you?