Sandscape CLI

Connect a browser game to Sandscape, work on it locally, and prepare it for publishing.

The Sandscape CLI connects a local game folder to Sandscape. You can use it from a terminal or let a coding agent handle the commands for you.

Give this prompt to your coding agent

Open your coding agent in the game folder, then paste this prompt:

Ensure Node.js (>= 18) is installed.
Install the Sandscape skill globally:
  npx -y @sandscape/cli@latest skill install
Then use it to interface with the Sandscape platform.

The agent will choose the right command for the folder, ask you to approve a one-time browser login, and stop at a review page before the game goes public. You make the final publishing decision.

Log inConnectEditSyncPublish

What you can do with the CLI

Connect a game that already exists on your computer.
Download one of your Sandscape projects into a new folder.
Pull changes from Sandscape and push local changes back.
Add publishing details, cover art, and gameplay footage.
Prepare a review page, then publish when you are satisfied with it.

Run commands yourself

You need Node.js 18 or newer. You can run the latest CLI without installing it:

npx -y @sandscape/cli@latest <command>

Or install the command globally:

npm install -g @sandscape/cli
sandscape <command>

The examples in these docs use sandscape. If you do not install it globally, replace sandscape with npx -y @sandscape/cli@latest.

Guides

Set up the CLI

Install the coding-agent skill or run the CLI from a terminal.

Log in

Authorize this computer through your browser.

Connect your game

Create a Sandscape project from a folder on your computer.

Clone and sync

Download a project, pull updates, and push your changes.

Publish

Prepare the game page, add media, and get a review link.

Command reference

Look up every command and option.

Asset generation stays in the web app

Use the Sandscape web app to generate images, 3D models, audio, and voices. The CLI syncs the resulting files but does not run asset generation locally.