Robo CLI

The Robo.js CLI provides commands for developing, building, deploying, and managing your project. All commands are run via npx robo (or your package manager's equivalent).

Global Options

These flags are available on most commands:

Flag	Alias	Description
`--silent`	`-s`	Suppress all output
`--verbose`	`-v`	Print additional debugging information
`--help`	`-h`	Show available options for the command
`--version`	`-V`	Output the Robo.js version number

The primary way to run your Robo during development. Watches for file changes and automatically rebuilds, similar to nodemon. This command runs build behind the scenes and updates bot commands on each restart.

When running in a TTY, robo dev launches an interactive terminal where you can type / commands to inspect state, manage Flashcore, and more.

npx robo dev

Flag	Alias	Description
`--hmr`	`-H`	Enable hot module replacement for handlers (experimental)
`--instance-id`	`-id`	Specify the instance ID to use
`--log-level`	`-l`	Set the log level (`debug`, `info`, `warn`, `error`)
`--mode`	`-m`	Specify the mode(s) to run in (`dev`, `beta`, `prod`, etc.)
`--silent`	`-s`	Suppress all output
`--verbose`	`-v`	Print additional debugging information

`robo start`

Runs your Robo in production after running build. Use this when self-hosting instead of deploying to RoboPlay.

Like dev, this also launches an interactive terminal in TTY environments.

npx robo start

Flag	Alias	Description
`--instance-id`	`-id`	Specify the instance ID to use
`--log-level`	`-l`	Set the log level (`debug`, `info`, `warn`, `error`)
`--mode`	`-m`	Specify the mode(s) to run in (`dev`, `beta`, `prod`, etc.)
`--silent`	`-s`	Suppress all output
`--verbose`	`-v`	Print additional debugging information

Building

`robo build`

Prepares your project for production by compiling source files, generating a manifest, and registering any command updates. Run this before using start.

npx robo build

Flag	Alias	Description
`--dev`	`-d`	Build for development
`--mode`	`-m`	Specify the mode(s) to build for
`--silent`	`-s`	Suppress all output
`--verbose`	`-v`	Print additional debugging information
`--watch`	`-w`	Watch for changes and rebuild automatically

`robo build plugin`

Works similarly to build, but optimizes your source files to be published as a plugin via npm.

npx robo build plugin

Plugin Management

`robo add`

Installs a plugin from npm and registers it with your Robo. You can also install plugins from a local directory.

npx robo add @robojs/server@next
npx robo add @robojs/ai@next @robojs/cron@next

Flag	Alias	Description
`--force`	`-f`	Forcefully install and register packages
`--no-seed`	`-ns`	Skip seeding starter files from the plugin
`--silent`	`-s`	Suppress all output
`--trigger`	`-t`	Setup hook trigger context (`add` or `create`)
`--verbose`	`-v`	Print additional debugging information
`--yes`	`-y`	Auto-accept seed files without prompting

`robo remove`

Uninstalls a plugin from your Robo and removes its config file.

npx robo remove @robojs/server@next

Flag	Alias	Description
`--force`	`-f`	Forcefully remove and unregister packages
`--silent`	`-s`	Suppress all output
`--verbose`	`-v`	Print additional debugging information

`robo sync`

Syncs the Robo with the latest plugins and configurations. Useful after manually editing plugin configs or adding plugins without robo add.

npx robo sync

Flag	Alias	Description
`--silent`	`-s`	Suppress all output
`--verbose`	`-v`	Print additional debugging information

`robo upgrade`

Upgrades Robo.js and all installed plugins to the latest version.

npx robo upgrade

Flag	Alias	Description
`--force`	`-f`	Forcefully install updates
`--no-self-check`	`-ns`	Skip checking for Sage CLI updates
`--silent`	`-s`	Suppress all output
`--verbose`	`-v`	Print additional debugging information

Hosting

`robo deploy`

Bundles your Robo's source files and deploys to RoboPlay.

npx robo deploy

Flag	Alias	Description
`--silent`	`-s`	Suppress all output
`--verbose`	`-v`	Print additional debugging information

npx robo login

`robo logout`

Sign out of your RoboPlay account.

npx robo logout

`robo cloud`

Manage your cloud deployments on RoboPlay. This command has the following subcommands:

`robo cloud status`

Check your RoboPlay session status, Robo Pods, and connectivity.

npx robo cloud status

Flag	Alias	Description
`--credentials`	`-creds`	Output session file in base64 format (copies to clipboard)
`--silent`	`-s`	Suppress all output
`--verbose`	`-v`	Print additional debugging information

`robo cloud start`

Start your linked Robo Pod.

npx robo cloud start

`robo cloud stop`

Stop your linked Robo Pod.

npx robo cloud stop

`robo cloud logs`

View your Robo's remote logs from RoboPlay.

npx robo cloud logs

npx robo cli --inspect
npx robo cli --inspect build

Flag	Alias	Description
`--inspect`	`-i`	Show all registered CLI commands and extensions

Pass a command name after --inspect to view details for that specific command.

Other

`robo help`

Display help for the CLI or a specific command.

npx robo help
npx robo build --help

Next Steps

Interactive Terminal

Built-in and custom slash commands.

Extending the CLI

Add custom commands and hooks.

RoboPlay

Deploy your Robo with one command.