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:
bash
Copied
1
brew install airplanedev/tap/airplane
Otherwise, you can install with our installation script:
bash
Copied
1
curl -L https://github.com/airplanedev/cli/releases/latest/download/install.sh | sh
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.
bash
Copied
1
airplane login
2
# If you want to change teams or log out: airplane logout
To confirm you're logged in, you can run airplane auth info:
Copied
1
airplane auth info
2
  Signed in as youremail@example.com
3
  Using team MyTeam (ID: 1rGi5xu8bPuxT8TV0KKwP10RQuD)

Updating the CLI
To update the CLI, run the following:
Copied
1
airplane update
The airplane update command was added in v0.3.172 (August 9th, 2023). If you get an Unknown command "update" for "airplane" error, you should upgrade the CLI by instead re-running the installation command.

Local development with Studio
The Airplane Studio provides a rich development experience that allows you to quickly iterate on Tasks and Views, even before they've been deployed. To manage code for tasks and views locally, we recommend using the Airplane CLI to start Studio with a local development server.

Starting Studio
Airplane Studio can be started locally with airplane dev:
bash
Copied
1
$ airplane dev
2
Discovering tasks and views...registered 2 tasks and 1 view.
3


4
Started studio session at https://app.airplane.dev/studio?host=http://localhost:4000 (^C to quit)
5
Press ENTER to open the studio in the browser.
See Studio for more info.
PrivacyTermsSupport