Nebula

nebula config

Configure a deploy target, the deployed mesh's database, or the Unity editor path

generated from the sources

To configure a deploy target, the deployed mesh's database, or the Unity editor path, run:

nebula config <hetzner|database|unity|source|show>

hetzner API token, project, region and machine types for nebula deploy --target hetzner database where a deployed orchestrator keeps the control plane and saved entities: a PostgreSQL URL, or SQLite on the VM unity the Unity editor to build with, when it is not where Unity Hub puts it source the Nebula checkout nebula init --embed copies the package from (--path; 'none' to clone on demand) show print the current configuration (secrets masked)

Settings live in ~/.nebula-cli/config.json (private to you: it holds tokens and the database password). A database URL in nebula.json (deploy.database) or NEBULA_DATABASE_URL in the environment takes precedence over it.

Options

OptionDescription
--token <token>Hetzner: API token (else prompted; HCLOUD_TOKEN in the environment always wins).
--location <name>Hetzner: region (ash, hil, sin, nbg1, fsn1, hel1).
--url <url>Database: postgres://user:password@host/db, sqlite:<file on the VM>, or 'default' for SQLite on the orchestrator VM.
--editor <path>Unity: path to the editor executable or the Hub's Editor folder.
--path <path>Source: a Nebula checkout for nebula init to copy from ('none' to clone on demand).

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 config hetzner
nebula config database --url postgres://nebula:secret@db.example.com/nebula
nebula config unity --editor "C:\Program Files\Unity\Hub\Editor"
nebula config show

On this page