Nebula

nebula start

Run the mesh locally: SpacetimeDB, the control-plane module, orchestrator, gateway and workers

generated from the sources

Run the mesh locally: SpacetimeDB, the control-plane module, orchestrator, gateway and workers.

nebula start [--build] [--workers N] [--npcs N] [--bots N] [--open-ui]
Starts a local SpacetimeDB if none answers on the configured address, publishes the control-plane module with
fresh data, then launches the orchestrator from the last build; the orchestrator starts the gateway and the
workers. Join from the Editor (Play) or with the client build. Defaults come from nebula.json (mesh section).

Options

OptionDescription
--buildbuild first (nebula build)
--workers <N>worker processes (default from nebula.json, 4)
--npcs <N>worker-simulated NPCs spread across the mesh (default 0)
--bots <N>headless bot clients that roam and shoot (default 0; each is a full client process)
--open-uiopen the mesh dashboard in the browser once it is up
--skip-publishdo not re-publish the control-plane module

Global options

These work with every command and may appear before or after it.

OptionDescription
--project <path>run against another Nebula project instead of the current folder
-v, --verboseprint stack traces and the commands the CLI runs
-y, --yesanswer every confirmation with yes

Examples

nebula start --open-ui
nebula start --build --workers 2
nebula start --workers 4 --npcs 128

On this page