prompt-suite
v1.0.18
Published
Prompt Suite - Prompt Engineering & Workflow Automation
Maintainers
Readme
Prompt Suite - Development Workflow Automation
Prompt Suite is a comprehensive prompt system that automates the software development process from raw customer request → production-ready code + tests.
📑 Table of Contents
- Installation
- Updating / Upgrading
- Overview
- Complete Workflow
- Quick Start
- What Gets Installed
- Available Commands
- Workflow Rules (Step 0)
- Requirement Steps (Step 1)
- Technical Design Steps (Step 2)
- Test Plan Steps (Step 3)
- Implementation Steps (Step 4)
- Test Code Steps (Step 5)
- Validation Step (Step 6)
- Usage Tips
- Multi-Language Support
- File Structure
- Manual IDE Setup
- Complete Example
- Troubleshooting
- Contributing
- License
📦 Installation
To install Prompt Suite in your project:
# Install the package
npm install prompt-suite -D
# Initialize and setup
npx prompt-suite initDuring initialization, you'll be prompted to select your IDE:
- VSCode / Cursor - Prompts will be installed to
.github/prompts/ - Antigravity - Prompts will be installed to
.agent/workflows/ - Skip - Manual setup later
The installer will:
- Copy resources (rules, scripts, templates) to
prompt-suite/folder - Copy prompt files directly to your IDE's prompts directory
- Update IDE settings (VSCode only)
⚠️ Important: Run this command on your local machine (where your IDE is installed), NOT inside a Docker container.
🔄 Updating / Upgrading
To update prompt-suite to the latest version:
1. Update the package
npm install prompt-suite@latest -D2. Update resources and prompts
Safe Mode (Default):
Preserves your customizations by skipping modified files:
npx prompt-suite initForce Overwrite:
Resets everything to latest defaults (⚠️ overwrites your changes):
npx prompt-suite init --forceConflict Resolution:
If a file exists but differs from the new version, a .new file will be created (e.g., README.md.new) for manual comparison and merging.
📋 Overview
Prefix: /ps. - All Prompt Suite commands start with this prefix
🎯 Complete Workflow
[Step 0] Generate Workflow Rules (Requirement/Design/Test/Code Rules)
↓
[Step 1] Requirement Document
↓
[Step 2] Technical Design
↓
[Step 3] Test Plan
↓
[Step 4] Feature Code (Direct Modification)
↓
[Step 5] Test Code (Direct Modification)
↓
[Step 6] Full Validation🚀 Quick Start
1. Install and Initialize
npm install prompt-suite -D
npx prompt-suite initSelect your IDE when prompted. Prompts will be automatically installed.
2. Generate Coding Rules (One-time)
# Copy template
cp prompt-suite/tasks/templates/gen-rule-template.md my-rules.md
# Edit my-rules.md with your stack info
# Then generate all rules:
/ps.0-gen-rules my-rules.md
# AI will automatically write 10 rule files to prompt-suite/rules/3. Start Your First Feature
# Copy template
cp prompt-suite/tasks/templates/gen-requirement-template.md FEAT-001-request.md
# Edit FEAT-001-request.md with your feature request
# Then generate requirement:
/ps.1-gen-requirement FEAT-001-request.md
# AI auto-creates folder: prompt-suite/tasks/FEAT-001/
# Generate design (AI auto-writes FEAT-001-design.md):
/ps.2-gen-design prompt-suite/tasks/FEAT-001/FEAT-001-requirement.md
# Generate test plan (AI auto-writes FEAT-001-test.md)
/ps.3-gen-test-plan prompt-suite/tasks/FEAT-001/FEAT-001-design.md
# Generate code (AI modifies codebase directly):
/ps.4-gen-code prompt-suite/tasks/FEAT-001/FEAT-001-design.md📦 What Gets Installed
In prompt-suite/ folder:
rules/- Project-specific Workflow Rules (Requirement, Design, Code, etc.)scripts/- Setup scripts for manual IDE configurationtasks/- Task artifacts and templatestemplates/- Input templates for commands{TASK-ID}/- Generated task artifacts (requirements, designs, plans)
README.md- This documentation
In your IDE:
- VSCode/Cursor:
.github/prompts/*.md- All prompt files - Antigravity:
.agent/workflows/*.md- All prompt files
📚 Available Commands
🛡️ Workflow Rules (Step 0: One-time Setup)
| Command | Purpose | AI Behavior |
| :---------------- | :------------------------- | :------------------------------------------------ |
| /ps.0-gen-rules | Generate all project rules | Auto-writes 10 files to prompt-suite/rules/ |
| /ps.0-rev-rules | Review and improve rules | Updates rules in prompt-suite/rules/ |
📝 Requirement Steps (Step 1)
| Command | Purpose | AI Behavior |
| :---------------------- | :----------------------------------- | :----------------------------------------- |
| /ps.1-gen-requirement | Raw request → Structured requirement | Auto-writes {task-id}-requirement.md |
| /ps.1-rev-requirement | Review and refine requirements | Updates {task-id}-requirement.md |
🏗️ Technical Design Steps (Step 2)
| Command | Purpose | AI Behavior |
| :----------------- | :----------------------------- | :------------------------------------ |
| /ps.2-gen-design | Requirement → Technical Design | Auto-writes {task-id}-design.md |
| /ps.2-rev-design | Review design implementability | Updates {task-id}-design.md |
🧪 Test Plan Steps (Step 3)
| Command | Purpose | AI Behavior |
| :-------------------- | :------------------- | :---------------------------------- |
| /ps.3-gen-test-plan | Design → Test Plan | Auto-writes {task-id}-test.md |
| /ps.3-rev-test-plan | Review test coverage | Updates {task-id}-test.md |
💻 Implementation Steps (Step 4)
| Command | Purpose | AI Behavior |
| :--------------- | :-------------------------------- | :-------------------------------------- |
| /ps.4-gen-code | Design → Feature Code | Modifies codebase directly |
| /ps.4-rev-code | Review code quality & correctness | Fixes code directly if issues found |
🧪 Test Code Steps (Step 5)
| Command | Purpose | AI Behavior |
| :-------------------- | :-------------------- | :--------------------------------------- |
| /ps.5-gen-test-code | Test Plan → Test Code | Modifies codebase directly |
| /ps.5-rev-test-code | Review test quality | Fixes tests directly if issues found |
✅ Validation Step (Step 6)
| Command | Purpose | AI Behavior |
| :--------------- | :---------------------------------- | :----------------------------------- |
| /ps.6-validate | Cross-stage validation (Req → Test) | Generates inline analysis report |
💡 Usage Tips
Input Format
All commands require file path input (not direct text):
# ✅ Correct - file path
/ps.1-gen-requirement FEAT-001-request.md
# ❌ Wrong - direct text not supported
/ps.1-gen-requirement "I want a login feature"Task ID Requirement
Filenames must contain a Task ID (e.g., FEAT-001, BUG-123):
# ✅ Valid filenames
/ps.1-gen-requirement customer-request-FEAT-001.md
/ps.2-gen-design BUG-123-bugfix.md
# ❌ Invalid - no Task ID
/ps.1-gen-requirement request.mdTask IDs follow the pattern: {TYPE}-{NUMBER} (e.g., FEAT-001, BUG-123)
| Type | Purpose | Example |
| :--------------- | :--------------------------- | :------------- |
| FEAT-xxx | New feature or functionality | FEAT-001 |
| BUG-xxx | Bug fix | BUG-042 |
| IMP-xxx | Improvement or enhancement | IMP-023 |
| REFACTOR-xxx | Code refactoring | REFACTOR-001 |
| HOTFIX-xxx | Critical production fix | HOTFIX-001 |
| SPIKE-xxx | Research or investigation | SPIKE-001 |
| CHORE-xxx | Maintenance tasks | CHORE-015 |
💡 See
prompt-suite/tasks/templates/TASK-ID-TYPES.mdfor detailed guidelines
Version Control
When the AI modifies code directly, we recommend reviewing the changes via your IDE's source control view before committing.
# Review changes
git status
git diff
# Commit
git add .
git commit -m "feat: implement feature FEAT-001"Flexible Workflow
You don't need to run all steps. Adapt based on complexity:
Small task (bug fix):
/ps.1-gen-requirement → /ps.2-gen-design → /ps.4-gen-codeMedium task (new feature):
/ps.1-gen-requirement → /ps.1-rev-requirement
→ /ps.2-gen-design → /ps.2-rev-design
→ /ps.3-gen-test-plan → /ps.4-gen-code → /ps.5-gen-test-codeLarge task (critical feature):
Full workflow (Steps 0-6)🌍 Multi-Language Support
Supported languages: en (English), vi (Vietnamese), ja (Japanese), ko (Korean)
Technical terms (API, HTTP, JWT, etc.) always stay in English.
Example:
Task ID: FEAT-001
Language: vi
Raw Request: Tôi muốn user đăng nhập bằng email/password...📁 File Structure
project/
├── prompt-suite/ # Installed resources
│ ├── rules/ # Generated coding rules
│ │ ├── ps.1-gen-requirement.rule.md
│ │ ├── ps.1-rev-requirement.rule.md
│ │ └── ...
│ ├── scripts/ # Manual setup scripts
│ │ ├── setup-ps-chat-vscode.sh
│ │ └── setup-ps-chat-antigravity.sh
│ ├── tasks/ # Task artifacts & templates
│ │ ├── templates/ # Input templates
│ │ │ ├── gen-rule-template.md
│ │ │ └── gen-requirement-template.md
│ │ └── FEAT-001/ # Generated task artifacts
│ │ ├── FEAT-001-requirement.md
│ │ ├── FEAT-001-design.md
│ │ └── FEAT-001-test.md
│ └── README.md
│
├── .github/prompts/ # VSCode prompts (auto-installed)
│ ├── ps.0-gen-rules.prompt.md
│ ├── ps.1-gen-requirement.prompt.md
│ └── ...
│
├── .agent/workflows/ # Antigravity prompts (auto-installed)
│ ├── ps.0-gen-rules.prompt.md
│ ├── ps.1-gen-requirement.prompt.md
│ └── ...
│
└── src/ # Your source code🔧 Manual IDE Setup
If you skipped IDE selection during init, you can run setup scripts manually:
# For VSCode/Cursor
bash prompt-suite/scripts/setup-ps-chat-vscode.sh
# For Antigravity
bash prompt-suite/scripts/setup-ps-chat-antigravity.shScenario: User Login with Rate Limiting
Step 0: Generate Workflow Rules
cp prompt-suite/tasks/templates/gen-rule-template.md my-rules.md
# Edit: Step: all, Stack: Laravel + Vue.js, Architecture: Clean Architecture
/ps.0-gen-rules my-rules.mdStep 1: Generate Requirement
cp prompt-suite/tasks/templates/gen-requirement-template.md FEAT-001-request.md
# Edit: Task ID: FEAT-001, Raw Request: User login with email/password...
/ps.1-gen-requirement FEAT-001-request.md
/ps.1-rev-requirement prompt-suite/tasks/FEAT-001/FEAT-001-requirement.mdStep 2: Generate Design
/ps.2-gen-design prompt-suite/tasks/FEAT-001/FEAT-001-requirement.md
/ps.2-rev-design prompt-suite/tasks/FEAT-001/FEAT-001-design.mdStep 3: Generate Test Plan
/ps.3-gen-test-plan prompt-suite/tasks/FEAT-001/FEAT-001-design.md
/ps.3-rev-test-plan prompt-suite/tasks/FEAT-001/FEAT-001-test.mdStep 4: Generate Code
/ps.4-gen-code prompt-suite/tasks/FEAT-001/FEAT-001-design.md
# AI modifies codebase directly
git add . && git commit -m "feat: login with rate limiting (FEAT-001)"Step 5: Generate Test Code
/ps.5-gen-test-code prompt-suite/tasks/FEAT-001/FEAT-001-test.md
# AI modifies codebase directlyStep 6: Validate
/ps.6-validate \
prompt-suite/tasks/FEAT-001/FEAT-001-requirement.md \
prompt-suite/tasks/FEAT-001/FEAT-001-design.md \
prompt-suite/tasks/FEAT-001/FEAT-001-test.md🔍 Troubleshooting
Issue: Prompts not showing in IDE
VSCode/Cursor:
- Check if files exist in
.github/prompts/ - Verify
.vscode/settings.jsonhaschat.promptFilesRecommendations - Restart VSCode/Cursor
Antigravity:
- Check if files exist in
.agent/workflows/ - Restart Antigravity
Solution:
# Re-run setup manually
bash prompt-suite/scripts/setup-ps-chat-vscode.sh # VSCode
bash prompt-suite/scripts/setup-ps-chat-antigravity.sh # AntigravityIssue: Task ID not recognized
Error: "Error: No Task ID found in filename"
Solution:
# ❌ Wrong
/ps.1-gen-requirement request.md
# ✅ Correct - include Task ID in filename
/ps.1-gen-requirement FEAT-001-request.mdIssue: Rules not found
Error: "Workflow rules not found"
Solution:
# Generate rules first (Step 0)
cp prompt-suite/tasks/templates/gen-rule-template.md my-rules.md
# Edit my-rules.md
/ps.0-gen-rules my-rules.mdIssue: Package version mismatch
Solution:
# Clear cache and reinstall
npm cache clean --force
rm -rf node_modules package-lock.json
npm install
npx prompt-suite@latest init --force🤝 Contributing
Issues and pull requests are welcome!
📄 License
ISC
Made with ❤️ by Phong Le
