brewdoc:my-claude
Scannednpx machina-cli add skill kochetkov-ma/claude-brewcode/my-claude --openclawMy Claude
Generates documentation about your Claude Code installation and environment.
Mode Detection
Detect mode from $ARGUMENTS:
$ARGUMENTS value | Mode | Sub-mode |
|---|---|---|
| empty | INTERNAL | — |
ext or external (alone) | EXTERNAL | default |
ext context or external context | EXTERNAL | context-schema |
starts with r or research | RESEARCH | query = rest of args |
After detection, load the appropriate reference file:
- INTERNAL:
$BD_PLUGIN_ROOT/skills/my-claude/references/internal-mode.md - EXTERNAL:
$BD_PLUGIN_ROOT/skills/my-claude/references/external-mode.md - RESEARCH:
$BD_PLUGIN_ROOT/skills/my-claude/references/research-mode.md
BD_PLUGIN_ROOT is injected by brewdoc's pre-task.mjs hook and available in your context.
Output Directory
All generated docs go to ~/.claude/brewdoc/ (global, not project-specific).
Create if not exists: mkdir -p ~/.claude/brewdoc
INDEX Tracking
Append entry to ~/.claude/brewdoc/INDEX.jsonl:
{"ts":"2026-02-28T10:00:00","mode":"internal","path":"~/.claude/brewdoc/20260228_my-claude-internal.md","title":"Internal Claude Setup Overview","version":"1.0"}
If an existing entry for the same mode exists: use AskUserQuestion — header: "INDEX", question: "Entry for this mode already exists (v{VERSION}). Update it?", options: "Yes, update (bump version)" / "No, create new entry".
INTERNAL Mode
Goal: Document your local Claude Code setup — CLAUDE.md files, rules, agents, skills, memories.
Sources to analyze:
~/.claude/CLAUDE.md— global instructions~/.claude/rules/*.md— global rules~/.claude/agents/*.md— global agents~/.claude/skills/— global skills- Project
CLAUDE.md(current working directory) .claude/rules/*.md— project rules~/.claude/projects/**/memory/MEMORY.md— memory files
Process:
- Spawn 3 parallel
Exploreagents, one per source group: (1) global ~/.claude config, (2) project .claude config, (3) memory files - Aggregate findings into structured document
- Write to
~/.claude/brewdoc/YYYYMMDD_my-claude-internal.md - Spawn independent
revieweragent to validate facts (file paths exist, content accurate) - Apply reviewer fixes if any
- Add INDEX entry
Output document structure:
# Claude Code Internal Setup — {date}
## Global Configuration
### Instructions (CLAUDE.md)
### Rules ({N} rules)
### Agents ({N} agents)
### Skills ({N} skills)
## Project Configuration
### Project Instructions
### Project Rules
## Memory
### Active Memories ({N} entries)
## Summary
| Component | Count | Location |
|-----------|-------|----------|
EXTERNAL Mode
Goal: Document Claude Code's hook/context/agent architecture from official sources + local analysis.
Sub-mode default:
- Analyze local hook files for event model patterns
- WebSearch for recent Claude Code releases and CHANGELOG
- Spawn
general-purposeagents for: official docs (code.claude.com), GitHub releases, community forums - Generate
~/.claude/brewdoc/YYYYMMDD_my-claude-external.md
Sub-mode context-schema:
- Focus specifically on context injection schema (additionalContext, updatedInput, etc.)
- Output:
~/.claude/brewdoc/external/YYYYMMDD_context-schema.md
RESEARCH Mode
Goal: Research a specific query about Claude Code using multiple sources.
Query: everything after r or research in $ARGUMENTS
Process:
- Analyze query — divide into 2-5 source groups (official docs, GitHub, Reddit, forums, marketplaces)
- Spawn
general-purposeagents per source group in parallel - Aggregate with citation tracking (source URL per fact)
- Spawn independent
revieweragent to validate facts and source reliability - Output:
~/.claude/brewdoc/YYYYMMDD_research-{slug}.md
Output structure:
# Research: {query} — {date}
## Findings
### {Source Group 1}
...
## Sources
| Fact | Source | Reliability |
|------|--------|-------------|
## Review Verdict
Source
git clone https://github.com/kochetkov-ma/claude-brewcode/blob/main/brewdoc/skills/my-claude/SKILL.mdView on GitHub Overview
Generates structured documentation for Claude Code installations, covering internal setup, external hooks/context/agents references, and web-based research. It loads a mode-specific reference file and uses a reviewer to validate facts and paths. Outputs go to ~/.claude/brewdoc with an INDEX.jsonl entry for traceability.
How This Skill Works
Detects mode from ARGUMENTS (internal, external, or research). Loads the corresponding reference file under the BD_PLUGIN_ROOT and coordinates analysis across sources (global Claude config, project config, and memory files). Writes a markdown document to the brewdoc directory and spawns a reviewer to confirm accuracy; updates INDEX.jsonl and handles existing entries via a user prompt.
When to Use It
- Document your local Claude Code installation (internal mode).
- Generate external docs on hooks, context, or agents for a project.
- Produce context-schema focused documentation (context injection details).
- Perform targeted research from official sources, GitHub, or forums.
- Create or update project-scoped CLAUDE.md docs and track changes with INDEX.
Quick Start
- Step 1: Set ARGUMENTS to internal (empty), ext/external, or r/research for the desired mode.
- Step 2: Run brewdoc:my-claude to generate the document in ~/.claude/brewdoc.
- Step 3: Check the generated file and the INDEX.jsonl entry; run the reviewer if updates are needed.
Best Practices
- Clearly separate internal, external, and research outputs for easy navigation.
- Verify all source paths exist before generation to avoid missing content.
- Keep CLAUDE.md, rules, agents, skills, and memories up to date for accuracy.
- Run a reviewer pass to address any factual or path issues before finalizing.
- Maintain consistent output naming under ~/.claude/brewdoc and update INDEX.jsonl on changes.
Example Use Cases
- Internal Claude Code setup overview for a new workstation.
- External mode doc detailing hooks and context for a project.
- Context-schema doc outlining updatedInput and additionalContext fields.
- Research doc summarizing findings from forums and GitHub releases.
- Updated INDEX entry after a mode change or new run.