Skip to main content
Version: 0.3

gest generate

Generate shell completions and man pages for gest.

Usage​

gest generate <COMMAND> [OPTIONS]

Subcommands​

CommandDescription
completionsPrint shell completion scripts to stdout
man-pagesWrite man page files to a directory

generate completions​

Print shell completion scripts to stdout. Pipe the output to the appropriate location for your shell.

gest generate completions --shell <SHELL>

Options​

FlagDescription
--shell <SHELL>Target shell: bash, elvish, fish, powershell, zsh

Examples​

# Bash
gest generate completions --shell bash > ~/.local/share/bash-completion/completions/gest

# Zsh
gest generate completions --shell zsh > ~/.zfunc/_gest

# Fish
gest generate completions --shell fish > ~/.config/fish/completions/gest.fish

generate man-pages​

Write roff man page files for all commands to a directory.

gest generate man-pages --output-dir <OUTPUT_DIR>

Options​

FlagDescription
--output-dir <OUTPUT_DIR>Directory to write man page files into

Examples​

gest generate man-pages --output-dir ./man