Welcome to Click¶

Click is a Python package for creating beautiful command line interfacesin a composable way with as little code as necessary. It’s the “CommandLine Interface Creation Kit”. It’s highly configurable but comes withsensible defaults out of the box.

It aims to make the process of writing command line tools quick and funwhile also preventing any frustration caused by the inability to implementan intended CLI API.

Click in three points:

• arbitrary nesting of commands

• automatic help page generation

• supports lazy loading of subcommands at runtime

What does it look like? Here is an example of a simple Click program:

importclick@click.command()@click.option('--count',default=1,help='Number of greetings.')@click.option('--name',prompt='Your name',help='The person to greet.')defhello(count,name):"""Simple program that greets NAME for a total of COUNT times."""forxinrange(count):click.echo(f"Hello{name}!")if__name__=='__main__':hello()

And what it looks like when run:

$pythonhello.py--count=3Your name: JohnHello John!Hello John!Hello John!

It automatically generates nicely formatted help pages:

$pythonhello.py--helpUsage: hello.py [OPTIONS]  Simple program that greets NAME for a total of COUNT times.Options:  --count INTEGER  Number of greetings.  --name TEXT      The person to greet.  --help           Show this message and exit.

You can get the library directly from PyPI:

pipinstallclick

Documentation¶

About Project¶

• This documentation is structured according toDiataxis and written withMyST

• Version Policy

• Contributing

• Donate