Skip to content
orch8.io

12 results

CLI reference

orch8 is the Rust CLI shipped with the engine. It runs the local Studio and talks to a remote engine through the REST API; it never requires direct database access.

Note
This page follows current main. Commands added after 0.7.1 are marked by the current-main release notes. Runorch8 --help for the exact binary you installed.

Install

Bash
# macOS / Linux
curl -fsSL https://raw.githubusercontent.com/orch8-io/engine/main/install.sh | sh

# Homebrew
brew tap orch8-io/orch8 && brew install orch8

# Native-release launchers
npm install --global @orch8/cli
pipx install orch8-cli

# Windows PowerShell
irm https://raw.githubusercontent.com/orch8-io/engine/main/install.ps1 | iex

orch8 --version

Connection and output

URL, API key, and tenant are global: place them before or after the subcommand. Environment variables keep secrets out of shell history. Use --output json for scripts and--yes only when a reviewed destructive command must run without a prompt.

Bash
export ORCH8_URL=https://engine.example.com/api/v1
export ORCH8_API_KEY=replace-me
export ORCH8_TENANT_ID=acme

orch8 health
orch8 instance list --state scheduled --limit 50
orch8 instance get <instance-id> --watch
orch8 --output json instance outputs <instance-id>

Local development

Bash
orch8 init my-project
orch8 dev my-project

# CI smoke test with virtual time and no HTTP server
orch8 dev my-project --no-server --skip-timers --once

# Configuration and connectivity diagnosis
orch8 doctor

Author and validate workflows

Bash
orch8 templates list --catalog-url https://cloud.orch8.io/api/catalog/templates
orch8 templates pull react-loop --out sequence.json
orch8 generate "triage support tickets with human escalation"

orch8 sequence upgrade-format sequence.json --out upgraded.json
orch8 sequence preflight --file upgraded.json
orch8 sequence dataflow --file upgraded.json --out-dir generated
orch8 sequence apply upgraded.json --dry-run
orch8 sequence apply upgraded.json
orch8 test run sequence.contracts.json

Operate and recover

Bash
orch8 instance diagnose <instance-id>
orch8 instance tree <instance-id>
orch8 instance retry <instance-id>
orch8 signal <instance-id> pause
orch8 signal <instance-id> resume

orch8 checkpoint list <instance-id>
orch8 checkpoint latest <instance-id>
orch8 --yes checkpoint prune <instance-id> --keep 3

orch8 release diff <release-id>
orch8 release validate <release-id> --sample 20
orch8 release evaluate <release-id>
orch8 release promote <release-id>

Connectors and packages

Bash
orch8 pieces search slack
orch8 pieces install <piece-name>

orch8 package build package.toml
orch8 package verify workflow.orch8pkg
orch8 package install workflow.orch8pkg

orch8 demo crash-recovery
orch8 demo portable-agent

Discover the full surface

The CLI also includes bootstrap, fleet contexts, runtime registration, portable-agent wrappers, inspection, debugging, deployment, migration, cron, and support-bundle commands. Use nested help instead of relying on a website snapshot:

Bash
orch8 --help
orch8 sequence --help
orch8 execution --help
orch8 portable --help

Ready to try Orch8?

One command to install. Then run your first local sequence.

Bash
curl -fsSL https://orch8.io/start.sh | sh
Quick Start GuideOr skip the setup with Cloud →
Previous← SQLite & Test ModeNextCore Concepts →
Was this helpful?