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 --params, --man, --tree or --help-format, SCRIPT is loaded
and described without being run. The first three answer a question a person
is asking right now; --help-format renders the target as an artifact for a
program or a build step. Extra arguments after SCRIPT navigate into nested
subcommands; for --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]...
- --params
- Show the parameters of the target CLI and exit, without running it.
- --man
- Read the manual page of the target CLI and exit, without running it.
- --tree
- Show the tree of nested subcommands of the target CLI and exit, without
running it.
- --help-format
[carapace|json|json-full|man|markdown|markdown-full]
- Render the target CLI in the given format and exit, without running
it.
- --output-dir
DIRECTORY
- With --help-format, write the rendering into this directory instead of
printing it. Created if missing.
- --install
- With --help-format, write the rendering where its consumer looks for it
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 --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,help,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.
- Read the manual page of the target CLI and exit, without running it.
- Show the tree of nested subcommands of the target CLI and exit, without
running it.
- Render the target CLI in the given format and exit, without running
it.
- With --help-format, write the rendering into this directory instead of
printing it. Created if missing.
- With --help-format, write the rendering where its consumer looks for it
instead of printing it, and echo the written path.
- With --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.