Getting Started¶

git clone <repo-url>
cd typer-template
uv sync --all-extras
uv run pre-commit install

uv run cli-app --help
uv run cli-app --version
uv run cli-app --authors

# Enable DEBUG logging for the duration of the command
uv run cli-app --verbose command example-command hello

# Emit machine-readable JSON instead of Rich text
uv run cli-app --output-format json command example-command hello

# Pipe stdin into a command
echo "hello" | uv run cli-app command example-command

# Install completion for the current shell
uv run cli-app completion install

# Or target a specific shell
uv run cli-app completion install --shell zsh

# Print the script without installing
uv run cli-app completion show

uv run task lint        # ruff check .
uv run task fmt         # ruff format .
uv run task typecheck   # mypy src/
uv run task test        # pytest (parallel, 80% coverage enforced)
uv run task test-fast   # pytest --no-cov -n auto
uv run task audit       # pip-audit dependency audit

uv run pytest                        # full suite
uv run pytest --no-cov               # skip coverage (faster)
uv run pytest tests/path/to/test.py  # single file

uv run cz bump            # bump version, update CHANGELOG, create tag
uv run cz changelog       # update CHANGELOG without bumping
uv run cz changelog --dry-run

import structlog
from typer import Context, Typer

from cli_app.utils.console import get_console
from cli_app.utils.output import OutputFormat, render_output

app = Typer()
console = get_console()
log = structlog.get_logger()


@app.command()
def my_action(ctx: Context, name: str) -> None:
    """Do something."""
    log.debug("my_action called", name=name)
    fmt = ctx.obj.get("output_format", OutputFormat.text) if ctx.obj else OutputFormat.text
    render_output(
        {"name": name},
        fmt,
        text_render=lambda: console.print(f"Hello, [bold]{name}[/bold]!"),
    )

from .my_command import app as my_command_app

from cli_app.cli.commands import my_command_app
app.add_typer(my_command_app, name="my-command")

from cli_app.utils.stdin import read_stdin_if_piped

@app.command()
def process(ctx: Context, text: str | None = None) -> None:
    resolved = text if text is not None else read_stdin_if_piped()
    if not resolved:
        raise typer.Exit(1)
    ...

CLI_APP_LOG_LEVEL=DEBUG
CLI_APP_LOG_USE_JSON_FORMATTER=true   # JSON logs for Datadog/Loki/etc.
CLI_APP_CONSOLE_WIDTH=120