octl

Interactive CLI for local development of the Olympus Identity Platform.

What It Does

octl deploy — Bootstrap Local Stack

Auto-installs Podman, podman-compose, and kubectl via Homebrew (macOS), initializes and starts the Podman machine, builds dev container images, starts all services in the correct order (infrastructure → migrations → Ory → apps → seed), verifies health and displays access URLs + test credentials.

octl destroy — Stop & Clean

Stop and remove all dev containers, volumes, and images.

octl — Interactive Menu

Running without arguments shows a menu with Deploy / Destroy options.

Production deployment is handled by Daedalus — the deployment wizard. Version bumps are handled by the Release Manager agent.

Prerequisites

• Node.js 20+ and npm (runtime)

The following are auto-installed by octl deploy if missing:

• Podman, podman-compose, and kubectl (via Homebrew on macOS, apt on Linux)

Installation

npm install -g @olympusoss/octl

Then run from anywhere:

octl

Workspace

octl is part of the Olympus Identity Platform. All repos should be cloned as siblings under a shared workspace:

Olympus/
├── platform/    # Infrastructure & Podman Compose
├── athena/      # Admin dashboard
├── hera/        # Auth & consent UI
├── site/        # Brochure site & OAuth2 playground
├── canvas/      # Design system
├── sdk/         # Shared settings & encryption
└── octl/        # CLI tool (this repo)

Tech Stack

| Category | Technology | |----------|-----------| | Runtime | Bun (ESM) | | Language | TypeScript | | Prompts | @inquirer/prompts | | Linting | Biome |

Project Structure

src/
├── index.ts               # Main CLI entry — menu dispatch
├── types.ts               # DevAction type
├── commands/
│   └── dev.ts             # Local dev: install Podman, build, start, seed, destroy
└── lib/
    ├── shell.ts           # Command execution (exec, execInteractive)
    └── ui.ts              # Terminal formatting + colors

License

MIT