About deepwiki
deepwiki is a terminal tool for querying documentation from public GitHub repositories, aimed at developers exploring codebases. It provides documentation tables of contents, full wiki content, and single- or multi-repository Q&A.
Key features
- 01View documentation tables of contents
- 02Retrieve full wiki content
- 03Ask questions about repositories
- 04Query multiple repositories
- 05Output JSON data
Use cases
- 01Survey a library’s documentation structure
- 02Retrieve a project’s full documentation
- 03Ask about a specific codebase mechanism
- 04Understand interactions between libraries
Install
Copy the command and run it in a terminal.
$
npx skills add https:/ / github.com/ seflless/ deepwiki --skill deepwikiAfter installing, type/deepwikiin Claude Code to confirm it loaded.
Details
From the project READMEdeepwiki
Query any public GitHub repo's docs from the terminal via DeepWiki. Assumes Node.js is installed.
Commands
| Command | Usage | Description |
|---|---|---|
toc | npx @seflless/deepwiki toc <owner/repo> | Table of contents |
wiki | npx @seflless/deepwiki wiki <owner/repo> | Full wiki content |
ask | npx @seflless/deepwiki ask <owner/repo> "<question>" | AI-powered Q&A |
ask | npx @seflless/deepwiki ask <repo1> <repo2> "<question>" | Multi-repo Q&A (max 10) |
Flags
| Flag | Purpose |
|---|---|
--json | Raw JSON output (good for piping) |
-q, --quiet | No spinners/progress |
--no-color | Disable colors |
Examples
# Understand a library's structure
npx @seflless/deepwiki toc facebook/react
# Get full docs for reference
npx @seflless/deepwiki wiki oven-sh/bun --json > bun-docs.json
# Ask a specific question
npx @seflless/deepwiki ask anthropics/claude-code "How does the tool permission system work?"
# Cross-project question
npx @seflless/deepwiki ask facebook/react vercel/next.js "How do server components work across these projects?"
Tips
- Use
--jsonwhen you need structured data to parse - Use
tocfirst to understand what docs exist, thenaskfor specifics - Multi-repo
askis great for understanding how libraries interact
Comments
Markdown supported