PromptUp

Set up your AI workspace in one command.

Production-grade NPX CLI SDK that scaffolds Spec-Driven Development (SDD) workspaces
with integrated AI agent configurations.

One command. Complete setup. Multiple AI tools supported.

Features • Quick Start • Documentation • AI Agents • Roadmap • Contributing

✨ 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

🤖 Supported AI Agents

See Agents Overview for full details.

🧩 CLI Commands

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

🗺️ Roadmap

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