227 lines
9.6 KiB
Markdown
227 lines
9.6 KiB
Markdown
# jsc-doc — 跨 AI 助理 Plugin 模板
|
||
|
||
一個可同時被 **Claude Code、Codex、Antigravity、OpenCode、GitHub Copilot** 安裝的 plugin 模板。
|
||
核心是以 [Agent Skills（`SKILL.md`）](https://agentskills.io) 標準撰寫的共用 skills（唯一真實來源放在 `skills/`），
|
||
搭配各助理各自的 plugin manifest，讓**同一個 repo** 可用各家**原生 plugin CLI** 安裝。
|
||
在 Claude Code 與 Antigravity 中，skill 以 **`/jsc-doc:` 前綴**呼叫（例如 `/jsc-doc:hello`）。
|
||
|
||
---
|
||
|
||
## 前綴與呼叫方式
|
||
|
||
| 助理 | 安裝方式 | 呼叫 | `/jsc-doc:` 前綴 |
|
||
| --- | --- | --- | --- |
|
||
| Claude Code | `claude plugin`（marketplace） | `/jsc-doc:<name>` 或自動觸發 | ✅ |
|
||
| Codex | `codex plugin`（marketplace） | `$<name>` 或 `/skills` 選單 | ❌（用 `$name`） |
|
||
| Antigravity | `agy plugin install` | `/jsc-doc:<name>` 或自動觸發 | ✅ |
|
||
| OpenCode | skills 目錄（複製/clone） | 描述需求自動觸發 | ❌（依名稱） |
|
||
| GitHub Copilot CLI | `copilot plugin`（marketplace） | 自然語言或 plugin skills | ❌（無 `/jsc-doc:` 前綴） |
|
||
|
||
> Codex 不支援自訂前綴（skill 以 `$name` 呼叫）；OpenCode 由模型依描述自動呼叫；Copilot CLI 透過原生 plugin 安裝後以自然語言或 plugin skills 使用。三者皆**不強制**前綴。
|
||
|
||
---
|
||
|
||
## 目錄結構
|
||
|
||
同一個 repo 同時帶四種 manifest，彼此以路徑隔離、互不干擾；各助理都讀同一份 `skills/`。
|
||
|
||
```
|
||
doc/
|
||
├── .claude-plugin/
|
||
│ ├── plugin.json # Claude 外掛定義（name: "jsc-doc"）
|
||
│ └── marketplace.json # Claude marketplace（name: "doc"，source 指向本 repo）
|
||
├── .codex-plugin/
|
||
│ └── plugin.json # Codex 外掛定義（name: "jsc-doc"，skills: "./skills"）
|
||
├── .agents/plugins/
|
||
│ └── marketplace.json # Codex marketplace（name: "doc"，url source 指向本 repo）
|
||
├── plugin.json # Antigravity 外掛定義（name: "jsc-doc"，skills: "./skills/"）
|
||
├── skills/ # ★ 唯一真實來源：所有 skills
|
||
│ └── hello/SKILL.md
|
||
├── AGENTS.md # 跨助理共用指引
|
||
└── README.md
|
||
```
|
||
|
||
---
|
||
|
||
## 安裝 / 更新 / 移除（各助理）
|
||
|
||
> 指令中的 repo 網址換成你的：`https://gitea.jsc.idv.tw/plugins/doc.git`
|
||
>
|
||
> **Claude / Codex 從 git URL 安裝（會 clone 遠端），請先把本 repo `push` 到 gitea。**
|
||
> **Antigravity 的 `agy plugin install <url>` 目前只支援 github.com**；gitea 請改用「clone + 本地路徑」（見 Antigravity 節）。
|
||
> 本機/離線：Claude 可用本地路徑加 marketplace；Antigravity 用本地路徑安裝。
|
||
|
||
> **⚠ 0.0.1 升級請先移除舊安裝再重新安裝。** 這版 marketplace 名稱已統一為 `jsc`，
|
||
> `<plugin 名>@<marketplace 名>` 會被視為不同條目，**不能直接 update 遷移**：
|
||
>
|
||
> ```bash
|
||
> claude plugin uninstall jsc-doc@jsc
|
||
> claude plugin marketplace remove jsc
|
||
> claude plugin marketplace add https://gitea.jsc.idv.tw/plugins/doc.git
|
||
> claude plugin install jsc-doc@jsc
|
||
> ```
|
||
>
|
||
> 移除後若還有舊鍵 `jsc-doc@jsc-plugins`，請一併清掉並重開工作階段。
|
||
|
||
### Claude Code
|
||
|
||
```bash
|
||
# 安裝
|
||
claude plugin marketplace add https://gitea.jsc.idv.tw/plugins/doc.git
|
||
claude plugin install jsc-doc@jsc
|
||
|
||
# 更新
|
||
claude plugin marketplace update jsc
|
||
claude plugin update jsc-doc@jsc
|
||
|
||
# 移除
|
||
claude plugin uninstall jsc-doc@jsc
|
||
claude plugin marketplace remove jsc
|
||
```
|
||
|
||
- 工作階段內 slash 版（等價）：把 `claude plugin` 換成 `/plugin`。
|
||
- 本機開發（免 push）：`claude plugin marketplace add C:\Users\h3285\source\repos.plugins\doc`（本地路徑）後再 install。
|
||
- **呼叫**：`/jsc-doc:<name>`（例 `/jsc-doc:hello`）。
|
||
|
||
### Codex
|
||
|
||
```bash
|
||
# 安裝
|
||
codex plugin marketplace add https://gitea.jsc.idv.tw/plugins/doc.git
|
||
codex plugin add jsc-doc@jsc
|
||
|
||
# 更新（重新抓取 marketplace 的 git 快照）
|
||
codex plugin marketplace upgrade doc
|
||
|
||
# 移除
|
||
codex plugin remove jsc-doc@jsc
|
||
codex plugin marketplace remove jsc
|
||
```
|
||
|
||
- 安裝 token `jsc-doc@jsc` = plugin 名（`.codex-plugin/plugin.json` 的 `name`）@ marketplace 名（`.agents/plugins/marketplace.json` 的 `name`）。
|
||
- 本 repo 的 Codex marketplace 以 `url` 來源指向自己，故 Codex **一律從 gitea 安裝**（需先 push）；安裝後重啟 Codex。
|
||
- **呼叫**：`$<name>`（例 `$hello`），或用 `/skills` 選單。
|
||
|
||
### Antigravity（`agy`）
|
||
|
||
> `agy plugin install <url>` 目前**只支援 github.com**；gitea 等自架 git 不支援 URL 安裝，請先 `git clone` 再用**本地路徑**安裝。
|
||
|
||
```bash
|
||
# 安裝：clone 後用本地路徑
|
||
git clone https://gitea.jsc.idv.tw/plugins/doc.git ~/plugins/doc
|
||
agy plugin install ~/plugins/doc
|
||
|
||
# 更新（agy 無 update 子指令 → git pull 後重裝）
|
||
git -C ~/plugins/doc pull
|
||
agy plugin uninstall jsc-doc
|
||
agy plugin install ~/plugins/doc
|
||
|
||
# 移除
|
||
agy plugin uninstall jsc-doc
|
||
```
|
||
|
||
- 若把 skills 放到 GitHub，則可直接 `agy plugin install https://github.com/<owner>/<repo>`。
|
||
- 其他：`agy plugin list`、`agy plugin enable jsc-doc` / `disable jsc-doc`、`agy plugin validate <path>`。安裝後重啟工作階段。
|
||
- **呼叫**：`/jsc-doc:<name>`（例 `/jsc-doc:hello`）或依描述自動觸發。
|
||
|
||
### OpenCode
|
||
|
||
OpenCode 的「plugin」是 TypeScript/npm 套件，不適用於 skill 包；skills 改用**目錄安裝**。
|
||
OpenCode 會讀 `~/.config/opencode/skills/`（也會讀 `~/.claude/skills/`、`~/.agents/skills/`）。
|
||
|
||
```bash
|
||
# 安裝
|
||
git clone https://gitea.jsc.idv.tw/plugins/doc.git ~/plugins/doc
|
||
mkdir -p ~/.config/opencode/skills
|
||
cp -r ~/plugins/doc/skills/* ~/.config/opencode/skills/
|
||
|
||
# 更新
|
||
git -C ~/plugins/doc pull
|
||
cp -r ~/plugins/doc/skills/* ~/.config/opencode/skills/
|
||
|
||
# 移除
|
||
rm -rf ~/.config/opencode/skills/hello
|
||
```
|
||
|
||
> **Windows PowerShell**：`cp -r A B` → `Copy-Item A B -Recurse -Force`、`rm -rf X` → `Remove-Item X -Recurse -Force`、`~` → `$HOME`。
|
||
|
||
- **呼叫**：直接描述需求，模型會依 skill 描述自動透過 skill 工具呼叫。
|
||
|
||
### GitHub Copilot CLI
|
||
|
||
Copilot CLI 支援與 Claude Code 類似的原生 plugin / marketplace 指令，可直接從 marketplace 安裝、更新與移除本 plugin。
|
||
|
||
```bash
|
||
# 安裝
|
||
copilot plugin marketplace add https://gitea.jsc.idv.tw/plugins/doc.git
|
||
copilot plugin install jsc-doc@jsc
|
||
|
||
# 更新
|
||
copilot plugin marketplace update jsc
|
||
copilot plugin update jsc-doc@jsc
|
||
|
||
# 移除
|
||
copilot plugin uninstall jsc-doc@jsc
|
||
copilot plugin marketplace remove jsc
|
||
```
|
||
|
||
- 安裝 token `jsc-doc@jsc` = plugin 名（plugin manifest 的 `name`）@ marketplace 名。
|
||
- `copilot plugin marketplace add` 支援 GitHub `owner/repo`、git URL 與本地路徑；Gitea repo 可用上方 HTTPS URL。
|
||
- **呼叫**：在 Copilot CLI 中用自然語言描述需求，例如 `copilot -i "跑 hello 確認 plugin 裝好了"`。
|
||
|
||
---
|
||
|
||
## 用 CLI 直接執行 skill（headless / 一次性）
|
||
|
||
安裝好之後，不必進互動介面，一行指令就能叫某個 skill 跑完並印出結果：
|
||
|
||
| 助理 | headless 指令 | 執行 `hello` skill |
|
||
| --- | --- | --- |
|
||
| Claude Code | `claude -p "<prompt>"` | `claude -p "/jsc-doc:hello"` |
|
||
| Codex | `codex exec "<prompt>"` | `codex exec '$hello'` |
|
||
| Antigravity | `agy -p "<prompt>"` | `agy -p "/jsc-doc:hello"` |
|
||
| OpenCode | `opencode run "<message>"` | `opencode run "用 hello skill 打個招呼"` |
|
||
| GitHub Copilot CLI | `copilot -p "<message>"` | `copilot -p "用 hello skill 打個招呼"` |
|
||
|
||
- Claude / Antigravity 支援 `/jsc-doc:` 前綴，直接 `-p "/jsc-doc:<name>"` 即可。
|
||
- Codex 以 `$<name>` 觸發；在 shell 請用**單引號**避免 `$` 被展開：`codex exec '$hello'`。
|
||
- OpenCode 與 Copilot 沒有前綴，用自然語言描述需求；Copilot CLI 會讀取已安裝 plugin 提供的 skills。
|
||
- 帶引數就接在後面，例如 `claude -p "/jsc-doc:hello 參數"`、`codex exec '$hello 參數'`。
|
||
|
||
---
|
||
|
||
## Skills 目錄
|
||
|
||
> 此區塊列出本 plugin 內含的所有 skills（名稱／描述／使用方法）。
|
||
> 新增或修改 skill 後，請同步手動更新標記之間的內容。
|
||
|
||
<!-- JSC-SKILLS:START -->
|
||
|
||
### `hello`
|
||
|
||
範例 skill，用來驗證 jsc plugin 是否安裝成功，也是新增 skill 的範本。當使用者輸入 hello、想測試 plugin、或想看 skill 模板長什麼樣子時觸發；回覆一句問候並簡述此 plugin 的用途。
|
||
|
||
- **Claude Code / Antigravity**：`/jsc-doc:hello`
|
||
- **Codex**：`$hello`，或用 `/skills` 選單
|
||
- **OpenCode / GitHub Copilot CLI**：描述需求自動觸發
|
||
|
||
<!-- JSC-SKILLS:END -->
|
||
|
||
---
|
||
|
||
## 新增一個 skill
|
||
|
||
1. 複製範本：`cp -r skills/hello skills/<your-skill-name>`
|
||
2. 編輯 `skills/<your-skill-name>/SKILL.md` 的 frontmatter：
|
||
- `name`：小寫、數字、連字號（`-`），最長 64 字元。**這就是 Claude Code / Antigravity 的 `/jsc-doc:<name>`**。
|
||
- `description`：第三人稱，寫清楚「何時用、何時不用」與觸發關鍵字 — 這是各助理自動載入的唯一依據。
|
||
3. 在內文寫下 skill 的具體步驟。
|
||
4. 手動把這個 skill 補進上方「Skills 目錄」區塊。
|
||
5. **bump 版本並 push**：各助理都以 git 內容/版本判斷更新，請把 `.claude-plugin/plugin.json`、`.codex-plugin/plugin.json`、`plugin.json` 三個 manifest 的 `version` 一起 bump，commit 後 push 到 gitea。
|
||
6. 讓各助理更新：
|
||
- Claude：`claude plugin update jsc-doc@jsc`
|
||
- Codex：`codex plugin marketplace upgrade doc`
|
||
- Antigravity：`git -C ~/jsc-plugin pull && agy plugin uninstall jsc-doc && agy plugin install ~/jsc-plugin`
|
||
- OpenCode：`git pull` 後重新複製 `skills/`
|
||
- Copilot：`copilot plugin marketplace update jsc && copilot plugin update jsc-doc@jsc`
|