Enhance Output Format Options and Standardize CLI Arguments #11
Description
Description
Currently, the CLI interface has inconsistent argument naming and limited output format options. This change aims to improve the user experience by standardizing the arguments and adding JSON output support.
Changes Required
CLI Arguments
- Replace current output-related arguments with standardized options:
- Add --output or -o for output format selection (default, markdown, json)
- Replace --changes with --hide-changes (inverted logic for better UX)
- Keep --detailed for showing detailed information
- Remove --markdown flag as it will be handled by the output format
Output Formats
- Implement three output formats:
- default: Current console output format
- markdown: Current markdown format
- json: New JSON output format with enhanced insights
JSON Output Structure
- The JSON output should include:
- Plan summary statistics
- Resource changes (if not hidden)
- Detailed resource information (if requested)
- Additional insights from analyzers
- Timestamp and metadata
Implementation Notes
- Maintain backward compatibility where possible
- Follow Python best practices
- Keep the code clean and well-documented
- Ensure proper error handling for invalid output formats
- Add appropriate tests for new functionality