The Replicated Vendor CLI is a command-line interface that helps vendors package KOTS applications using a command-line interface, including the management of releases, channels, customers, and entitlements.
This guide already assumes that you have created a team and an initial KOTS application in Vendor. You’ll also need:
You’ll need to set up two environment variables to interact with https://vendor.replicated.com:
REPLICATED_APP should be set to the name of your KOTS application, as shown in the URL path at https://vendor.replicated.com/apps. Note that this is case sensitive
REPLICATED_API_TOKEN should be set to a token created at https://vendor.replicated.com/team/tokens.
Ensure the token has “Write” access or you’ll be unable create new releases. Once you have the values, set them in your environment.
For Linux/Mac environments:
export REPLICATED_APP=my_kots_app export REPLICATED_API_TOKEN=d5cdf814bae01b211a8e891593dc12e1158238d27932d082a32b98706e576216
For Windows environments, use:
set REPLICATED_APP=my_kots_app && setx REPLICATED_APP my_kots_app set REPLICATED_API_TOKEN=d5cdf814bae01b211a8e891593dc12e1158238d27932d082a32b98706e576216 setx REPLICATED_API_TOKEN d5cdf814bae01b211a8e891593dc12e1158238d27932d082a32b98706e576216
There are three options for installing the Vendor CLI.
To install latest Vendor CLI on Mac with Brew:
brew install replicatedhq/replicated/cli
To install latest Vendor CLI on Mac without Brew:
curl -s https://api.github.com/repos/replicatedhq/replicated/releases/latest \ | grep "browser_download_url.*darwin_amd64.tar.gz" \ | cut -d : -f 2,3 \ | tr -d \" \ | wget -O replicated.tar.gz -qi - tar xf replicated.tar.gz replicated && rm replicated.tar.gz mv replicated /usr/local/bin/replicated
To install latest Vendor CLI on Linux:
curl -s https://api.github.com/repos/replicatedhq/replicated/releases/latest \ | grep "browser_download_url.*linux_amd64.tar.gz" \ | cut -d : -f 2,3 \ | tr -d \" \ | wget -O replicated.tar.gz -qi - tar xf replicated.tar.gz replicated && rm replicated.tar.gz mv replicated /usr/local/bin/replicated
To run latest Vendor CLI through a docker container:
docker run \ -e $REPLICATED_APP \ -e $REPLICATED_API_TOKEN \ replicated/vendor-cli --help
For simplicity, we will represent usage assuming the CLI has been downloaded and installed to the desktop.