usecli 0.1.28

A powerful Python CLI framework for building beautiful, developer-friendly command-line tools.

Explore the Documentation »
Report Bug · Request Feature

Table of Contents

1. About
2. Quick Start
3. Usage
4. Development
5. Contributing
6. License

About

useCli A powerful Python CLI framework for building beautiful, developer-friendly command-line tools. It gives you:

• Prefix matching — Type he instead of help
• Interactive mode — Fuzzy finder for commands
• Auto-generated help — Clean, styled output
• Command scaffolding — make:command generates boilerplate
• UI components — Prompts, menus, styled console output

(back to top)

Quick Start

Install usecli:

uv add 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

(back to top)

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
inspire      Random quote
make:command Create new command

Hiding Built-in Commands

[tool.usecli]
hide_init = true
hide_inspire = true

(back to top)

Development

See the Development Guide for setup, testing, and architecture details.

(back to top)

Contributing

Read the Contributing Guide.

Quick workflow:

1. Fork and branch: git checkout -b feature/name
2. Make changes
3. Run checks: uv run poe clean-full
4. Commit and push
5. Open a Pull Request

(back to top)

License

MIT. See LICENSE.

(back to top)

---

_{Built by thememium}