flagship configure

Configure the CLI

flagship configure


flagship configure - Set the credentials of your flagship account


flagship configure [-i CLIENT_ID | --client-id = CLIENT_ID] [-s CLIENT_SECRET | --client-secret = CLIENT_SECRET] [-a ACCOUNT_ID | --account-id = ACCOUNT_ID] [-e ACCOUNT_ENVIRONMENT_ID | --account-environment-id = ACCOUNT_ENVIRONMENT_ID] [--config = CONFIG_FILE]


Config file

You either insert your credentials in flags(client id, client secret, account id, account environment) or you use the config flag that contain these information and import them to generate your token.


Access to your credentials

This feature and the access to the generation of credentials is related to the Remote Control API, it's still in Early Adoption phase, if you want to try it and have any questions, feel free to ask [email protected]

Create credentials

Create credentials


    Set your credentials (account_id, account_env_id, client_id, client_secret) by managing the file credentials.yaml ($HOME/.flagship/credentials.yaml)

The command creates a credentials file at $HOME/.flagship/credentials.yaml and writes the value of the flags as key-value pairs, and automatically generates the access token to manage your flagship resources.




--client-id = CLIENT_ID

    The client id of your flagship account

--client-secret = CLIENT_SECRET

    The client secret of your flagship account

--account-id = ACCOUNT_ID

    The account id of your flagship account

--account-environment-id = ACCOUNT_ENVIRONMENT_ID

    The account environment id of your flagship account

--config = CONFIG_FILE

    Your config file (default is $HOME/.flagship/credentials.yaml)

Here's an example of the credentials.yaml, you must fill the info from Flagship platform

account_id: ai
account_environment_id: aei
client_id: ci
client_secret: cs


Required information

Client id, client secret, account id and account environment id are required field, you either insert them as flags or import a file that contains them with config flag


CLI usage

After configuring the CLI, you are good to go !