feat: add skill install scripts and move skill into htsy/

2026-07-01 15:53:37 +08:00
parent 3212e64776
commit 1f4a00a0b0
15 changed files with 465 additions and 0 deletions
@@ -0,0 +1,110 @@
+# htsy agent skill
+
+本仓库提供海豚私域 `htsy` 通用 agent skill。真正需要安装到 agent skills 目录的内容只有 [`htsy/`](htsy/) 目录。
+
+安装后，agent 读取到该 skill 时，会按 [`htsy/SKILL.md`](htsy/SKILL.md) 的说明使用 `htsy-cli` 调用海豚私域接口。
+
+## 安装
+
+不同 agent 的 skills 目录不同。常见目标：
+
+- Claude Code 用户级：`~/.claude/skills/htsy`
+- Claude Code 项目级：`./.claude/skills/htsy`
+- Codex 用户级：`${CODEX_HOME:-$HOME/.codex}/skills/htsy`
+- 其他支持 `SKILL.md` 目录格式的 agent：使用该 agent 文档指定的 skills 目录
+
+如果已经 clone 了本仓库，在仓库根目录执行：
+
+```bash
+# Claude Code 用户级
+./scripts/install-htsy-skill.sh --agent claude
+
+# Claude Code 项目级
+./scripts/install-htsy-skill.sh --agent claude-project
+
+# Codex 用户级
+./scripts/install-htsy-skill.sh --agent codex
+
+# 其他 agent，传入完整目标 skill 目录
+./scripts/install-htsy-skill.sh --dest /path/to/agent/skills/htsy
+```
+
+Windows PowerShell：
+
+```powershell
+# Claude Code 用户级
+PowerShell -ExecutionPolicy Bypass -File .\scripts\install-htsy-skill.ps1 -Agent claude
+
+# Claude Code 项目级
+PowerShell -ExecutionPolicy Bypass -File .\scripts\install-htsy-skill.ps1 -Agent claude-project
+
+# Codex 用户级
+PowerShell -ExecutionPolicy Bypass -File .\scripts\install-htsy-skill.ps1 -Agent codex
+
+# 其他 agent，传入完整目标 skill 目录
+PowerShell -ExecutionPolicy Bypass -File .\scripts\install-htsy-skill.ps1 -Dest C:\path\to\agent\skills\htsy
+```
+
+如果还没有 clone 本仓库：
+
+```bash
+git clone --depth 1 https://git.ikuban.com/server/htsy-skill.git
+cd htsy-skill
+./scripts/install-htsy-skill.sh --agent claude
+```
+
+Windows PowerShell：
+
+```powershell
+git clone --depth 1 https://git.ikuban.com/server/htsy-skill.git
+Set-Location htsy-skill
+PowerShell -ExecutionPolicy Bypass -File .\scripts\install-htsy-skill.ps1 -Agent claude
+```
+
+重新执行安装脚本可更新本地 skill。脚本会替换目标位置的 `htsy` skill 目录。
+
+## 手动安装
+
+也可以手动把仓库里的 `htsy/` 目录复制到目标 agent 的 skills 目录。
+
+Claude Code 用户级：
+
+```text
+~/.claude/skills/htsy
+```
+
+Claude Code 项目级：
+
+```text
+./.claude/skills/htsy
+```
+
+Codex 用户级：
+
+```text
+~/.codex/skills/htsy
+```
+
+Windows Claude Code 用户级：
+
+```text
+%USERPROFILE%\.claude\skills\htsy
+```
+
+Windows Codex 用户级：
+
+```text
+%USERPROFILE%\.codex\skills\htsy
+```
+
+确认目标目录里存在 `SKILL.md`：
+
+```text
+<agent-skills-dir>/htsy/SKILL.md
+```
+
+安装完成后，重新打开或刷新对应 agent 会话，让 skill 列表重新加载。
+
+## 给 agent 的说明
+
+面向 AI/agent 的最短安装指令放在 [`llms.txt`](llms.txt)。如果 agent 正在读取本仓库，请优先读取 `llms.txt`，判断当前 agent 类型后按其中步骤安装 `htsy/`。