agentsclimarketplace

Reviewing cli command

Skill ComeOnOliver/skillshub/skills/https-deeplearning-ai/sc-agent-skills-files/reviewing-cli-command

🧠 The right skill, one API call. AI agent skills registry with token-efficient skill resolution. 5,000+ skills from 500+ top repos.

Install
npx -y skills add ComeOnOliver/skillshub --skill reviewing-cli-command

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

What its author says it does

Copied from the file, not written here

Provides checklist for reviewing Typer CLI command implementations. Covers structure, Annotated syntax, error handling, exit codes, display module usage, destructive action patterns, and help text conventions. Use when user asks to review/check/verify a CLI command, wants feedback on implementation, or asks if a command follows best practices.

SKILL.md

3.3 KB, 831 tokens by cl100k_base, as published. Nobody here has run it

Reviewing CLI Commands

Checklist for reviewing Typer CLI command implementations.

Review Process

  1. Read the command file
  2. Check each section below
  3. Report findings using output format at bottom

Structure

  • File in src/<cli_app>/commands/
  • Has app = typer.Typer() and @app.command()
  • Command groups use @app.command() for each subcommand
  • Registered in commands/__init__.py with add_typer()
  • Single commands: add_typer(app) without name
  • Command groups: add_typer(app, name="group")

Arguments & Options

  • Uses Annotated syntax
  • Arguments for required positional input
  • Options for optional named parameters
  • Short flags where appropriate (-f, -q)
  • Help text: lowercase, no period, brief
# GOOD:
name: Annotated[str, typer.Argument(help="item name")]
force: Annotated[bool, typer.Option("--force", "-f", help="skip confirmation")] = False

# BAD:
name: str = typer.Argument(..., help="The name of the item.")

Error Handling

  • Validates input before processing
  • Exit codes: 0=success, 1=error, 2=invalid input
  • Errors via display.error()
  • Uses raise typer.Exit(code) after errors
  • Uses raise typer.Abort() for cancellation
# GOOD:
if id < 1:
    display.error("ID must be positive")
    raise typer.Exit(EXIT_INVALID_INPUT)

# BAD:
if id < 1:
    print("Error: ID must be positive")
    return

Output

  • All output through display module
  • No print(), typer.echo(), or console.print()
# GOOD:
display.success(f"Added '{task.title}'")

# BAD:
print(f"Added '{task.title}'")

Destructive Actions

  • Has --force / -f flag
  • typer.confirm() with default=False
  • Shows "Cancelled" on abort
# GOOD:
if not force:
    confirm = typer.confirm(f"Delete '{task.title}'?", default=False)
    if not confirm:
        display.info("Cancelled")
        raise typer.Abort()

# BAD: defaults to Yes
confirm = typer.confirm(f"Delete?", default=True)

Help Text

  • Docstring exists
  • Imperative mood ("Add a task" not "Adds a task")
  • First line < 60 characters

Common Mistakes

MistakeFix
print()display.success/error/warning/info()
Wrong exit code0=success, 1=error, 2=invalid
Missing --force on deleteAdd force option with default False
Confirmation defaults Yesdefault=False in typer.confirm()
Old Typer syntaxAnnotated[type, typer.Argument()]
Missing app = typer.Typer()Each command file needs its own app
Not registeredadd_typer(app) in commands/__init__.py

Review Output Format

## Review: <command_name>

[OK] Uses Annotated syntax
[OK] Has docstring in imperative mood
[X] Missing --force flag on destructive command
[X] Uses print() instead of display module
[!] Help text could be shorter

### Summary
<brief summary of issues found>

### Suggested Fixes
<code suggestions if needed>

Keep looking

Skills are one crate of 328,083. Ordering is by how many stacks a row turns up in, so the top of any crate is what has actually been picked rather than what has the most stars.