Files
skill-template/SKILL.md
2026-06-07 11:28:45 +08:00

3.0 KiB
Raw Blame History

name, description, version, author, metadata, allowed-tools
name description version author metadata allowed-tools
技能开发模板(通用业务版) OpenClaw 通用业务技能开发模板,覆盖任务执行、日志记录、外部系统对接、隔离测试等典型能力。复制后请按 references/DEVELOPMENT.md 完成定制。 1.0.14 深圳匠厂科技有限公司
openclaw
slug platform_kit_min_version emoji category developer_ids
your-skill-slug 1.0.11 📦 通用
10032
12428
bash

技能开发模板skill-template

这是一个用于复制的新技能模板,不是业务技能本身。新建技能时,应复制本仓库结构,再把占位内容替换成你的真实业务实现。

模板使用方式

  1. 复制目录为你的新 skill 仓库。
  2. 全局替换 your-skill-slug技能开发模板(通用业务版) 等占位词。
  3. references/CLI.mdscripts/ 分层与 README.md 的说明补业务逻辑。

目录约定

  • 根目录结构参考现有规范技能:assets/references/scripts/tests/evals/
  • CLI 入口固定为 scripts/main.py
  • 业务逻辑按 cli / db / service / util 分层;公共能力从 jiangchang-platform-kit 提供的 jiangchang_skill_core 引用。

最小命令

python {baseDir}/scripts/main.py health
python {baseDir}/scripts/main.py version

运行依赖

  • Python 运行环境由匠厂宿主注入共享 runtime{JIANGCHANG_DATA_ROOT}/python-runtime/.venv
  • 公共能力来自共享 runtime 安装的 jiangchang-platform-kit>=1.0.11jiangchang_skill_core 包);新技能不得在仓库内保留 scripts/jiangchang_skill_core/ 副本。
  • config、logging、runtime_env、rpa、media-assets、video_session、runtime_diagnostics 等均从共享 venv 的 jiangchang_skill_core import而非技能目录副本。
  • 本技能特有的 Python 三方依赖请声明在根目录 requirements.txt(默认已含 jiangchang-platform-kit>=1.0.11);宿主安装/更新技能后会自动安装到共享 venv。
  • Skill 代码不要自行 pip install;系统级依赖(如 VC++ Runtime仅在 health / preflight 中提示用户安装。
  • health 使用 collect_runtime_diagnostics 输出统一 runtime 诊断(只读,不下载/修复 media-assets

重要说明

  • 复制后请同步修改 scripts/util/constants.py 中的 SKILL_SLUG / SKILL_VERSION
  • 如技能无需持久化,可保留 db/ 目录但不主动调用。
  • metadata.openclaw.developer_ids 用于声明技能发布后的默认开发者可见用户 ID 列表。
  • 当技能在平台中 access_scope = 0(不公开)时,任务执行流程会把 developer_ids 中的用户自动补写到 skill_user_access,使这些开发者仍可在技能市场中查看该技能。
  • developer_ids 建议写为正整数数组;第一个 ID 会作为主开发者同步到 skills.developer_id
  • 面向用户与编排的文档写在 references/,不要再新增旧式 docs/ / optional/ 结构。