Skip to content

Zelos CLI Installation

The Zelos CLI lets you interact with the Zelos App, Zelos Agent, or Zelos Cloud directly from the terminal.

Quick Install

curl -fsSL https://release.zeloscloud.io/cli/install.sh | bash
powershell -ExecutionPolicy ByPass -c "irm https://release.zeloscloud.io/cli/install.ps1 | iex"
# macOS / Linux
ZELOS_VERSION=0.1.0 curl -fsSL https://release.zeloscloud.io/cli/install.sh | bash

# Windows
powershell -ExecutionPolicy ByPass -c "$env:ZELOS_VERSION='0.1.0'; irm https://release.zeloscloud.io/cli/install.ps1 | iex"

Manual Install

Download the binary for your platform, extract, and place it somewhere on your PATH:

curl -fsSL https://release.zeloscloud.io/cli/latest/zelos-aarch64-apple-darwin.tar.gz | tar xz
sudo mv zelos /usr/local/bin/
curl -fsSL https://release.zeloscloud.io/cli/latest/zelos-x86_64-apple-darwin.tar.gz | tar xz
sudo mv zelos /usr/local/bin/
curl -fsSL https://release.zeloscloud.io/cli/latest/zelos-x86_64-unknown-linux-gnu.tar.gz | tar xz
sudo mv zelos /usr/local/bin/
curl -fsSL https://release.zeloscloud.io/cli/latest/zelos-aarch64-unknown-linux-gnu.tar.gz | tar xz
sudo mv zelos /usr/local/bin/

Download and extract manually:

  1. Download zelos-x86_64-pc-windows-msvc.zip
  2. Extract zelos.exe
  3. Move it to a directory on your PATH, or add its location to PATH

Verify

zelos version

Shell Completions

The installer automatically sets up shell completions. If you installed manually, or want to regenerate them:

zelos completions bash --install

Then add to your ~/.bashrc:

source ~/.zelos/completions/zelos
zelos completions zsh --install

Then add to your ~/.zshrc (before compinit):

fpath=(~/.zelos/completions $fpath)
autoload -Uz compinit && compinit
zelos completions fish --install

Fish picks up completions automatically from ~/.config/fish/completions/.

zelos completions powershell --install

Then add to your PowerShell profile ($PROFILE):

. ~/.zelos/completions/zelos.ps1

You can also print completions to stdout (e.g. for piping):

zelos completions bash    # or zsh, fish, powershell, elvish

Commands

Usage: zelos [OPTIONS] <COMMAND>

Commands:
  status       Print Zelos system status
  login        Login to Zelos Cloud
  logout       Logout from Zelos Cloud
  actions      List, execute, and inspect agent actions
  agent        Inspect and configure the Zelos agent
  extensions   Manage Zelos Agent extensions
  live         Interact with live agent data
  trace        Trace file operations
  update       Update the Zelos CLI to the latest version
  version      Print version
  completions  Generate or install shell completions
  help         Print this message or the help of the given subcommand(s)

Options:
  -q, --quiet       Disable logging to console
  -v, --verbose...  Log to console, with increasing verbosity
  -h, --help        Print help
  -V, --version     Print version

See the CLI Reference for full command documentation, flags, and usage examples.

Configuration

The CLI stores credentials in your system keyring and configuration in ~/.zelos/.

Environment Variable Description
RUST_LOG Override log level (e.g. RUST_LOG=debug)

Uninstall

Remove the binary, configuration, and completions:

rm -rf ~/.zelos
rm -f ~/.config/fish/completions/zelos.fish
rm -f ~/.config/elvish/lib/zelos-completions.elv

If you installed manually to /usr/local/bin:

sudo rm /usr/local/bin/zelos

Remove the binary, configuration, and completions:

Remove-Item -Recurse -Force "$HOME\.zelos"

🚀 What's Next?