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 — installing and updating agents, deploying modules onto agent hosts, managing registry credentials, publishing modules to the registry, and managing tokens.
Two audiences typically reach for it:
- Operators and IT admins installing and managing agents and modules on Istari Digital Platform hosts.
- 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](../Integrations SDK/index.md).
Key features
- Single binary, multi-platform. Distributions are published for Ubuntu (20.04 / 22.04 / 24.04), RHEL 8/9 and derivatives, macOS (Apple Silicon), and Windows. No runtime dependencies.
- Guided PATH setup.
stari setupandstari path addinstall the binary on PATH on macOS, Linux, and Windows, with version-aware update prompts. - Agent lifecycle. Install, initialize, and uninstall agents from Artifactory or a local archive. Create and list agent personal access tokens.
- Module deployment on agent hosts. Install, update, list, and uninstall modules on agent machines — with environment targeting (
release,dev,demo,stage). - Registry interaction. Publish modules, deprecate a single version or all versions, list available functions and modules visible to your account.
Common tasks
Commands grouped by goal — see the CLI reference for the full options on each.
- Install or update an agent on a host —
stari agent install --repository <repo>. - Install or update a module on an agent host —
stari module install @scope:<module>orstari module update @scope:<module>. - List installed modules on an agent —
stari module list. - Uninstall a module from an agent —
stari module uninstall @scope:<module>. - Create a Personal Access Token for an agent —
stari agent create token --token_name <name>. - Publish a module to the registry —
stari client publish 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.
For module authoring tasks (scaffolding a project, defining function schemas, linting manifests, generating test files, running build / test / install scripts), see [Integrations SDK](../Integrations SDK/index.md).
Configuration
The CLI stores the registry URL and Personal Access Token in istari_digital_config.yaml. Set it up with:
stari client init <registry_url> <registry_api_key> --yes
See Configuration for default file locations and manual editing.
What's in this section
| Page | What it covers |
|---|---|
| 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. |