Skip to content

Installation

Install the latest release:

Terminal window
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.

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

Install a specific release:

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

Install into a custom directory:

Terminal window
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.

You can also build from source.

From the repository root:

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

Check the CLI:

Terminal window
bin/ork version

The docs site is a separate Starlight app:

Terminal window
cd docs
npm install
npm run dev