Skip to content

docs: promote init wizard as recommended Quick Start option #307

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
TerminalGravity wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: promote init wizard as recommended Quick Start option #307

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 14 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,18 @@ The pattern is always the same: vague prompt → Claude guesses → wrong output

## Quick Start

### Option A: npx (fastest — no install)
### Option A: Interactive setup (recommended)

The init wizard creates your `.mcp.json` and `.preflight/` config in one step:

```bash
cd /path/to/your/project
npx preflight-dev init
```

It walks you through profile selection (minimal/standard/full), embedding provider, and config directory setup — then writes everything for you. Just restart Claude Code when it's done.

### Option B: One-liner (fastest — no wizard)

```bash
claude mcp add preflight -- npx -y preflight-dev-serve
Expand All @@ -90,7 +101,7 @@ claude mcp add preflight \
-- npx -y preflight-dev-serve
```

### Option B: Clone & configure manually
### Option C: Clone & configure manually

```bash
git clone https://github.com/TerminalGravity/preflight.git
Expand All @@ -115,7 +126,7 @@ Add to your project's `.mcp.json`:

Restart Claude Code. The tools activate automatically.

### Option C: npm (global)
### Option D: npm (global)

```bash
npm install -g preflight-dev
Expand Down
Loading