Skip to main content

Installation

To install ArconQ CLI as a global NuGet package extension, follow these steps:

  1. Install ArconQ CLI as a global NuGet package extension:

    Open a terminal or command prompt and type:

       dotnet tool install --global ArconQ.CLI --add-source https://nexus.macrix.eu/repository/arq-nuget
    tip

    If you would like to use some Release Candidate (-rc) version of the tool, add --prerelease flag to the dotnet tool command, for example:

       dotnet tool install --global ArconQ.CLI --prerelease --add-source https://nexus.macrix.eu/repository/arq-nuget

    This command will download the latest version of ArconQ CLI from the official NuGet repository and install it as a global extension.

  2. Verify installation

    To verify that ArconQ CLI has been successfully installed, type in the command line:

       arq --version

    If everything is set up correctly, you should see the version number of ArconQ CLI displayed, confirming a successful installation.

  3. Create external client

    • Go to the External Clients page and create a new External Client:
      • provide the ClientID (the recommended is arq-cli)
      • in the roles tab select the developer role
    • Once the External Client is created copy its Client Secret value - it will be needed later
    External client

  4. Configure connection

    For proper use of the CLI, a configuration of the ArconQ instance must be added. There are two ways to achieve this. Choose whichever you prefer:

    1. Use the profile command to create a new configuration profile using the External Client's ClientID and Client Secret from the point above
    2. Add environment variables (explained below)

    Follow these instructions to create environment variables for ArconQ CLI on the Windows system:

    • Open the Start menu and search for "Environment Variables."

    • Click on "Edit the system environment variables."

    • In the System Properties window, click the "Environment Variables..." button.

    • Add following System variables:

    • Name: ARQ_CLI_CLIENT_ID, Value: the ClientID you used to create an External Client in the point above (the recommended is arq-cli)

    • Name: ARQ_CLI_SERVER_URL, Value: your ArconQ instance URL (in this manual https://arconq.prod is used)

    • Name: ARQ_CLI_CLIENT_SECRET, Value: the Client Secret copied from the External Client created above

    • Click "OK" to save the environment variable.

Uninstallation​

Open a terminal or command prompt and use the following command to uninstall ArconQ CLI as a global NuGet package extension:

```shell
dotnet tool uninstall --global ArconQ.CLI
```

Update​

Open a terminal or command prompt and use the following command to update ArconQ CLI:

```shell
dotnet tool update --global ArconQ.CLI
```