Skip to main content

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.

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.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for orkestr-cli 0.5.0
File Size Uploaded
orkestr_cli-0.5.0.tar.gz 31.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for orkestr-cli 0.5.0
File Interpreter ABI Platform
orkestr_cli-0.5.0-py3-none-any.whl Python 3 none any Details

Total release size: 60.0 kB

Release files / orkestr_cli-0.5.0.tar.gz

Download URL orkestr_cli-0.5.0.tar.gz
Size 31.2 kB
Tags Source
SHA-256 checksum
How to use checksums
2eb3005cb00f6e65d05b4966b1c8d14a576906d702b8ba283866fe25f4c24749
BLAKE2b-256 checksum
How to use checksums
63119b367c5121e8673d11fd65987980836ae504f1e5cb094dfe943e9b525d8b
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.0-py3-none-any.whl

Download URL orkestr_cli-0.5.0-py3-none-any.whl
Size 28.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a02830aa6f1c562adeba9ca469c2c419368497264713a04115d652e894687c73
BLAKE2b-256 checksum
How to use checksums
d17eb3a25b24ccf88b165565f0e44e458a05c56615b2c161937350a98745dcd1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.13

Release history Release notifications | RSS feed

0.5.3

2 release files

0.5.2

2 release files

0.5.1

2 release files

This release

0.5.0 This release

2 release files

0.4.0

2 release files

0.3.0

2 release files

0.2.0

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page