Guide to the new
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
- Old commands and their new equivalents
- The new top-level commands
- Unchanged top-level commands
How to move to the new version
- Open a terminal.
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
Commands for launching and interacting with deployments in the cloud.
spatial cloud upload: Upload an assembly.
spatial cloud launch: Launch a cloud deployment.
spatial cloud delete: Delete and archive the given deployment.
spatial cloud history snapshot: Commands for dealing with a deployment’s snapshot history:
spatial cloud connect external: Connect a local external worker (ie a client) to the deployment.
Commands for launching and interacting with local deployments.
spatial local launch: Launch a local deployment.
spatial local worker launch: Launch a local, external worker.
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
spatial project deployment: Commands for managing deployments:
spatial project deployment tags add: Add a tag to a deployment.
spatial project deployment tags delete: Delete a tag from a deployment.
spatial project deployment list live: List the project’s live deployments.
spatial project deployment list archived: List the project’s archived deployments.
spatial project deployment launch: Launch a cloud deployment.
spatial project deployment delete: Delete and bring down the deployment.
spatial project history: Commands for managing a project’s snapshot histories:
spatial project history snapshot: Commands for managing snapshots:
spatial project history clone: Clone a history.
spatial project history list: List a project’s histories.
spatial project history create: Create a new history and upload a snapshot to it.
spatial project assembly: Commands for managing a project’s assemblies:
spatial project assembly list: List the assemblies in the project.
spatial project assembly create: Create an empty assembly.
spatial project assembly delete: Delete an assembly.
spatial project assembly upload: Upload an assembly.
spatial project assembly download: Download an assembly.
spatial project assembly artifact: Commands for managing artifacts in a project’s assembly.
spatial project assembly worker: Commands for managing worker assemblies.
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.
spatial worker build: Build workers.
spatial worker clean: Clean worker directories.
spatial worker codegen: Generate code from schema for workers.
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