These are the docs for 13.8, an old version of SpatialOS. The docs for this version are frozen: we do not correct, update or republish them. 14.5 is the newest →

spatial local launch

Start a SpatialOS simulation locally.


Start a cloud-like SpatialOS environment which runs and manages the specified deployment configuration locally. Defaults to using 'default_launch.json' in the root of your project.If default_launch.json doesn't exist, looks for 'default_launch.pb.json' in the root of your project.

spatial local launch [launch_configuration] [flags]


      --enable_inspector_v2              Enable serving of inspector-v2 route. (default true)
      --enable_jvm_debugging             Specifies whether to start JVM with the debugging capability.
      --enable_pre_run_check             Ensure that changes to the schema have been applied before starting a local deployment. (default true)
      --experimental_runtime string      Specify an experimental runtime version instead of using the latest stable released version.
      --local_service_grpc_port uint16   Port on which the local version of Improbable's public gRPC services are started. (default 22000)
      --local_service_http_port uint16   Port on which the local version of Improbable's public HTTP services are started. (default 21000)
      --network_check_timeout duration   Timeout for internet connection check spatial does at startup. (default 10s)
      --runtime_log_level string         The minimum log level required to display a log message in the CLI. Permitted values: debug, info, warn, error. (default "info")
      --show_internal_runtime_logs       If true, all runtime logs will be displayed (including internal system logs).
      --snapshot string                  Relative path to a snapshot to be used when launching. If this flag is not specified and no legacy snapshot flags are set in your deployment configuration, SpatialOS attempts to launch using the default snapshot snapshots/default.snapshot.

Options inherited from parent commands

      --json_output            Print output in JSON format. Useful when you need to parse the Spatial CLI output.
      --log_directory string   Sets the directory log files will be created in. If not specified, this is set to <project_root>/logs when inside a project directory and logging is disabled when outside a project directory.
      --log_level string       Sets the log level. Available log levels: debug, info, warning, error, fatal, or panic.
      --main_config string     The path to your project's main configuration file (usually called spatialos.json)
      --no_animation           Disable dynamic output elements such as the spinner, progress bars, etc.

Search results

Was this page helpful?

Thanks for letting us know!

Thanks for your feedback

Need more help? Ask on the forums