Skip to main content

Module shell

Module shell 

Source

Enums§

ShellError
Errors produced by shell integration commands.

Constants§

ENV_ENTRIES
Static environment variable entries for the ENVIRONMENT section.
EXIT_CODES
Static exit code entries for the EXIT CODES section.
KNOWN_BUILTINS
Command names that cmd_man accepts as a man-page fallback when the name is not yet wired into the live clap subcommand tree.
KNOWN_BUILTIN_DESCRIPTIONS
(name, description) pairs for every entry in KNOWN_BUILTINS. Single source of truth for shell completion scripts — drives the bash, zsh, and fish generators so adding a new built-in doesn’t need touching three hand-maintained lists (review #3).

Functions§

build_program_man_page
Build a complete roff man page for the entire CLI program.
build_synopsis
Build the roff SYNOPSIS line from a clap Command’s arguments.
cmd_completion
Handler: generate a shell completion script and return it as a String.
cmd_man
Handler: look up a subcommand and return its roff man page.
completion_command
Build the completion clap subcommand.
generate_grouped_bash_completion
Generate a bash completion script with grouped module support.
generate_grouped_fish_completion
Generate a fish completion script with grouped module support.
generate_grouped_zsh_completion
Generate a zsh completion script with grouped module support.
generate_man_page
Build a complete roff man page string for a CLI subcommand.
has_man_flag
Pre-parse --man from raw argv. Returns true if present.
man_command
Build the man clap subcommand.
register_completion_command
Attach the completion subcommand to the given command. Returns the command with the subcommand added. prog_name is accepted for API symmetry and future dynamic use; the builder itself is currently static.
register_man_command
Attach the man subcommand to the given command. Returns the command with the subcommand added.