SDKs & CLI

Official client libraries and command-line tool for integrating Orch8 into your stack. SDKs provide typed wrappers for common engine API domains, and the CLI supports operational workflows from the terminal.

Client SDKs

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

TypeScript / Node.js

Typed API client with a fluent WorkflowBuilder, polling worker, exponential backoff, and observability hooks.

npm install @orch8.io/sdk

View docs →

Python

Async httpx client with Pydantic models across sequences, instances, pools, credentials, circuit breakers, approvals, workers, and more.

pip install orch8-io-sdk

View docs →

Go

Zero external dependencies with context.Context support across the engine API and worker helpers.

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

View docs →

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	✓	—	—

SDK coverage follows each package release and can lag new engine routes. API guide and OpenAPI location →

REST API

Don't see your language?

Orch8 exposes a versioned REST API and generates an OpenAPI document from the running engine. Use any HTTP client for routes not wrapped by your SDK version.

View API reference →