Airplane CLI

The Airplane CLI, airplane, is the primary way you'll create and deploy new tasks. The CLI also provide utility methods for managing API keys, getting/setting configs, and executing tasks.

The full CLI source code is available on GitHub: airplanedev/cli

Installing the CLI

macOS
Linux
Windows
macOS

If you use Homebrew, you can install the CLI by running:

brew install airplanedev/tap/airplane

Otherwise, you can install with our installation script:

curl -L https://github.com/airplanedev/cli/releases/latest/download/install.sh | sh
Linux

You can install the CLI with our installation script:

curl -L https://github.com/airplanedev/cli/releases/latest/download/install.sh | sh
Windows

You can install the CLI from PowerShell with our installation script:

iwr https://github.com/airplanedev/cli/releases/latest/download/install.ps1 -useb | iex

Once you've installed it, you can log in to the CLI by running login. This will open a browser window to complete authentication - you can close the window when you're done.

airplane login
# If you want to change teams or log out: airplane logout

To confirm you're logged in, you can run airplane auth info:

airplane auth info
Signed in as [email protected]
Using team MyTeam (ID: 1rGi5xu8bPuxT8TV0KKwP10RQuD)

Upgrading the CLI

Upgrading the CLI is similar to installing:

macOS
Linux
Windows
macOS

Using Homebrew:

brew update && brew upgrade airplanedev/tap/airplane

If not using Homebrew, you can re-run the installation script:

curl -L https://github.com/airplanedev/cli/releases/latest/download/install.sh | sh
Linux

You can upgrade the CLI by re-running the installation script:

curl -L https://github.com/airplanedev/cli/releases/latest/download/install.sh | sh
Windows

You can upgrade the CLI by re-running the installation script:

iwr https://github.com/airplanedev/cli/releases/latest/download/install.ps1 -useb | iex