Skip to main content

Introduction

open-cli turns OpenAPI descriptions into a local, policy-aware command surface. Point it at an OpenAPI file, and it generates a typed CLI — with help text, parameter validation, secret resolution, and audit logging — without writing any glue code.

Two binaries, two roles

BinaryRole
ocliUser-facing CLI. Asks the runtime for the effective catalog, renders dynamic commands, and sends execution requests.
oclirdRuntime daemon. Loads config, runs discovery, builds the normalized catalog, resolves secrets, enforces policy, executes upstream HTTP calls, and writes audit events.

You can run them in two modes:

  • Embedded modeocli --embedded ... starts the runtime in-process for a single invocation. No daemon required. Start here.
  • Daemon mode — start oclird, then point ocli at it with --runtime. Better for repeated use, warm caches, and shared access.

Important: the command tree is dynamic

ocli does not have a static command tree. It fetches the catalog before Cobra renders most help output. In practice that means even ocli --help usually needs a reachable runtime plus a usable config path. Always use the embedded flag for first runs:

./bin/ocli --embedded --config ./.cli.json --help

This behavior is deliberate and is called out throughout these docs.

How the pieces fit together

  1. ocli resolves a runtime URL or starts an embedded runtime.
  2. The runtime loads .cli.json, merges scope files, and validates the effective config.
  3. Discovery resolves API descriptions from OpenAPI documents, service roots, or API catalogs.
  4. The catalog builder applies overlays, loads skill manifests and Arazzo workflows, and normalizes tools.
  5. ocli renders service/group/tool commands from the selected effective view.
  6. Tool execution goes back through the runtime so policy, secrets, retries, cache state, and audit logging stay centralized.

Who should read which section

You are…Start here
New user / first runInstallationQuickstart
Agent author / end userChoose your pathCLI overview
Operator / platform teamRuntimeConfigurationOperations
Enterprise evaluatorEnterprise readinessAuthentik reference proofFleet validation
ContributorDiscovery & CatalogDevelopment

Next steps

  1. Installation — build the two binaries (takes ~1 minute).
  2. Quickstart — get a generated command tree running in embedded mode.
  3. Choose your path — pick the runtime model and doc route that fits your goal.