explain

If $ARGUMENTS is empty or not provided:

Display usage information and ask for input:

Usage: /explain <target>

Examples:

• /explain pkg/auth/login.go - Explain a file
• /explain HandleAuthentication - Explain a function
• /explain pkg/services/ - Explain a package

Workflow:

1. Analyze the specified Go code target
2. Extract key concepts, interfaces, dependencies
3. Generate documentation-style explanation
4. Create Mermaid diagrams for complex flows
5. Identify idiomatic Go patterns used

Ask the user: "What file, function, or package would you like me to explain?"

---

If $ARGUMENTS is provided:

Generate a comprehensive explanation of the specified Go code. Creates documentation-style output with Mermaid diagrams for complex flows.

Configuration

• Target: $ARGUMENTS (file path, function name, or package)

Context Management

Before loading file content:

1. Check size first: Use Glob to find the file, note its size
2. For files >300 lines:
   • Read first 50 lines (package, imports, type declarations)
   • Use Grep to find specific function/type definitions
   • Read only the relevant sections
   • Do NOT load entire file into context
3. For packages with >20 files:
   • List files first with Glob
   • Read doc.go if present
   • Sample 2-3 representative files maximum

Steps

1. Identify Target Scope

   • If file path: Check file size before reading
   • If function name: Search for the function across packages
   • If package: Analyze the package structure

2. Analyze Go Code Structure

   For files, extract:

   • Package and purpose
   • Exported vs unexported identifiers
   • Types and interfaces defined
   • Key functions and methods
   • Dependencies (imports)

   For functions, extract:

   • Signature (receiver, params, returns)
   • Error handling patterns
   • Goroutine usage
   • Channel operations
   • Context handling

   For packages, extract:

   • Package purpose and API surface
   • Public interfaces
   • Internal organization
   • Dependencies on other packages