craft_cli.completion package

Submodules

• craft_cli.completion.completion module
  • Option
    • Option.bashdefault
    • Option.default
    • Option.dirnames
    • Option.filenames
    • Option.noquote
    • Option.nosort
    • Option.nospace
    • Option.plusdirs
  • Action
    • Action.alias
    • Action.arrayvar
    • Action.binding
    • Action.builtin
    • Action.command
    • Action.directory
    • Action.disabled
    • Action.enabled
    • Action.export
    • Action.file
    • Action.function
    • Action.group
    • Action.helptopic
    • Action.hostname
    • Action.job
    • Action.keyword
    • Action.running
    • Action.service
    • Action.setopt
    • Action.shopt
    • Action.signal
    • Action.user
    • Action.variable
  • get_set_flags()
  • CompGen
    • CompGen.options
    • CompGen.actions
    • CompGen.glob_pattern
    • CompGen.prefix
    • CompGen.suffix
    • CompGen.words
    • CompGen.filter_pattern
  • Arg
    • Arg.flags
    • Arg.completion_command
    • Arg.from_global_argument()
    • Arg.from_action()
    • Arg.flag_list
  • Argument
    • Argument.flag_list
  • OptionArgument
    • OptionArgument.flag_list
  • CommandMapping
    • CommandMapping.options
    • CommandMapping.args
    • CommandMapping.params
    • CommandMapping.all_args
  • complete()
  • main()

Module contents

Bash completion script generation module.

craft_cli.completion.complete(shell_cmd: str, get_app_info: Callable[[], tuple[Dispatcher, dict[str, Any] | None]]) → str

Generate a bash completion script based on a craft-cli dispatcher.

Parameters:

• shell_cmd – The name of the command being completed for

• get_app_info – A function that returns a populated craft-cli dispatcher and the config needed to create its commands

Returns:

A bash completion script for shell_cmd