Implementation Guides

These guides walk through the reference examples that ship with the quickli source package. Each guide explains the code line-by-line so you can follow along, run the examples yourself, and understand how the framework primitives work together.

How to use these guides

Every guide is self-contained. You can read them in any order, but the sequence below builds knowledge progressively from the smallest possible example to a larger multi-command application.

1. Hello World — your first entrypoint, one argument, one flag.
2. File viewer (quickcat) — global options, multiple file arguments, and the file_path validator.
3. Directory listing (quickls) — optional arguments, multiple options, and the directory_path validator.
4. Directory creator (quickmkdir) — repeatable options and combining multiple paths in one call.
5. File head (quickhead) — numeric conversion with int and the positive_number validator.
6. Multi-command CLI (pyk5l) — multiple commands, global options, and custom validators on a kubectl-like application.

Prerequisites

Install quickli before running any example:

pip install quickli

All examples run on Python 3.12, 3.13, and 3.14.