docs-search

@davila7 · 收录于 5 天前 · 上游提交 5 天前

Search auto-generated codebase documentation for function signatures, API docs, class definitions, and code comments. Use when the user asks to "search docs", "find documentation", "look up a function", "check the API", or before implementing changes to verify correct signatures and patterns.

场景代码查阅接口联调开发前检查

适合你，如果经常需要查阅代码库文档来确认函数用法或API细节

/ 下载安装

https://github.com/davila7/claude-code-templates/tree/main/cli-tool/components/skills/ai-maestro/docs-search ↗

/ 通过 npx 安装 校验哈希

npx oh-my-skill add davila7/claude-code-templates/docs-search

/ 通过 bash 安装

curl -fsSL https://oh-my-skill.com/install.sh | bash -s -- davila7/claude-code-templates/docs-search

/ 已经装过?验证本机副本,不用重装

npx oh-my-skill verify davila7/claude-code-templates/docs-search

安装目标可用 --agent / --scope 或 --to 明确指定;省略时只会在唯一已存在的 agent 目录上自动选择,零命中或多命中会停止并提示。content_hash 缺失或不一致均拒装。

29874GitHub stars

~526上下文体积 · 单文件

索引托管

怎么用

商店整理自技能原文 · 版本 279b978 · 表述以原文为准

它做什么

装上后，Claude 会在实现代码前先搜索本地 AI Maestro 索引的自动生成文档，返回函数签名、API 文档、类定义和代码注释等具体信息。

什么时候触发

当用户要求“搜索文档”、“查找函数”或“检查 API”时，或准备修改代码需验证签名时触发。

装好后可以这样说

语义搜索函数或模块

精确匹配关键字

根据文档ID获取

技能原文 SKILL.md作者撰写 · MIT · 279b978

AI Maestro Documentation Search

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.

Prerequisites

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

Core Behavior

Before implementing any code changes, search docs first:

Receive instruction -> Search docs -> Then implement

Commands

Search

| 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 |

Index

| 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 |

Document Types

| 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 |

Usage Examples

# 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

Full AI Maestro Experience

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.

按 MIT 许可原样转载,未经改动 · 在 GitHub 查看 →

登录即可评论;带「已验证安装」的,是发布者名下有本店的安装或持有记录。

…