Skip to main content
Version: 0.4.0

Configure Plane

Follow these steps to configure plane. You only have to do this once.

  1. Create a new context by running plane config create-context <CONTEXT-NAME>. Replace <CONTEXT-NAME> with any recognizable name.
  2. You will be asked to provide the following information
    1. Enter your Seaplane API Key: <YOUR-SEAPLANE-API-KEY> (just like a sudo command no characters are shown)
    2. Enter a name for this API Key: This can be any name you like
    3. Add advanced properties [y/N]? : N

Confirm everything is working as expected by running the following two commands:

plane config use-context <YOUR-CONTEXT-NAME>
plane auth refresh

plane supports the use of multiple contexts. Repeat the steps for each API key in your account. You can switch between API keys by running plane config use-context <CONTEXT-NAME>

Listing All Contexts

You can list all configured contexts by running the following command

plane config list-contexts