@riotprompt/riotplan 0.0.4 → 1.0.2-dev.0

package/README.md

@@ -53,13 +53,218 @@ grunnverk/prompts/
 ## Installation
 
 ```bash
-npm install riotplan
+npm install -g @riotprompt/riotplan
 ```
 
-## Usage (Coming Soon)
+Or as a development dependency:
+
+```bash
+npm install --save-dev @riotprompt/riotplan
+```
+
+### AI-Powered Generation (Optional)
+
+`riotplan` can use AI to generate detailed, actionable plans from your descriptions. Install an execution provider:
+
+```bash
+# For Anthropic Claude (recommended)
+npm install @riotprompt/execution-anthropic
+
+# For OpenAI GPT
+npm install @riotprompt/execution-openai
+
+# For Google Gemini
+npm install @riotprompt/execution-gemini
+```
+
+Set your API key:
+
+```bash
+export ANTHROPIC_API_KEY="sk-ant-..."
+export OPENAI_API_KEY="sk-..."
+export GOOGLE_API_KEY="..."
+```
+
+Without an AI provider, `riotplan` falls back to template-based generation.
+
+## Command-Line Interface
+
+### Creating a Plan
+
+Create a new plan with AI generation:
+
+```bash
+riotplan create my-feature
+```
+
+This will:
+1. Prompt for your plan description (opens editor)
+2. Ask if you want analysis first or direct generation
+3. Use AI to generate detailed plan content
+4. Create all plan files with actionable steps
+
+Options:
+
+```bash
+riotplan create my-feature --direct           # Skip analysis, generate directly
+riotplan create my-feature --steps 7          # Specify number of steps
+riotplan create my-feature --provider anthropic  # Choose AI provider
+riotplan create my-feature --model claude-sonnet-4-5  # Specify model
+riotplan create my-feature --no-ai            # Use templates only
+```
+
+Creates:
+
+```
+my-feature/
+├── my-feature-prompt.md     # Your original description
+├── SUMMARY.md               # AI-generated overview and approach
+├── EXECUTION_PLAN.md        # Step-by-step strategy
+├── STATUS.md                # Current state tracking
+└── plan/
+    ├── 01-analysis.md       # Detailed step with specific tasks
+    ├── 02-design.md         # Concrete acceptance criteria
+    ├── 03-implementation.md # Testing strategies
+    └── ...
+```
+
+**AI vs Templates**: With AI, you get specific, actionable content tailored to your project. Without AI, you get template files with placeholders to fill in manually.
+
+### Checking Status
+
+Show current plan status:
+
+```bash
+riotplan status                 # Current directory
+riotplan status ./my-plan       # Specific path
+riotplan status -v              # Verbose output
+riotplan status --json          # JSON output
+```
+
+Example output:
+
+```
+Plan: my-feature
+Status: 🔄 in_progress
+Progress: 45% (5/11 steps)
+Current Step: 06-testing
+Last Updated: 2026-01-10
+
+Blockers: None
+Issues: 1 (low priority)
+```
+
+### Managing Steps
+
+List steps in a plan:
+
+```bash
+riotplan step list              # All steps
+riotplan step list --pending    # Only pending
+riotplan step list --all        # Include completed
+```
+
+Example output:
+
+```
+✅ 01 analysis
+✅ 02 design
+✅ 03 architecture
+✅ 04 implementation-core
+🔄 05 implementation-api
+⬜ 06 testing
+⬜ 07 documentation
+⬜ 08 release
+```
+
+Add a new step:
+
+```bash
+riotplan step add "Integration Testing"
+riotplan step add "Security Audit" --number 07
+riotplan step add "Review" --after 05
+```
+
+Mark steps as started or completed:
+
+```bash
+riotplan step start 05
+riotplan step complete 05
+```
+
+### Managing Feedback
+
+Create and list feedback records:
+
+```bash
+riotplan feedback create        # Create feedback record
+riotplan feedback list          # List feedback records
+```
+
+### Validating Plans
+
+Validate plan structure:
+
+```bash
+riotplan plan validate          # Current directory
+riotplan plan validate ./my-plan # Specific path
+riotplan plan validate --fix    # Attempt to fix issues
+```
+
+Checks:
+- Required files exist (STATUS.md, EXECUTION_PLAN.md, etc.)
+- STATUS.md is parseable
+- Step files have valid numbering (01-*, 02-*, etc.)
+- Step dependencies are valid
+- No circular dependencies
+
+Archive a completed plan:
+
+```bash
+riotplan plan archive           # Current directory
+riotplan plan archive ./my-plan # Specific path
+```
+
+### Status Indicators
+
+| Symbol | Meaning |
+|--------|---------|
+| ⬜ | Pending |
+| 🔄 | In Progress |
+| ✅ | Completed |
+| ❌ | Failed |
+| ⏸️ | Blocked |
+| ⏭️ | Skipped |
+
+### Generate from Existing Prompt
+
+If you already have a plan directory with a prompt file:
+
+```bash
+riotplan generate ./my-plan --steps 5
+riotplan generate ./my-plan --provider anthropic --model claude-sonnet-4-5
+```
+
+### Configuration
+
+Create `.riotplanrc.json` in your plan directory:
+
+```json
+{
+  "defaultProvider": "anthropic",
+  "autoUpdateStatus": true,
+  "stepTemplate": "detailed",
+  "analysis": {
+    "enabled": true,
+    "directory": "analysis"
+  }
+}
+```
+
+## Programmatic Usage
 
 ```typescript
-import { loadPlan, resumePlan } from 'riotplan';
+import { loadPlan, resumePlan } from '@riotprompt/riotplan';
 
 // Load an existing plan
 const plan = await loadPlan('./prompts/my-feature');
@@ -146,10 +351,10 @@ _No issues encountered._
 
 ## Related Packages
 
-- `riotprompt` - Prompt modeling for single interactions
-- `agentic` - Multi-turn conversation framework
-- `execution` - LLM provider interfaces
-- `riotplan-cli` - Command-line interface (coming soon)
+- `@riotprompt/riotprompt` - Prompt modeling for single interactions
+- `@riotprompt/agentic` - Multi-turn conversation framework
+- `@riotprompt/execution` - LLM provider interfaces
+- `@riotprompt/riotplan-commands-*` - Command packages (plan, status, step, feedback)
 
 ## Philosophy
 
@@ -168,3 +373,5 @@ A plan provides structure for complex, iterative AI-assisted work where:
 
 Apache-2.0
 
+<!-- v1.0.0 -->
+

package/dist/bin.d.ts

@@ -0,0 +1 @@
+export { }

package/dist/bin.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+import { q as createProgram } from "./cli-BAr1IsMF.js";
+const program = createProgram();
+program.parse();
+//# sourceMappingURL=bin.js.map

package/dist/bin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bin.js","sources":["../src/cli/bin.ts"],"sourcesContent":["#!/usr/bin/env node\n\n/**\n * RiotPlan CLI executable entry point\n * This file is the actual binary that gets executed when running `riotplan`\n */\n\nimport { createProgram } from './cli.js';\n\nconst program = createProgram();\nprogram.parse();\n"],"names":[],"mappings":";;AASA,MAAM,UAAU,cAAA;AAChB,QAAQ,MAAA;"}