Table of Contents
About
useCli A powerful Python CLI framework for building beautiful, developer-friendly command-line tools. It gives you:
- Prefix matching — Type
heinstead ofhelp - Interactive mode — Fuzzy finder for commands
- Auto-generated help — Clean, styled output
- Command scaffolding —
make:commandgenerates boilerplate - UI components — Prompts, menus, styled console output
Quick Start
Install usecli with uv (recommended)
uv add usecli
Install with pip (alternative)
pip install usecli
Initialize
usecli init
Create a command
usecli make:command hello
Your new command is ready in the commands directory:
class HelloCommand(BaseCommand):
def signature(self) -> str:
return "hello"
def description(self) -> str:
return "Say hello"
def handle(self, name: str = Argument(..., help="Your name")) -> None:
console.print(f"Hello, {name}!")
Run it:
usecli hello world
Usage
Prefix Matching
Type partial command names:
usecli he # help
usecli ma:co # make:command
Interactive Mode
usecli --interactive # Fuzzy finder for all commands
usecli -i hello # Run 'hello' command interactively
Command Groups
Colon-separated commands group automatically in help:
def signature(self) -> str:
return "db:migrate"
Displays as:
db:
migrate Run migrations
backup Backup database
Space-separated signatures create nested subcommands:
def signature(self) -> str:
return "spec show" # usecli spec show
UI Components
from usecli import console, Prompt, Confirm, Menu
console.print("[green]Done![/green]")
name = Prompt.ask("Enter name")
ok = Confirm.ask("Continue?")
choice = Menu(["A", "B", "C"]).show()
Available Commands
about Show app info
help Show help
init Initialize usecli (usecli only)
inspire Random quote
make:command Create new command (usecli only)
make:theme Create new theme (usecli only)
Development
See the Development Guide for setup, testing, and architecture details.
Contributing
Read the Contributing Guide.
Quick workflow:
- Fork and branch:
git checkout -b feature/name - Make changes
- Run checks:
uv run poe clean-full - Commit and push
- Open a Pull Request
License
MIT. See LICENSE.
Built by thememium
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file usecli-0.1.72.tar.gz.
File metadata
- Download URL: usecli-0.1.72.tar.gz
- Upload date:
- Size: 60.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.11.28 {"installer":{"name":"uv","version":"0.11.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1655d50787dbb0792c00e52cdad37770105e55f64a6477e990e7976d4429e60a
|
|
| MD5 |
8df8cbf8f97e3f5c5e35ac548e197ca4
|
|
| BLAKE2b-256 |
5e139e77dc1126cb19c73e3e715b1130bde3effbf22fd71c2c1d31563ddb2401
|
File details
Details for the file usecli-0.1.72-py3-none-any.whl.
File metadata
- Download URL: usecli-0.1.72-py3-none-any.whl
- Upload date:
- Size: 86.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.11.28 {"installer":{"name":"uv","version":"0.11.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5933e3a4a0ed6b5d78f754bfbc09dc44b549afa5f23aeeee0578e70d802b3673
|
|
| MD5 |
1ef76f5b711ab3095bf16a14b7633214
|
|
| BLAKE2b-256 |
fa42b39a949fa6a80ac7824c852472db79550204b78481cbd234841d451ef943
|
