Deep Wiki

AI-Powered Wiki Generator for Code Repositories — GitHub Copilot CLI Plugin

Generate comprehensive, structured, Mermaid-rich documentation wikis for any codebase — with dark-mode VitePress sites, onboarding guides, and deep research capabilities. Distilled from the prompt architectures of OpenDeepWiki and deepwiki-open.

Installation

From a marketplace

# Inside Copilot CLI, run these slash commands:
/plugin marketplace add microsoft/skills
/plugin install deep-wiki@skills

copilot --plugin-dir ./deep-wiki

Commands

Agents

View available agents: /agents

Skills (Auto-Invoked)

Quick Start

# Install the plugin (slash command inside Copilot CLI)
/plugin install deep-wiki@skills

# Generate a full wiki with onboarding guides and VitePress site
/deep-wiki:generate

# Fast wiki — concise, parallelized, avoids rate limits
/deep-wiki:crisp

# Just the structure
/deep-wiki:catalogue

# Single page with dark-mode diagrams
/deep-wiki:page Authentication System

# Generate onboarding guides
/deep-wiki:onboard
…

How It Works

Repository → Scan → Catalogue (JSON TOC) → Per-Section Pages → Assembled Wiki
                                                    ↓
                                         Mermaid Diagrams + Citations
                                                    ↓
                                         Onboarding Guides (Contributor, Staff Engineer, Executive, PM)
                                                    ↓
                                         VitePress Site (Dark Theme + Click-to-Zoom)
                                                    ↓
                                         AGENTS.md Files (Only If Missing)
                                                    ↓
                                         llms.txt + llms-full.txt (LLM-friendly)
                                                    ↓
                                         GitHub Pages Deployment (Optional)

Design Principles

1. Source-linked citations: Before any task, resolve the source repo URL (or confirm local). All citations use file:line for remote repos, (file:line) for local
2. Structure-first: Always generate a TOC/catalogue before page content
3. Evidence-based: Every claim cites file_path:line_number with clickable links — no hand-waving
4. Diagram-rich: Minimum 3–5 dark-mode Mermaid diagrams per page using multiple diagram types, with click-to-zoom and comment blocks. More diagrams = better — use them liberally for architecture, flows, state, data models, and decisions.
5. Table-driven: Prefer tables over prose for any structured information. Use summary tables, comparison tables, and always include a "Source" column with citations.
6. Progressive disclosure: Big picture first, then drill into details. Every section starts with a TL;DR.
7. Hierarchical depth: Max 4 levels for component-level granularity
8. Systems thinking: Architecture → Subsystems → Components → Methods
9. Never invent: All content derived from actual code — trace real implementations
10. Dark-mode native: All output designed for dark-theme rendering (VitePress)
11. Depth before breadth: Trace actual code paths, never guess from file names
12. Agent-discoverable: Output placed at standard paths (llms.txt at repo root, AGENTS.md in key folders) so coding agents and MCP tools find documentation automatically

Agent & MCP Integration

The generated output is designed to be discoverable by coding agents using the GitHub MCP Server or any MCP-compatible tool:

How it works with GitHub MCP:

1. Agent calls get_file_contents on llms.txt → gets project summary + links to all wiki pages
2. Agent calls get_file_contents on specific wiki pages → gets full documentation with source citations
3. Agent calls search_code with patterns → finds relevant wiki sections across the repository
4. Agent reads AGENTS.md → Documentation section points to wiki and onboarding guides

Plugin Structure

deep-wiki/
├── .claude-plugin/
│   └── plugin.json          # Plugin manifest (name, version, description)
├── commands/                 # Slash commands (/deep-wiki:*)
│   ├── generate.md          # Full wiki generation pipeline
│   ├── crisp.md             # Fast, concise wiki (rate-limit-friendly)
│   ├── catalogue.md         # Wiki structure as JSON
│   ├── page.md              # Single page with dark-mode diagrams
│   ├── changelog.md         # Git-based changelog
│   ├── research.md          # 5-iteration deep research
│   ├── ask.md               # Q&A about the repo
│   ├── onboard.md           # Onboarding guide generation
│   ├── agents.md            # AGENTS.md generation (only if missing)
│   ├── llms.md              # llms.txt generation for LLM-friendly access
│   ├── deploy.md            # GitHub Pages deployment workflow generation
│   ├── ado.md               # Azure DevOps Wiki export script generation
│   └── build.md             # VitePress site packaging
├── skills/                   # Auto-invoked based on context
…

License

MIT