Hiding Commands and Options in Click CLI Help Messages

Zettel#174

zettelkasten
Published

2024-08-18

With Click, you can hide a specific option or command from appearing in the help message by setting the hidden parameter to True.

Hiding an Option

@click.option(
    ...
    hidden=True,
)

Hiding a Command

@click.command(
    ...
    hidden=True,
)

Indicate a Deprecated Command

You can use the parameter deprecated to indicate that a command is deprecated.

@click.command(
    ...
    deprecated=True,
)

References