code/commands/builtins/explain.md

metadata

name: explain
description: Explain how the current codebase or a specific file works
argument-hint: File path or "codebase"

Explain

Target: $ARGUMENTS

Explain the code clearly and concisely.

If target is "codebase" or empty:

1. Use list_dir to map the project structure
2. Identify the entry point (app.py, main.py, index.js, etc.)
3. Read the entry point and key modules
4. Produce a high-level architecture summary

If target is a file path:

1. read_file the target
2. Read any files it imports/requires (one level deep)
3. Explain:
   • What the file does
   • Its main functions/classes
   • How it fits into the larger project
   • Any non-obvious patterns or gotchas

Format your explanation for a developer who is new to this code. Use:

• Short paragraphs for prose
• Code snippets for examples
• A "Key takeaways" list at the end

Don't editorialize — describe what's there, not what should be.