@okam/ai
v0.1.0
Published
CLI for AI-assisted PRD (Product Requirements Document) task processing.
Keywords
Readme
@okam/ai
CLI for AI-assisted PRD (Product Requirements Document) task processing.
Installation
npx @okam/ai <command>Commands
init
Initialize a new PRD project with prd.json and progress.txt templates.
npx @okam/ai init
npx @okam/ai init --force # Overwrite existing filesCreates a prd.json with the following structure:
{
"project": "",
"goal": "",
"config": {
"agent": "claude",
"context": "",
"verification": "Run your tests and type checks."
},
"statuses": ["pending", "in_progress", "completed", "blocked"],
"tasks": [
{ "id": "1", "description": "", "status": "pending", "steps": [] }
]
}Also creates a progress.txt log with a creation date header.
ralph
Run an AI agent to process PRD tasks iteratively.
npx @okam/ai ralph # Run 1 iteration
npx @okam/ai ralph 5 # Run 5 iterations
npx @okam/ai ralph -a codex # Use Codex CLI instead of ClaudePrerequisites:
jq- JSON processor for parsing AI responsesbash- Shell for running the orchestration script- Either
claudeCLI (for--agent claude) orcodexCLI (for--agent codex)
Options:
| Flag | Description | Default |
|------|-------------|---------|
| -a, --agent <agent> | AI agent to use (claude or codex) | claude |
| -c, --context <path> | Additional context file or directory | Current working directory |
| -v, --verification <cmd> | Verification command after each task | Run your tests and type checks. |
| -p, --prd <path> | Path to prd.json file | prd.json |
| --progress <path> | Path to progress.txt file | progress.txt |
Configuration priority: CLI flags > prd.json config > defaults. If config.context is a relative path, it is resolved relative to the PRD file.
archive
Archive prd.json and progress.txt to archive/ folder with timestamped filenames.
npx @okam/ai archiveFiles are renamed to: {type}_{project-slug}_{YYYY-MM-DD_HH-mm-ss}.{ext}
Example: prd_my-project_2026-01-22_11-35-31.json
Configuration
Configure defaults in your prd.json config section:
{
"config": {
"agent": "claude",
"context": "NX monorepo with React, TypeScript, Tailwind CSS",
"verification": "npx nx run-many -t build lint test"
}
}Development
nx build ai # Build the library
nx test ai # Run unit tests
nx lint ai # Run linting