AKOS CLI

Set up the agentskit-os command line, run your first health check, and configure shell completion.

The AKOS CLI (agentskit-os) lets you manage every part of your AKOS workspace from a terminal: initialize workspaces, run flows, manage agents, configure triggers, operate secrets, and deploy plugins — all scriptable and CI-friendly.

Requirements

An active AKOS workspace (self-hosted desktop or cloud tenant)
Credentials for that workspace from your AKOS administrator

Installation

The agentskit-os CLI is provided as part of your AKOS enterprise plan. Your administrator distributes the build for your platform and your CI environment. If you don't have it yet, contact your AKOS administrator or account team for access.

Once it's installed, confirm it's available:

agentskit-os --version

First run: doctor

Before doing anything else, run the built-in diagnostics to confirm the CLI is configured correctly:

agentskit-os doctor

doctor checks:

Node.js version compatibility
Platform support
Whether the core AKOS runtime is linked
The AGENTSKITOS_HOME data directory
Available trigger kinds

To also verify that your AI provider credentials are present (no secret values are printed):

agentskit-os doctor --creds

To run a live connectivity probe (LLM round-trip + sandbox check, 10-second timeout):

agentskit-os doctor --live

doctor options

Flag	Description
`--live`	Run live LLM and sandbox probes
`--creds`	Check AI provider credential presence
`--air-gap`	Skip cloud providers when checking credentials
`--provider <id>`	Restrict credential check to one provider (repeatable)
`--env-prefix <pfx>`	Environment variable prefix to scan (default: `AGENTSKITOS_`)
`--secrets-file <path>`	Merge key names from a dotenv-style file into the credentials check
`--no-probes`	Skip vault and keychain probes
`--init-audit-key <wsId>`	Pre-generate an ed25519 audit signing key for a workspace and exit

Getting help

Every command and subcommand accepts --help:

agentskit-os --help
agentskit-os run --help
agentskit-os config validate --help

Shell completion

Generate and install a completion script for your shell so you can tab-complete commands and flags.

Bash — add to ~/.bashrc:

eval "$(agentskit-os completion bash)"

Zsh — add to ~/.zshrc:

eval "$(agentskit-os completion zsh)"

Fish — save to the completions directory:

agentskit-os completion fish > ~/.config/fish/completions/agentskit-os.fish

Supported shells: bash, zsh, fish.

Checking for updates

agentskit-os upgrade

To print the current and latest version without installing:

agentskit-os upgrade --check

CI environments

When the environment variable AGENTSKIT_TOKEN is set, auth login is skipped automatically. This is the recommended pattern for non-interactive CI pipelines.

Next steps

Authentication — log in, manage credentials, and work with secrets
Agents — register, list, version, promote, and compare agents
Flows and Runs — create flows, execute them, and analyze results
Command Reference — all top-level commands at a glance

On this page