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 →

Tools installation guide for Linux

Installing the SpatialOS CLI is a prerequisite for using the Worker SDK. (The Launcher isn’t supported on Linux, and you get access to the Console when you sign up to SpatialOS.)

Note that for Linux, the CLI is in beta.

1. System requirements

Before following the installation guide check that your machine meets the hardware requirements.

If you’re using a corporate network with a strict firewall, raise a support request (for customers with a service agreement) or ask on our forums and we’ll take you through some custom setup steps.

2. Set up the SpatialOS CLI

To set up the SpatialOS CLI:

  1. Download the CLI for Linux (64bit): Download.

    By downloading the CLI, you agree to the SpatialOS EULA.

  2. Put the CLI in a directory.

    For example, bin in your home directory: mkdir -p $HOME/bin && mv $HOME/Downloads/spatial $HOME/bin.

  3. Add the directory to your PATH.

  4. Make sure the CLI is executable: run chmod +x <path_to_spatial_here>.

  5. Check this succeeded by running spatial update in your terminal. You should get the output:

    Current version of the 'spatial' command-line tool: <version number>

    Attempting to download the latest version...

Next steps

Follow the language-specific Worker SDK setup guide in C++, C#, Java, or C.

Search results

Was this page helpful?

Thanks for letting us know!

Thanks for your feedback

Need more help? Ask on the forums