Skip to main content

CLI for the Orkestr deployment platform

Project description

orkestr-cli

CLI for the Orkestr deployment platform.

Install

pip install orkestr-cli

Quick start

# Authenticate with your API token
orkestr login

# List your projects
orkestr projects list

# Deploy
orkestr deploy my-api

# View logs
orkestr logs my-api

# Check health
orkestr health my-api

Commands

Command Description
orkestr login / logout / whoami Auth
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> Trigger a deployment
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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

orkestr_cli-0.2.0.tar.gz (16.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

orkestr_cli-0.2.0-py3-none-any.whl (16.7 kB view details)

Uploaded Python 3

File details

Details for the file orkestr_cli-0.2.0.tar.gz.

File metadata

  • Download URL: orkestr_cli-0.2.0.tar.gz
  • Upload date:
  • Size: 16.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.8

File hashes

Hashes for orkestr_cli-0.2.0.tar.gz
Algorithm Hash digest
SHA256 3d9724601ebb0533722eacb5e73cc29a227187a7f2f487993a209e5fb76ed8f1
MD5 50735cf5edba395a2485fbb6d2e12f0c
BLAKE2b-256 7fb75b31cdf32aa03c6a663bdbb161c6b706d109181e1a7a923dc2b963982df5

See more details on using hashes here.

File details

Details for the file orkestr_cli-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: orkestr_cli-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 16.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.8

File hashes

Hashes for orkestr_cli-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4f4356e5f6dac3a925562dc2fc23510ce6873ca067d08e80293c7231f811fd30
MD5 f8ce8f3bb3d5fbe795e174bbc15206ba
BLAKE2b-256 11cddfa118aaf6420b19e2401c77d0b39bc2f27ef681fdc13a0f413f63c3e201

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page