SDKs & CLI

Official client libraries and command-line tool for integrating Orch8 into your stack. The engine exposes 122+ REST endpoints — SDKs provide typed wrappers, and the CLI gives you full control from the terminal.

Client SDKs

Typed wrappers covering the full API surface with polling workers, circuit breaker awareness, and exponential backoff.

TypeScript / Node.js

Full API client (80+ methods) with fluent WorkflowBuilder, polling worker with circuit breaker awareness, exponential backoff, and observability hooks.

npm install @orch8.io/sdk

View docs →80 methods

Python

Async httpx client with Pydantic models. 76 methods covering all engine domains — sequences, instances, pools, credentials, circuit breakers, and more. Worker with backoff and CB checks.

pip install orch8-io-sdk

View docs →76 methods

Go

Zero external dependencies. context.Context on all methods. 75 methods covering the full engine API. Goroutine-based worker with circuit breaker awareness and exponential backoff.

go get github.com/orch8-io/sdk-go

View docs →75 methods

CLI

Full engine control from the terminal. Deploy sequences, manage instances, inspect circuit breakers, and more.

orch8-cli

Go binary. macOS, Linux, Windows.

Install

Homebrewbrew tap orch8-io/orch8 && brew install orch8-cli

Gogo install github.com/orch8-io/cli@latest

Configuration

Flag	Env var	Description
--url	ORCH8_URL	Engine API URL (default: localhost:8080)
--tenant	ORCH8_TENANT	Tenant ID (default: default)
--api-key	ORCH8_API_KEY	API key for authentication
--json	—	Output as JSON

Commands

deployDeploy sequence definitions from JSON files

sequenceCRUD, deprecate, list versions

instanceCreate, list, inspect, pause, resume, cancel, retry, signal

sessionCreate, close, and query grouped instances

triggerManage webhook, NATS, file_watch, and event triggers

cronSchedule recurring workflow execution

poolResource pools for concurrency control

workerMonitor external worker tasks and stats

credentialManage stored credentials and secrets

pluginManage engine plugins (WASM, gRPC)

clusterList nodes, drain for maintenance

approvalHuman-in-the-loop approval management

circuit-breakerInspect and reset circuit breaker states

View source on GitHub Download binaries →

SDK comparison

All three SDKs now cover the full engine API including resource pools, credentials, circuit breakers, and approvals. Workers include circuit breaker awareness and exponential backoff.

Capability	TS	PY	GO
Sequences (CRUD + migrate)	✓	✓	✓
Instances (CRUD + signals + inject)	✓	✓	✓
Workflow builder (fluent API)	✓	—	—
Polling worker	✓	✓	✓
Circuit breaker awareness	✓	✓	✓
Exponential backoff	✓	✓	✓
Checkpoints	✓	✓	✓
DLQ + bulk ops	✓	✓	✓
Cron schedules	✓	✓	✓
Triggers	✓	✓	✓
Sessions	✓	✓	✓
Plugins	✓	✓	✓
Circuit breakers	✓	✓	✓
Cluster management	✓	✓	✓
Credentials	✓	✓	✓
Resource pools	✓	✓	✓
Approvals	✓	✓	✓
SSE streaming	✓	—	—

All SDKs now cover the full engine API. Full API reference (122+ endpoints) →

REST API

Don't see your language?

Orch8 exposes a full REST API with 122+ endpoints and an OpenAPI spec. Use any HTTP client to create workflows, schedule instances, and send signals.

View API reference →