Logo
OpenScaler

CLI

Sign in and call the OpenScaler API from a terminal with osctl.

osctl CLI

Sign in and call the OpenScaler API from a terminal.

osctl is the official command-line interface for OpenScaler. Use --help on any command for details.

osctl --help
osctl computer create --help

Install

osctl is in preview. With a Go toolchain, from the cli/ source tree:

go build -o osctl ./cmd/osctl
./osctl --help

Put osctl on your PATH so you can run it from any directory.

Install shell completion with osctl completion bash (or zsh / fish / powershell) and load the script your shell prints.

Sign in

On a laptop:

osctl auth login

On a remote session (SSH), where a browser cannot return to this machine:

osctl auth login --device

To paste a token created on Profile instead:

osctl auth init
API tokens

Each osctl auth login creates a listed token on Profile. Revoke it there if the secret is leaked. For remote terminals, CI and agents, set OPENSCALER_API_TOKEN or use osctl auth init. Do not use browser login in those environments.

AI agents

osctl works well with AI agents. Point them at --help, or use osctl tools --json for a machine-readable command tree.

osctl tools --json