Skip to main content

Profile

The profile command consists of subcommands that allow you to save and manage multiple ArconQ CLI credentials configurations saved in a file.

profile add​

arq profile add <profile_name>

This command will prompt you to enter the following configuration details:

  1. Server URL

  2. ClientSecret

  3. ClientID

info

You need to create new External Client with ClientID - 'arq-cli' in External clients and copy Client secret value.

info

The entered configuration will be saved to a JSON file named cli_config.json in the .arconq directory within your user profile.

Example usage:

$ arq profile add prod
Please enter the Server URL:
https://arconq.prod
Please enter the ClientSecret:
TeQVpKxEKoWs2LEdk23MlEsMZVMsv0ul
Please enter the ClientID:
arq-cli
Successfully added the test profile
ArconQ.CLI configuration saved successfully!

profile remove​

arq profile remove <profile_name>

This command allows you to remove an already existing profile.

profile use​

arq profile use <profile_name>

This command sets the given profile as the new default profile.

profile edit​

arq profile edit <profile_name>

This command allows you to edit the data of a given profile. It will ask you to provide server url, client secret and client id in the same way as in the arq profile add command.

profile list​

arq profile list <profile_name>

This command prints the current configuration of profiles.

Example usage:

$ arq profile list
Default profile: test
Profiles:
| Name       | Server Url                    |
| dev        | https://arconq.dev            |
| prod       | https://arconq.prod           |
| test       | https://arconq.test           |