CLI Overview¶
The prdtool CLI provides commands for creating, managing, validating, and scoring Product Requirements Documents.
Command Structure¶
Global Flags¶
| Flag | Short | Description | Default |
|---|---|---|---|
--file |
-f |
PRD file path | PRD.json |
--help |
-h |
Help for any command | |
--version |
-v |
Version information |
Commands¶
Document Management¶
| Command | Description |
|---|---|
init |
Initialize a new PRD with required metadata |
show |
Display PRD contents as JSON |
validate |
Validate PRD against schema |
score |
Score PRD quality against rubric |
view |
Generate human-readable views |
Content Addition¶
| Command | Description |
|---|---|
add problem |
Add a problem statement |
add persona |
Add a user persona |
add goal |
Add a goal |
add nongoal |
Add a non-goal |
add solution |
Add a solution option |
add req |
Add a functional requirement |
add nfr |
Add a non-functional requirement |
add metric |
Add a success metric |
add risk |
Add a risk |
add decision |
Add a decision record |
Deployment¶
| Command | Description |
|---|---|
deploy |
Generate AI assistant configurations |
Typical Workflow¶
-
Initialize a new PRD:
-
Add content incrementally:
-
Validate the structure:
-
Score for quality:
-
Generate views for stakeholders:
See Command Reference for detailed documentation of each command, or Examples for complete workflows.