PromptUp

Set up your AI workspace in one command.

✨ Features

✅ One-command scaffolding — Instant SDD workspace setup
✅ Multi-agent support — Configure Copilot, Cursor, Claude, Windsurf, and more
✅ Spec-Driven Development — Structured workflow (Specify → Plan → Implement → Validate)
✅ Production-ready — TypeScript, tests, CI/CD, and documentation included
✅ Extensible — Adapter system for LLM providers (v0.2.0+)

🚀 Quick Start

Install & Run

No installation required:

npx promptup init

What It Does

1. Prompts for setup:

   • Project name
   • Author
   • AI agents to configure

2. Scaffolds workspace:

   my-project/
     ├─ specs/              # YAML specifications
     ├─ prompts/            # Reusable AI prompts
     ├─ docs/               # Auto-generated docs
     ├─ .github/            # Copilot instructions (if selected)
     ├─ cursor-rules.md     # Cursor config (if selected)
     ├─ claude.md           # Claude instructions (if selected)
     └─ promptup.config.json # PromptUp settings

3. Validates setup:

   npx promptup doctor

📖 Documentation

| Doc | Description | | ----------------------------------------------------- | ------------------------------------------ | | Overview | Purpose, tagline, quickstart | | CLI Reference | Command syntax, flags, examples | | SDD Spec | Overview of Spec-Driven Development | | Agents Overview | Full IDE/Agent matrix + setup instructions | | Templates | Template architecture and customization | | Configuration | promptup.config.json schema | | Architecture | Internal structure, module flow | | Roadmap | Version roadmap (v0.1 → v1.0) | | Contributing | Development guide | | Testing | Vitest coverage and CI details | | Security | Dependency hardening policy | | Telemetry | Opt-in policy & behavior |

🤖 Supported AI Agents

| Agent | Status | Files Generated | | ------------------ | ------ | ---------------------------------------------------- | | GitHub Copilot | ✅ | .github/copilot-instructions.md | | Copilot CLI | ✅ | .github/chatmodes/ | | Cursor | ✅ | cursor-rules.md, cursor.json | | Claude Code | ✅ | claude.md, .claude/policies.md | | Windsurf | ✅ | .windsurf/instructions.md | | Generic | ✅ | ai-instructions.md |

See Agents Overview for full details.

🧩 CLI Commands

| Command | Description | | ---------------------------- | ------------------------------------------------- | | promptup init | Bootstrap SDD workspace (interactive prompts) | | promptup spec new <name> | Create new spec file + update docs/spec-index.md | | promptup sync | Re-apply configs (non-destructive) | | promptup agents add <name> | Add AI agent configuration | | promptup agents remove <name> | Remove AI agent configuration | | promptup doctor | Validate workspace health |

See CLI Reference for full command documentation.

📋 Example Workflow

1. Initialize Workspace

npx promptup init

Select agents: GitHub Copilot, Cursor, Claude Code
Result: Complete SDD workspace with agent configs

2. Create Specification

npx promptup spec new user-authentication

Generated:

• specs/user-authentication.spec.yaml — Spec template
• docs/spec-index.md — Updated index

3. Implement with AI

Open in your IDE:

• Cursor reads cursor-rules.md automatically
• Claude Code reads claude.md automatically
• GitHub Copilot uses .github/copilot-instructions.md

Your AI agent now understands your project's SDD methodology!

4. Validate Setup

npx promptup doctor

Checks:

• ✅ All required files exist
• ✅ Config file is valid
• ✅ Agent files are present
• ✅ Specs directory initialized

🛠️ Tech Stack

| Category | Tools | | --------------- | -------------------------------------------------- | | Language | TypeScript (Node 20+, ESM) | | Package Mgr | pnpm | | CLI | Commander | | Templates | Handlebars | | Tests | Vitest (≥90% coverage) | | Lint/Format | ESLint + Prettier | | CI/CD | GitHub Actions + Changesets | | License | MIT |

🗺️ Roadmap

| Version | Milestone | Status | | ---------- | ----------------------------------------------------- | ---------- | | v0.1.0 | Core CLI + SDD scaffolding | ✅ Released | | v0.1.1 | Multi-agent support (Copilot, Cursor, Claude, Windsurf) | 🚧 In Progress | | v0.2.0 | Adapter system (OpenAI, Azure, Anthropic) | 📅 Planned | | v1.0.0 | GUI dashboard + docs site + community templates | 🚀 Future |

See Roadmap for detailed milestones.

🤝 Contributing

We welcome contributions! Please see Contributing Guide.

Quick Start:

1. Fork and clone the repo
2. Install dependencies: pnpm install
3. Run tests: pnpm test
4. Make changes and submit PR

Coverage requirement: ≥90%

📄 License

MIT License

🔗 Links

• GitHub: github.com/promptup/promptup
• NPM: npmjs.com/package/promptup
• Issues: Report bugs
• Discussions: Ask questions

🙏 Acknowledgments

Built with ❤️ for developers using AI.

Inspired by the need for standardized AI-assisted development workflows.

Get started now:

npx promptup init

⭐ Star us on GitHub — it helps!

Made with ❤️ for developers using AI