plugins/doc
2
0
Fork 0
Code Pull Requests Activity

chore(plugin 設定): 更新 doc plugin marketplace 與 manifest 描述 #4

Merged
admin merged 4 commits from develop into master 2026-06-17 03:52:46 +00:00
Conversation 1 Commits 4 Files Changed 6
+21 -29
1 changed files with 21 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit ffc9ee2fb7 - Show all commits
README.md
+21 -29
View File
@@ -1,7 +1,7 @@
# jsc — 跨 AI 助理文件化 Skill 集合 # jsc — 跨 AI 助理文件化 Skill 集合
一個可同時被 **Claude Code、Codex、Antigravity、OpenCode** 安裝的文件化 skill 集合。 一個可同時被 **Claude Code、Codex、Antigravity、OpenCode** 安裝的文件化 skill 集合。
目前內含：對齊 docker-compose 行內註解（`doc-docker`）、為專案 function 補齊 XML 文件並更新 README 功能目錄（`doc-funcs`）。 目前內含兩個實作型 skills：`doc-docker` 用於整理 `docker-compose.yaml` 的行內註解與標題日期；`doc-funcs` 用於掃描專案 functions、建立 `.docs/` 草稿、補齊 XML 文件註解並更新 README 功能目錄。
核心是以 [Agent Skills（`SKILL.md`）](https://agentskills.io) 標準撰寫的共用 skills（唯一真實來源放在 `skills/`）， 核心是以 [Agent Skills（`SKILL.md`）](https://agentskills.io) 標準撰寫的共用 skills（唯一真實來源放在 `skills/`），
搭配各助理各自的 plugin manifest，讓**同一個 repo** 可用各家**原生 plugin CLI** 安裝。 搭配各助理各自的 plugin manifest，讓**同一個 repo** 可用各家**原生 plugin CLI** 安裝。
在 Claude Code 與 Antigravity 中，skill 以 **`/jsc:` 前綴**呼叫（例如 `/jsc:doc-docker`）。 在 Claude Code 與 Antigravity 中，skill 以 **`/jsc:` 前綴**呼叫（例如 `/jsc:doc-docker`）。
@@ -48,7 +48,7 @@ doc/
## 安裝 / 更新 / 移除（各家原生 plugin CLI） ## 安裝 / 更新 / 移除（各家原生 plugin CLI）
> 指令中的 repo 網址換成你的：`https://gitea.jsc.idv.tw/plugins/template.git` > 指令中的 repo 網址：`https://gitea.jsc.idv.tw/plugins/doc.git`
> >
> **Claude / Codex 從 git URL 安裝（會 clone 遠端），請先把本 repo `push` 到 gitea。** > **Claude / Codex 從 git URL 安裝（會 clone 遠端），請先把本 repo `push` 到 gitea。**
> **Antigravity 的 `agy plugin install <url>` 目前只支援 github.com**；gitea 請改用「clone + 本地路徑」（見 Antigravity 節）。 > **Antigravity 的 `agy plugin install <url>` 目前只支援 github.com**；gitea 請改用「clone + 本地路徑」（見 Antigravity 節）。
@@ -58,7 +58,7 @@ doc/
```bash ```bash
# 安裝 # 安裝
claude plugin marketplace add https://gitea.jsc.idv.tw/plugins/template.git claude plugin marketplace add https://gitea.jsc.idv.tw/plugins/doc.git
claude plugin install jsc@jsc-plugins claude plugin install jsc@jsc-plugins
# 更新 # 更新
@@ -71,14 +71,14 @@ claude plugin marketplace remove jsc-plugins
``` ```
- 工作階段內 slash 版（等價）：把 `claude plugin` 換成 `/plugin`。 - 工作階段內 slash 版（等價）：把 `claude plugin` 換成 `/plugin`。
- 本機開發（免 push）：`claude plugin marketplace add C:\Users\h3285\source\repos.plugins\template`（本地路徑）後再 install。 - 本機開發（免 push）：`claude plugin marketplace add C:\Users\h3285\source\repos.plugins\doc`（本地路徑）後再 install。
- **呼叫**：`/jsc:<name>`（例 `/jsc:hello`）。 - **呼叫**：`/jsc:<name>`（例 `/jsc:doc-docker`）。
### Codex ### Codex
```bash ```bash
# 安裝 # 安裝
codex plugin marketplace add https://gitea.jsc.idv.tw/plugins/template.git codex plugin marketplace add https://gitea.jsc.idv.tw/plugins/doc.git
codex plugin add jsc@jsc-plugins codex plugin add jsc@jsc-plugins
# 更新（重新抓取 marketplace 的 git 快照） # 更新（重新抓取 marketplace 的 git 快照）
@@ -91,7 +91,7 @@ codex plugin marketplace remove jsc-plugins
- 安裝 token `jsc@jsc-plugins` = plugin 名（`.codex-plugin/plugin.json` 的 `name`）@ marketplace 名（`.agents/plugins/marketplace.json` 的 `name`）。 - 安裝 token `jsc@jsc-plugins` = plugin 名（`.codex-plugin/plugin.json` 的 `name`）@ marketplace 名（`.agents/plugins/marketplace.json` 的 `name`）。
- 本 repo 的 Codex marketplace 以 `url` 來源指向自己，故 Codex **一律從 gitea 安裝**（需先 push）；安裝後重啟 Codex。 - 本 repo 的 Codex marketplace 以 `url` 來源指向自己，故 Codex **一律從 gitea 安裝**（需先 push）；安裝後重啟 Codex。
- **呼叫**：`$<name>`（例 `$hello`），或用 `/skills` 選單。 - **呼叫**：`$<name>`（例 `$doc-docker`），或用 `/skills` 選單。
### Antigravity（`agy`） ### Antigravity（`agy`）
@@ -99,7 +99,7 @@ codex plugin marketplace remove jsc-plugins
```bash ```bash
# 安裝：clone 後用本地路徑 # 安裝：clone 後用本地路徑
git clone https://gitea.jsc.idv.tw/plugins/template.git ~/jsc-plugin git clone https://gitea.jsc.idv.tw/plugins/doc.git ~/jsc-plugin
agy plugin install ~/jsc-plugin agy plugin install ~/jsc-plugin
# 更新（agy 無 update 子指令 → git pull 後重裝） # 更新（agy 無 update 子指令 → git pull 後重裝）
@@ -113,7 +113,7 @@ agy plugin uninstall jsc
- 若把 skills 放到 GitHub，則可直接 `agy plugin install https://github.com/<owner>/<repo>`。 - 若把 skills 放到 GitHub，則可直接 `agy plugin install https://github.com/<owner>/<repo>`。
- 其他：`agy plugin list`、`agy plugin enable jsc` / `disable jsc`、`agy plugin validate <path>`。安裝後重啟工作階段。 - 其他：`agy plugin list`、`agy plugin enable jsc` / `disable jsc`、`agy plugin validate <path>`。安裝後重啟工作階段。
- **呼叫**：`/jsc:<name>`（例 `/jsc:hello`）或依描述自動觸發。 - **呼叫**：`/jsc:<name>`（例 `/jsc:doc-docker`）或依描述自動觸發。
### OpenCode ### OpenCode
@@ -122,7 +122,7 @@ OpenCode 會讀 `~/.config/opencode/skills/`（也會讀 `~/.claude/skills/`、`
```bash ```bash
# 安裝 # 安裝
git clone https://gitea.jsc.idv.tw/plugins/template.git ~/jsc-plugin git clone https://gitea.jsc.idv.tw/plugins/doc.git ~/jsc-plugin
mkdir -p ~/.config/opencode/skills mkdir -p ~/.config/opencode/skills
cp -r ~/jsc-plugin/skills/* ~/.config/opencode/skills/ cp -r ~/jsc-plugin/skills/* ~/.config/opencode/skills/
@@ -131,7 +131,7 @@ git -C ~/jsc-plugin pull
cp -r ~/jsc-plugin/skills/* ~/.config/opencode/skills/ cp -r ~/jsc-plugin/skills/* ~/.config/opencode/skills/
# 移除 # 移除
rm -rf ~/.config/opencode/skills/hello rm -rf ~/.config/opencode/skills/doc-docker ~/.config/opencode/skills/doc-funcs
``` ```
> **Windows PowerShell**：`cp -r A B` → `Copy-Item A B -Recurse -Force`、`rm -rf X` → `Remove-Item X -Recurse -Force`、`~` → `$HOME`。 > **Windows PowerShell**：`cp -r A B` → `Copy-Item A B -Recurse -Force`、`rm -rf X` → `Remove-Item X -Recurse -Force`、`~` → `$HOME`。
@@ -144,17 +144,17 @@ rm -rf ~/.config/opencode/skills/hello
安裝好之後，不必進互動介面，一行指令就能叫某個 skill 跑完並印出結果： 安裝好之後，不必進互動介面，一行指令就能叫某個 skill 跑完並印出結果：
| 助理 | headless 指令 | 執行 `hello` skill | | 助理 | headless 指令 | 執行 `doc-docker` skill |
| --- | --- | --- | | --- | --- | --- |
| Claude Code | `claude -p "<prompt>"` | `claude -p "/jsc:hello"` | | Claude Code | `claude -p "<prompt>"` | `claude -p "/jsc:doc-docker"` |
| Codex | `codex exec "<prompt>"` | `codex exec '$hello'` | | Codex | `codex exec "<prompt>"` | `codex exec '$doc-docker'` |
| Antigravity | `agy -p "<prompt>"` | `agy -p "/jsc:hello"` | | Antigravity | `agy -p "<prompt>"` | `agy -p "/jsc:doc-docker"` |
| OpenCode | `opencode run "<message>"` | `opencode run "用 hello skill 打個招呼"` | | OpenCode | `opencode run "<message>"` | `opencode run "整理 docker-compose 註解"` |
- Claude / Antigravity 支援 `/jsc:` 前綴，直接 `-p "/jsc:<name>"` 即可。 - Claude / Antigravity 支援 `/jsc:` 前綴，直接 `-p "/jsc:<name>"` 即可。
- Codex 以 `$<name>` 觸發；在 shell 請用**單引號**避免 `$` 被展開：`codex exec '$hello'`。 - Codex 以 `$<name>` 觸發；在 shell 請用**單引號**避免 `$` 被展開：`codex exec '$doc-docker'`。
- OpenCode 沒有前綴，用自然語言描述需求，模型會自動透過 skill 工具呼叫。 - OpenCode 沒有前綴，用自然語言描述需求，模型會自動透過 skill 工具呼叫。
- 帶引數就接在後面，例如 `claude -p "/jsc:hello 參數"`、`codex exec '$hello 參數'`。 - 帶引數就接在後面，例如 `claude -p "/jsc:doc-docker docker-compose.yaml"`、`codex exec '$doc-docker docker-compose.yaml'`。
--- ---
@@ -165,17 +165,9 @@ rm -rf ~/.config/opencode/skills/hello
<!-- JSC-SKILLS:START --> <!-- JSC-SKILLS:START -->
### `hello`
範例 skill，用來驗證 jsc plugin 是否安裝成功，也是新增 skill 的範本。當使用者輸入 hello、想測試 plugin、或想看 skill 模板長什麼樣子時觸發；回覆一句問候並簡述此 plugin 的用途。
- **Claude Code / Antigravity**：`/jsc:hello`
- **Codex**：`$hello`，或用 `/skills` 選單
- **OpenCode**：描述需求自動觸發
### `doc-docker` ### `doc-docker`
整理並對齊 docker-compose.yaml 的行內註解與標題區塊。當使用者要對齊 docker-compose 註解、整理 compose 檔註解欄位、更新 compose 標題日期，或提到 docker-compose、dc-tidy、align_comments、註解對齊時使用此 skill。 整理並對齊 `docker-compose.yaml` 的行內註解與標題區塊，優先透過內建 shell/awk 腳本批次處理或處理指定檔案。當使用者要對齊 docker-compose 註解、整理 compose 檔註解欄位、更新 compose 標題日期，或提到 docker-compose、dc-tidy、align_comments、註解對齊時使用此 skill。
- **Claude Code / Antigravity**：`/jsc:doc-docker` - **Claude Code / Antigravity**：`/jsc:doc-docker`
- **Codex**：`$doc-docker`，或用 `/skills` 選單 - **Codex**：`$doc-docker`，或用 `/skills` 選單
@@ -183,7 +175,7 @@ rm -rf ~/.config/opencode/skills/hello
### `doc-funcs` ### `doc-funcs`
為目前專案的每個 function 建立 .docs/ 草稿並補齊 XML 文件，最後更新 README 功能目錄。當使用者要補齊 function 文件、產生 XML doc、為每個 method 加 summary/param/remarks、建立 .docs 草稿，或提到 doc-funcs、function 文件化、XML documentation comments 時使用此 skill。 掃描目前專案所有可文件化的 function/method，建立 `.docs/doc-funcs-index.md` 與逐 function 草稿，再依草稿補齊 XML documentation comments，最後更新 README 功能目錄並執行合適驗證。當使用者要補齊 function 文件、產生 XML doc、為每個 method 加 summary/param/remarks、建立 .docs 草稿，或提到 doc-funcs、function 文件化、XML documentation comments 時使用此 skill。
- **Claude Code / Antigravity**：`/jsc:doc-funcs` - **Claude Code / Antigravity**：`/jsc:doc-funcs`
- **Codex**：`$doc-funcs`，或用 `/skills` 選單 - **Codex**：`$doc-funcs`，或用 `/skills` 選單
@@ -195,7 +187,7 @@ rm -rf ~/.config/opencode/skills/hello
## 新增一個 skill ## 新增一個 skill
1. 複製範本：`cp -r skills/hello skills/<your-skill-name>` 1. 建立目錄：`mkdir -p skills/<your-skill-name>`
2. 編輯 `skills/<your-skill-name>/SKILL.md` 的 frontmatter： 2. 編輯 `skills/<your-skill-name>/SKILL.md` 的 frontmatter：
- `name`：小寫、數字、連字號（`-`），最長 64 字元。**這就是 Claude Code / Antigravity 的 `/jsc:<name>`**。 - `name`：小寫、數字、連字號（`-`），最長 64 字元。**這就是 Claude Code / Antigravity 的 `/jsc:<name>`**。
- `description`：第三人稱，寫清楚「何時用、何時不用」與觸發關鍵字 — 這是各助理自動載入的唯一依據。 - `description`：第三人稱，寫清楚「何時用、何時不用」與觸發關鍵字 — 這是各助理自動載入的唯一依據。