c05708162c
GitHub Pages is configured to serve from /docs in main branch. Moved documentation site from plugins/compounding-engineering/docs/ to repository root /docs folder. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
525 lines
22 KiB
HTML
525 lines
22 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en" class="theme-dark">
|
|
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<title>Command Reference - Compounding Engineering</title>
|
|
<meta content="Complete reference for all 16 slash commands in the Compounding Engineering plugin." name="description" />
|
|
<meta content="width=device-width, initial-scale=1" name="viewport" />
|
|
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css" />
|
|
<link href="../css/style.css" rel="stylesheet" type="text/css" />
|
|
<link href="../css/docs.css" rel="stylesheet" type="text/css" />
|
|
<script src="../js/main.js" type="text/javascript" defer></script>
|
|
</head>
|
|
|
|
<body>
|
|
<div class="background-gradient"></div>
|
|
<div class="docs-layout">
|
|
<aside class="docs-sidebar">
|
|
<div class="sidebar-header">
|
|
<a href="../index.html" class="nav-brand">
|
|
<span class="logo-icon"><i class="fa-solid fa-layer-group"></i></span>
|
|
<span class="logo-text">CE Docs</span>
|
|
</a>
|
|
</div>
|
|
<nav class="sidebar-nav">
|
|
<div class="nav-section">
|
|
<h3>Getting Started</h3>
|
|
<ul>
|
|
<li><a href="getting-started.html">Installation</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="nav-section">
|
|
<h3>Reference</h3>
|
|
<ul>
|
|
<li><a href="agents.html">Agents (23)</a></li>
|
|
<li><a href="commands.html" class="active">Commands (13)</a></li>
|
|
<li><a href="skills.html">Skills (11)</a></li>
|
|
<li><a href="mcp-servers.html">MCP Servers (two)</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="nav-section">
|
|
<h3>Resources</h3>
|
|
<ul>
|
|
<li><a href="changelog.html">Changelog</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="nav-section">
|
|
<h3>On This Page</h3>
|
|
<ul>
|
|
<li><a href="#workflow-commands">Workflow (four)</a></li>
|
|
<li><a href="#utility-commands">Utility (12)</a></li>
|
|
</ul>
|
|
</div>
|
|
</nav>
|
|
</aside>
|
|
|
|
<main class="docs-content">
|
|
<div class="docs-header">
|
|
<nav class="breadcrumb">
|
|
<a href="../index.html">Home</a>
|
|
<span>/</span>
|
|
<a href="getting-started.html">Docs</a>
|
|
<span>/</span>
|
|
<span>Commands</span>
|
|
</nav>
|
|
<button class="mobile-menu-toggle" data-sidebar-toggle>
|
|
<i class="fa-solid fa-bars"></i>
|
|
</button>
|
|
</div>
|
|
|
|
<article class="docs-article">
|
|
<h1><i class="fa-solid fa-terminal color-accent"></i> Command Reference</h1>
|
|
<p class="lead">
|
|
Complete documentation for all 16 slash commands. Commands automate complex multi-step workflows
|
|
by orchestrating multiple agents, tools, and processes.
|
|
</p>
|
|
|
|
<!-- Workflow Commands -->
|
|
<section id="workflow-commands">
|
|
<h2><i class="fa-solid fa-arrows-spin"></i> Workflow Commands (four)</h2>
|
|
<p>Core workflow commands that embody the Plan-Delegate-Assess-Codify philosophy.</p>
|
|
|
|
<div class="command-detail" id="workflows-plan">
|
|
<div class="command-detail-header">
|
|
<code class="command-detail-name">/workflows:plan</code>
|
|
</div>
|
|
<p class="command-detail-description">
|
|
Transform feature descriptions into well-structured project plans following conventions.
|
|
</p>
|
|
<h4>Arguments</h4>
|
|
<p><code>[feature description, bug report, or improvement idea]</code></p>
|
|
<h4>Workflow</h4>
|
|
<ol>
|
|
<li><strong>Repository Research (Parallel)</strong> - Launch three agents simultaneously:
|
|
<ul>
|
|
<li><code>repo-research-analyst</code> - Project patterns</li>
|
|
<li><code>best-practices-researcher</code> - Industry standards</li>
|
|
<li><code>framework-docs-researcher</code> - Framework documentation</li>
|
|
</ul>
|
|
</li>
|
|
<li><strong>SpecFlow Analysis</strong> - Run <code>spec-flow-analyzer</code> for user flows</li>
|
|
<li><strong>Choose Detail Level</strong>:
|
|
<ul>
|
|
<li><strong>MINIMAL</strong> - Simple bugs/small improvements</li>
|
|
<li><strong>MORE</strong> - Standard features</li>
|
|
<li><strong>A LOT</strong> - Major features with phases</li>
|
|
</ul>
|
|
</li>
|
|
<li><strong>Write Plan</strong> - Save as <code>plans/<issue_title>.md</code></li>
|
|
<li><strong>Review</strong> - Call <code>/plan_review</code> for multi-agent feedback</li>
|
|
</ol>
|
|
<div class="callout callout-info">
|
|
<div class="callout-icon"><i class="fa-solid fa-circle-info"></i></div>
|
|
<div class="callout-content">
|
|
<p>This command does NOT write code. It only researches and creates the plan.</p>
|
|
</div>
|
|
</div>
|
|
<div class="card-code-block">
|
|
<pre><code>/workflows:plan Add OAuth integration for third-party auth
|
|
/workflows:plan Fix N+1 query in user dashboard</code></pre>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="command-detail" id="workflows-review">
|
|
<div class="command-detail-header">
|
|
<code class="command-detail-name">/workflows:review</code>
|
|
</div>
|
|
<p class="command-detail-description">
|
|
Perform exhaustive code reviews using multi-agent analysis, ultra-thinking, and worktrees.
|
|
</p>
|
|
<h4>Arguments</h4>
|
|
<p><code>[PR number, GitHub URL, branch name, or "latest"]</code></p>
|
|
<h4>Workflow</h4>
|
|
<ol>
|
|
<li><strong>Setup</strong> - Detect review target, optionally use git-worktree for isolation</li>
|
|
<li><strong>Launch 12 Parallel Review Agents</strong>:
|
|
<ul>
|
|
<li><code>kieran-rails-reviewer</code>, <code>dhh-rails-reviewer</code></li>
|
|
<li><code>security-sentinel</code>, <code>performance-oracle</code></li>
|
|
<li><code>architecture-strategist</code>, <code>data-integrity-guardian</code></li>
|
|
<li><code>pattern-recognition-specialist</code>, <code>git-history-analyzer</code></li>
|
|
<li>And more...</li>
|
|
</ul>
|
|
</li>
|
|
<li><strong>Ultra-Thinking Analysis</strong> - Stakeholder perspectives, scenario exploration</li>
|
|
<li><strong>Simplification Review</strong> - Run <code>code-simplicity-reviewer</code></li>
|
|
<li><strong>Synthesize Findings</strong> - Categorize by severity (P1/P2/P3)</li>
|
|
<li><strong>Create Todo Files</strong> - Using file-todos skill for all findings</li>
|
|
</ol>
|
|
<div class="callout callout-warning">
|
|
<div class="callout-icon"><i class="fa-solid fa-triangle-exclamation"></i></div>
|
|
<div class="callout-content">
|
|
<p><strong>P1 (Critical) findings BLOCK MERGE.</strong> Address these before merging.</p>
|
|
</div>
|
|
</div>
|
|
<div class="card-code-block">
|
|
<pre><code>/workflows:review 42
|
|
/workflows:review https://github.com/owner/repo/pull/42
|
|
/workflows:review feature-branch-name
|
|
/workflows:review latest</code></pre>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="command-detail" id="workflows-work">
|
|
<div class="command-detail-header">
|
|
<code class="command-detail-name">/workflows:work</code>
|
|
</div>
|
|
<p class="command-detail-description">
|
|
Execute work plans efficiently while maintaining quality and finishing features.
|
|
</p>
|
|
<h4>Arguments</h4>
|
|
<p><code>[plan file, specification, or todo file path]</code></p>
|
|
<h4>Phases</h4>
|
|
<ol>
|
|
<li><strong>Quick Start</strong>
|
|
<ul>
|
|
<li>Read plan & clarify requirements</li>
|
|
<li>Setup environment (live or worktree)</li>
|
|
<li>Create TodoWrite task list</li>
|
|
</ul>
|
|
</li>
|
|
<li><strong>Execute</strong>
|
|
<ul>
|
|
<li>Task execution loop with progress tracking</li>
|
|
<li>Follow existing patterns</li>
|
|
<li>Test continuously</li>
|
|
<li>Figma sync if applicable</li>
|
|
</ul>
|
|
</li>
|
|
<li><strong>Quality Check</strong>
|
|
<ul>
|
|
<li>Run test suite</li>
|
|
<li>Run linting</li>
|
|
<li>Optional reviewer agents for complex changes</li>
|
|
</ul>
|
|
</li>
|
|
<li><strong>Ship It</strong>
|
|
<ul>
|
|
<li>Create commit with conventional format</li>
|
|
<li>Create pull request</li>
|
|
<li>Notify with summary</li>
|
|
</ul>
|
|
</li>
|
|
</ol>
|
|
<div class="card-code-block">
|
|
<pre><code>/workflows:work plans/user-authentication.md
|
|
/workflows:work todos/042-ready-p1-performance-issue.md</code></pre>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="command-detail" id="workflows-codify">
|
|
<div class="command-detail-header">
|
|
<code class="command-detail-name">/workflows:codify</code>
|
|
</div>
|
|
<p class="command-detail-description">
|
|
Document a recently solved problem for the knowledge base.
|
|
</p>
|
|
<h4>Arguments</h4>
|
|
<p><code>[optional: brief context about the fix]</code></p>
|
|
<h4>Workflow</h4>
|
|
<ol>
|
|
<li><strong>Preconditions</strong> - Verify problem is solved and verified working</li>
|
|
<li><strong>Launch seven parallel subagents</strong>:
|
|
<ul>
|
|
<li>Context Analyzer - Extract YAML frontmatter skeleton</li>
|
|
<li>Solution Extractor - Identify root cause and solution</li>
|
|
<li>Related Docs Finder - Find cross-references</li>
|
|
<li>Prevention Strategist - Develop prevention strategies</li>
|
|
<li>Category Classifier - Determine docs category</li>
|
|
<li>Documentation Writer - Create the file</li>
|
|
<li>Optional Specialized Agent - Based on problem type</li>
|
|
</ul>
|
|
</li>
|
|
<li><strong>Create Documentation</strong> - File in <code>docs/solutions/[category]/</code></li>
|
|
</ol>
|
|
<h4>Auto-Triggers</h4>
|
|
<p>Phrases: "that worked", "it's fixed", "working now", "problem solved"</p>
|
|
<div class="card-code-block">
|
|
<pre><code>/workflows:codify
|
|
/workflows:codify N+1 query optimization</code></pre>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
|
|
<!-- Utility Commands -->
|
|
<section id="utility-commands">
|
|
<h2><i class="fa-solid fa-wrench"></i> Utility Commands (12)</h2>
|
|
<p>Specialized commands for specific tasks like changelog generation, bug reporting, and parallel resolution.</p>
|
|
|
|
<div class="command-detail" id="changelog">
|
|
<div class="command-detail-header">
|
|
<code class="command-detail-name">/changelog</code>
|
|
</div>
|
|
<p class="command-detail-description">
|
|
Create engaging changelogs for recent merges to main branch.
|
|
</p>
|
|
<h4>Arguments</h4>
|
|
<p><code>[optional: daily|weekly, or time period in days]</code></p>
|
|
<h4>Output Sections</h4>
|
|
<ul>
|
|
<li>Breaking Changes (top priority)</li>
|
|
<li>New Features</li>
|
|
<li>Bug Fixes</li>
|
|
<li>Other Improvements</li>
|
|
<li>Shoutouts</li>
|
|
<li>Fun Fact</li>
|
|
</ul>
|
|
<div class="card-code-block">
|
|
<pre><code>/changelog daily
|
|
/changelog weekly
|
|
/changelog 7</code></pre>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="command-detail" id="create-agent-skill">
|
|
<div class="command-detail-header">
|
|
<code class="command-detail-name">/create-agent-skill</code>
|
|
</div>
|
|
<p class="command-detail-description">
|
|
Create or edit Claude Code skills with expert guidance on structure and best practices.
|
|
</p>
|
|
<h4>Arguments</h4>
|
|
<p><code>[skill description or requirements]</code></p>
|
|
<div class="card-code-block">
|
|
<pre><code>/create-agent-skill PDF processing for document analysis
|
|
/create-agent-skill Web scraping with error handling</code></pre>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="command-detail" id="generate-command">
|
|
<div class="command-detail-header">
|
|
<code class="command-detail-name">/generate_command</code>
|
|
</div>
|
|
<p class="command-detail-description">
|
|
Create a new custom slash command following conventions and best practices.
|
|
</p>
|
|
<h4>Arguments</h4>
|
|
<p><code>[command purpose and requirements]</code></p>
|
|
<div class="card-code-block">
|
|
<pre><code>/generate_command Security audit for codebase
|
|
/generate_command Automated performance testing</code></pre>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="command-detail" id="heal-skill">
|
|
<div class="command-detail-header">
|
|
<code class="command-detail-name">/heal-skill</code>
|
|
</div>
|
|
<p class="command-detail-description">
|
|
Heal skill documentation by applying corrections discovered during execution.
|
|
</p>
|
|
<h4>Arguments</h4>
|
|
<p><code>[optional: specific issue to fix]</code></p>
|
|
<h4>Approval Options</h4>
|
|
<ol>
|
|
<li>Apply and commit</li>
|
|
<li>Apply without commit</li>
|
|
<li>Revise changes</li>
|
|
<li>Cancel</li>
|
|
</ol>
|
|
<div class="card-code-block">
|
|
<pre><code>/heal-skill API endpoint URL changed
|
|
/heal-skill parameter validation error</code></pre>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="command-detail" id="plan-review">
|
|
<div class="command-detail-header">
|
|
<code class="command-detail-name">/plan_review</code>
|
|
</div>
|
|
<p class="command-detail-description">
|
|
Have multiple specialized agents review a plan in parallel.
|
|
</p>
|
|
<h4>Arguments</h4>
|
|
<p><code>[plan file path or plan content]</code></p>
|
|
<h4>Review Agents</h4>
|
|
<ul>
|
|
<li><code>dhh-rails-reviewer</code> - Rails conventions</li>
|
|
<li><code>kieran-rails-reviewer</code> - Rails best practices</li>
|
|
<li><code>code-simplicity-reviewer</code> - Simplicity and clarity</li>
|
|
</ul>
|
|
<div class="card-code-block">
|
|
<pre><code>/plan_review plans/user-authentication.md</code></pre>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="command-detail" id="report-bug">
|
|
<div class="command-detail-header">
|
|
<code class="command-detail-name">/report-bug</code>
|
|
</div>
|
|
<p class="command-detail-description">
|
|
Report a bug in the compounding-engineering plugin.
|
|
</p>
|
|
<h4>Arguments</h4>
|
|
<p><code>[optional: brief description of the bug]</code></p>
|
|
<h4>Information Collected</h4>
|
|
<ul>
|
|
<li>Bug category (Agent/Command/Skill/MCP/Installation)</li>
|
|
<li>Specific component name</li>
|
|
<li>Actual vs expected behavior</li>
|
|
<li>Steps to reproduce</li>
|
|
<li>Error messages</li>
|
|
<li>Environment info (auto-gathered)</li>
|
|
</ul>
|
|
<div class="card-code-block">
|
|
<pre><code>/report-bug Agent not working
|
|
/report-bug Command failing with timeout</code></pre>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="command-detail" id="reproduce-bug">
|
|
<div class="command-detail-header">
|
|
<code class="command-detail-name">/reproduce-bug</code>
|
|
</div>
|
|
<p class="command-detail-description">
|
|
Reproduce and investigate a bug using logs and console inspection.
|
|
</p>
|
|
<h4>Arguments</h4>
|
|
<p><code>[GitHub issue number]</code></p>
|
|
<h4>Investigation Process</h4>
|
|
<ol>
|
|
<li>Read GitHub issue details</li>
|
|
<li>Launch parallel investigation agents</li>
|
|
<li>Analyze code for failure points</li>
|
|
<li>Iterate until root cause found</li>
|
|
<li>Post findings to GitHub issue</li>
|
|
</ol>
|
|
<div class="card-code-block">
|
|
<pre><code>/reproduce-bug 142</code></pre>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="command-detail" id="triage">
|
|
<div class="command-detail-header">
|
|
<code class="command-detail-name">/triage</code>
|
|
</div>
|
|
<p class="command-detail-description">
|
|
Triage and categorize findings for the CLI todo system.
|
|
</p>
|
|
<h4>Arguments</h4>
|
|
<p><code>[findings list or source type]</code></p>
|
|
<h4>User Decisions</h4>
|
|
<ul>
|
|
<li><strong>"yes"</strong> - Create/update todo file, change status to ready</li>
|
|
<li><strong>"next"</strong> - Skip and delete from todos</li>
|
|
<li><strong>"custom"</strong> - Modify and re-present</li>
|
|
</ul>
|
|
<div class="callout callout-info">
|
|
<div class="callout-icon"><i class="fa-solid fa-circle-info"></i></div>
|
|
<div class="callout-content">
|
|
<p>This command does NOT write code. It only categorizes and creates todo files.</p>
|
|
</div>
|
|
</div>
|
|
<div class="card-code-block">
|
|
<pre><code>/triage code-review-findings.txt
|
|
/triage security-audit-results</code></pre>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="command-detail" id="resolve-parallel">
|
|
<div class="command-detail-header">
|
|
<code class="command-detail-name">/resolve_parallel</code>
|
|
</div>
|
|
<p class="command-detail-description">
|
|
Resolve all TODO comments using parallel processing.
|
|
</p>
|
|
<h4>Arguments</h4>
|
|
<p><code>[optional: specific TODO pattern or file]</code></p>
|
|
<h4>Process</h4>
|
|
<ol>
|
|
<li>Analyze TODO comments from codebase</li>
|
|
<li>Create dependency graph (mermaid diagram)</li>
|
|
<li>Spawn parallel <code>pr-comment-resolver</code> agents</li>
|
|
<li>Commit and push after completion</li>
|
|
</ol>
|
|
<div class="card-code-block">
|
|
<pre><code>/resolve_parallel
|
|
/resolve_parallel authentication
|
|
/resolve_parallel src/auth/</code></pre>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="command-detail" id="resolve-pr-parallel">
|
|
<div class="command-detail-header">
|
|
<code class="command-detail-name">/resolve_pr_parallel</code>
|
|
</div>
|
|
<p class="command-detail-description">
|
|
Resolve all PR comments using parallel processing.
|
|
</p>
|
|
<h4>Arguments</h4>
|
|
<p><code>[optional: PR number or current PR]</code></p>
|
|
<h4>Process</h4>
|
|
<ol>
|
|
<li>Get all unresolved PR comments</li>
|
|
<li>Create TodoWrite list</li>
|
|
<li>Launch parallel <code>pr-comment-resolver</code> agents</li>
|
|
<li>Commit, resolve threads, and push</li>
|
|
</ol>
|
|
<div class="card-code-block">
|
|
<pre><code>/resolve_pr_parallel
|
|
/resolve_pr_parallel 123</code></pre>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="command-detail" id="resolve-todo-parallel">
|
|
<div class="command-detail-header">
|
|
<code class="command-detail-name">/resolve_todo_parallel</code>
|
|
</div>
|
|
<p class="command-detail-description">
|
|
Resolve all pending CLI todos using parallel processing.
|
|
</p>
|
|
<h4>Arguments</h4>
|
|
<p><code>[optional: specific todo ID or pattern]</code></p>
|
|
<h4>Process</h4>
|
|
<ol>
|
|
<li>Get unresolved TODOs from <code>/todos/*.md</code></li>
|
|
<li>Analyze dependencies</li>
|
|
<li>Spawn parallel agents</li>
|
|
<li>Commit, mark as resolved, push</li>
|
|
</ol>
|
|
<div class="card-code-block">
|
|
<pre><code>/resolve_todo_parallel
|
|
/resolve_todo_parallel 042
|
|
/resolve_todo_parallel p1</code></pre>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="command-detail" id="prime">
|
|
<div class="command-detail-header">
|
|
<code class="command-detail-name">/prime</code>
|
|
</div>
|
|
<p class="command-detail-description">
|
|
Prime/setup command for project initialization.
|
|
</p>
|
|
<div class="card-code-block">
|
|
<pre><code>/prime</code></pre>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
|
|
<!-- Navigation -->
|
|
<nav class="docs-nav-footer">
|
|
<a href="agents.html" class="nav-prev">
|
|
<span class="nav-label">Previous</span>
|
|
<span class="nav-title"><i class="fa-solid fa-arrow-left"></i> Agents</span>
|
|
</a>
|
|
<a href="skills.html" class="nav-next">
|
|
<span class="nav-label">Next</span>
|
|
<span class="nav-title">Skills <i class="fa-solid fa-arrow-right"></i></span>
|
|
</a>
|
|
</nav>
|
|
</article>
|
|
</main>
|
|
</div>
|
|
|
|
<script>
|
|
document.querySelector('[data-sidebar-toggle]')?.addEventListener('click', () => {
|
|
document.querySelector('.docs-sidebar').classList.toggle('open');
|
|
});
|
|
</script>
|
|
</body>
|
|
|
|
</html>
|