技能 编程开发 代码库文档搜索工具

代码库文档搜索工具

v20261108
docs-search
此技能用于搜索代码库中自动生成的文档,包括函数签名、API 文档、类定义和代码注释。它是 AI Maestro 套件的一部分,旨在在实施更改前验证正确的模式和签名。用户可以进行语义搜索、关键词匹配或查找特定文档类型,如函数、类和模块。支持项目索引和更新。
获取技能
271 次下载
概览

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

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

Index

CommandDescription
docs-index.sh [path]Full index from project
docs-index-delta.sh [path]Delta index (new/modified files only)
docs-list.shList all indexed documents
docs-stats.shIndex statistics

Document Types

TypeSources
functionJSDoc, RDoc, docstrings
classClass-level comments
moduleModule/namespace comments
interfaceTypeScript interfaces
componentReact/Vue component comments
readmeREADME files
guidedocs/ 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.

信息
分类 编程开发
名称 docs-search
版本 v20261108
大小 2.54KB
更新时间 2026-11-09
语言