CLI reference Find the syntax and options for each nebula command.
generated from the sources Use the nebula command-line tool to add Nebula to a Unity project, run a local mesh, and deploy it. To read the same help in a terminal, run nebula --help or nebula <command> --help. See Install the CLI before you begin.
nebula < comman d > [options] Command Summary nebula setup Install the prerequisites for running Nebula locally nebula init Install Nebula into the Unity project in the current folder
Command Summary nebula build Build the Unity player and standalone .NET services nebula start Start the orchestrator, gateway, and workers on this computer nebula stop Stop the local mesh (every process of the build) nebula status Show workers, containers, entity counts, persistence, and recent events nebula logs Read the log for the orchestrator, gateway, a worker, or a bot client nebula scale Change the worker range of the running mesh nebula dashboard Open the Nebula Dashboard of the local mesh or the deployed one
Command Summary nebula config Configure a deploy target, the deployed mesh's database, or the Unity editor path nebula deploy Build and deploy the mesh to Nebula Cloud or your own Hetzner project nebula destroy Delete the deployed mesh nebula env Manage the environment variables your workers get
Command Summary nebula cloud Log in to Nebula Cloud, log out, or show your account nebula deployments List the Nebula Cloud deployments of the project's organization nebula rollback Roll a Nebula Cloud deployment back to its previous release
Command Summary nebula restart-workers Restart a Nebula Cloud deployment's workers one at a time, to apply env changes
Option Description --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.