Token导航 LogoToken导航TokenDH.com
研究检索执行命令github未标认证来源可访问许可证需确认审计提醒

build-docs构建文档

Agent Skill

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

总安装

245

周安装

10

GitHub Stars

66

下载量

79
CodexClaudeCursorGemini CLI

安装说明

本站只整理中文说明和来源信息,不托管安装包,也不代用户安装。

GitHub

来源数

2

许可证

unknown

最后核验

2026-05-01

来源状态

来源可访问

安装方式

通过对话安装

复制提示词发给支持本地命令或 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

简介

依据配置文件批量生成文档包,支持多版本管理。

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

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

适合场景

01

用户想查找某类 Agent Skill 时

02

需要根据任务场景推荐可安装能力包时

03

需要对比不同来源的安装命令和来源信息时

能力概览

能力 1

按任务关键词查找相关 Skills

能力 2

展示可复制的安装命令

能力 3

保留来源站点、仓库和原始说明,方便继续核验

能力 4

展示第三方安全扫描或审计结果

安装后应在对应宿主中按原始 README 的触发条件使用;具体调用方式请以来源页面和 README 为准。

平台分布

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 或依赖。用户安装前应确认命令来源、仓库内容和执行环境。

安装前确认

本站仅展示第三方公开信息,不托管安装包,不提供自动安装或运行环境。安装前应自行审查源码、依赖和命令行为。来源安全扫描存在 warning/failed 结果,不能写成本站确认安全。当前只有一个来源,正式发布前建议补源仓库或其他目录站核验。

来源信息

继续浏览同类 Skills