feat: reword phase to epic, update mkdocs
This commit is contained in:
62
docs/content/stories/epic3/3.4-module-cli.md
Normal file
62
docs/content/stories/epic3/3.4-module-cli.md
Normal file
@@ -0,0 +1,62 @@
|
||||
# Story 3.4: Module Management CLI Tool
|
||||
|
||||
## Metadata
|
||||
- **Story ID**: 3.4
|
||||
- **Title**: Module Management CLI Tool
|
||||
- **Epic**: 3 - Module Framework
|
||||
- **Status**: Pending
|
||||
- **Priority**: Medium
|
||||
- **Estimated Time**: 4-5 hours
|
||||
- **Dependencies**: 3.1, 3.3
|
||||
|
||||
## Goal
|
||||
Provide CLI tooling for managing modules, validating dependencies, and testing module loading.
|
||||
|
||||
## Description
|
||||
This story creates a CLI tool that allows developers and operators to manage modules, validate dependencies, test module loading, and inspect module information.
|
||||
|
||||
## Deliverables
|
||||
|
||||
### 1. CLI Tool (`cmd/platformctl/main.go`)
|
||||
- `platformctl modules list` - List all loaded modules with versions
|
||||
- `platformctl modules validate` - Validate module dependencies
|
||||
- `platformctl modules test <module>` - Test module loading
|
||||
- `platformctl modules info <module>` - Show module details
|
||||
- `platformctl modules dependencies <module>` - Show module dependencies
|
||||
- Command-line argument parsing
|
||||
- Error handling and user-friendly output
|
||||
|
||||
### 2. Makefile Integration
|
||||
- `make install-cli` - Install CLI tool
|
||||
- `make cli` - Build CLI tool
|
||||
- `make cli-test` - Test CLI tool
|
||||
|
||||
## Implementation Steps
|
||||
|
||||
1. **Create CLI Tool**
|
||||
- Create `cmd/platformctl/main.go`
|
||||
- Use cobra for CLI framework
|
||||
- Implement commands
|
||||
|
||||
2. **Implement Commands**
|
||||
- List command
|
||||
- Validate command
|
||||
- Test command
|
||||
- Info command
|
||||
|
||||
3. **Add to Makefile**
|
||||
- Add build commands
|
||||
- Add install commands
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] CLI tool lists all modules
|
||||
- [ ] Dependency validation works
|
||||
- [ ] Module testing works
|
||||
- [ ] CLI is installable and usable
|
||||
- [ ] Commands provide helpful output
|
||||
- [ ] Error messages are clear
|
||||
|
||||
## Files to Create/Modify
|
||||
- `cmd/platformctl/main.go` - CLI tool
|
||||
- `Makefile` - Add CLI commands
|
||||
|
||||
Reference in New Issue
Block a user