Skip to content

v0.1.6 — wizard: explanatory note at start

Choose a tag to compare

@Juliocbm Juliocbm released this 24 May 02:47

Patch release. UX improvement to the interactive beacon init wizard.

What's new

The wizard now shows a boxed note before the first prompt explaining what the wizard will do — so users know what to expect (and what gets touched in their repo) before answering questions.

┌  Beacon — initialize docs convention
│
◇  This wizard will: ──────────────────────────────────────────────────────────╮
│                                                                              │
│  1. Ask about your project type and which doc categories to enable           │
│  2. Create a `docs/` folder structure in this directory                      │
│  3. Generate AI rule files (CLAUDE.md, AGENTS.md, etc.) at the project root  │
│  4. Add a `docs:lint` script to your package.json (if present)               │
│                                                                              │
│  Press Ctrl+C to abort. Nothing is written until you confirm all choices.    │
│                                                                              │
├──────────────────────────────────────────────────────────────────────────────╯
│
◆  Project type?

The non-interactive path (beacon init --yes ...) is unchanged — the note only appears in the interactive wizard.

Why

First-time users had no way to know what the wizard would touch in their repo (docs/, CLAUDE.md, package.json, etc.) before answering questions. The note removes that uncertainty and confirms Ctrl+C is safe (nothing writes until all choices are confirmed).

Upgrade

npm install -D beacon-docs@latest

Full Changelog: v0.1.5...v0.1.6