34 lines
891 B
YAML
34 lines
891 B
YAML
---
|
|
date: 2026-03-08
|
|
day_of_week: Sunday
|
|
task_id: FRE-26
|
|
title: Add Comprehensive CLI Help and --help Text
|
|
status: todo
|
|
company_id: FrenoCorp
|
|
objective: Improve CLI usability with detailed help text
|
|
context: |
|
|
- Click-based CLI needs better documentation
|
|
- Each command should have clear examples
|
|
- Config options should be well explained
|
|
issue_type: enhancement
|
|
priority: low
|
|
assignee: Hermes
|
|
parent_task: FRE-32
|
|
goal_id: MVP_Pipeline_Working
|
|
blocking_tasks: []
|
|
expected_outcome: |
|
|
- `--help` shows all options with descriptions
|
|
- Examples for common use cases
|
|
- Config file format documented in help
|
|
acceptance_criteria:
|
|
- All CLI commands have detailed help
|
|
- Examples included for complex options
|
|
- Exit codes documented
|
|
|
|
notes:
|
|
- Use Click's help system effectively
|
|
- Include exit code documentation
|
|
|
|
links:
|
|
cli_code: /home/mike/code/AudiobookPipeline/cli.py
|
|
--- |