Warlok Docs

Agent + CLI Quickstart

CLI

Warlok CLI Quickstart

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

1. Install + Verify

pnpm dlx @warlok/cli@latest --help

2. Authenticate

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

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

3. Generate a Character

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

Useful Commands

pnpm dlx @warlok/cli@latest status <generation_id>
pnpm dlx @warlok/cli@latest list --json
pnpm dlx @warlok/cli@latest download <generation_id> --rigged
pnpm dlx @warlok/cli@latest doctor --json
pnpm dlx @warlok/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.