explore

Explore and understand an unfamiliar codebase

Explore Codebase

Help the user understand the structure and organization of an unfamiliar codebase.

Workflow

Execute the following steps:

  1. Identify repository: If $ARGUMENTS is provided, use it as the repo name. Otherwise, use list_repos to show available repositories and ask which one to explore.

  2. Check capabilities: Use get_index_status to see which features are enabled (git, call-graph, etc.)

  3. Get AI overview: Use explain_codebase to get an AI-friendly summary of the codebase

  4. Show structure: Use get_project_structure with max_depth=3 to show the directory tree

  5. Find main components:

    • Use find_symbols with symbol_type="class" to find main data structures
    • Use find_symbols with symbol_type="function" and pattern="*main*" to find entry points
  6. Understand dependencies: Use get_import_graph to show how modules connect

  7. Check for issues: Use find_circular_imports to identify potential architectural problems

  8. Summarize: Provide a clear summary of:

    • Project structure and organization
    • Key modules and their purposes
    • Entry points
    • Any architectural concerns (circular deps, etc.)

Arguments

Repository to explore: $ARGUMENTS