npm package: @promptup/cli
Description: Set up your AI workspace in one command - Spec-Driven Development scaffolding with multi-agent support and interview framework
Author: PromptUp Contributors
Latest version: 0.3.2

<div align="center">

<img src="PromptUp-Icon.png" alt="PromptUp Logo" width="400" height="400"/>

# PromptUp

**Set up your AI workspace in one command.**

[![npm version](https://img.shields.io/npm/v/promptup.svg?style=flat-square&color=5D6D7E)](https://www.npmjs.com/package/promptup)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](https://opensource.org/licenses/MIT)
[![CI](https://github.com/promptup/promptup/actions/workflows/ci.yml/badge.svg?style=flat-square)](https://github.com/promptup/promptup/actions)
[![Coverage](https://img.shields.io/codecov/c/github/promptup/promptup?style=flat-square&color=brightgreen)](https://codecov.io/gh/promptup/promptup)
[![TypeScript](https://img.shields.io/badge/TypeScript-5.3-blue?style=flat-square&logo=typescript)](https://www.typescriptlang.org/)
[![Node.js](https://img.shields.io/badge/Node.js-20+-green?style=flat-square&logo=node.js)](https://nodejs.org/)

<p align="center">
  <strong>Production-grade NPX CLI SDK that scaffolds Spec-Driven Development (SDD) workspaces<br/>with integrated AI agent configurations.</strong>
</p>

<p align="center">
  One command. Complete setup. Multiple AI tools supported.
</p>

<p align="center">
  <a href="#-features">Features</a> •
  <a href="#-quick-start">Quick Start</a> •
  <a href="#-documentation">Documentation</a> •
  <a href="#-supported-ai-agents">AI Agents</a> •
  <a href="#-roadmap">Roadmap</a> •
  <a href="#-contributing">Contributing</a>
</p>

</div>

<p align="center">
  <img src="https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png" alt="-----------------------------------------------------" />
</p>

---

## ✨ 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:

```bash
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**:
   ```bash
   npx promptup doctor
   ```

---

## 📖 Documentation

| Doc                                                   | Description                                |
| ----------------------------------------------------- | ------------------------------------------ |
| [Overview](./docs/overview.md)                        | Purpose, tagline, quickstart               |
| [CLI Reference](./docs/cli-reference.md)              | Command syntax, flags, examples            |
| [SDD Spec](./docs/sdd-spec.md)                        | Overview of Spec-Driven Development        |
| [Agents Overview](./docs/agents-overview.md)          | Full IDE/Agent matrix + setup instructions |
| [Templates](./docs/templates.md)                      | Template architecture and customization    |
| [Configuration](./docs/config.md)                     | `promptup.config.json` schema              |
| [Architecture](./docs/architecture.md)                | Internal structure, module flow            |
| [Roadmap](./docs/roadmap.md)                          | Version roadmap (v0.1 → v1.0)              |
| [Contributing](./docs/contributing.md)                | Development guide                          |
| [Testing](./docs/testing.md)                          | Vitest coverage and CI details             |
| [Security](./docs/security.md)                        | Dependency hardening policy                |
| [Telemetry](./docs/telemetry.md)                      | 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](./docs/agents-overview.md) 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](./docs/cli-reference.md) for full command documentation.*

---

## 📋 Example Workflow

### 1. Initialize Workspace

```bash
npx promptup init
```

**Select agents**: GitHub Copilot, Cursor, Claude Code  
**Result**: Complete SDD workspace with agent configs

---

### 2. Create Specification

```bash
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

```bash
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](./docs/roadmap.md) for detailed milestones.*

<p align="center">
  <img src="https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png" alt="-----------------------------------------------------" />
</p>

## 🤝 Contributing

We welcome contributions! Please see [Contributing Guide](./docs/contributing.md).

**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](./LICENSE)

---

## 🔗 Links

- **GitHub**: [github.com/promptup/promptup](https://github.com/promptup/promptup)
- **NPM**: [npmjs.com/package/promptup](https://www.npmjs.com/package/promptup)
- **Issues**: [Report bugs](https://github.com/promptup/promptup/issues)
- **Discussions**: [Ask questions](https://github.com/promptup/promptup/discussions)

---

## 🙏 Acknowledgments

Built with ❤️ for developers using AI.

Inspired by the need for standardized AI-assisted development workflows.

---

**Get started now:**

```bash
npx promptup init
```

<p align="center">
  <img src="https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png" alt="-----------------------------------------------------" />
</p>

<div align="center">

### ⭐ Star us on GitHub — it helps!

[![GitHub stars](https://img.shields.io/github/stars/promptup/promptup?style=social)](https://github.com/promptup/promptup/stargazers)
[![GitHub forks](https://img.shields.io/github/forks/promptup/promptup?style=social)](https://github.com/promptup/promptup/network/members)

**Made with ❤️ for developers using AI**

</div>