Rich-Click

Common errors

Warnings

Install

Install compatibility verified last tested: 2026-05-12

Imports

• click

  import rich_click as click

  This is the most common and recommended way to use rich-click as a drop-in replacement for Click.

• RichCommand, RichGroup
  wrong

  from rich_click import command, group

  correct

  from rich_click import RichCommand, RichGroup

  While 'command' and 'group' are re-exported, using the explicit 'RichCommand' and 'RichGroup' is clearer when opting for declarative usage with `cls=`.

Quickstart stale last tested: 2026-04-24

This example demonstrates a basic rich-click CLI with options, a prompt, and an environment variable for an API key. Save it as `cli.py` and run `python cli.py --help` for rich-formatted output or `python cli.py --name World`.

import rich_click as click
import os

@click.command()
@click.option("--count", default=1, help="Number of greetings.")
@click.option("--name", prompt="Your name", help="The person to greet.")
@click.option(
    "--api-key",
    envvar="MY_APP_API_KEY",
    help="API key for external service.",
    default=os.environ.get('MY_APP_API_KEY', '')
)
def hello(count, name, api_key):
    """
    A simple program that greets NAME for a total of COUNT times.
    It also demonstrates an optional API key from an environment variable.
    """
    if not api_key:
        click.echo("[red]Warning:[/] No API key provided (set MY_APP_API_KEY environment variable).")

    for _ in range(count):
        click.echo(f"Hello, {name}!")

if __name__ == '__main__':
    hello()