Skip to content

docs: 補上 Antigravity CLI 安裝與使用說明 #10

Description

@SamWang32191

背景

Repository 已同時提供 Codex 與 Antigravity manifests,但目前 README 尚未完整說明 Antigravity CLI 使用者應如何驗證、安裝及呼叫各個 plugin。

Codex 的 .agents/plugins/marketplace.json 不是 Antigravity CLI marketplace;Antigravity CLI 的安裝單位是各個 plugins/<name> 目錄,而不是 repository root。以 Antigravity CLI 1.1.18 實測:

agy plugin validate ./plugins/cmd  -> OK,處理 8 個 skills
agy plugin validate ./plugins/dev  -> OK,處理 1 個 skill
agy plugin validate .              -> 失敗,repository root 沒有 plugin.json

目標

在 README 補上一節完整且經過實測的「Antigravity CLI 安裝與使用」,讓使用者不需要理解 Codex marketplace 結構也能正確使用 cmddev

文件應涵蓋

  1. 說明 Codex 與 Antigravity 的入口差異:

    • Codex:plugins/<name>/.codex-plugin/plugin.json
    • Antigravity CLI:plugins/<name>/plugin.json
    • .agents/plugins/marketplace.json 僅供 Codex marketplace 使用。
  2. 說明 workspace 載入與全域安裝的差別:

    • 驗證 .agents/plugins.json 在目前支援的 Antigravity CLI 版本中,是否會於 workspace 自動載入 plugins/
    • 若不會,修正 README 的既有敘述,不要宣稱 CLI 會自動載入。
    • 若要在其他 projects 使用,應逐個安裝 plugin。
  3. 提供可複製執行的驗證與安裝指令:

    agy plugin validate ./plugins/cmd
    agy plugin validate ./plugins/dev
    
    agy plugin install ./plugins/cmd
    agy plugin install ./plugins/dev
    
    agy plugin list
  4. 列出安裝後的主要 slash commands:

    • cmd/commit/commit-push/commit-push-pr/create-branch/fix-pr/grill-on-point/pr/push
    • dev/sdkman-switch-jdk
  5. 補上 enable、disable、uninstall 的基本操作。

  6. 說明必要環境與相依項目:

    • Git/GitHub CLI 與登入狀態。
    • sdkman-switch-jdk 需要 POSIX shell 與 SDKMAN。
    • cmd 部分 workflows 會呼叫未封裝在 plugin 內的 skills,例如 git-commit-co-authorgrill-with-docsgrillingdomain-modeling;文件需說明如何取得,或明確標示不是獨立安裝即可完整運作。
  7. 說明 agents/openai.yaml 是 Codex/OpenAI UI metadata,Antigravity CLI 主要載入 SKILL.md,不應把該 metadata 當成跨平台保證。

驗收條件

  • README 新增獨立的 Antigravity CLI 使用章節。
  • 所有列出的指令均以目前支援的 Antigravity CLI 版本實際驗證。
  • 明確區分 repository root、Codex marketplace 與個別 Antigravity plugin directory。
  • 明確說明 workspace-local 與全域安裝的行為及作用範圍。
  • cmddev 安裝後能在 /skills 中找到預期 skills,並至少各完成一次不造成外部副作用的 smoke test。
  • 文件列出外部 skill/CLI/SDKMAN 相依,避免把結構驗證通過誤寫成所有 workflows 都能獨立執行。
  • 不改變 plugin 行為或 manifest schema;若實測發現相容性缺陷,另開 implementation issue。

非目標

  • 本 issue 不新增一鍵安裝器。
  • 本 issue 不重寫現有 skills。
  • 本 issue 不建立新的 Antigravity marketplace 格式。

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationready-for-agentFully specified, ready for an AFK agent

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions