cli-module_skill

Overview

This skill provides a CliModule for creating custom CLI commands with full dependency injection and Typer integration. It lets you define async or sync command handlers, command groups, and rich argument/option parsing while services are injected automatically. Use it to add maintainable, discoverable application commands that reuse your app's DI container.

How this skill works

Define commands with the @cli.command() decorator; function parameters are classified automatically as DI dependencies, Typer arguments, or options based on type and default values. Command groups are created via cli.group(...) and support nested commands. The module reads CLI configuration from MYFY_CLI_ environment variables and integrates Typer features like progress bars, enums, and custom help texts.

When to use it

• Add administrative or maintenance commands to a myfy application (migrations, seed, reset).
• Create CLI entry points that need application services like DB sessions or config injected.
• Implement complex argument parsing, flags, enums, or file imports using Typer features.
• Group related commands (e.g., db:seed, db:reset) for discoverability and organization.

Best practices

• Write concise docstrings for each handler — they become command help text.
• Keep commands focused: one clear responsibility per command.
• Prefer DI-injected services instead of creating connections inside commands.
• Use Typer for complex arguments/options to get automatic help and validation.
• Handle errors and exit codes explicitly (raise typer.Exit(1) on failure).
• Use typer.progressbar and styled output for long-running tasks and status.

Example use cases

• Seed a database with test users via an injected UserService: myfy app seed-users --count 20.
• Count or query records using an injected AsyncSession: myfy app count-users.
• Import data from files with typed arguments and dry-run option: myfy app import-data file.csv --dry-run.
• Group DB utilities under db:seed and db:reset with confirmation flags and force option.
• Create deployment or maintenance commands that accept enums, versions, and flags (deploy production -v 1.2.3 --skip-tests).