• English

    • HolyCrab CLI quick start

    Choose one installation method: copy a prompt into Codex or Claude Code, or run the command yourself. Then configure your API Key and return to your Agent.

    Before you start

    • A Windows, macOS, or Linux computer on which you can install Python 3.10 or newer.
    • A HolyCrab account and Codex on the same computer. Claude Code is supported in the same way.

    One-click install

    Open Install HolyCrab CLI, select One-click install, and click Copy prompt. Paste it into Codex or Claude Code on the computer where you want to install the CLI.

    • The Agent checks the operating system, dependencies and existing installation, runs the matching installer if needed, and checks the CLI and Agent integration. Follow any dependency, permission or restart instructions it reports.
    • When prompted for API Key setup, run holycrab setup in your own terminal. Paste the API Key only into its protected input, never into Agent chat.
    Installation prompt
    Install HolyCrab CLI in this environment. Check the OS, shell, Python 3.10+ and any existing installation. If needed, run only the matching official command:

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

Read the installed HolyCrab Skill (or the source below), check PATH and run holycrab doctor --json. Check the current Agent integration; report any missing dependency, permission or required restart.

Run holycrab auth status. If the API Key is missing, ask me to open the API Key page and run holycrab setup in my local terminal. Never ask for the Key in chat.

Report CLI, Agent integration and account configuration status separately. Only install and check; do not submit generation tasks.

SKILL.md: https://raw.githubusercontent.com/AstroxNetwork/skills/v0.4.4/holycrab/SKILL.md

API Key: https://generate.holycrab.ai/user-tokens

CLI Setup: https://holycrab.ai/guide/cli/

    Manual install

    On the same installation page, select Manual install, choose macOS / Linux or Windows, and copy the command into Terminal or PowerShell. If you installed with an Agent, skip this step.

    WindowsPowerShell commands, Python requirements and installation checks.macOS / LinuxTerminal commands, Python and curl requirements, and installation checks.

    After installation

    Configure your API KeyIf setup is incomplete, follow the API Key instructions. If the API Key is already configured and valid, continue to Agent usage.Use with CodexCheck available models and estimate credits before approving generation. Claude Code follows the same workflow.

    SKILL.md and CLI Setup

    On the installation page, SKILL.md downloads the Skill for the installer version. Downloading this file does not install the CLI. CLI Setup ↗ opens this guide in a new tab.

    Key terms

    WordPlain meaning
    CLIThe small HolyCrab tool installed on your computer.
    Terminal / PowerShellThe window where you paste installation and setup commands.
    CodexThe Agent you talk to; it uses the local HolyCrab tool for you.
    API KeyA private password that lets this computer use your HolyCrab account.
    Task ID / Asset IDA unique identifier for looking up a generation task or an uploaded asset.

    If it did not work

    • If a dependency, permission or Agent restart is required, follow the reported action or use the matching system installation guide.
    • If installation or API Key setup fails, use the troubleshooting chapter with the error message. Remove API Keys before sharing it.