Skip to content
Overwire Docs

Installation

Overwire ships as a macOS desktop app with a scriptable CLI companion. Both run the same engine.

Requirements

Section titled “Requirements”
  • macOS (Apple silicon or Intel) for the desktop app.
  • A Docker-API-compatible container engine (e.g., Docker Desktop, Colima, OrbStack, Rancher Desktop) for live step execution. Mock runs, parsing, linting, and simulation work without one.
  • Node.js for the CLI.

Desktop app

Section titled “Desktop app”

Download the DMG for your architecture from overwire.io, drag Overwire to Applications, and open it. The app is signed and notarized.

CLI

Section titled “CLI”

The CLI will be published as @overwire/cli on npm at launch:

Terminal window
npm install -g @overwire/cli

Verify the environment once installed:

Terminal window
overwire doctor

doctor checks your Node version, container engine reachability, and the .overwire/ config tree, and tells you exactly what is missing for live runs.

Next step

Section titled “Next step”

Initialize a project to scaffold the .overwire/ config tree.

overwire.io

Overwire is not affiliated with, endorsed by, or sponsored by GitHub, Inc., Microsoft Corporation, or Docker, Inc. GitHub and GitHub Actions are trademarks of GitHub, Inc.