Skip to content

Source install and doctor

This task builds source and runs local checks. It does not apply a workload. Authenticated CLI checks require daemon setup; bootstrap creates local identity and state, and the daemon can reconcile its configured workload.

Terminal window
git clone https://github.com/hostwright/hostwright.git
cd hostwright
swift build

The package uses pinned SwiftPM dependencies, including Yams for bounded YAML decoding and Containerization behind its helper. SQLite uses the system library.

Terminal window
swift test

You can list what exists first with swift test list, or use the repository’s scripts/test.sh helper. Passing tests on your machine confirm the build.

Terminal window
swift run hostwright --version

This prints the current source version.

Use the CLI and daemon from the same signed installation. Complete identity bootstrap and daemon startup under the same macOS account and local paths first. Version and help work on a source build; doctor uses the authenticated Control API.

Terminal window
hostwright doctor
hostwright doctor --output json

doctor runs safe local checks only: OS version, Apple silicon and macOS 26+ gate, Swift toolchain version, container executable lookup and supported version probes, hostwright.yaml presence, state-path policy, telemetry policy, and a local resource-intelligence report.

A missing container executable is reported as a warning, not a crash. In the JSON report, benchmark dimensions that were not measured are reported explicitly as unmeasured; doctor reports only measured values. The full check list is in Doctor checks.

You have a built CLI. After completing the signed-installation step, you also have a verdict on current host compatibility. Hostwright installs from source or the unsupported vendor tap. brew install hostwright remains unavailable. Official cask acceptance and a verified no-tap installation are required for the intended GA launch. Continue with Plan a single service.