orkestr-cli 0.3.0

CLI for the Orkestr deployment platform

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

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

All commands support --json for raw JSON output.

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

Documentation

Full docs at orkestr.eu/docs