Skip to main content

orca — OpenStack Rich Command-line Alternative

Project description

orca logo

orca

OpenStack Rich Command-line Alternative — a unified CLI for managing OpenStack cloud infrastructure.

Full Documentation

Highlights

  • 60+ command groups covering every major OpenStack service (Keystone, Nova, Neutron, Cinder, Glance, Swift, Heat, Octavia, Designate, Barbican, Magnum, Gnocchi, Aodh, CloudKitty, Placement, Freezer)
  • Typed service layer — every resource flows through a typed *Service class with TypedDict models, catching field-name typos at mypy time
  • Rich terminal output — coloured tables, trees and progress bars powered by Rich
  • Multi-account profiles — named profiles, clouds.yaml and OS_* env var support, transparent token caching
  • Shell auto-completion — Bash, Zsh, and Fish, with per-profile resource caching
  • Orca-exclusive commandsoverview, watch, doctor, audit, cleanup, export, find, ip-whois

Quick Start

pip install orca-openstackclient
orca setup           # interactive credential setup
orca server list     # list your VMs

From source (development):

git clone https://github.com/stackopshq/orca-cli.git
cd orca-cli
poetry install --with dev
poetry run orca --help

Requires Python 3.9 – 3.14.

Commands at a glance

Compute (Nova)

server · server bulk · flavor · keypair · aggregate · hypervisor · availability-zone · compute-service · server-group · usage · limits · event

Networking (Neutron)

network · floating-ip · security-group · subnet-pool · trunk · qos

Storage

volume · image (Glance) · object / container (Swift) · backup (Freezer)

Identity (Keystone)

project · user · role · domain · group · credential · application-credential · endpoint · endpoint-group · service · region · policy · trust · token · auth · access-rule · limit · registered-limit · catalog

Federation (Keystone)

identity-provider · federation-protocol · mapping · service-provider

Platform services

stack (Heat) · loadbalancer (Octavia) · zone / recordset (Designate) · secret (Barbican) · cluster (Magnum) · metric (Gnocchi) · alarm (Aodh) · rating (CloudKitty) · placement

Orca-exclusive

overview · watch · doctor · audit · cleanup · export · find · ip · quota · profile · setup

Documentation

Full documentation: stackopshq.github.io/orca-cli

Local preview:

poetry install --with docs
mkdocs serve

Release notes: see CHANGELOG.md.

Architectural decisions: docs/adr/.

License

Apache-2.0

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

orca_openstackclient-2.6.1.tar.gz (300.5 kB view details)

Uploaded Source

Built Distribution

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

orca_openstackclient-2.6.1-py3-none-any.whl (372.8 kB view details)

Uploaded Python 3

File details

Details for the file orca_openstackclient-2.6.1.tar.gz.

File metadata

  • Download URL: orca_openstackclient-2.6.1.tar.gz
  • Upload date:
  • Size: 300.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for orca_openstackclient-2.6.1.tar.gz
Algorithm Hash digest
SHA256 48d58bdc3cce2ee0a9944125828fc0e64ed981ec675a99a30d94e2b9dcfd0077
MD5 ea8c69e0fd8e9de88574b1f2367829b8
BLAKE2b-256 2b870182670492e7d5afe7c2c45324d1bee4f1df867d190079c0de3ed2ae3f6b

See more details on using hashes here.

Provenance

The following attestation bundles were made for orca_openstackclient-2.6.1.tar.gz:

Publisher: publish.yml on stackopshq/orca-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file orca_openstackclient-2.6.1-py3-none-any.whl.

File metadata

File hashes

Hashes for orca_openstackclient-2.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7d9f2973834493fd8ce95186eb73dd5f5aeeebf65731588bea963875887bc215
MD5 5769b21a855cd3178c79f81a6b4c3d15
BLAKE2b-256 2931a8fb945f346312ea8511c34b2ce6ae25cdfcae506c7a4a06f6f8fb263108

See more details on using hashes here.

Provenance

The following attestation bundles were made for orca_openstackclient-2.6.1-py3-none-any.whl:

Publisher: publish.yml on stackopshq/orca-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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