CLI overview - tableverse-kit

The tvk command runs your game locally and hands finished source to Tableverse. The scaffold installs it in the project root. From the project root, invoke it with:

npx tvk --help

Commands

Command	Purpose
`tvk validate`	Load and validate the game definition.
`tvk dev`	Start the local rules server, the frontend, and the developer shell.
`tvk login`	Sign in to Tableverse in your browser.
`tvk whoami`	Print the signed-in account.
`tvk logout`	Revoke and remove the saved login.
`tvk upload`	Package the project source and start a platform build.

Use --help after any command to see its current options:

npx tvk upload --help

Config file

tvk validate, tvk dev, and tvk upload search the current directory and its parents for tableverse.config.ts.

import { defineConfig } from "@tableverse-kit/config";
import { game } from "./engine/src/game.ts";

export default defineConfig({
  game,
  publish: {
    engine: "./engine",
    frontend: "./client",
  },
});

Run commands from the project root or any directory below it:

cd client
npx tvk validate

The CLI walks upward to the nearest tableverse.config.ts.

Recommended checks

Run TypeScript before CLI validation. The CLI loads the built definition, while TypeScript catches mistakes in code paths that may not run during definition assembly.

npm run typecheck
npx tvk validate

Local server

Start your complete local development environment.

Upload

Link a project and start a platform build.

​Commands

​Config file

​Recommended checks

Local server

Upload

Commands

Config file

Recommended checks