project-onboarding

# Project Onboarding

> **Turn vague project ideas into locked specifications through structured AI-assisted dialogue.**
> 
> **Tech-agnostic by design** — works with any framework or stack.

[![npm version](https://img.shields.io/npm/v/project-onboarding-skill.svg)](https://www.npmjs.com/package/project-onboarding-skill)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Works with Qwen Code](https://img.shields.io/badge/Qwen%20Code-compatible-blue)](https://qwenlm.github.io/qwen-code/)
[![Works with Claude Code](https://img.shields.io/badge/Cursor%20Code-compatible-8A2BE2)](https://docs.anthropic.com/en/docs/claude-code/overview)
[![Works with OpenCode](https://img.shields.io/badge/OpenCode-compatible-green)](https://opencode.ai)

A **technology-neutral** skill for AI coding agents that transforms a rough idea into production-ready engineering documents — **before any code is written**. Asks the right questions. Never invents requirements. Never assumes your stack. Produces a traceable, locked specification that works with **any framework** — JavaScript, Python, Go, Rust, or anything else.

**The skill asks — you decide.**

---

## Quick Install

### Option 1: npx (Recommended — all platforms)

```bash
npx project-onboarding-skill
```

Interactive installer — choose which AI agents to install for.

### Option 2: curl (Unix / macOS / Linux)

```bash
curl -fsSL https://raw.githubusercontent.com/raindragon14/project-onboarding/v3.0.3/install.sh | bash
```

### Option 3: PowerShell (Windows)

```powershell
iwr -useb https://raw.githubusercontent.com/raindragon14/project-onboarding/v3.0.3/install.ps1 | iex
```

### Option 4: Manual

Copy [`SKILL.md`](SKILL.md) and [`references/`](references/) to your agent's skill directory:

| Agent | Global Path | Project Path |
|-------|-------------|--------------|
| **Qwen Code** | `~/.qwen/skills/project-onboarding/` | `.qwen/skills/project-onboarding/` |
| **Claude Code