Guides

Manage configurations

Manage flagship configurations

Suggest Edits

🚧

This feature is still on beta phase

You may encounter some bugs with the configuration feature, to overcome the bugs use the "Clear all configuration" command to reinitialze the extension and reconfigure it.

Overview

The configuration feature lets you manage multiple flagship accounts and environments and easily switch between them.

Each configuration contains :

  • Name (unique)
  • Client ID
  • Client Secret
  • Account ID
  • Account environment ID

You can retrieve these data from the platform or follow these instructions

Create credentials

Create credentials

Usage

If you log in for the first time, you will land on the welcome page, once you click on the configure button you will be instructed to insert a unique name for your configuration (we recommend accountName-EnvironmentName).

Welcome page

Welcome page

There are two ways to set a configuration:

  • Insert the Client ID, Client Secret, Account ID then Account Environment ID.
  • Import the IDs for a file. (Only JSON, YAML, and Yml are supported)
Example of configuration file to import

Example of a configuration file to import

When you are all set up you can use the extension.

Example of logged extension

Example of logged extension

If you want to add another configuration use the Manage configuration feature in the "Quick Access" panel

Configuration feature

Configuration feature

📘

Adding new configuration

Once you add a new configuration, it's not automaticly selected, you have to use the Manage configuration feature to select it.

Then on the + icon to insert a new configuration, you can select, edit or delete the configuration.

Operation on configuration

Operations on configuration

🚧

Configuration validation

Validation of a configuration is performed after a selection.

Change configuration

Change configuration

If you want to delete or clear all configurations and log out, use the built-in VSCode command ctrl+shift+p/⌘+shift+p then type "Flagship: Clear all configurations".

❗️

"Flagship: Clear all configurations" command is not reversible

🚧

Token expires after 24 hours

The token generated from the configuration expired after 24 hours, you have to reselect the configuration to generate a new token.

🚧

The VSCode extension use Flagship CLI

The extension use the CLI to manage flagship resources, so any changes made in configuration in the VSCode will affect the CLI authentication configuration.

Updated about 2 months ago