Skip to Content
kusaw docsv1.0.0
CLI reference

kusaw completion

Generate the autocompletion script for kusaw for the specified shell. See each sub-command's help for details on how to use the generated script.

kusaw completion

Generate the autocompletion script for kusaw for the specified shell. See each sub-command's help for details on how to use the generated script.

Usage

Text
kusaw completion [flags]

Flags

NameShortTypeDefaultDescription
--configstringPath to kusaw.yaml (overrides KUSAW_CONFIG and parent search)
--factorystringfactory name from kusaw list
--help-hboolfalsehelp for completion

Subcommands

kusaw completion bash

Generate 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:

Text
source <(kusaw completion bash)

To load completions for every new session, execute once:

Linux:

Text
kusaw completion bash > /etc/bash_completion.d/kusaw

macOS:

Text
kusaw completion bash > $(brew --prefix)/etc/bash_completion.d/kusaw

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

Text
kusaw completion bash
NameShortTypeDefaultDescription
--configstringPath to kusaw.yaml (overrides KUSAW_CONFIG and parent search)
--factorystringfactory name from kusaw list
--help-hboolfalsehelp for bash
--no-descriptionsboolfalsedisable completion descriptions

Example:

Text
kusaw completion bash

kusaw completion fish

Generate the autocompletion script for the fish shell.

To load completions in your current shell session:

Text
kusaw completion fish | source

To load completions for every new session, execute once:

Text
kusaw completion fish > ~/.config/fish/completions/kusaw.fish

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

Text
kusaw completion fish [flags]
NameShortTypeDefaultDescription
--configstringPath to kusaw.yaml (overrides KUSAW_CONFIG and parent search)
--factorystringfactory name from kusaw list
--help-hboolfalsehelp for fish
--no-descriptionsboolfalsedisable completion descriptions

Example:

Text
kusaw completion fish

kusaw completion powershell

Generate the autocompletion script for powershell.

To load completions in your current shell session:

Text
kusaw completion powershell | Out-String | Invoke-Expression

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

Text
kusaw completion powershell [flags]
NameShortTypeDefaultDescription
--configstringPath to kusaw.yaml (overrides KUSAW_CONFIG and parent search)
--factorystringfactory name from kusaw list
--help-hboolfalsehelp for powershell
--no-descriptionsboolfalsedisable completion descriptions

Example:

Text
kusaw completion powershell

kusaw completion zsh

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:

Text
echo "autoload -U compinit; compinit" >> ~/.zshrc

To load completions in your current shell session:

Text
source <(kusaw completion zsh)

To load completions for every new session, execute once:

Linux:

Text
kusaw completion zsh > "${fpath[1]}/_kusaw"

macOS:

Text
kusaw completion zsh > $(brew --prefix)/share/zsh/site-functions/_kusaw

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

Text
kusaw completion zsh [flags]
NameShortTypeDefaultDescription
--configstringPath to kusaw.yaml (overrides KUSAW_CONFIG and parent search)
--factorystringfactory name from kusaw list
--help-hboolfalsehelp for zsh
--no-descriptionsboolfalsedisable completion descriptions

Example:

Text
kusaw completion zsh

Exit codes

CodeNameDescription
0okSuccess.
1errorRuntime error.
2usageUsage or validation error.
3rejectedControl request rejected; the error string is printed verbatim.
4not picked upControl request not picked up within the wait time while serve runs.

Example

Text
kusaw completion bash

On this page