ALPHAEarly access — $1 per summon · 5 summons/day · rough edges expected
WARLOK

CLI

Warlok CLI Quickstart

Use the Warlok CLI for local scripts, CI jobs, and agent workflows. All commands support structured output with --json.

Alpha status

The CLI package is published as @warlok-net/cli. It uses the live REST API with API-key auth (see Agents).

1. Install + Verify

pnpm dlx @warlok-net/cli@latest --help

2. Authenticate

Create an API key at /settings/api-keys, then run:

pnpm dlx @warlok-net/cli@latest auth login --base-url https://api.warlok.net --api-key <your_key>

3. Generate a Character

pnpm dlx @warlok-net/cli@latest generate character --name ranger-v1 --prompt "stylized ranger in t-pose, game-ready" --wait

4. Derive a Character Pack from One Image

--pack reads one character image into parts (body, head, hair, clothing layers, shoe, held item) and generates each part as its own GLB. It reserves several credits (one per planned part; unused parts are refunded). Parts are unrigged visual candidates: measured fit, assembly and rigging happen outside Warlok. Export one ZIP with original components, references, construction metadata and an agent prompt. These commands require built source 0.1.2 until npm publication.

Source preview

Implemented in the repository source; not yet in the published @latest CLI. The HTTP API deploys independently; check its tool schema and warlok --help of your installed version before relying on it.

warlok generate character --pack --image ./ranger.png --name ranger-pack --json
warlok status <generation_id> --json          # pack.parts lists body, head, hair, garments, shoe, held
warlok export <generation_id> --json           # poll pack.delivery until ready
warlok download <generation_id> --package      # originals, references and reconstruction guide

Useful Commands

pnpm dlx @warlok-net/cli@latest status <generation_id>
pnpm dlx @warlok-net/cli@latest list --json
pnpm dlx @warlok-net/cli@latest download <generation_id> --rigged
pnpm dlx @warlok-net/cli@latest doctor --json
pnpm dlx @warlok-net/cli@latest mcp print-config --format json

Notes

  • Use --json for deterministic machine parsing.
  • Never hardcode live keys in committed files.
  • For non-interactive agents, set WARLOK_API_URL and WARLOK_API_KEY.
  • --rigged prefers the alpha character-stage GLB when present; production rigging remains alpha-scoped.