Skip to content

Installation

The RunAgents CLI lets you manage your agents, tools, model providers, runs, and approvals from the terminal.

curl -fsSL https://runagents-releases.s3.amazonaws.com/cli/install.sh | sh

Override the install directory:

INSTALL_DIR=~/.local/bin curl -fsSL https://runagents-releases.s3.amazonaws.com/cli/install.sh | sh

npm

Current version: 1.0.6

npm install -g @runagents/cli

Or run without installing:

npx @runagents/cli version

Download Binary

Pre-built binaries for every platform — no dependencies required.

curl -sL https://runagents-releases.s3.amazonaws.com/cli/v1.0.0/runagents_darwin_arm64.tar.gz | tar xz
sudo mv runagents /usr/local/bin/

curl -sL https://runagents-releases.s3.amazonaws.com/cli/v1.0.0/runagents_darwin_amd64.tar.gz | tar xz
sudo mv runagents /usr/local/bin/

curl -sL https://runagents-releases.s3.amazonaws.com/cli/v1.0.0/runagents_linux_amd64.tar.gz | tar xz
sudo mv runagents /usr/local/bin/

curl -sL https://runagents-releases.s3.amazonaws.com/cli/v1.0.0/runagents_linux_arm64.tar.gz | tar xz
sudo mv runagents /usr/local/bin/

Download runagents_windows_amd64.zip, extract runagents.exe, and place it somewhere on your PATH.

curl -sLO https://runagents-releases.s3.amazonaws.com/cli/v1.0.0/runagents_1.0.0_linux_amd64.deb
sudo dpkg -i runagents_1.0.0_linux_amd64.deb

curl -sLO https://runagents-releases.s3.amazonaws.com/cli/v1.0.0/runagents_1.0.0_linux_amd64.rpm
sudo rpm -i runagents_1.0.0_linux_amd64.rpm

Verify Installation

runagents version

runagents version 1.0.0

Configuration

Configure the CLI with your API endpoint and key:

runagents config set endpoint https://api.runagents.io
runagents config set api-key YOUR_API_KEY

Get your API key from the RunAgents console under Settings.

Verify your configuration:

runagents config get

Endpoint: https://api.runagents.io
API Key:  sk-****...****1234

Configuration is stored in ~/.runagents/config.json.

Environment Variables

Variable Description
RUNAGENTS_ENDPOINT API endpoint URL
RUNAGENTS_API_KEY API key for authentication

Shell Completion

runagents completion bash > /etc/bash_completion.d/runagents

runagents completion zsh > "${fpath[1]}/_runagents"

runagents completion fish > ~/.config/fish/completions/runagents.fish

runagents completion powershell | Out-String | Invoke-Expression

Need an API key?

Request a free trial and we'll get you set up within 24 hours.