Skip to main content

Installation

To download and execute the Witboost CLI, the following requirements must be met:

  • Deploy Token: A valid deploy token is required to authenticate and authorize the download of the binary. Ask the Witboost team to obtain a deploy token.
  • System requirements: A Linux, Windows with x86_64 (64-bit) architecture, or macOS.
  • Shell environment: Access to a shell with standard utilities installed (e.g., curl, chmod).
  • Execution permissions: The binary must be made executable after download.
  • Witboost access token: A valid token is also required to authenticate with Witboost once the CLI is running.

Step 1 — Get your Witboost access token​

To obtain a Witboost access token, follow the instructions for creating a service account.

Step 2 — Download the Witboost CLI Binary​

Installation for Linux / Windows​

To download the Witboost CLI binary, run the following command in your shell. Make sure to replace <deploy_token> with your valid deploy token.

Replace <version> with the desired CLI version (you can check available versions here and <platform> with your target platform. Available platforms are:

  • witboost-linux-x64 (Linux 64-bit)
  • witboost-win-x64.exe (Windows 64-bit)

The following example shows the download command for Linux x64:

curl --user <deploy_token> \
--output "witboost" <download_url>/<version>/witboost-linux-x64

To obtain both the <deploy_token> and <download_url>, contact the Witboost team.

After downloading the binary, you need to grant execution permissions so that it can be run as a program:

chmod +x witboost

Installation for MacOS​

Installation via brew.

export HOMEBREW_GITLAB_API_TOKEN=<deploy_token>
brew tap witboost/witboost-infra https://gitlab.com/AgileFactory/Witboost.Mesh/iac/witboost.mesh.infrastructure.witboostcli.homebrew-tap.git
brew install witboost
warning

If the brew tap command requires further authentication, you use whatever username and the same token as password.

Upgrading the MacOS CLI

If you already have the CLI installed, you can easily upgrade to the latest version by running:

brew upgrade witboost

Step 3 — Use the Witboost CLI​

Once the binary is executable, you can start using the Witboost CLI by running it directly from the shell. Before running the command, replace the parameter values with your specific configuration. Here is an example evaluation run through the CLI:

witboost governance evaluate \
    --witboost-base-url http://witboost.com/api \
    --base-url https://wcg.witboost.com/governance-platform \
    --token $TOKEN \
    --resource-type dataproduct \
    --env production \
    --descriptor-file ../descriptor.yaml \
    --resource-id urn:dmb:dp:sales:testdp:0 \
    --output json \
    --output-file evaluation_report.json

For detailed information about the available commands and their parameters, refer to the Commands Reference section.