Skip to main content

click plugin to show the command tree of your CLI

Project description

click-command-tree

WARNING: This has really only been tested with python3 and click 6 and 7. I plan to do better testing and integrate CI so find all possible versions this can be used with.

click-command-tree is a click plugin to show the command tree of your CLI

example:

from pkg_resources import iter_entry_points

import click
from click_plugins import with_plugins


@with_plugins(iter_entry_points('click_command_tree'))
@click.group()
def root():
    pass


@root.group()
def command_group():
    pass


@command_group.command()
def nested_command():
    pass


@root.command()
def standard_command():
    pass


if __name__ == '__main__':
    root()
↪ python example.py --help
Usage: example.py [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  command-group
  standard-command
  tree

↪ python example.py tree
root
├── command-group
│   └── nested-command
├── standard-command
└── tree

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for click-command-tree, version 1.0.0
Filename, size File type Python version Upload date Hashes
Filename, size click_command_tree-1.0.0-py3-none-any.whl (3.5 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size click-command-tree-1.0.0.tar.gz (2.2 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page