deep-wiki
Access AI-generated documentation and insights for GitHub repositories via DeepWiki. This skill should be used when exploring unfamiliar codebases, understanding repository architecture, finding implementation patterns, or asking questions about how a GitHub project works. Supports any public GitHub repository.
When & Why to Use This Skill
DeepWiki is a specialized Claude skill designed to accelerate GitHub repository exploration through AI-generated documentation and intelligent insights. It empowers developers to rapidly comprehend unfamiliar codebases, analyze complex software architectures, and extract implementation patterns from any public GitHub project. By providing instant technical Q&A and structured wiki content, it eliminates the need for manual, time-consuming code audits and streamlines the developer onboarding process.
Use Cases
- Rapid Onboarding: Quickly grasp the high-level architecture and logic of a new or unfamiliar project without manually browsing hundreds of files.
- Architectural Research: Analyze the design patterns, dependency structures, and organizational logic of popular open-source frameworks like React, Next.js, or Prisma.
- Implementation Discovery: Find specific examples of how features are implemented or how certain libraries are integrated within a real-world codebase.
- Technical Q&A: Ask complex, natural-language questions about a repository's internal workings, such as 'How does the query engine handle concurrent requests?'
- Documentation Generation: Generate structured summaries and topic lists for public repositories that lack comprehensive or up-to-date documentation.
| name | deep-wiki |
|---|---|
| description | Access AI-generated documentation and insights for GitHub repositories via DeepWiki. This skill should be used when exploring unfamiliar codebases, understanding repository architecture, finding implementation patterns, or asking questions about how a GitHub project works. Supports any public GitHub repository. |
DeepWiki
Base directory for this skill: /home/hazeruno/.config/opencode/skills/deep-wiki
DeepWiki provides AI-generated documentation and Q&A for GitHub repositories. Use it to quickly understand codebases, explore architecture, and get answers about how projects work.
When to Use
- Exploring an unfamiliar GitHub repository
- Understanding project architecture and structure
- Finding how specific features are implemented
- Getting quick answers about a codebase without reading all source code
- Learning about dependencies, patterns, and design decisions
Quick Start
Run the CLI script with bun (use absolute path):
bun /home/hazeruno/.config/opencode/skills/deep-wiki/scripts/deepwiki.ts <command> [options]
Available Commands
read-wiki-structure
Get a list of documentation topics available for a repository.
bun /home/hazeruno/.config/opencode/skills/deep-wiki/scripts/deepwiki.ts read-wiki-structure --repo-name "facebook/react"
read-wiki-contents
View the full AI-generated documentation for a repository.
bun /home/hazeruno/.config/opencode/skills/deep-wiki/scripts/deepwiki.ts read-wiki-contents --repo-name "vercel/next.js"
ask-question
Ask any question about a repository and get an AI-generated answer.
bun /home/hazeruno/.config/opencode/skills/deep-wiki/scripts/deepwiki.ts ask-question \
--repo-name "prisma/prisma" --question "How does the query engine work?"
Global Options
-t, --timeout <ms>: Call timeout (default: 30000)-o, --output <format>: Output format:text|markdown|json|raw
Requirements
- Bun runtime
mcporterpackage (embedded in script)
References
See references/api_reference.md for detailed API documentation.