Skip to main content
Version: 2026.09

Get started with the CLI

The Istari Digital CLI (stari) is the command-line tool for operating an Istari Digital deployment from a shell. Install it and authenticate it to your platform so you can publish a module or manage keys.

Download the agent and module packages from the Customer Portal in the browser. To have stari download those packages itself, see Connect the CLI to the Customer Portal.

1. Check for an existing install​

stari --version

If the command is missing, continue. To replace an older build, download the new archive and run path add from the new directory, then open a new terminal and check stari --version again.

2. Download and put stari on your PATH​

  1. Sign in at https://portal.istari.app.
  2. Open Assets → Utilities → Istari Digital CLI.
  3. Download the archive for your host.
HostArchive
Ubuntu 20.04 / 22.04 / 24.04stari_ubuntu_<RELEASE>-amd64-v<VERSION>.tar.gz
RHEL 8 or 9 (and Rocky, AlmaLinux, Oracle)stari_rhel_<MAJOR>-amd64-v<VERSION>.tar.gz
macOS (Apple Silicon)stari_macos-arm64-v<VERSION>.tar.gz
Windowsstari_windows-amd64-v<VERSION>.zip

Unpack it. The executable inside still has the platform name (for example stari_macos-arm64), not stari.

macOS and Linux:

tar -xzf stari_macos-arm64-v<VERSION>.tar.gz
cd stari_macos-arm64
chmod +x stari_macos-arm64
./stari_macos-arm64 path add

Windows (PowerShell):

Expand-Archive -Path stari_windows-amd64-v<VERSION>.zip -DestinationPath .
cd stari_windows-amd64
.\stari_windows-amd64.exe path add

Use the filename you downloaded. Answer yes at the prompt, or pass --yes. Open a new terminal and run stari --version.

Run path add as the account that will use stari, not with sudo.

For Artifactory URLs on many hosts, see the CLI reference.

3. Authenticate with a User key​

Copy the API URL from Settings → Developer Settings → Endpoints in the web app.

Create a User key (not an Agent key):

  1. Click your avatar → Developer → Generate Key.
  2. Name the key, then Generate.
  3. Download credentials while the key is on screen — the file is shown only once.
  4. Store it where only you can read it:
mkdir -p ~/.istari_digital
mv ~/Downloads/istari-credentials-<key id>.json ~/.istari_digital/
chmod 600 ~/.istari_digital/istari-credentials-<key id>.json

On Windows, use %USERPROFILE%\istari_digital\.

See Keys.

Then initialize the CLI. Replace the URL with the one you copied:

stari client init https://api.example.istari.app --identity-service --credentials-file ~/.istari_digital/istari-credentials-<key id>.json --yes
stari client init https://api.example.istari.app --identity-service --credentials-file "$env:USERPROFILE\istari_digital\istari-credentials-<key id>.json" --yes

Confirm:

stari client ping

Next​