CLI commands

The disko command ships in @disko-game/cli (Node.js 22 or later). Every command accepts --json and never prompts: a missing value fails with exit code 2 and names the flag. Commands, flags, exit codes and error codes below are generated from the CLI's own definitions.

Commands

disko dev

Run the game in a test room, reloading it on every edit.

disko dev [--project <dir>] [--json] [--no-open]

disko publish

Build, check and upload a game release.

disko publish [--dry-run] [--out <file>] [--visibility <visibility>] [--project <dir>] [--json]

disko login

Sign in with the browser, or store a CLI token read from stdin.

disko login [--with-token] [--json]

disko logout

Delete the stored credential.

disko logout [--json]

disko dev events

With --json, disko dev writes one JSON event per line (NDJSON) on stdout; progress stays on stderr. stopped is always the last event.

• sign_in_required

• room_ready

• reload

• runtime_error

• host_restarted

• stopped

Event fields

Combine --json with --no-open and DISKO_TOKEN to run without a browser:

DISKO_TOKEN="$TOKEN" npx disko dev --json --no-open

{"event": "room_ready", "room_id": "…", "link": "https://play.disko.ooo/?room=…", "expires_at": 1790000000}
{"event": "reload", "status": "failed", "problems": [{"code": "import_unresolved", "path": "src/main.ts", "line": 3, "column": 18, "message": "…", "docs": "…"}]}
{"event": "reload", "status": "ok", "digest": "blake3:…"}

stopped is always the last event. After Ctrl-C its reason is "interrupted" ("terminated" for SIGTERM); after a failure the exit code follows the exit-code table.

disko dev host file

A game decides how a match plays. The room decides everything around it: who may join, what happens to chat, which game is loaded. disko dev provides a simple room for you, and you can replace it with your own.

Without a host file, disko dev uses a built-in host: it shows every chat message, and runs the start-game, stop-game, pause-game and resume-game game events as room.start(), room.stop(), room.pause() and room.resume(). A game that starts itself with game.start(), as the scaffold does, needs nothing more.

To try your own room behavior, add a server.js to the game project that default-exports a host function, like a room project's room.js:

import { Room } from "@disko-game/room";

// The host function. `main.js` calls it in production and `disko dev` calls
// it with a test room: pass `options` through to `Room.launch` and return
// the room.
/** @param {import("@disko-game/room").HostOptions} options */
export default async function host(options) {
  const room = await Room.launch({ ...options, name: "My disko room" });

  // Nothing appears in chat unless the room sends it.
  room.on("chat-request", ({ player, text }) => {
    void room.send({ author: player, content: text });
  });

  room.on("player-join", ({ player }) => {
    void room.send(`${player.name} joined`);
  });

  return room;
}

• disko dev calls it with the test room's id and token, the project as game ({ path }), a loopback listen address and the endpoints. It must pass them through to Room.launch and resolve to the room it launched. See HostOptions.

• It imports @disko-game/room; install it in the game project (npm install @disko-game/room) so the import resolves.

• It runs in its own Node process. An edit to server.js closes the room and runs the new server.js in a fresh process with the same test room; players reconnect. server.js is not part of the game and is never published.

• A TypeScript project may use server.ts instead, which Node 22.18 or later runs directly (type stripping, so only erasable syntax). server.js wins when both exist.

• If the host function throws or its process fails, the error is reported with the phase host, and the next edit of any file tries again.

disko dev limits

A test room expires ten minutes after its last lease renewal, which disko dev renews while it runs. Each session creates a new test room, and an account can run at most two at a time; a third fails with quota_exceeded. A test room counts only while its host holds a lease: a session you stop frees its slot within seconds, and one that was killed frees it when its lease runs out (about 30 seconds).

Exit codes

Error codes

With --json, a failure prints {"ok": false, "command": …, "error": <code>, …} on stdout (for disko dev, the final stopped event carries error). An exit code 1 always comes with problems; an unexpected failure is reported as the problem internal_error. Each code has a page.

Environment variables

Flags win over variables, which win over the profile.

URLs must use https, except on localhost. Stored credentials are kept per API host, so a local credential is never sent to production.

Credentials

Signed-in commands use, in order: DISKO_TOKEN; a token stored by disko login --with-token; a stored browser sign-in; otherwise a browser sign-in, which prints the URL (and opens it unless --no-open is given) and waits up to five minutes. Credentials are stored only in the OS credential store. See CLI tokens & CI.