orkestr-cli
CLI for the Orkestr deployment platform.
Install
pip install orkestr-cli
Quick start
# Log in: opens a browser link, you approve, the CLI gets a scoped token.
# In CI use: orkestr login --token <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
| Command | Description |
|---|---|
orkestr login / logout / whoami |
Auth |
orkestr init |
Link the current directory to a new project (interactive) |
orkestr projects list|create|show|update|delete|analyze |
Manage projects |
orkestr projects env-vars|webhook|webhook-toggle <project> |
Project env vars + git webhook |
orkestr envs list|create|update|delete|env-vars |
Manage environments |
orkestr deploy [project] |
Build + deploy, stream the pipeline, print the live URL (. = linked dir; --detach to not wait) |
orkestr deployments list|show|logs|build-log|rollback |
Deployment history |
orkestr functions list|show|create|update|deploy|delete |
Serverless functions |
orkestr functions logs|invoke|env-vars|metrics|rotate-key |
Function ops |
orkestr addons list|add|show|delete|backups|backup|download |
Add-ons (Postgres/Redis) |
orkestr addons auto-backup|backup-info|delete-backup |
Backup config |
orkestr logs|stats|health <project> |
Runtime container logs / stats / health |
orkestr metrics|app-health|deployment-stats <project> |
Request metrics, app health, deploy stats |
orkestr sleep|wake <project> |
Manually sleep/wake a container |
orkestr domains list|verify |
Custom domains |
orkestr registry list|scan|delete |
Docker registry images |
orkestr activity / orkestr dashboard |
Audit log + summary |
orkestr notifications list|read|read-all |
Notifications |
orkestr tokens list|create|delete |
API tokens |
orkestr groups list|show|create|delete|add|remove |
Project groups (workspaces) |
orkestr connections list|repos|disconnect |
Git provider OAuth connections |
orkestr sbx create|list|info|exec|shell|metrics|pause|resume|kill |
Sandboxes - isolated ephemeral Linux VMs |
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.
Agents (orkestr agents, private beta)
Build and run managed agents for accounts in the Agent Runtime beta. The model key is added once in the console.
orkestr agents credentials # your model keys (never shown)
export GITHUB_TOKEN=... # a tool server's key, from your shell
orkestr agents tools add github --url https://api.githubcopilot.com/mcp/ --auth-env GITHUB_TOKEN
orkestr agents create triage --prompt-file prompt.md --tools github --skill-file labels.md
orkestr agents run triage "Label the newest issue"
orkestr agents publish triage --prompt-file prompt.md --notes "tighter labels"
orkestr agents promote triage prod 1 # roll back
All commands support --json for raw JSON output.
PyPI project page: pypi.org/project/orkestr-cli
Documentation
Full docs at orkestr.eu/docs
Metadata
Release files for orkestr-cli 0.5.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| orkestr_cli-0.5.2.tar.gz | 40.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| orkestr_cli-0.5.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 76.7 kB
Release files / orkestr_cli-0.5.2.tar.gz
| Download URL | orkestr_cli-0.5.2.tar.gz |
|---|---|
| Size | 40.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
17fde9def3ab89b038bb1ba0898bdaaa7677638195315d365eab95c7b484ab4b
|
|
BLAKE2b-256 checksum How to use checksums |
1d0f4f2527a4ad2303d8e1bd7fb4e60780b7d8962467fc44554c194333c09208
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.13
|
Release files / orkestr_cli-0.5.2-py3-none-any.whl
| Download URL | orkestr_cli-0.5.2-py3-none-any.whl |
|---|---|
| Size | 36.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
5b7eb1a243533887e49b2037d3a3064edaac3d5d8b2e45f0c0fd44a0de7a489c
|
|
BLAKE2b-256 checksum How to use checksums |
9d6102b1770d519acdc844ab6b5ea50d90b4d1c66cd5df41b4d7a7e1c0382dee
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.13
|