Guide

Guide is an interactive teaching skill that walks you through every feature of the brewcode/brewdoc/brewtools plugin suite. It tracks your progress, supports multiple languages, and adapts to your level.

/brewdoc:guide
/brewdoc:guide overview
/brewdoc:guide killer-flow

Haiku-powered

Guide runs on the haiku model for fast, lightweight responses. It is read-only and never modifies your project files.

9 Topics, 3 Domains

The guide covers the entire plugin suite across three progressive domains:

Domain A: Getting Started

  1. Three Plugins Overviewoverview

    What is brewcode/brewdoc/brewtools, the philosophy behind the suite, and what makes it unique.

  2. Installation & Updatesinstallation

    Marketplace setup, installing all 3 plugins, verifying versions, enabling auto-update.

Domain B: Core Workflow

  1. Spec, Plan, Startkiller-flow

    The infinite task pipeline: SPEC defines what, PLAN defines how, START does the work with automatic handoff.

  2. Dynamic Teamsteams

    Create 5-20 domain-specific agents tailored to your project. Self-evolving with trace tracking.

  3. Skills Catalogskills-catalog

    All 22+ skills across the three plugins with trigger examples and recommended order.

Domain C: Mastery

  1. Agents Catalogagents-catalog

    All 14+ agents with roles, model selection, and when to use each one.

  2. Build Your Owncustomization

    Create custom skills, agents, and hooks using skill-creator, agent-creator, and hook-creator.

  3. Project Configurationintegration

    CLAUDE.md, rules, memory, teams directory, and the full .claude/ structure.

  4. Power Featuresadvanced

    Grepai semantic search, convention extraction, quorum code review, secrets scanning.

How It Works

The guide follows a 5-phase flow:

PhaseWhat happens
0Validate environment — checks docs site, GitHub release, installed plugin versions
1Language & progress — select language (EN/RU/PT), load progress from previous sessions
2Menu or direct topic — show interactive menu or jump to a topic by name
3Deliver topic — present 3-4 sections with pauses for questions, examples, and deep dives
4Update progress — mark topic complete, recommend next topic

Between sections, you can choose:

  • Continue to the next section
  • Show me an example with project context
  • Go deeper for more detail
  • Skip or Back to menu

Progress Tracking

Progress is saved to ~/.claude/brewdoc/guide-progress.json and persists across sessions.

{
  "lang": "en",
  "completed": ["overview", "installation"],
  "last_topic": "killer-flow",
  "last_ts": "2026-04-02T10:00:00Z",
  "shown_count": { "overview": 2, "installation": 1 }
}

Returning users see their completion status and a recommendation for the next topic.

Two helper scripts manage the guide:

ScriptPurpose
validate.shCheck docs site, GitHub release, installed versions, auto-update status
progress.shCRUD for progress JSON: read, complete, lang, reset, status

Environment Health Check

On every launch, the guide checks your environment and shows a health table:

Component     Status      Details
Docs Site     UP          200
Latest        v3.4.20     GitHub
brewcode      3.4.20      current
brewdoc       3.4.20      current
brewtools     3.4.20      current
Auto-update   ON

Direct topic access

Jump straight to any topic: /brewdoc:guide killer-flow. Partial matching works too: /brewdoc:guide agent resolves to the agents catalog.