cli-root-yo

Reusable CLI kernel for building unified command-line interfaces with consistent behavior, output style, help, and extension semantics. Built on Typer + Rich.

What It Does

cli-root-yo provides the shared foundation that downstream CLI tools build on:

• Root app factory — create_app() builds a fully configured Typer app from a declarative spec
• Built-in commands — version, info, and optional config/env groups
• Plugin system — explicit callables + cli_root_yo.plugins entry-point discovery
• XDG paths — platform-aware config/data/state/cache directory resolution (macOS + Linux)
• Output primitives — heading, success, warning, error, action, detail, bullet, emit_json
• Runtime context — immutable singleton accessible to all commands during invocation
• JSON mode — --json/-j flag with deterministic output (indent=2, sorted keys, no ANSI)
• NO_COLOR — respects the NO_COLOR convention
• Debug mode — CLI_ROOT_YO_DEBUG=1 prints tracebacks to STDERR

Prerequisites

• Python 3.10+
• pip

Installation

pip install cli-root-yo

For development:

git clone https://github.com/Daylily-Informatics/cli-root-yo.git
cd cli-root-yo
pip install -e ".[dev]"

Quick Start

from cli_root_yo.spec import CliSpec, XdgSpec
from cli_root_yo.app import run

spec = CliSpec(
    prog_name="my-tool",
    app_display_name="My Tool",
    dist_name="my-tool",
    root_help="A CLI built with cli-root-yo.",
    xdg=XdgSpec(vendor="my-tool"),
)

exit_code = run(spec)

This gives you my-tool version, my-tool info, my-tool --help, --json support, and all the standard behaviors out of the box.

Adding Commands via Plugin

# my_tool/plugin.py
def register(registry, spec):
    registry.add_command(None, "greet", greet_cmd, help_text="Say hello.")

def greet_cmd():
    from cli_root_yo import output
    output.success("Hello, world!")

Register it in your spec:

from cli_root_yo.spec import PluginSpec

spec = CliSpec(
    ...,
    plugins=PluginSpec(explicit=["my_tool.plugin.register"]),
)

Or via entry points in pyproject.toml:

[project.entry-points."cli_root_yo.plugins"]
my-tool = "my_tool.plugin:register"

Config & Env Groups

Enable optional built-in command groups by providing specs:

from cli_root_yo.spec import ConfigSpec, EnvSpec

spec = CliSpec(
    ...,
    config=ConfigSpec(
        primary_filename="config.json",
        template_bytes=b'{"key": "value"}\n',
    ),
    env=EnvSpec(
        env_dir_name=".venv",
        activate_script_rel="bin/activate",
    ),
)

This adds config path|init|show|validate|edit|reset and env status|activate|deactivate|reset.

Public API

Exit Codes

Build / Test / Lint

# Run tests
python -m pytest tests/ -v --cov=cli_root_yo

# Lint + format check
ruff check cli_root_yo tests
ruff format --check cli_root_yo tests

# Type check
mypy cli_root_yo --ignore-missing-imports

# Build distribution
python -m build
twine check dist/*

License

MIT — see LICENSE.