DOC_INDEX
THEME
DOCS/Getting Started/Installation

Installation

Install OrchStep on macOS, Linux, or Windows

Quick Install

curl -fsSL https://orchstep.dev/install.sh | sh

Package Managers

PlatformCommand
Homebrewbrew tap orchstep/tap && brew install orchstep
npmnpm install -g orchstep
pippip install orchstep
Dockerdocker pull orchstep/orchstep:latest

GitHub Action

Install the OrchStep CLI in a workflow with setup-orchstep:

steps:
  - uses: actions/checkout@v4
  - uses: orchstep/setup-orchstep@v1
    with:
      version: latest
  - run: orchstep run deploy

Or run a workflow in a single step with run-orchstep:

steps:
  - uses: actions/checkout@v4
  - uses: orchstep/run-orchstep@v1
    with:
      workflow: deploy.orchstep.yml
      vars: |
        env=production

Verify

orchstep version

Try the interactive menu

Once orchstep is on your PATH, run it from any directory with an orchstep.yml:

orchstep menu

You'll get a keyboard-driven task picker — hotkeys for instant launch, fuzzy search via arrow keys or /, and a filter cycle on f. Plain orchstep (no subcommand) also auto-launches the menu when run in a terminal; in CI it exits cleanly with an error rather than hanging.

< Where It RunsQuick Start >