-
Notifications
You must be signed in to change notification settings - Fork 1
Open
Labels
area:cliCLI commands and UXCLI commands and UXarea:docsDocumentationDocumentationarea:opsOperations and self-hostingOperations and self-hostingphase:2Roadmap phase 2Roadmap phase 2size:lLargeLargetype:enhancementEnhancementEnhancement
Description
Problem / motivation
The CLI has grown into a broad command surface, but it would benefit from more consistent UX and better operator tooling.
Current opportunities include:
- command convention inconsistencies across subcommands
- missing validation and shared flag patterns
- no dedicated
doctorcommand for config/connectivity checks - JSON-first output with limited human-friendly options
- docs likely to drift as commands evolve
Proposed solution
Improve CLI ergonomics and maintainability in one coordinated phase.
Scope:
- standardise command conventions and validation patterns
- add a
doctorcommand - add output modes such as json, yaml, and table
- generate CLI command reference documentation from Cobra metadata
Alternatives considered
Treat each improvement as separate work. That is possible, but the pieces are closely related and benefit from a shared design pass.
Additional context
Related existing issue:
Suggested checklist:
- Define command UX conventions
- Introduce shared validation/helpers where appropriate
- Implement
seerr-cli doctor - Add configurable output modes
- Generate CLI reference docs
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
area:cliCLI commands and UXCLI commands and UXarea:docsDocumentationDocumentationarea:opsOperations and self-hostingOperations and self-hostingphase:2Roadmap phase 2Roadmap phase 2size:lLargeLargetype:enhancementEnhancementEnhancement