@openrender/cli

Install the openRender CLI from npm, then run the openrender command inside a game project.

npm install -g @openrender/cli
openrender --version

openRender is an AI-native game development infrastructure Developer Kit. It gives AI coding agents a project-state layer for Project Consistency Memory, compact memory, visual evidence, engine-ready asset handoff, visual baselines, helper code, reports, verification records, rollback state, and task packets for external agent harnesses.

Common Commands

openrender context --json --compact
openrender scan --json
openrender doctor --json
openrender install-agent --platform codex --dry-run --json

Compile and inspect before writing files:

openrender compile sprite \
  --from tmp/slime_idle_strip.png \
  --target phaser \
  --id enemy.slime.idle \
  --frames 6 \
  --frame-size 64x64 \
  --dry-run \
  --json

Install, verify, and summarize:

openrender compile sprite --from tmp/slime_idle_strip.png --target phaser --id enemy.slime.idle --frames 6 --frame-size 64x64 --install --json
openrender verify --run latest --json --compact
openrender report --run latest --json --compact
openrender diff --run latest --json --compact

For local continuity between agent runs:

openrender memory ingest --run latest --json
openrender memory query --for style --json --compact
openrender consistency context --json --compact
openrender task packet --for ui --json --compact
openrender visual review --from screenshots/latest.png --json --compact
openrender value report --for ui --json --compact
openrender memory review --run latest --json
openrender memory context --json --compact
openrender service snapshot --json

Usage-based Pro DevKit foundation commands are available in 1.4.1. Free OSS commands remain usable without login, billing, telemetry, or sync.

openrender login --email [email protected] --json
openrender license activate --key or_dev_example --json
openrender license status --json
openrender pro list --json
openrender pro install love2d-ui-pack --json
openrender pro validate --profile love2d-ui --json --compact
openrender usage status --json
openrender usage sync --json

Pro usage events are metadata only. They include license, hashed project id, feature, command, credits, timestamp, CLI version, and optional pack id; they do not include filenames, screenshots, prompts, raw reports, source paths, project names, or media.

DB-backed Pro licensing enforces plan activation limits and signs local tokens with a seven-day offline grace window. Pro pack installs write signed manifests and hash-verified rule/helper/workflow/template artifacts under ~/.openrender/pro/packs/, outside project source.

The package name is @openrender/cli; the installed binary is openrender.