orcher 0.1.1

_{Run ORCHER on your machine, and start, watch and control workflows on any engine, from your terminal.}

orcher works the same against a local engine, a self-hosted one, or ORCHER Cloud.

• Local engine: orcher dev start runs the engine and its database in Docker, ready in seconds
• Run: start a workflow with JSON input or key=value parameters, and wait for its result
• Inspect: list, filter and search executions; see each one's status, result, journal, tasks and log
• Control: cancel or terminate a workflow, send it an event, or act on many at once
• Cloud: log in to ORCHER Cloud and keep a context per environment
• Scriptable: -o json, -o yaml or -o name, and exit codes that mean something

Install

macOS and Linux:

curl --proto '=https' --tlsv1.2 -LsSf https://github.com/orcher-io/cli/releases/latest/download/orcher-installer.sh | sh

Windows (PowerShell):

powershell -ExecutionPolicy Bypass -c "irm https://github.com/orcher-io/cli/releases/latest/download/orcher-installer.ps1 | iex"

Or with a package manager:

Every release has binaries for macOS (Apple silicon and Intel), Linux (x86_64 and arm64, glibc and musl) and Windows (x86_64) on its release page, with checksums.

Quick start

Start a local engine. It needs Docker, and keeps its data until you delete it:

orcher dev start                           # the engine on localhost:50051

Run a worker against it (the quickstart has one in Python, TypeScript and Rust), then:

orcher workflow start order --task-queue quickstart-python --id order-1001 --input '"order-1001"'
orcher workflow result order-1001          # wait for it, and print what it returned
orcher workflow list                       # recent workflow executions
orcher workflow get order-1001             # one of them in detail
orcher workflow history order-1001         # every step the engine recorded
orcher logs order-1001 --follow            # its log, until it ends

Commands

Run orcher <command> --help for every flag and more examples.

Where commands go

The local engine's ports are bound to 127.0.0.1: it runs without authentication unless its config file turns it on. orcher dev start and orcher server start take --engine-version (default 0.5.5) to run another engine release, and other ports when the defaults, 50051 and 8080, are taken.

A command that fails prints the reason to stderr and exits with status 1; so do workflow result and run for a workflow that failed, was canceled or terminated, or did not finish in time. Commands that would stop or delete something ask first; pass --force when there is no terminal to ask on.

Contributing

Issues and pull requests are welcome. See CONTRIBUTING.md for how to build, test and propose a change.

License

Licensed under the Apache License, Version 2.0.