• 繁體中文(台灣)
  • HolyCrab CLI 快速開始

    選擇一種安裝方式:複製提示詞到 Codex 或 Claude Code,或在終端機執行安裝命令。安裝完成後,配置 API Key並在 Agent 中使用。

    開始前的準備

    • 一臺 Windows、macOS 或 Linux 電腦,可以安裝 Python 3.10 或更高版本。
    • HolyCrab 帳號,以及同一台電腦上的 Codex;Claude Code 也以相同方式支援。

    一鍵安裝

    開啟安裝 HolyCrab CLI,選擇 一鍵安裝,點選 複製提示詞,貼上到需要安裝 CLI 的電腦上的 Codex 或 Claude Code。

    • Agent 會識別系統、檢查依賴和已有安裝,按需執行對應安裝命令,再檢查 CLI 和 Agent 接入狀態。缺少依賴、權限或需要重啟時,按提示處理。
    • 需要配置帳號時,在本機終端機執行 holycrab setup,只將 API Key 貼上到隱藏輸入處,不要發到 Agent 對話中。
    安裝提示詞
    安裝 HolyCrab CLI。檢查目前的作業系統、Shell、Python 3.10+ 和既有安裝;需要安裝時,只執行符合環境的官方指令:
    
    macOS / Linux:
    curl -fsSL https://holycrab.ai/cli/install.sh | sh && export PATH="$HOME/.local/bin:$PATH"
    
    Windows PowerShell:
    irm https://holycrab.ai/cli/install.ps1 | iex
    
    讀取已安裝的 HolyCrab Skill(或下方原文),檢查 PATH,執行 holycrab doctor --json,並檢查目前 Agent 的連接狀態。缺少相依套件、權限或需要重新啟動時,說明具體操作。
    
    執行 holycrab auth status。尚未設定 API Key 時,引導我開啟 API Key 頁面,在本機終端機執行 holycrab setup;不要要求我把 Key 貼到對話中。
    
    分別回報 CLI、Agent 連接和帳號設定狀態。本次只安裝和檢查,不提交生成任務。
    
    SKILL.md: https://raw.githubusercontent.com/AstroxNetwork/skills/v0.4.4/holycrab/SKILL.md
    
    API Key: https://generate.holycrab.ai/user-tokens
    
    CLI 安裝: https://holycrab.ai/tw/guide/cli/

    手動安裝

    在同一個安裝頁面選擇 手動安裝,切換 macOS / Linux 或 Windows,將複製的命令貼上到終端機或 PowerShell。已通過一鍵安裝完成的使用者可跳過此步驟。

    安裝後

    SKILL.md 與 CLI 安裝入口

    安裝頁的 SKILL.md 用於下載與安裝器版本一致的 Skill 檔案;僅下載檔案不會安裝 CLI。右側 CLI 安裝 ↗ 會在新標籤頁開啟本指南。

    常用術語說明

    術語含義
    CLI安裝在電腦上的 HolyCrab 命令列工具。
    終端機 / PowerShell用於輸入安裝和 setup 命令的系統程式。
    Codex通過對話協助呼叫本機 HolyCrab 工具的 Agent。
    API Key用於驗證這台電腦訪問 HolyCrab 帳號權限的私密憑據。
    任務 ID / 素材 ID用於後續查詢特定生成任務或素材的唯一編號。

    未成功時

    • 需要補充依賴、權限或重啟 Agent 時,按檢查結果處理,或檢視對應系統的安裝教程。
    • 安裝或API Key 配置失敗時,根據錯誤資訊檢視故障排查。分享報錯前請移除 API Key。