Skip to content

Zelos CLI Installation

The zelos command works with Zelos agents, traces, notebooks, extensions and Zelos Cloud from a terminal. Use it to script a test bench, run notebooks in CI or stream data without opening the app.

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.10 curl -fsSL https://release.zeloscloud.io/cli/install.sh | bash

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

Manual Install

Download the binary for your platform, extract, and install it to ~/.zelos/bin (the same location the quick install uses — no sudo required):

curl -fsSL https://release.zeloscloud.io/cli/latest/zelos-aarch64-apple-darwin.tar.gz | tar xz
mkdir -p ~/.zelos/bin && mv zelos ~/.zelos/bin/

curl -fsSL https://release.zeloscloud.io/cli/latest/zelos-x86_64-unknown-linux-gnu.tar.gz | tar xz
mkdir -p ~/.zelos/bin && mv zelos ~/.zelos/bin/

curl -fsSL https://release.zeloscloud.io/cli/latest/zelos-aarch64-unknown-linux-gnu.tar.gz | tar xz
mkdir -p ~/.zelos/bin && mv zelos ~/.zelos/bin/

Download and extract manually:

  1. Download zelos-x86_64-pc-windows-msvc.zip
  2. Extract zelos.exe
  3. Move it to %USERPROFILE%\.zelos\bin, or another directory on your PATH

On macOS / Linux, add ~/.zelos/bin to your PATH if it isn't already:

echo 'export PATH="$HOME/.zelos/bin:$PATH"' >> ~/.profile && source ~/.profile

Verify

zelos version

The CLI runs on Apple Silicon Macs, x86_64 and ARM64 Linux, and x86_64 Windows. Intel Macs are not supported.

Update

zelos update

zelos update --version <version> installs a specific version instead of the latest.

Shell Completions

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

zelos completions bash --install

zelos completions zsh --install

zelos completions fish --install

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

zelos completions powershell --install

--install updates your shell startup file automatically when the shell needs an explicit activation step. If you intentionally disabled shell startup changes, the command prints the exact snippet to add manually.

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

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

Commands

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

Configuration

The CLI shares its settings and sign-in with the Zelos app. Settings live in the same data folders the app uses (see Uninstall for each platform's paths). zelos login stores your sign-in in the system keyring, or in a file in the data folder when no keyring is available.

Environment Variable Description
ZELOS_AGENT_URL Default agent endpoint for --host (default localhost:2300); an explicit --host wins
ZELOS_DATA_DIR Use this folder for all settings, data and logs instead of the platform defaults
ZELOS_NOTEBOOKS_DIR Use this folder for notebooks instead of Zelos Notebooks in your documents folder
RUST_LOG Override log level (e.g. RUST_LOG=debug)

See the CLI Reference for every environment variable.

Uninstall

Remove the binary and completions:

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

Both the quick and manual installs place the binary under ~/.zelos/bin. Also remove the ~/.zelos/bin line the installer added to your shell profile (~/.profile, ~/.bashrc, or ~/.zshrc). Settings and sign-in are shared with the app; see Uninstall to remove them.

Remove the binary and completions:

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

Settings and sign-in are shared with the app; see Uninstall to remove them.

🚀 What's Next?