Istari Digital CLI

The Istari Digital CLI (stari) is the command-line tool for operating an Istari Digital deployment from a shell. It packages the day-to-day operations around a running platform into a single binary — publishing modules to the registry, listing and deprecating module versions, and managing the keys and tokens that authenticate to the platform.

Install stari as part of Install: you need it on the agent host before you can publish a module. Get started puts it on your PATH and authenticates it to your platform. The same commands work on Windows, Linux, and macOS.

Two audiences typically reach for it:

• Integration developers publishing modules to the registry and managing module versions. For the module authoring workflow — scaffolding, schema definition, implementation, linting, and testing — see the Integrations SDK.
• Operators and IT admins managing agent keys and inspecting what a deployment exposes.

Installing an agent or a module on a host does not go through the CLI: install the packages from the Customer Portal, following Agents and Module deployment.

Common tasks

Commands grouped by goal — see the CLI reference for the full options on each.

• Publish a module to the registry — stari client publish module_manifest.json.
• Check a manifest before publishing — stari module lint module_manifest.json.
• Deprecate a single module version — stari client deprecate-module-version "@scope:<module>" "<version>" "<reason>".
• List functions or modules visible to your account — stari client list functions / stari client list modules.
• Create a key for yourself — stari key generate -o <path> && stari key register -k <path> --configure.
• Create a new agent from its own host — stari key generate --agent <env> && stari key create-agent -k <path> --configure --env <env>. The platform assigns the agent's ID, and --configure points the agent's configuration at the key. See Creating a new agent with a key.
• Rotate the key on an existing agent — stari key generate -o <path> && stari key register -k <path> --agent --principal-id <agent client id> --configure, run on the agent host as the account that owns its configuration. See Agent keys.
• List installed modules on an agent — stari module list.
• Let a host download packages from the Customer Portal — stari client setup-portal <backend_api_url> <token>.

For module authoring tasks (scaffolding a project, defining function schemas, linting manifests, generating test files, running build / test / install scripts), see Integrations SDK.

Configuration

The CLI keeps the API URL and credentials in istari_digital_config.yaml, written by stari client init — see Get started, or Configuration in the reference.

Commands that pull packages from the Customer Portal use an organization access token. See Connect the CLI to the Customer Portal.

What's in this section

Page	What it covers
Get started	Install stari and authenticate with a User key.
CLI reference	Full reference for stari: download URLs, PATH setup, every command and flag, examples.
Function test file generation	Deep dive on stari function generate test_files — schema annotations, interactive prompts, file layout. Used during module authoring.
PAT → Key exchange	How to use stari key exchange to replace PATs with keys for the CLI, arbitrary PATs, and agents.
Creating a new agent with a key	How to provision an agent that does not exist yet, on its own host, with stari key generate and stari key create-agent.
Connect the CLI to the Customer Portal	Organization access token so stari can download agent and module packages.