Token导航 LogoToken导航

Agent Skill · 研究检索

build-docs(构建文档)

用于辅助文档、README、Markdown、说明文和内容稿件的整理与改写。它适合让 Agent 提炼结构、补齐章节、统一术语、检查链接或把零散材料整理成可读文档。使用时应保留项目已有事实、命令和路径,不要把未确认的信息写成确定结论;涉及对外文案时,还需要控制语气,避免过度营销或夸大能力。

build-docs 是研究检索类 Agent Skill,可用宿主为 Codex、Claude、Cursor、Gemini CLI,通过GitHub 仓库获取,权限为执行命令;许可证信息还不明确,第三方扫描有提醒项,按安装量在研究检索类的 73,675 个 Skill 里排第 67,439。

总安装 245周安装 10GitHub Stars 66下载 79核验 2026-05-01

安装说明

本站只整理中文说明,不托管安装包,也不代用户安装。
GitHub
许可证
unknown

安装方式

通过对话安装

复制提示词发给支持本地命令或 Skills 的 AI 助手,先确认命令和权限,再让它执行。

请帮我安装这个 Agent Skill:build-docs(构建文档)
来源仓库:https://github.com/olorehq/olore
仓库路径:skills/build-docs
安装命令:
npx skills add https://github.com/olorehq/olore --skill build-docs
安装前请先检查当前环境是否支持对应 CLI,并向我确认将要执行的命令、安装目录、联网范围和文件读写权限;确认后再执行。

命令行安装

复制命令到本机终端执行。该命令会通过 npx skills 从第三方来源获取 Skill;本站只展示命令,不托管安装包,也不自动执行。

skills.shnpx skills
npx skills add https://github.com/olorehq/olore --skill build-docs

这个 Skill 是做什么的

研究检索类 Skill 主要解决「找资料、核对事实、把来源整理清楚」的问题,通常会让助手先检索再总结。

依据配置文件批量生成文档包,支持多版本管理。可指定单个或多个配置项(如 prisma、zod)进行文档提取。优先使用缓存内容,--force 参数强制重新下载原始资源。输出路径固定于 vault/configs/,请勿更改默认目录结构。build-docs 属于研究检索类 Skill,可作为该场景下的辅助能力补充。

来源仓库内路径:skills/build-docs

上手步骤

4 步
  1. 1

    确认自己的宿主工具

    公开资料标注支持 Codex、Claude、Cursor、Gemini CLI;先确认自己用的是其中之一,再按对应工具的 Skills 目录放置。

  2. 2

    拿到安装命令

    可以直接复制的命令是 npx skills add https://github.com/olorehq/olore --skill build-docs;命令里的占位符换成自己的路径或密钥再执行。

  3. 3

    安装后重启宿主

    命令执行完要完全退出宿主工具再打开,让新装的 Skill 被重新扫描到,否则列表里可能看不到。

  4. 4

    按最小权限试用

    它需要执行命令,先在测试目录或测试账号里跑,确认没问题再放到正式项目。

常见问题

6 条

build-docs 怎么安装?

在终端执行 npx skills add https://github.com/olorehq/olore --skill build-docs。装完完全退出宿主工具再打开,让它重新扫描本地 Skill。

build-docs 支持哪些 AI 工具?

公开资料标注支持 Codex、Claude、Cursor、Gemini CLI。其他工具只要能读取本地 Skill 目录,一般也能手动放进去,但要自己确认触发方式是否一致。

build-docs 需要什么权限?

权限级别是执行命令。安装流程涉及命令执行,可能通过 npx skills add https://github.com/olorehq/olore --skill build-docs 联网下载 Skill 或依赖。用户安装前应确认命令来源、仓库内容和执行环境。

build-docs 是免费的吗?

公开资料没有标注明确许可证,收费和商用限制都无法确认。正式使用前请到来源仓库核对授权说明。

build-docs 用的人多吗?

公开数据是累计安装 245 次,近一周安装 10 次,下载 79 次,GitHub 66 星。这些数字来自第三方目录统计,只能当作热度参考,不代表质量或安全性。

build-docs 安全吗?

第三方扫描有提醒项,说明存在需要人工确认的行为。安装前请打开源码看清它读了什么、联网到哪里。

值得选的地方和要先想清楚的地方

值得选的地方

  • 同时适配 4 种工具,换客户端不用重新找替代品。

先想清楚的地方

  • 需要执行命令,装到常用环境前要先评估影响面。
  • 许可证没有明确标注,能不能商用、能不能再分发都不确定。
  • 第三方扫描存在提醒项或未通过项,需要人工逐条确认。
  • 第三方目录整理,版本更新和行为细节以来源仓库为准。

适不适合你

更适合

  • 已经在用 Codex,想直接扩展它能力的人。
  • 需要处理研究检索类任务、又不想每次都手写提示词的人。

不太适合

  • 不能接受 Skill 在你机器上执行命令的人。
  • 需要明确授权才能用到公司项目里的场景。
  • 需要厂商级技术支持和 SLA 的生产系统。

研究检索类 Skill 对比

6 个同类
Skill总安装GitHub 星权限许可证扫描
find-skills

寻找技能 · Codex、Claude

31,199,81316,486操作浏览器MIT有提醒
self-improving-agent

自我改进 Agent · OpenClaw

16,464,0023,396接触敏感数据MIT-0通过
soultrace

灵魂追踪 · Codex、Claude

7,588,94412需要联网未明确有提醒
self-improving

自我完善 · OpenClaw

6,829,2841,046需要联网MIT-0通过
microsoft-foundry

微软代工厂 · Codex、Claude

6,614,144764调用外部服务未明确有提醒
build-docs

构建文档 · 本页

24566执行命令未明确有提醒

按安装量取同分类前几名;数字来自第三方目录统计,只作热度参考,不代表质量结论。

SKILL.md 原文

Build Docs

Build documentation packages from configs in vault/configs/.

Usage

/build-docs                      # All configs, all versions
/build-docs prisma               # All versions for prisma config
/build-docs prisma@latest        # Specific version only
/build-docs prisma zod           # Multiple configs
/build-docs prisma --force       # Re-download even if exists

Workflow

Phase 1: Parse Arguments

Parse $ARGUMENTS:

  • No args → Process all configs in vault/configs/*.json
  • name without @ → All versions for that config
  • name@version → Specific version only
  • --force flag → Re-download even if exists

Phase 2: Discover Work

For each config, list versions and check what needs building:

# List configs
ls vault/configs/*.json

# Get versions from a config
jq -r '.versions | keys[]' vault/configs/{name}.json

# Check if version is built (olore-lock.json exists)
test -f vault/packages/{name}/{version}/olore-lock.json

Built = vault/packages/{name}/{version}/olore-lock.json exists Work = versions without olore-lock.json (unless --force)

Phase 3: Report Plan and Confirm

Show what will be built and ask for confirmation:

Build plan:
  prisma@latest - not built
  zod@latest - exists (skip)
  nextjs@16.1.3 - not built

Will build 2 packages. Proceed?

Phase 4: Spawn Subagents (PARALLEL)

CRITICAL: Spawn ALL subagents in a SINGLE message for parallel execution.

For each package that needs building, spawn a package-builder subagent:

Use package-builder agent: prisma@latest
Use package-builder agent: nextjs@16.1.3

If --force flag was set, pass it to subagents:

Use package-builder agent: prisma@latest --force

Example with 3 packages: In ONE message, spawn THREE subagents:

  • package-builder: prisma@latest
  • package-builder: zod@latest
  • package-builder: nextjs@16.1.3

All subagents run in parallel. Each handles:

  1. Download docs from source
  2. Filter files (if needed)
  3. Generate TOC.md
  4. Generate SKILL.md

Phase 5: Summary

Collect results from all subagents and report:

Build complete:
  ✅ prisma@latest - 312 files (126 filtered), tier 3
  ✅ zod@latest - 17 files, tier 1
  ⏭️  nextjs@16.1.3 - skipped (exists)

Install with: olore install ./vault/packages/prisma/latest

Config Structure

Config file: vault/configs/prisma.json

{
  "name": "prisma",
  "_source": { "type": "github", "repo": "prisma/docs", "path": "content" },
  "versions": {
    "latest": { "ref": "main" }
  }
}

Package Structure (after build)

vault/packages/{name}/{version}/
├── olore-lock.json    # Build metadata
├── SKILL.md           # Skill definition (generated)
├── TOC.md             # Table of contents (generated)
└── contents/
    └── *.md           # Documentation files

After Build

For development (changes immediately visible):

olore link ./vault/packages/prisma/latest

For testing final package (copies to ~/.olore):

olore install ./vault/packages/prisma/latest

After install/link, skills are available as /olore-<name>-<version> (e.g., /olore-prisma-latest).

Standalone Skills

Individual phases can be run independently without the full pipeline:

/download-docs prisma@latest         # Download + filter only
/build-artifacts prisma@latest       # Regenerate SKILL.md + TOC.md only

Use --force on any standalone skill to regenerate even if output exists.

Dependencies:

  • /download-docs has no dependencies (runs first)
  • /build-artifacts requires contents/ from /download-docs

Reference

  • Adding new documentation - Config file format, GitHub/URL sources
  • Conventions - Config vs lock files, naming rules
  • Templates: vault/packages/docs-packager/1.0.0/templates/ (single source of truth)

Requirements

  • jq - JSON parsing
  • git - GitHub cloning
  • curl - URL downloads

平台分布

Codex

36.19%
按下载量换算29

Claude

33.63%
按下载量换算27

Cursor

18.21%
按下载量换算14

Gemini CLI

9.29%
按下载量换算7

安全审计

Gen Agent Trust Hub

可疑

Socket

可疑

Snyk

可疑

权限和风险

执行命令

安装流程涉及命令执行,可能通过 npx skills add https://github.com/olorehq/olore --skill build-docs 联网下载 Skill 或依赖。用户安装前应确认命令来源、仓库内容和执行环境。

安装前确认

本站仅展示第三方公开信息,不托管安装包,不提供自动安装或运行环境。安装前应自行审查源码、依赖和命令行为。来源安全扫描存在提醒或未通过项,安装前请自行复核。目前只有一个公开来源,建议同时核对源仓库。

继续浏览同类 Skills