CLI reference

Generated from opengame help --json (CLI 0.3.3). Run opengame <command> --help for the same text in a terminal.

Internal build. Install the tarball the team supplies; the package is not on a public registry.

Choose a task

Start with the quickstart for a private preview, or For agents for approval and structured output.

Task	Commands
Prepare and check a game	init, check, dev
Sign in and check access	login, whoami, token, logout
Deploy and play a private preview	deploy, status, deployments, open
Enter a jam	jams, submit
Work with an existing game	games, link, pull, stats
Check usage and tooling	limits, vendor, skills, upgrade, version

Commands

Command	What it does
`init`	Create opengame.json for an existing game.
`check`	Find local build and asset problems before uploading.
`dev`	Serve a local export with game-runtime headers. Under a contract that adds the SDK, pages also get the host runtime and SDK, as they do when hosted. If the contract supports opting out, sdk.inject: false leaves out the SDK.
`login`	Sign in through your browser.
`deploy`	Build, check and upload a release, then return with the address of its deployment page, where the checks run and the private preview plays once they pass. Add `--wait` to stay until they finish. Once the preview is ready, the achievements opengame.json declares are saved by deploy `--wait` or by the next `opengame status` in this folder. Removing an achievement from opengame.json does not switch it off. To retire one, send PUT /api/v1/games/{id}/achievements with `achievementId`, title, description and active: false. Unlocks are never deleted.
`status`	Show the most recent deploy for this folder, with its findings. Finishes saving its declared achievements if the deploy could not. Removing an achievement from opengame.json does not switch it off. To retire one, send PUT /api/v1/games/{id}/achievements with `achievementId`, title, description and active: false. Unlocks are never deleted.
`deployments`	List the linked game’s deploys, newest first: status, when, size, who started each one, why any stopped, and each one’s page or preview.
`open`	Open the linked game’s private page in your browser.
`submit`	Send one release to review, and enter it in a jam.
`jams`	List open jams, or show one jam’s tracks and flags.
`games`	List your games and their latest deploy.
`link`	Connect this folder to an existing game.
`pull`	Bring website metadata into this folder.
`stats`	Read analytics for a game you own, or this folder’s linked game, for one complete ISO week, Monday to Sunday in UTC. Average playtime is total playtime divided by distinct players in the week.
`whoami`	Show the account and permissions for this token.
`token`	Create, list or revoke tokens in your browser.
`logout`	Revoke this device’s token and remove it locally.
`limits`	Show bundle limits and your remaining account allowance.
`vendor`	Create a separate export with dependencies downloaded at their exact versions, rewritten and hashed.
`skills`	Install the OpenGame skills for your coding agent.
`upgrade`	Install the current CLI, or print the line that does.
`version`	Print the CLI version.

opengame init

Create opengame.json for an existing game.

opengame init [dir] [options]

Flag	What it does
`--title <value>`	Game title. Without it, read from index.html’s title, then package.json, then the folder name.
`--description <value>`	One or two sentences about the game.
`--output <value>`	Static build folder. Required when several outputs contain index.html.
`--engine <value>`	Engine export recipe. Otherwise detect source markers and built-export signatures; unknown projects use custom. The IDs are on the engine support page.
`--genre <value>`	A genre slug. Without it, guessed from the title and description; a wrong one lists the slugs.
`--kind <game\|world\|decomp\|mod>`	What you are making. Without it, init asks a person in a terminal, with game selected, and makes a game for everyone else. One of `game`, `world`, `decomp`, `mod`. Default `game`.
`--based-on <value>`	The game a decomp or a mod is made from, as in `--based-on` “Doom”. Required for a decomp or a mod, and not allowed for a game or a world.

Also takes the global flags.

opengame init . --title "My game"
opengame init . --kind mod --based-on "Doom"

opengame check

Find local build and asset problems before uploading.

opengame check [dir] [options]

Flag	What it does
`--external-assets <value>`	Asset plan JSON naming its kind, or auto. For a large export, `--external-assets` auto is the same as a plan of `{"delivery":"large-game-v1","assets":"auto"}`: opengame chooses which files to send separately. For Kaigen: `{"delivery":"kaigen-assets-v1","assets":["cooked/","oc_heads/"]}`, where a path ending in / takes every eligible file under it. Kaigen and large-game-v1 need large-asset access on your account; the server checks every plan again.
`--unity-assets <value>`	Unity asset plan JSON: `{"assets":["Build/game.data"]}`. The same as `--external-assets` for a Unity plan. Paths are relative to the export root; the server checks the plan again.
`--vendor`	Download dependencies from approved sources at the exact versions your code names into the packaging copy, with hashes and licenses.
`--build`	Run the build command from opengame.json first, so the check reads fresh output.

Also takes the global flags.

opengame check .
opengame check . --build --json

opengame dev

Serve a local export with game-runtime headers. Under a contract that adds the SDK, pages also get the host runtime and SDK, as they do when hosted. If the contract supports opting out, sdk.inject: false leaves out the SDK.

opengame dev [dir] [options]

Flag	What it does
`--port <value>`	Loopback port. Zero (the default) chooses a free port.
`--contract <value>`	Runtime contract. Defaults to 2027-03, which new games are published under. 2026-10 and 2026-11 allow neither cross-origin isolation nor eval, let a game reach only OpenGame’s own hosts, and add no SDK. 2027-01 allows cross-origin isolation and eval, lets a game reach only OpenGame’s own hosts, and adds the SDK to every page. It is deprecated, and no new release gets it. 2027-02 allows cross-origin isolation but not eval, lets a game reach only OpenGame’s own hosts, and adds the SDK to every page. A release on 2026-11 whose scan finds threads is moved onto it automatically. 2027-03 allows eval but not cross-origin isolation, lets a game reach any https host, and adds no SDK. 2027-04 allows cross-origin isolation and eval, lets a game reach any https host, and adds the SDK to every page. A release on 2027-03 whose scan finds threads is moved onto it automatically.
`--build`	Run the manifest build before serving an immutable snapshot.
`--external-assets <value>`	The asset plan or auto selection used by check and deploy. Planned files are served from disk on request; the remaining export must fit the ordinary limits. This command serves locally without hashing or uploading.

Also takes the global flags.

opengame dev . --build
opengame dev . --contract 2027-04
opengame dev . --external-assets kaigen-assets.json

opengame login [options]

Flag	What it does
`--device-name <value>`	Name shown on the approval page and in settings. Defaults to this machine’s hostname and today’s date.
`--no-wait`	Print the URL and code, then exit 3 with next: `opengame login --continue`. The default in agent mode.
`--wait`	Wait for the browser approval even in agent mode, where login and `--continue` otherwise return without it.
`--continue`	Finish a login started with `--no-wait`. In agent mode it waits up to 10 seconds, then exits 3 if access is not allowed yet; run it again.
`--force`	Replace a saved login that still works.

Also takes the global flags.

opengame login
opengame login --no-wait --json
opengame login --continue --json

opengame deploy

Build, check and upload a release, then return with the address of its deployment page, where the checks run and the private preview plays once they pass. Add --wait to stay until they finish. Once the preview is ready, the achievements opengame.json declares are saved by deploy --wait or by the next opengame status in this folder. Removing an achievement from opengame.json does not switch it off. To retire one, send PUT /api/v1/games/{id}/achievements with achievementId, title, description and active: false. Unlocks are never deleted.

opengame deploy [dir] [options]

Flag	What it does
`--external-assets <value>`	Asset plan JSON naming its kind, or auto. For a large export, `--external-assets` auto is the same as a plan of `{"delivery":"large-game-v1","assets":"auto"}`: opengame chooses which files to send separately. For Kaigen: `{"delivery":"kaigen-assets-v1","assets":["cooked/","oc_heads/"]}`, where a path ending in / takes every eligible file under it. Kaigen and large-game-v1 need large-asset access on your account; the server checks every plan again.
`--unity-assets <value>`	Unity asset plan JSON: `{"assets":["Build/game.data"]}`. The same as `--external-assets` for a Unity plan. Paths are relative to the export root; the server checks the plan again.
`--accept-statement <value>`	Accept the publication statement for a Kaigen asset plan, using the version `opengame check` prints beside its words. Unity and large-game-v1 plans need none.
`--title <value>`	Title when deploy creates a missing manifest.
`--description <value>`	Description when deploy creates a missing manifest.
`--genre <value>`	Genre when deploy creates a missing manifest.
`--kind <game\|world\|decomp\|mod>`	Kind when deploy creates a missing manifest. Without it, a game. One of `game`, `world`, `decomp`, `mod`. Default `game`.
`--based-on <value>`	The game a decomp or a mod is made from, as in `--based-on` “Doom” when deploy creates a missing manifest. Required for a decomp or a mod, and not allowed for a game or a world.
`--output <value>`	Static build folder when deploy creates a missing manifest.
`--vendor`	Download dependencies from approved sources at the exact versions your code names into the packaging copy, with hashes and licenses.
`--dry-run`	Build, check and package without uploading. With `--no-build`, check and package only.
`--no-build`	Skip the build command in opengame.json and package build.output as it is, when the export is already built and its command cannot run here, such as a Godot or Emscripten toolchain on another machine. A command that changes the export, such as one that adds the SDK, is skipped too.
`--idempotency-key <value>`	Retry key. Reuse it to resume one deploy; a new one starts another.
`--metadata <preserve\|local>`	preserve keeps newer website edits to the title, description and other product fields. local replaces them with opengame.json. One of `preserve`, `local`. Default `preserve`.
`--wait`	Stay until the checks finish, up to 300 seconds, and exit with their outcome. For CI that needs the result as an exit code.
`--no-wait`	Return once the upload is in. This is the default; the flag remains so older scripts keep working.
`--timeout <value>`	With `--wait`, stop watching after this many seconds (at most 300), exiting 5 with the checks still running. Setting it implies `--wait`.

Also takes the global flags.

opengame deploy .
opengame deploy . --dry-run
opengame deploy . --no-build
opengame deploy . --wait --json

opengame status

Show the most recent deploy for this folder, with its findings. Finishes saving its declared achievements if the deploy could not. Removing an achievement from opengame.json does not switch it off. To retire one, send PUT /api/v1/games/{id}/achievements with achievementId, title, description and active: false. Unlocks are never deleted.

opengame status [dir] [options]

Flag	What it does
`--watch`	Follow the deploy until it is ready, refused, or the watch window closes.
`--timeout <value>`	Stop watching after this many seconds (at most 300), exiting 5 with the checks still running.

Also takes the global flags.

opengame status . --watch

opengame deployments

List the linked game’s deploys, newest first: status, when, size, who started each one, why any stopped, and each one’s page or preview.

opengame deployments [dir] [options]

Flag	What it does
`--game <value>`	A game ID or public ID from `opengame games`, instead of the linked folder’s.

Also takes the global flags.

opengame deployments
opengame deployments --game <id> --json

opengame open

Open the linked game’s private page in your browser.

opengame open [dir] [options]

Flag	What it does
`--game <value>`	Game id or public id.

Also takes the global flags.

opengame submit

Send one release to review, and enter it in a jam.

opengame submit [dir] [options]

Flag	What it does
`--release <value>`	The release id to submit: `releaseId` from `opengame status --json` once the deploy is ready, or from `opengame deploy`ments `--json`. Agents must name it.
`--jam <value>`	The jam slug to enter, from `opengame jams`.
`--no-jam`	Submit without a jam, when the server accepts marketplace submissions.
`--qa`	Send to review for the QA destination: no jam, and published unlisted once a reviewer approves it. The account needs a QA grant from an OpenGame owner. Takes no jam flags.
`--track <value>`	The jam track. `opengame jams <slug>` lists them.
`--models <value>`	Comma-separated models the game was made with, from the jam’s form.
`--sponsor <value>`	Comma-separated sponsor tracks to enter.
`--evidence-<sponsor> <value>`	What that sponsor’s model did in the game, one flag per sponsor, for example `--evidence-fal`.
`--yes`	Skip the confirmation a person is asked for.
`--idempotency-key <value>`	Retry key. Reuse it to check on one submission; a new one starts another.
`--no-wait`	Return once submitted, without waiting for certification in the browser.

Also takes the global flags.

opengame submit
opengame submit --release <id> --no-jam --json
opengame submit --release <id> --qa --json
opengame submit --release <id> --jam <slug> --track rpg --models claude,fal --sponsor fal --evidence-fal "All prop textures"

opengame jams

List open jams, or show one jam’s tracks and flags.

opengame jams [slug] [options]

Also takes the global flags.

opengame jams
opengame jams <slug> --json

opengame games

List your games and their latest deploy.

opengame games [options]

Flag	What it does
`--cursor <value>`	`nextCursor` from the previous page.

Also takes the global flags.

opengame link

Connect this folder to an existing game.

opengame link [dir] [options]

Flag	What it does
`--game <value>`	Game id or public id from `opengame games`.
`--replace`	Replace an existing link.

Also takes the global flags.

opengame pull

Bring website metadata into this folder.

opengame pull [dir] [options]

Also takes the global flags.

opengame stats

Read analytics for a game you own, or this folder’s linked game, for one complete ISO week, Monday to Sunday in UTC. Average playtime is total playtime divided by distinct players in the week.

opengame stats [game|dir] [options]

Flag	What it does
`--game <value>`	Game ID or public ID from `opengame games`. Defaults to the linked game.
`--window <week>`	Always week. A week is readable 6 hours after it ends on Sunday at midnight UTC. Any other window is refused. One of `week`. Default `week`.
`--period <value>`	Which ISO week, such as 2026-W43. Defaults to the newest complete week.
`--funnel <value>`	Ordered custom event names separated by commas, from 2 to 10 steps.

Also takes the global flags.

opengame stats
opengame stats <game-id> --json
opengame stats --game <id> --window week --period 2026-W42 --json
opengame stats --period 2026-W40 --json

opengame whoami

Show the account and permissions for this token.

opengame whoami [options]

Also takes the global flags.

opengame token

Create, list or revoke tokens in your browser.

opengame token create|list|revoke [options]

Flag	What it does
`--name <value>`	Token name, for create.
`--scopes <read\|deploy\|submit>`	Comma-separated scopes, for create. A token never has more than the session that makes it. Any of `read`, `deploy`, `submit`. Default `deploy`.
`--game <value>`	Pin the token to one game, for create.
`--id <value>`	The 16-character public token id, for revoke. Never the token itself.

Also takes the global flags.

opengame token create --name "Build runner" --scopes read,deploy
opengame token list

opengame logout

Revoke this device’s token and remove it locally.

opengame logout [options]

Flag	What it does
`--revoke`	Also revoke a token supplied by OPENGAME_TOKEN, everywhere it is used.

Also takes the global flags.

opengame limits

Show bundle limits and your remaining account allowance.

opengame limits [options]

Also takes the global flags.

opengame vendor

Create a separate export with dependencies downloaded at their exact versions, rewritten and hashed.

opengame vendor [dir] [options]

Flag	What it does
`--output <value>`	New staging folder inside the project. Defaults to .opengame/vendor; existing folders are never overwritten.
`--build`	Run the manifest build before vendoring.

Also takes the global flags.

opengame vendor . --output vendored

opengame skills

Install the OpenGame skills for your coding agent.

opengame skills add|list [dir] [options]

Flag	What it does
`--agent <claude\|codex\|cursor\|opencode>`	Comma-separated agents to install for. Detected from the project when omitted. Any of `claude`, `codex`, `cursor`, `opencode`.
`--dir <value>`	The project folder, when it is not given as an argument.
`--skill <value>`	Install named skills from the catalog, separated by commas.
`--all`	Install the full catalog instead of the starting set.
`--replace`	Overwrite skills you have edited. Your edits are lost.
`--keep-edited`	Leave skills you have edited as they are and install the rest.

Also takes the global flags.

opengame skills add .
opengame skills add . --agent codex,cursor
opengame skills add . --keep-edited
opengame skills list --json

opengame upgrade

Install the current CLI, or print the line that does.

opengame upgrade [options]

Flag	What it does
`--dry-run`	Print the install command without running it.
`--allow-downgrade`	Install the server’s version even when it is older than this one.

Also takes the global flags.

opengame version

Print the CLI version.

opengame version [options]

Also takes the global flags.

Exit codes

Stable across versions. Branch on the code, then read the message.

Code	Name	Meaning
0	`ok`	Done. With `done:false` in the result, the deploy is still running on our side: open data.url to watch it, or follow it with `opengame status --watch`.
1	`check`	The game needs a change. Read the finding events, or the error’s finding and message when there are none, fix it, then run the finding’s verify command.
2	`input`	The command needs input: a flag, a choice or a different command. The message names it. With retry never, running the same command again cannot help.
3	`auth`	Sign in, or use a token with the right scope. Run the error’s next command when it has one. With retry never, signing in again will not help: the account itself has no access.
4	`rateLimited`	An allowance is used. Wait `retryAfterSeconds` when the error has it, then run the same command.
5	`server`	Our side or the network, and the game is fine. Run the error’s next command when it has one. With retry after-fix or never, waiting will not help; read the message. Otherwise wait (`retryAfterSeconds` when given) and run the same command.
6	`upgrade`	This CLI is too old. Run `opengame upgrade`.

JSON events

With --json, the CLI prints the final JSON object with collected findings and notices. For progress events, use --jsonl: one event per line, ending with result or error. A terminal gets plain text by default; a pipe or an agent gets JSON. JSON modes require explicit choices instead of command prompts.

Type	Meaning
`progress`	A stage started or moved on. `stage` names it; `operation` is the deploy’s id once it exists, and an upload carries `bytes` and `total`. Hashing an asset plan’s files is stage `assets`, with `files`, `totalFiles`, `bytes` and `total`.
`notice`	Something worth knowing that is not a failure. `code` names it, and `paths` lists the files when it is about files. The sign-in notice, `device_approval`, carries `url`, `userCode` and `expiresAt` to relay to the person.
`finding`	One problem, in the repair-finding shape: what was observed, where, how sure we are, whose fault, the fix, and when to retry.
`result`	The command finished. Always the last line on success.
`error`	The command failed. Always the last line on failure, with `code`, `message` and `exitCode`, plus `retry` (`now`, `after-fix`, `later` or `never`), `next`, `retryAfterSeconds` or `finding` when they apply. `retry` is left out when a command exits with a code other than the one its error code usually takes and sets no `retry` of its own.

When stdout is not a terminal, or CI or CLAUDECODE, CODEX_SANDBOX, CODEX_THREAD_ID, CURSOR_AGENT, OPENCODE or AI_AGENT is set to anything but 0, false or no, output defaults to one formatted JSON result or error. In a terminal, —human ignores those variables and prints text. Use --jsonl to stream events. With either JSON mode there are no command prompts or browser opens, and login prints the approval URL and code instead of waiting. Run opengame login --wait to wait for the browser anyway. See The repair loop for the finding shape and how to act on each field.

Environment

Variable	What it does
`OPENGAME_API_URL`	The internal origin the OpenGame team gave you. Set it before login or deploy: without it the CLI talks to https://opengame.io, which does not take creator deploys yet.
`OPENGAME_TOKEN`	A token from settings, for CI and agents. Never pass a token as a flag.
`OPENGAME_CREDENTIAL_STORE`	Set to file to store the login in ~/.config/opengame/auth.json instead of the macOS Keychain.
`XDG_CONFIG_HOME`	Where the login file and a pending login live, as $XDG_CONFIG_HOME/opengame. Defaults to ~/.config.
`HTTPS_PROXY`	Proxy for API requests, HTTP_PROXY for an http:// API origin. Lower-case spellings and NO_PROXY work; dependency vendoring uses direct DNS-checked HTTPS.
`NO_COLOR`	Plain output with no colour or motion. TERM=dumb does the same.
`OPENGAME_REDUCED_MOTION`	Set to 1 to keep colour but stop motion: the character holds still and changes land at once. The spinner still turns.
`COLORTERM`	truecolor or 24bit draws the character in full colour; anything else uses the 256-colour palette.
`COLORFGBG`	Read to tell a light terminal from a dark one, so the character’s outline suits it. Most terminals are taken as dark.
`OPENGAME_DEBUG`	Set to 1 to print the stack of an unexpected error to stderr.

Global flags

Every command takes these.

Flag	What it does
`--jsonl`	Stream one JSON event per line. The last line is a result or an error.
`--token-stdin`	Read the token from stdin instead of OPENGAME_TOKEN or the saved login.
`--json`	Print one formatted JSON result or error, including notices and findings.
`--human`	Print for a person even when a coding agent’s variable such as CLAUDECODE is set. Prompts still need a terminal.
`--no-browser`	Print the URL instead of opening a browser.
`--help`	Show the command’s help.
`--version`	Print the CLI version.

Start

Guides

Reference

Choose a task

Commands

opengame init

opengame check

opengame dev

opengame deploy

opengame status

opengame deployments

opengame open

opengame submit

opengame jams

opengame games

opengame link

opengame pull

opengame stats

opengame whoami

opengame token

opengame logout

opengame limits

opengame vendor

opengame skills

opengame upgrade

opengame version

Exit codes

JSON events

Environment

Global flags

​Choose a task

​Commands

​opengame init

​opengame check

​opengame dev

​opengame login

​opengame deploy

​opengame status

​opengame deployments

​opengame open

​opengame submit

​opengame jams

​opengame games

​opengame link

​opengame pull

​opengame stats

​opengame whoami

​opengame token

​opengame logout

​opengame limits

​opengame vendor

​opengame skills

​opengame upgrade

​opengame version

​Exit codes

​JSON events

​Environment

​Global flags

Choose a task

Commands

opengame init

opengame check

opengame dev

opengame login

opengame deploy

opengame status

opengame deployments

opengame open

opengame submit

opengame jams

opengame games

opengame link

opengame pull

opengame stats

opengame whoami

opengame token

opengame logout

opengame limits

opengame vendor

opengame skills

opengame upgrade

opengame version

Exit codes

JSON events

Environment

Global flags