Forrest logo
back to the spatial tool

spatial:tldr:4a89e

spatial: Launch a local worker to connect to your local deployment.
$ spatial local worker launch ${worker_type} ${launch_config}
try on your machine

The command "spatial local worker launch ${worker_type} ${launch_config}" is used to launch the SpatialOS worker locally, using the specified worker type and launch configuration.

Let's break down the command into its components:

  • "spatial": This is the command-line tool provided by SpatialOS that allows you to interact with and manage your SpatialOS projects.

  • "local": This signifies that you want to run the worker locally, as opposed to deploying it to a cloud-based SpatialOS deployment.

  • "worker": This is the keyword indicating that you want to launch a SpatialOS worker.

  • "launch": This specifies that you want to launch the worker.

  • "${worker_type}": This is a placeholder for the specific type of worker you want to launch. You should replace "${worker_type}" with the actual worker type, such as "worker" or "simulated_player".

  • "${launch_config}": This is another placeholder for the launch configuration that you want to use for the worker. Replace "${launch_config}" with the actual name or path of the launch configuration file. The launch configuration file contains information about the worker, such as its connection settings and initial parameters.

By providing the appropriate worker type and launch configuration, this command will launch the specified SpatialOS worker locally, allowing you to test and debug it on your development machine.

This explanation was created by an AI. In most cases those are correct. But please always be careful and never run a command you are not sure if it is safe.
back to the spatial tool