Airplane CLI
The Airplane CLI,
airplane
, is the primary way you'll create and deploy new tasks. The CLI also
provides utility methods for managing API keys, getting/setting configs, and executing tasks.Installing the CLI
If you use Homebrew, you can install the CLI by running:
bashCopied1brew install airplanedev/tap/airplane
Otherwise, you can install with our installation script:
bashCopied1curl -L https://github.com/airplanedev/cli/releases/latest/download/install.sh | sh
You can install the CLI with our installation script:
bashCopied1curl -L https://github.com/airplanedev/cli/releases/latest/download/install.sh | sh
You can install the CLI from PowerShell with our installation script:
bashCopied1iwr 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.bashCopied1airplane login2# If you want to change teams or log out: airplane logout
To confirm you're logged in, you can run
airplane auth info
:Copied1airplane auth info2Signed in as youremail@example.com3Using team MyTeam (ID: 1rGi5xu8bPuxT8TV0KKwP10RQuD)
Upgrading the CLI
Upgrading the CLI is similar to installing:
Using Homebrew:
bashCopied1brew update && brew upgrade airplanedev/tap/airplane
If not using Homebrew, you can re-run the installation script:
bashCopied1curl -L https://github.com/airplanedev/cli/releases/latest/download/install.sh | sh
You can upgrade the CLI by re-running the installation script:
bashCopied1curl -L https://github.com/airplanedev/cli/releases/latest/download/install.sh | sh
You can upgrade the CLI by re-running the installation script:
bashCopied1iwr https://github.com/airplanedev/cli/releases/latest/download/install.ps1 -useb | iex
Local development with Studio
The Airplane Studio provides a rich local development experience that allows you to quickly iterate
on Tasks and Views, even before they've been deployed.
Starting the studio
Airplane studio can be started with
airplane dev
:bashCopied1$ airplane dev2Discovering tasks and views...registered 2 tasks and 1 view.34Started studio session at https://app.airplane.dev/studio?host=http://localhost:4000 (^C to quit)5Press ENTER to open the studio in the browser.
See Local development with Studio for more info.