2. Set up Airship CLI in your terminal

You must use the Airship Launcher in order to login and sync files between your local development environment and the Airship server. Non-developer admins do not need to use the CLI tools.

If you are a Docker user, you can use Airship Launcher in a Docker container. If you don't use Docker, then you should install the Airship Launcher CLI tools.


OSX


OSX - Docker

If you already have Docker, you can skip install and start using docker for Airship development. If you aren’t familiar with Docker, use one of the other install methods.

Step 3. Start Using Docker


OSX - Quick Install

Easily install the command line tools by entering this into your terminal:

/bin/sh -c "$(curl -fsS https://install.airshipcms.io)"
Copied!

Once installation is complete, you should see this message:

airship cli installed on osx

You're done with installation! Continue to Step 3.

Skip to: Step 3. Local Development


OSX - Manual Install

If you prefer to manually install the Airship CLI tools on OSX, you can read and follow the instructions at https://install.airshipcms.io.


Linux


Linux - Docker

If you already have Docker, you can skip install and start using docker for Airship development. If you aren’t familiar with Docker, use one of the other install methods.

Step 3. Start Using Docker


Linux - Quick Install

Easily install the command line tools by entering this into your terminal:

/bin/sh -c "$(curl -fsS https://install.airshipcms.io)"
Copied!

Once installation is complete, you should see this message:

airship cli installed on linux

You're done with installation! Continue to Step 3.

Skip to: Step 3. Local Development


Linux - Manual Install

If you prefer to manually install the Airship CLI tools on Linux or WSL, you can read and follow the instructions at https://install.airshipcms.io.


Windows


Windows - Docker

If you already have Docker, you can skip install and start using docker for Airship development. If you aren’t familiar with Docker, use one of the other install methods.

Step 3. Start Using Docker


Windows with WSL

If you are running Windows Subsystem Linux, open a WSL terminal and use the Linux install instructions.

WSL Installation Instructions

Note: The Linux install instructions will not work with Git Bash.


Windows Choco Package

You can install the Airship CLI tools using the Chocolatey package manager.

If you don't have Chocolatey installed yet, follow the installation instructions here.

Once you have choco installed, you can install the latest version of Airship CLI tools.

Run the following command in your command prompt or powershell:

choco install airship
Copied!

If installation fails, then run the command again with administrative privileges.

Run as Administrator

Once installed, you can run all airship commands from an unelevated command prompt

After airship is installed, you will need to set one Environment variable, HOME to %UserProfile%

  1. Click in the Search bar.
  2. Start typing "edit the system environment variables".
  3. When the window pops up, click on the [Environment Variables] button.

Edit the system environment variables

Set HOME to %UserProfile%

Once installation is complete, you should see this message:

airship cli installed with choco on windows

You're done with installation! Continue to Step 3.

Skip to: Step 3. Local Development


Windows Manual Install

If you don't use WSL or the Chocolatey package manager, you can still install Airship CLI tools by following the Manual Install instructions.


Next: Local Development