Help

# /karimo:help — Help & Documentation Search

Get help with KARIMO commands or search documentation for specific topics.

## Usage

/karimo:help # List all commands by category /karimo:help {query} # Search documentation for query /karimo:help worktrees # Search docs for "worktrees" /karimo:help waves # Search docs for "waves" /karimo:help "error recovery" # Search docs for phrase

## Behavior

### No Query: List All Commands

When called without arguments, display all commands organized by category:

╭──────────────────────────────────────────────────────────────╮ │ KARIMO Commands │ ╰──────────────────────────────────────────────────────────────╯

Core Workflow: /karimo:plan Create new PRD through interview /karimo:run --prd {slug} Execute PRD tasks (feature branch) /karimo:dashboard Check execution progress (all PRDs) /karimo:dashboard --prd {slug} Detailed status for specific PRD /karimo:merge --prd {slug} Create final PR to main

Configuration: /karimo:configure Project setup (basic mode, auto-detect) /karimo:configure --advanced Full 9-step configuration /karimo:configure --preview Preview config without saving /karimo:configure --validate Validate existing config

Management: /karimo:feedback Capture learnings (auto-detection)

Diagnostics: /karimo:doctor Health check (7 diagnostic categories) /karimo:doctor --test Quick installation smoke test

Maintenance: /karimo:update Update to latest KARIMO version /karimo:configure --cd Configure preview deployments

Help: /karimo:help This command /karimo:help {query} Search documentation

Advanced: /karimo:research --prd {slug} Add research to existing PRD

Need more details? Run: /karimo:help {command-name} Example: /karimo:help plan

Documentation: .karimo/docs/

---

### With Query: Search Documentation

When called with a query, search all `.karimo/docs/*.md` files for relevant content.

**Step 1: Search for query in documentation**

Use Grep tool to search `.karimo/docs/` directory:

```bash
# Search for query in all markdown files
# Use case-insensitive search
# Show context (2 lines before/after)
# Return up to 10 results

Step 2: Format and display results

Present results in readable format:

╭──────────────────────────────────────────────────────────────╮
│  Help: "{query}"                                              │
╰──────────────────────────────────────────────────────────────╯

Found {N} matches in documentation:

📄 GLOSSARY.md:
   Wave: Group of independent tasks that execute in parallel. Tasks in
   Wave 2 cannot start until all Wave 1 tasks are merged. Waves enforce
   dependency ordering without over-serializing work.

   → Full file: .karimo/docs/GLOSSARY.md

📄 ARCHITECTURE.md:
   Wave-Based Execution Flow:
   1. PM Agent reads execution_plan.yaml for wave-based scheduling
   2. Creates worktrees for ready tasks
   3. Spawns agents for tasks (respects max_parallel)
   4. Wave 2 waits for Wave 1 completion

   → Full file: .karimo/docs/ARCHITECTURE.md (line 263)

📄 TROUBLESHOOTING.md:
   ### Wave 2 won't start despite Wave 1 complete
   Causes: PM agent hasn't detected Wave 1 completion
   Solution: Re-trigger execution with /karimo:run --prd {slug}

   → Full file: .karimo/docs/TROUBLESHOOTING.md (line 312)

Related topics you might find helpful:
  • Dependencies (GLOSSARY.md)
  • Task execution (ARCHITECTURE.md)
  • Error recovery (TROUBLESHOOTING.md)

Didn't find what you need? Try:
  /karimo:help {different query}
  /karimo:doctor (for diagnostics)

Step 3: Handle no results

If no matches found:

╭──────────────────────────────────────────────────────────────╮
│  Help: "{query}"                                              │
╰──────────────────────────────────────────────────────────────╯

No matches found for "{query}"

Try searching for related terms:
  • waves → execution, tasks, dependencies
  • PRD → plan, interview, requirements
  • review → greptile, code-review, automated
  • errors → troubleshooting, doctor, diagnostics

Available documentation:
  📄 GLOSSARY.md           Terminology and concepts
  📄 GETTING-STARTED.md    Installation and first PRD
  📄 ARCHITECTURE.md       System design and integration
  📄 COMMANDS.md           Detailed command reference
  📄 TROUBLESHOOTING.md    Common errors and solutions
  📄 DECISION_TREES.md     Command selection guidance
  📄 PHASES.md             Adoption phases explained
  📄 GLOB_PATTERNS.md      Boundary pattern library
  📄 SAFEGUARDS.md         Code integrity and security
  📄 CI-CD.md              Deployment integration
  📄 COMPOUND-LEARNING.md  Two-scope learning system

Run: /karimo:help {term} to search any of these

---

Search Implementation

Query Preprocessing

Before searching, normalize the query:

1. Trim whitespace
2. Handle multi-word queries: Keep spaces, search for exact phrase
3. Case insensitive: Use -i flag in grep
4. Word boundaries: Don't require exact word match (allow partial)

Grep Parameters

# Example Grep tool call
pattern: "{query}"
path: ".karimo/docs/"
output_mode: "content"
-i: true              # Case insensitive
-C: 2                 # 2 lines context before/after
-n: true              # Show line numbers
glob: "*.md"          # Only markdown files
head_limit: 10        # Max 10 results

Result Processing

For each match:

1. Extract filename from path
2. Extract line number
3. Extract context (matched line + 2 lines before/after)
4. Truncate long lines to 80 characters max
5. Highlight query term (if possible, use subtle emphasis)

Special Queries

Handle these queries specially:

Query	Action
```