oak-cli 0.5.5

The Oakestra CLI

The Oak-CLI is the command line interface for the Oakestra Edge Computing platform.

📚 Check out the Oak-CLI Wiki to get started.

---

oak (Go CLI) — recommended

The Go-based CLI is a single self-contained binary with no runtime dependencies. It runs on Linux, macOS, and Windows.

Install latest release

Linux / macOS

curl -sSL https://raw.githubusercontent.com/oakestra/oakestra-cli/main/oak_go_cli/install.sh | bash

The script auto-detects your OS and architecture (amd64 / arm64), downloads the latest release binary, installs it to /usr/local/bin/oak, and registers shell completions for bash and zsh.

Windows (PowerShell)

irm https://raw.githubusercontent.com/oakestra/oakestra-cli/main/oak_go_cli/install.ps1 | iex

This downloads the latest oak_cli_windows_amd64.zip, extracts oak.exe, and places it in $Env:LOCALAPPDATA\Programs\oak\, adding that directory to your PATH.

Shell completions

Completions are set up automatically by the install script. To enable them manually:

# zsh — add to ~/.zshrc if not already present
mkdir -p ~/.zsh/completions
oak completion zsh > ~/.zsh/completions/_oak
echo 'fpath=(~/.zsh/completions $fpath)' >> ~/.zshrc
echo 'autoload -Uz compinit && compinit' >> ~/.zshrc

# bash
oak completion bash > /etc/bash_completion.d/oak

# fish
oak completion fish > ~/.config/fish/completions/oak.fish

Build and install from source

Requires Go 1.21+.

# Clone the repository
git clone https://github.com/oakestra/oakestra-cli.git
cd oakestra-cli/oak_go_cli

# Run tests
go test ./...

# Build
go build -o oak .

# Install to $GOPATH/bin (must be on your PATH)
go install .

Quick start

# Point the CLI at your Oakestra root orchestrator
oak config set system_manager_ip <IP>

# Optional: set non-default credentials (default: Admin / Admin)
oak config credentials

# List applications
oak app show

# Create an application from an SLA file
oak app create my_app.json

# List services
oak service show

# Deploy a service instance
oak service deploy <service-id-or-name>

# Scale a service
oak service scale up <service-id-or-name> 3

# Inspect instances
oak service inspect <service-id-or-name>

Run oak --help or oak <command> --help for the full command reference.

---

oak-cli (Python CLI) — legacy

The original Python-based CLI. Recommended only if you need features not yet available in the Go version.

Benefits

• Native interface for the Oakestra APIs
• Eliminates the need to use external third-party tools
• Accelerated & simpler workflows
• The CLI commands can be chained together and used in custom scripts
• Automates tedious tasks away (e.g. acquiring login token, installing dependencies, and much more!)

Requirements

• Linux (preferably Debian/Ubuntu)
• Python 3.10+

Install from PyPI

pip install oak-cli

Install from source

git clone https://github.com/oakestra/oakestra-cli.git
cd oakestra-cli
make install-cli

Uninstall

make uninstall-cli
# or
pip uninstall oak-cli