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 →
Commands and options
spatial service start
Description
Start the local API service.
If you run this within a SpatialOS project directory, it uses your spatialos.json automatically. If you run it outside a SpatialOS project, you need to specify the path to a SpatialOS project configuration file using --main_config string.
spatial service start [options]
Options
--main_config string The path to your project's main configuration file (usually called spatialos.json).
--port int The port to run the local API service on (default 9876).
spatial service stop
Description
Stop the local API service.
spatial service stop [options]
Options
--port int The port of the running local API service (default 9876), if it's running. (If there's no service running on the port, this is a no-op.)
spatial service status
Description
spatial service status
Check the status of the local API service.
The output of this command looks something like:
Local API service is running on port 9876 with status RUNNING.
pid: 15754
port: 9876
project file path: /Users/name/Documents/project-name/spatialos.json