orkestr-cli

CLI for the Orkestr deployment platform.

Install

pip install orkestr-cli

Quick start

# Authenticate with your API token
orkestr login

# From inside your app's git repo: detect name/repo/branch and create the project
orkestr init

# Build, deploy, and wait for the live URL
orkestr deploy .

# ...or deploy a named project
orkestr deploy my-api

# View logs / check health
orkestr logs my-api
orkestr health my-api

orkestr init writes a gitignored .orkestr/config.json linking the directory to the project, so orkestr deploy . knows what to ship. It needs an orkestr account and the repo's git provider (GitHub, GitLab, Bitbucket, or Codeberg) connected to that account.

Commands

Sandboxes (orkestr sbx)

The same binary drives orkestr sandboxes - isolated, ephemeral Linux VMs for running untrusted or agent-generated code. Your orkestr login token drives them too (a default-scoped token, or one that carries sandboxes:read / sandboxes:write).

# create a Python sandbox with restricted egress
orkestr sbx create python-3.12 --network restricted

# run a command, stream its output, inherit its exit code (composes in scripts)
orkestr sbx exec sbx_01H... "python -c 'print(2**10)'"

# park it between turns, then pick it back up
orkestr sbx pause sbx_01H...
orkestr sbx resume sbx_01H...

# live usage, then terminate
orkestr sbx metrics sbx_01H...
orkestr sbx kill sbx_01H...

orkestr sbx exec exits with the command's own exit code. Add --json to any read command (list, info, metrics, create) for machine-readable output.

All commands support --json for raw JSON output.

PyPI project page: pypi.org/project/orkestr-cli

Documentation

Full docs at orkestr.eu/docs