Rich-Click

1.9.7 · active · verified Sat Mar 28

rich-click is a wrapper around Click that renders help output nicely using Rich. It provides attractive, color-formatted help text with minimal customization required, serving as a drop-in replacement for Click. The library is currently at version 1.9.7 and has an active development cycle with frequent releases.

Warnings

breaking Rich-Click 1.9+ dropped support for Python 3.7, Click 7, and Rich versions 10/11. Ensure your environment uses Python 3.8+, Click 8+, and Rich 12+ for full compatibility and features.
Fix: Upgrade Python to 3.8+, Click to 8+, and Rich to 12+.
gotcha Rich formatting markup (e.g., '[red]') in help texts is disabled by default to maintain broad compatibility. It will render as plain text unless explicitly enabled.
Fix: Enable rich markup by setting `click.rich_click.USE_RICH_MARKUP = True` or by configuring `RichHelpConfiguration` with `use_rich_markup=True`.
gotcha Minor Typer incompatibilities, such as default panel placements, have been addressed in recent versions. For optimal integration with Typer CLIs, ensure `rich-click[typer]` is installed.
Fix: Install `rich-click[typer]` and upgrade rich-click to version 1.9.6 or later.
gotcha Subcommand discovery in help text had inconsistent behavior between versions 1.8 and 1.9.3. If using an affected version, subcommands might not display correctly.
Fix: Upgrade to rich-click v1.9.3 or later to ensure correct subcommand discovery behavior, which was restored to match v1.8.
gotcha Early versions (prior to v1.9.5) experienced strange encoding issues on Windows environments, potentially leading to malformed help output.
Fix: Upgrade to rich-click v1.9.5 or later for improved Windows compatibility.
deprecated The 'groups' feature for organizing commands and options was superseded by the more intuitive 'Panels' API in rich-click 1.9. While old code might still function, 'Panels' offer more powerful customization.
Fix: Migrate to the 'Panels' API for command and option organization for better control and flexibility.

Install

pip install rich-click Basic Installation
pip install "rich-click[typer]" With Typer Support

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
```
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

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()

view raw JSON →