Installation

macOS

On macOS, the recommended install path is Homebrew:

brew install orkhq/tap/ork

You can also tap the repository first:

brew tap orkhq/tap
brew install ork

Homebrew installs ork onto your PATH and makes upgrades straightforward:

brew upgrade ork

Linux Or Manual Install

Use the install script when you are on Linux, do not use Homebrew, or want to install into a specific directory:

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

The installer detects your operating system and architecture, downloads the matching release asset from GitHub, verifies the checksum when the release publishes one, and installs ork into ~/.local/bin by default.

Requirements

• macOS with Homebrew, or macOS/Linux with curl and tar
• Any tools required by the adapters you use, such as Docker, Terraform, or AWS CLI

Options

Install a specific release:

curl -fsSL https://tryork.dev/install | ORK_VERSION=v0.1.0 sh

Install into a custom directory:

curl -fsSL https://tryork.dev/install | ORK_INSTALL_DIR=/usr/local/bin sh

If ork is installed into ~/.local/bin, make sure that directory is on your PATH.

Tune download behavior for slow or unreliable networks:

curl -fsSL https://tryork.dev/install | ORK_DOWNLOAD_RETRIES=5 ORK_DOWNLOAD_MAX_TIME=600 sh

The installer uses retries, connection timeouts, and a visible progress bar when run in an interactive terminal. These environment variables are available when you need to override the defaults:

• ORK_DOWNLOAD_RETRIES, default 3
• ORK_DOWNLOAD_RETRY_DELAY, default 2 seconds
• ORK_DOWNLOAD_CONNECT_TIMEOUT, default 15 seconds
• ORK_DOWNLOAD_MAX_TIME, default 300 seconds per download

Build

You can also build from source.

From the repository root:

go build -o bin/ork ./cmd/ork

Check the CLI:

bin/ork version

Documentation Site

The docs site is a separate Starlight app:

cd docs
npm install
npm run dev