Skip to content

CLI Brand Management

Malek Kamel edited this page Sep 22, 2024 · 2 revisions

CLI Brand Management (Terminal)

Table of Contents


Checking Solara Status

To check the current status of Solara, run the following command in your terminal:

solara status

You should see output similar to the example below:

Solara Status

Onboarding a New Brand

To onboard a new brand, execute the following command and follow the prompts:

solara onboard

Alternatively, you can specify brand details directly:

solara onboard --brand_key YOUR_BRAND_KEY --brand_name YOUR_BRAND_NAME

Or use the shorthand version:

solara onboard -k YOUR_BRAND_KEY -n YOUR_BRAND_NAME

Switching Brands

To switch brands, run the command and follow the prompts:

solara switch

You can also specify the brand key directly:

solara switch --brand_key YOUR_BRAND_KEY

Or use the shorthand:

solara switch -k YOUR_BRAND_KEY

Cloning a Brand

To clone a brand, execute the command and follow the prompts:

solara onboard -c YOUR_BRAND_KEY

Alternatively, specify brand details directly:

solara onboard --clone YOUR_BRAND_KEY_TO_CLONE --brand_key YOUR_BRAND_KEY --brand_name YOUR_BRAND_NAME

Or use the shorthand:

solara onboard -c YOUR_BRAND_KEY_TO_CLONE -k YOUR_BRAND_KEY -n YOUR_BRAND_NAME

Exporting a Brand

To export brands via the terminal, use the following command:

solara export -k brand1 brand2 brand3 -d /path/to/export

You can also use this alternative command:

solara export --brand_keys brand1 brand2 brand3 --directory /path/to/export

Importing a Brand

To import brands, execute the following command:

solara import -c /path/to/brand1-solara-configurations.json /path/to/brand2-solara-configurations.json

Alternatively, use this command:

solara import --configurations /path/to/brand1-solara-configurations.json /path/to/brand2-solara-configurations.json

Offboarding a Brand

To offboard a brand, run the command and follow the prompts:

solara offboard

Alternatively, specify the brand key directly:

solara offboard --brand_key YOUR_BRAND_KEY

Or use the shorthand:

solara offboard -k YOUR_BRAND_KEY

Running Doctor

For All Brands

solara doctor

For a Specific Brand

solara doctor --brand_key YOUR_BRAND_KEY

Or use the shorthand:

solara doctor -k YOUR_BRAND_KEY

Global Options

  • --verbose or -v: Run in verbose mode (default: false). To see detailed output, include this option.

Example: Switch Without Verbose

Switch Verbose False

Example: Switch With Verbose

Switch Verbose True