Skip to content

/help <command> — per-command detailed help #15

@amayer1983

Description

@amayer1983

Requested by @famewolf in #2:

"/help could be used to get more specific parameter usage if you don't want all this in the general /help command."

Current behaviour

/help lists every command on a single message — good as overview, sparse on per-command details (parameters, examples).

Proposed

/help <command> — return a detailed help block for that one command, including:

  • Synopsis (/cleanup — no args)
  • What it does
  • Parameters with type / accepted values
  • Examples (≤ 3)
  • Side effects (e.g. "rate-limited to 1 per minute", "writes to update_history.json")

Helps power users discover capabilities without scrolling through the README.

Implementation sketch

i18n-heavy: each command needs a per-command help block in 16 languages. Easiest: just write EN + DE, the fallback layer handles the rest like with every other i18n key.

/help cleanup

*/cleanup* — Remove unused Docker images

Removes images older than CLEANUP_GRACE_HOURS (default 24h) that no
running container references. Optionally backs up locally-built images
as tarballs first if CLEANUP_BACKUP_LOCAL_ONLY is set.

Side effects:
• Writes a notification to all configured channels
• Frees disk; check disk usage before/after with /status

Open questions

  • Fuzzy match on the command? /help statu/status? Probably not for v1 — exact match keeps it predictable.
  • Wrong arg: /help nope → "no such command — try /help for the list" or list all? Probably the former.

Target

v1.18.0 alongside other small UX polish.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions