Search auto-generated codebase documentation for function signatures, API docs, class definitions, and code comments. Use when the user asks to "search docs", "
复制下面这句话,粘贴给 Claude Code、Codex、Cursor 等 AI 编程工具,它会读取安装说明并在你确认后完成安装。
请阅读 https://ai.atlankj.com/install/asset/gh-docs-search-ea79584fe69e ,按照其中的说明把「docs-search」安装到你(当前 AI 工具)中。执行前先告诉我将运行的命令和写入的位置,等我确认。
查看 AI 将读取的安装说明正在读取 GitHub 原文…
内容来自 GitHub 原始文件,由原作者维护。在 GitHub 查看
Search your codebase's auto-generated documentation for function signatures, class definitions, API docs, and code comments. Verify correct patterns before writing code. Part of the AI Maestro suite.
Requires AI Maestro running locally with documentation indexed.
# Install doc tools
git clone https://github.com/23blocks-OS/ai-maestro-plugins.git
cd ai-maestro-plugins && ./install-doc-tools.sh
Before implementing any code changes, search docs first:
Receive instruction -> Search docs -> Then implement
| Command | Description |
|---|---|
docs-search.sh <query> | Semantic documentation search |
docs-search.sh --keyword <term> | Exact keyword matching |
docs-find-by-type.sh <type> | Find by type (function, class, module) |
docs-get.sh <doc-id> | Get full document content |
| Command | Description |
|---|---|
docs-index.sh [path] | Full index from project |
docs-index-delta.sh [path] | Delta index (new/modified files only) |
docs-list.sh | List all indexed documents |
docs-stats.sh | Index statistics |
| Type | Sources |
|---|---|
function | JSDoc, RDoc, docstrings |
class | Class-level comments |
module | Module/namespace comments |
interface | TypeScript interfaces |
component | React/Vue component comments |
readme | README files |
guide | docs/ folder content |
# Semantic search
docs-search.sh "authentication flow"
# Keyword search for specific identifier
docs-search.sh --keyword "UserController"
# Find all class documentation
docs-find-by-type.sh class
# Get full document details
docs-get.sh doc-abc123
# Index your codebase (first time)
docs-index.sh /path/to/project
# Update index after changes
docs-index-delta.sh
This skill is part of the AI Maestro platform, which provides 6 skills for AI agent orchestration: messaging, memory, docs, graph, planning, and agent management.