Integrations

CLI

Generate images, videos, and edits straight from the terminal or from any script. Asynchronous with --wait, --json output for automation, automatic upload of local files.

Installation

bash

npm install -g @caranguejo/cli

bash

curl -fsSL https://caranguejo.art/install.sh | sh

bash

pnpm add -g @caranguejo/cli

Authentication

bash

# cole sua chave ck_live_… (Conta → Apps & API)
caranguejo auth login
# ou via variável de ambiente (CI):
export CARANGUEJO_API_KEY=ck_live_xxxxxxxx

Commands

Command	Description
`auth login \| status \| logout`	Manages the stored key (`~/.caranguejo/config.json`)
`models list [--type image\|video\|tool]`	Lists the model and tool catalog
`models get <slug>`	Capabilities and fields of a model
`generate <slug> [options]`	Generic generation (any model/tool)
`generate image --prompt …`	Shortcut for image (gpt-image-2)
`upload <file>`	Hosts a file and prints the public URL
`generations list \| get <id>`	Your generations via the API
`balance`	Credit balance

generate options: --prompt, --image/--start-frame/--end-frame/--audio (URL or local file, auto-uploaded), --aspect, --duration, --quality, --resolution, --param key=value (repeatable), --wait, --json.

Examples

Image

bash

caranguejo generate image --prompt "um caranguejo numa praia neon, cinematográfico" \
  --quality high --resolution 2K --size 3:2 --wait

Video (image-to-video)

bash

# descubra os modelos de vídeo disponíveis
caranguejo models list --type video
# gere a partir de uma foto local (upload automático)
caranguejo generate <video-model-slug> --prompt "gire o produto 360°" \
  --start-frame ./produto.png --duration 5 --aspect 9:16 --wait

Tool (upscale)

bash

caranguejo generate upscale --image ./foto.jpg --param scale=4 --wait

Automation (JSON)

bash

URL=$(caranguejo generate image --prompt "logo de caranguejo" --wait --json \
  | jq -r '.output.images[0].url')
echo "$URL"