Get SpatialOS

Sites

Menu
You are viewing the docs for 11.0, an old version of SpatialOS. 12.0 is the newest →

Guide to the new spatial commands

This page is an introduction to the new structure of the spatial command-line tool.

On this page:

How to move to the new version

  1. Open a terminal.
  2. Run spatial update.

You’ll now be able to use the new commands.

Old commands and their new equivalents

Old command New equivalent
spatial auth no change
spatial build spatial worker build
spatial clean spatial worker clean
spatial cloud remaining_capacity no equivalent
spatial codegen spatial worker codegen
spatial process_schema spatial schema
spatial connect spatial cloud connect external
spatial deployment launch spatial cloud launch
spatial diagnose no change
spatial init spatial auth login
spatial local start spatial local launch
spatial snapshot spatial project history snapshot or spatial cloud history snapshot
spatial update no change
spatial upload spatial project assembly upload or spatial cloud upload
spatial version no change
spatial worker launch spatial local worker launch

The new top-level commands

This section only gives an overview of the new commands. For full reference information, see the spatial documentation pages, or run the command in a terminal with the flag --help.

spatial cloud

Commands for launching and interacting with deployments in the cloud.

Sub-commands:

spatial local

Commands for launching and interacting with local deployments.

Sub-commands:

spatial project

Commands for managing a SpatialOS project (in the cloud). By default, when you run this from a project’s root directory, this will affect the relevant project. You can override this using the flag --project_name.

Sub-commands:

spatial worker

Commands for building, cleaning, and generating code for workers.

For all of these commands:

  • If run from the root directory of the project with no arguments, the command will be run for all workers.
  • If run from within a worker’s directory with no arguments, the command will be run for only that worker.
  • If you specify worker types, the command will be run for only those workers, regardless of the directory.

Sub-commands:

Unchanged top-level commands

The following commands haven’t changed at all:

Was this page helpful?

Thanks for letting us know!

Thanks for your feedback

Need more help? Ask on the forums