Skip to content

v0.1.7 — 4 explanation quick-wins (wizard hints, beacon new help, sync description)

Choose a tag to compare

View all tags
@Juliocbm Juliocbm released this 24 May 02:56
v0.1.7
6ce6c56

Patch release. Four explanation improvements across the CLI so first-time users don't have to guess.

1. Project type hints in the init wizard

Each option now shows which categories it enables by default:

●  Web Application (full-stack, SaaS)   core + business, integrations, operations, roadmaps
○  Backend Service / API                core + integrations, operations, roadmaps
○  Library / SDK / Package              core only (minimal)
○  CLI Tool                             core + operations
○  Mobile App                           core + business, integrations, operations, roadmaps
○  Monorepo / Workspace                 core + modules, integrations, operations, roadmaps
○  Custom (no defaults)                 nothing pre-selected — you opt into everything

Computed from defaultCategoriesFor() — single source of truth, no drift.

2. AI agent hints in the init wizard

Each agent option now shows which file it generates:

■  Claude Code        generates CLAUDE.md at project root
■  Cursor             generates .cursorrules + .cursor/rules/beacon.mdc
□  Codex / Copilot    generates AGENTS.md at project root
□  Gemini CLI         generates GEMINI.md at project root

3. Friendly help for beacon new without args

Instead of cac's terse "missing required arg" error, beacon new (no args) now prints a complete usage reference with all 11 doc types, destination paths, and examples:

$ beacon new
Usage:
  beacon new <type> <slug> [--category <integrations|operations>]

Available types:
  plan         active work with TODOs           → docs/plans/<slug>.plan.md
  adr          architecture decision record     → docs/adr/ADR-NNN-<slug>.md  (auto-numbered)
  pattern      replicable technical pattern     → docs/reference/<slug>.pattern.md
  eval         dated audit / snapshot           → docs/evaluations/YYYY-MM-DD-<slug>.eval.md
  architecture system structure document        → docs/architecture/<slug>.architecture.md
  module       functional / business module     → docs/modules/<slug>.module.md  (requires modules addon)
  guide        operational / integration setup  → docs/{integrations,operations}/<slug>.guide.md
  roadmap      multi-sprint roadmap             → docs/roadmaps/<slug>.roadmap.md  (requires roadmaps addon)
  todo         backlog item                     → docs/backlog/<slug>.todo.md
  business     business / strategy doc          → docs/business/<slug>.business.md  (requires business addon)
  compliance   regulatory document              → docs/compliance/<slug>.md  (requires compliance addon)

Examples:
  beacon new plan billing-integration
  beacon new adr add-rate-limiting
  beacon new guide deploy-staging --category operations

Slugs must be kebab-case (lowercase, hyphen-separated).

4. sync description expanded in --help

The global help now explains when to run sync, not just what it does:

Validation:
  sync     Regenerate AI rule files from docs/_meta/convention.md
           ↳ Run after editing convention.md, or if `lint` reports
             ai-files-sync (generated files drifted).
  lint     Validate the docs tree against the convention

Upgrade

npm install -D beacon-docs@latest

Full Changelog: v0.1.6...v0.1.7

Assets 2
Loading