Quickstart

Install the Rosebud CLI and publish your first game.

You need Node.js 22 or later.

Install the CLI

npm install --global @rosebudai/cli

To run it without installing, use npx @rosebudai/cli in place of rosebud, for example npx @rosebudai/cli publish --directory ./dist.

Publish your build folder

Build your game, then publish the build folder from your project's root:

rosebud publish --directory ./dist --title 'Moon Garden' \
  --description 'Collect five glowing seeds.'

Already have a ZIP? Use --zip ./game.zip instead of --directory. No build step? Copy index.html and everything it loads into a folder such as ./dist and publish that, not the project root.

Play it

Open the play_url from the result and play the game. A successful upload means the files were accepted, not that the game works.

Claim it within an hour

Open the claim_url, sign in and select Claim game. Unclaimed games are deleted after one hour. If you ran rosebud login first, the game is already in your account and there's nothing to claim.

Planning to ship updates? Run rosebud connect instead and open its approval_url. Approving it claims the game and lets the CLI update it, in one step.

The CLI saves the game's details in .rosebud/project.json, so later commands know which game to update. Add .rosebud/ to .gitignore.

Next steps

On this page