用途
voltagent-docs-bundle 用于查询 VoltAgent 内嵌于 node_modules/@voltagent/core/docs 的文档,适合需要获取与已安装版本精确匹配的 API 签名、指南和示例的场景。
主要能力
- 文档随安装的依赖版本一起打包,避免网页文档漂移或内容过时。
- 文档内容镜像了网站文档,并包含额外的文档集,覆盖完整的文档范围(指南、配方、平台文档等)。
- 可按目录浏览或按关键词全文搜索 Markdown 文档。
文档位置
文档位于:
node_modules/@voltagent/core/docs/
其目录结构包括:
actions.md
agents/
api/
blog/
community/
deployment-docs/
deployment.md
evals.md
evaluation-docs/
getting-started/
guardrails/
integrations/
models-docs/
observability/
observability-platform/
prompt-engineering-docs/
rag/
recipes/
repo-docs/
site-examples/
tools/
triggers.md
troubleshooting/
ui/
utils/
workflows/
如果在 VoltAgent 单体仓库内部,相同内容位于:
packages/core/docs/
使用方式
列出可用章节:
ls node_modules/@voltagent/core/docs
搜索某个主题:
rg -n "workflow" node_modules/@voltagent/core/docs -g"*.md"
读取文件:
cat node_modules/@voltagent/core/docs/workflows/overview.md
快速命令示例:
# List docs
ls node_modules/@voltagent/core/docs
# Find a keyword
rg -n "memory" node_modules/@voltagent/core/docs -g"*.md"
# Open a section
cat node_modules/@voltagent/core/docs/getting-started/quick-start.md
适用场景
- 需要查询与当前安装版本一致的 VoltAgent 文档。
- 需要查找 API 签名、使用指南或示例代码。
- 希望避免因网页文档更新而导致的信息不一致。
限制
资料未说明该技能包是否支持其他包管理器、是否提供图形界面、以及其他具体限制,暂未提供。