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:

Input Command

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

plane auth refresh

Expected Output

switched to <YOUR-CONTEXT-NAME>

JWT refreshed

tip

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 plane config list-contexts.

Input Command

plane config list-contexts

Expected Output

1. name is your <CONTEXT-NAME>. Use the <CONTEXT-NAME> to swtich between different API keys.
2. The key column stores your <API-Key-Name>, which holds your secret API key. Please note this column does not display your secret API key.
3. issuer is set to <default>.
4. carrier-url is set to <default>.

name        key     issuer                         carrier-url
------  ----------  -----------------------------  -------------
<name>  <key-name>  <default>                      <default>
<name>  <key-name>  <default>                      <default>
<name>  <key-name>  <default>                      <default>