asyncclick

What it is and what it does

Asyncclick is a fork of Click that brings async/await support to command-line interface building. Where Click requires synchronous command handlers, asyncclick lets you write async command and subcommand handlers that work seamlessly with asyncio or trio. You can mix sync and async handlers in the same program, and most of the Click API translates directly—the main difference is that several methods like BaseCommand.main and Context.invoke are now asynchronous.

The package inherits Click's core strengths: arbitrary nesting of commands, automatic help generation, and lazy subcommand loading. It depends only on colorama for terminal color support. Most existing Click code can be adapted by changing imports from click to asyncclick, though you'll need to await certain operations and may need to use anyio.run() to invoke commands from an async context.

Use it for

• Build CLI tools that need to perform async I/O (network calls, database queries) without blocking the event loop.
• Create command-line applications that integrate with asyncio or trio-based libraries and frameworks.
• Migrate existing Click-based CLIs to async when performance or concurrency requirements change.
• Develop multi-command CLI applications where some handlers are async and others remain synchronous.
• Write interactive CLI tools that use async prompts and need to remain responsive during user input.

Worth the install?

AI-flagged interpretation of the facts on this page. Verify before relying on it.

Install

asyncclick on PyPI

Before you install

Low install friction with a single runtime dependency (colorama). The package is actively maintained with a recent release 45 days ago and marked Production/Stable, though it requires Python 3.11 or later.

Requires Python 3.11 or later

License in practice

BSD-3-Clause is permissive and imposes no significant restrictions on use or redistribution in most contexts.

Quickstart

pip install asyncclick

import asyncclick as click

@click.command()
@click.option("--name", prompt="Your name")
async def hello(name):
    click.echo(f"Hello, {name}!")

if __name__ == '__main__':
    hello()

Package facts

Evidence: asyncclick-8.4.2.1-py3-none-any.whl

Tags

More Application Frameworks packages

See also click · opentelemetry-instrumentation-asyncclick · click-compose · auto-click-auto · rich-click · click-default-group · click-configfile · click-config-file · click-help-colors · click-datetime