Implementation Guides
Step-by-step tutorials that walk through the reference examples in the quickli source package. Learn how the framework primitives fit together by reading and running real code.
Guide 1: Hello World
Build your first quickli application: a single entrypoint that greets a user by name with an optional uppercase flag. Covers Application, Argument, and Option.
Guide 2: File Viewer (quickcat)
Build a cat-like file viewer with quickli. Learn global options, multiple file arguments, the file_path validator, and repeatable options.
Guide 3: Directory Listing (quickls)
Build a directory listing tool with quickli. Learn optional arguments with defaults, the directory_path validator, and suffix filtering.
Guide 4: Directory Creator (quickmkdir)
Build a mkdir-like directory creator with quickli. Learn how to create multiple directories in one call using repeatable options and combine multiple path operations.
Guide 5: File Head (quickhead)
Build a head-like file tool with quickli. Learn numeric conversion with converter=int and the positive_number validator to restrict option values.
Guide 6: Multi-Command CLI (pyk5l)
Build a kubectl-like multi-command CLI with quickli. Learn named commands with @app.command, global options shared across commands, custom validators, and CommandExecutionError for domain-level errors.
