click-extra wrap - Run, or introspect, any Click CLI through Click
Extra.
click-extra wrap [OPTIONS] SCRIPT
[ARGS]...
Run, or introspect, any Click CLI through Click Extra.
By default, runs SCRIPT with keyword highlighting and themed
styling for its help screens. The target CLI is not modified.
With --show-params, --man or --carapace, SCRIPT is loaded and
described without being run. Extra arguments after SCRIPT navigate into
nested subcommands; for --show-params, any trailing options are replayed
against the resolved command so the parameter table reports their value and
source.
Resolution order for SCRIPT: installed console_scripts entry
point, a local project directory (its entry point is read from
pyproject.toml or setup.cfg), Python file path, module:function notation, or
Python module name.
- SCRIPT
[ARGS]...
- --show-params
- Show the parameters of the target CLI and exit, without running it.
- --man
- Show the man page (roff) of the target CLI and exit, without running
it.
- --carapace
- Show the Carapace completion spec (YAML) of the target CLI and exit,
without running it.
- --output-dir
DIRECTORY
- With --man, write one .1 file per (sub)command into this directory instead
of printing a single page to stdout. Created if missing.
- --install
- With --carapace, write the spec into Carapace's user spec directory
instead of printing it, and echo the written path.
- --table-format
[aligned|asciidoc|colon-grid|csv|csv-excel|csv-excel-tab|csv-unix|double-grid|double-outline|fancy-grid|fancy-outline|github|grid|heavy-grid|heavy-outline|hjson|html|jira|json|json5|jsonc|latex|latex-booktabs|latex-longtable|latex-raw|mediawiki|mixed-grid|mixed-outline|moinmoin|orgtbl|outline|pipe|plain|presto|pretty|psql|rounded-grid|rounded-outline|rst|simple|simple-grid|simple-outline|textile|toml|tsv|unsafehtml|vertical|xml|yaml|youtrack]
- With --show-params, the rendering style of the parameter table. Falls back
to the click-extra group's --table-format when not set here.
- --columns
[id,spec,class,param_type,python_type,hidden,exposed,allowed_in_conf,envvars,default,is_flag,flag_value,is_bool_flag,multiple,nargs,prompt,confirmation_prompt,value,source]
- Restrict and reorder table columns, SQL SELECT-style. Comma-separated list
of column IDs. Default: all columns in canonical order.
- -h / --help
- Show this message and exit.
- Show the parameters of the target CLI and exit, without running it.
- Show the man page (roff) of the target CLI and exit, without running
it.
- Show the Carapace completion spec (YAML) of the target CLI and exit,
without running it.
- With --man, write one .1 file per (sub)command into this directory instead
of printing a single page to stdout. Created if missing.
- With --carapace, write the spec into Carapace's user spec directory
instead of printing it, and echo the written path.
- With --show-params, the rendering style of the parameter table. Falls back
to the click-extra group's --table-format when not set here.
- CLICK_EXTRA_WRAP_COLUMNS
- Restrict and reorder table columns, SQL SELECT-style. Comma-separated list
of column IDs. Default: all columns in canonical order.
- Show this message and exit.
- 0
- Success.
- 1
- A runtime error, or an aborted prompt (Ctrl-C, a declined
confirmation).
- 2
- A usage error: unknown option, invalid value, missing operand, or an
unparsable configuration file.