Getting Started

Installation

Xclif requires Python 3.12 or later.

pip install xclif

Or with uv:

uv add xclif

Why Xclif?

Xclif is built around two ideas:

  1. File-based routing — your directory structure is your command tree. No registration, no boilerplate. Drop a file in the right folder and the command exists.

  2. Function signatures as contracts — type annotations and default values define the CLI automatically. The function is the documentation.

Read the The Xclif Manifesto to understand how Xclif compares to Click, Typer, and argparse.

Next Steps