deep-wiki

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

DeepWiki

Base directory for this skill: C:\Users\lyf1143312445.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.

本技能的基础目录：C:\Users\lyf1143312445.config\opencode\skills\deep-wiki

DeepWiki为GitHub仓库提供由AI生成的文档与问答服务。你可以用它快速理解代码库、探索架构，并获取关于项目工作原理的答案。

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

探索不熟悉的GitHub仓库
理解项目架构与结构
查找特定功能的实现方式
无需阅读全部源代码即可快速获取代码库相关问题的答案
了解依赖项、模式与设计决策

Quick Start

快速开始

Run the CLI script with bun (use absolute path):

bash

bun C:\Users\lyf1143312445\.config\opencode\skills\deep-wiki/scripts/deepwiki.ts <command> [options]

使用bun运行CLI脚本（请使用绝对路径）：

bash

bun C:\Users\lyf1143312445\.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.

bash

bun C:\Users\lyf1143312445\.config\opencode\skills\deep-wiki/scripts/deepwiki.ts read-wiki-structure --repo-name "facebook/react"

获取仓库可用的文档主题列表。

bash

bun C:\Users\lyf1143312445\.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.

bash

bun C:\Users\lyf1143312445\.config\opencode\skills\deep-wiki/scripts/deepwiki.ts read-wiki-contents --repo-name "vercel/next.js"

查看仓库的完整AI生成文档。

bash

bun C:\Users\lyf1143312445\.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.

bash

bun C:\Users\lyf1143312445\.config\opencode\skills\deep-wiki/scripts/deepwiki.ts ask-question \
  --repo-name "prisma/prisma" --question "How does the query engine work?"

询问关于仓库的任意问题并获取AI生成的答案。

bash

bun C:\Users\lyf1143312445\.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

```
-t, --timeout <ms>
```
: 调用超时时间（默认值：30000）

-o, --output <format>

: 输出格式：

text

markdown

json

raw

Requirements

依赖要求

Bun runtime
```
mcporter
```
package (embedded in script)

Bun 运行时
```
mcporter
```
包（已嵌入脚本中）

References

参考资料

See

references/api_reference.md

for detailed API documentation.

详细的API文档请查看

references/api_reference.md

。