twx-skill

参考 Bitget agent_hub 的 bitget-skill 设计：Skill 说明 + 本机 CLI（twx）+ references 手册 + postinstall 拷贝到 Claude Code。

包含内容

| 路径 | 作用 | |------|------| | bin/twx.js | 片段检索 CLI（ESM，type: module），支持 --json | | data/snippets.json | 片段源数据（可 PR 扩展） | | skills/SKILL.md | Agent 触发与流程说明 | | references/quickstart.md | 任意项目里接入 .agents/skills/ 的一页说明（可复制给同事） | | scripts/install.js | npm install 后拷贝到 ~/.claude/skills/twx-skill/ | | scripts/sync-to-agents.mjs | 将 skill 同步到 monorepo 根目录 .agents/skills/twx-skill/ |

安装

npm install -g ./packages/twx-skill
# 或发布后
npm install -g twx-skill

验证：

twx --version
twx list --json

给其他项目用（Claude Code / Cursor + .agents）

在对方项目根（或子目录，能向上找到 .git）执行一条即可：

npx -y twx-skill@latest init

会生成 .agents/skills/twx-skill/（SKILL.md + references/，内含 quickstart.md）。无 Git 时用 init --here 或 init --root /绝对路径。

建议同事再装 CLI，便于 skill 里调片段：

npm install -g twx-skill

对方也可在自家 package.json 里加脚本，例如："skills:twx": "npx -y twx-skill@latest init"。

更细的说明见包内 references/quickstart.md。

Claude Code

npm install twx-skill（非仅 npx）时 postinstall 会尝试把 skill 写入 ~/.claude/skills/twx-skill/，与项目内 .agents/skills/ 可并存：全局一份、项目一份，按工具实际加载路径为准。

本仓库开发时同步 .agents

若编辑器加载仓库根 .agents/skills/：

cd packages/twx-skill && npm run sync:agents

或：

npx --yes ./packages/twx-skill init --root "$(pwd)"

仍建议全局安装 twx，skill 依赖 Bash 执行 twx … --json。

仅 Cursor、不用 .agents 时

将 skills/SKILL.md 复制到 .cursor/skills/twx-skill/SKILL.md（并复制 references/）；或在 User Rules 里写：「涉及 twx 片段时先运行 twx ... --json」。

（若 Cursor 后续提供官方 skill 安装路径，以官方文档为准。）

扩展片段

1. 直接编辑 data/snippets.json 中 snippets 数组；或
2. 增加 snippets-src/<id>.md（YAML frontmatter：title / tags / description），然后在本包目录执行 npm run gen:catalog。

许可证

MIT