Cyclopts is a Python framework for building command-line interfaces from type hints.
The framework turns annotated Python functions into CLI applications with arguments, options, subcommands, validation and automatically generated help pages. It supports complex types and lets developers customise how values are converted, validated and passed to an application.
This is free and open source software.
Key Features
- Build command-line interfaces directly from annotated Python functions.
- Offers a concise API for registering commands and default actions.
- Supports built-in types, unions, literals and user-defined types.
- Integrates with dataclasses, attrs classes and Pydantic models.
- Generates rich help pages from docstrings and contextual information.
- Provides clear error messages when supplied values cannot be converted.
- Supports custom converters, validators and token-parsing behaviour.
- Allows developers to customise application launching.
- Requires Python 3.10 or later.
Website: github.com/BrianPugh/cyclopts
Support:
Developer: Brian Pugh
License: Apache License 2.0
Cyclopts is written in Python. Learn Python with our recommended free books and free tutorials.
Related Software
| Command-Line Python Application Development Tools | |
|---|---|
| Python Fire | Library for automatically generating command line interfaces |
| argparse | Parser for command-line options, arguments and sub-commands |
| Click | Create beautiful command line interfaces in a composable way |
| Typer | Library for building CLI applications |
| Rich | Python library for rich text and beautiful formatting |
| alive-progress | Progress bar, with real-time throughput |
| Gooey | Convert console programs into end-user-friendly GUI software |
| Python Prompt Toolkit | Build powerful interactive command line and terminal applications |
| tqdm | Fast, extensible progress bar for Python and CLI |
| Asciimatics | Create full-screen text UIs from interactive forms to ASCII animations |
| Cement | CLI application framework for Python |
| docopt | Command-line interface description language |
| cliff | Framework for building command line programs |
| Cyclopts | Framework for building command-line interfaces |
Read our verdict in the software roundup.
 Explore our carefully curated directory of recommended free and open source software, covering every major software category.The directory forms part of our extensive collection of articles for Linux enthusiasts. It includes hundreds of detailed reviews, together with free and open source alternatives to proprietary software from companies such as Google, Microsoft, Apple, Adobe, IBM, Cisco, Oracle, and Autodesk. LinuxLinks also covers interesting projects worth exploring, Linux-compatible hardware, free programming books and tutorials, and much more. Know a useful free and open source Linux application that we haven’t covered? Tell us about it using our submission form. |
Please read our Comment Policy before commenting.