Back to Details

docs-search

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

AI Maestro Documentation Search

AI Maestro 文档搜索

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.
搜索代码库中自动生成的文档，查找函数签名、类定义、API文档和代码注释。在编写代码前验证正确的模式。该工具是AI Maestro套件的一部分。

Prerequisites

前提条件

Requires AI Maestro running locally with documentation indexed.
bash
undefined
需要本地运行AI Maestro并已索引文档。
bash
undefined

Install doc tools

Install doc tools

git clone https://github.com/23blocks-OS/ai-maestro-plugins.git cd ai-maestro-plugins && ./install-doc-tools.sh
undefined
git clone https://github.com/23blocks-OS/ai-maestro-plugins.git cd ai-maestro-plugins && ./install-doc-tools.sh
undefined

Core Behavior

核心流程

Before implementing any code changes, search docs first:
Receive instruction -> Search docs -> Then implement
在实施任何代码变更前，请先搜索文档：
Receive instruction -> Search docs -> Then implement

Commands

命令

Search

搜索

CommandDescription
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
命令说明
docs-search.sh <query>
语义化文档搜索
docs-search.sh --keyword <term>
精确关键词匹配
docs-find-by-type.sh <type>
按类型查找（函数、类、模块）
docs-get.sh <doc-id>
获取完整文档内容

Index

索引

CommandDescription
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
命令说明
docs-index.sh [path]
对项目进行完整索引
docs-index-delta.sh [path]
增量索引（仅针对新增/修改的文件）
docs-list.sh
列出所有已索引的文档
docs-stats.sh
索引统计信息

Document Types

文档类型

TypeSources
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
类型来源
function
JSDoc, RDoc, docstrings
class
类级注释
module
模块/命名空间注释
interface
TypeScript 接口
component
React/Vue 组件注释
readme
README 文件
guide
docs/ 文件夹内容

Usage Examples

使用示例

bash
undefined
bash
undefined

Semantic search

Semantic search

docs-search.sh "authentication flow"
docs-search.sh "authentication flow"

Keyword search for specific identifier

Keyword search for specific identifier

docs-search.sh --keyword "UserController"
docs-search.sh --keyword "UserController"

Find all class documentation

Find all class documentation

docs-find-by-type.sh class
docs-find-by-type.sh class

Get full document details

Get full document details

docs-get.sh doc-abc123
docs-get.sh doc-abc123

Index your codebase (first time)

Index your codebase (first time)

docs-index.sh /path/to/project
docs-index.sh /path/to/project

Update index after changes

Update index after changes

docs-index-delta.sh
undefined
docs-index-delta.sh
undefined

Full AI Maestro Experience

完整的AI Maestro 使用体验

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.
此功能是AI Maestro平台的一部分，该平台提供6种用于AI Agent编排的功能：消息传递、记忆、文档、图谱、规划和Agent管理。