Skip to content

Quickstart

Install HybridOps Core and reach a useful first result before connecting any infrastructure. Steps 1–3 verify the CLI and inspect a shipped blueprint locally; no cloud credentials or live environment are required. Continue with steps 4–6 when you are ready to prepare a real target.

1. Install

Cross-platform packages are available from the latest stable release. Choose the package for your workstation. Preview and previous releases are also available.

Install the latest stable release:

curl -fsSL https://github.com/hybridops-tech/hybridops-core/releases/latest/download/hybridops-core-linux.tar.gz | tar -xz
cd hybridops-core-*/
./install.sh

Download the macOS package for Apple silicon or Intel. Open the .pkg and follow the installer.

The package is not notarized. If macOS blocks the first launch, open System Settings → Privacy & Security and approve the package.

Download for Windows 11, extract all files, and open Install HybridOps.cmd.

The installer prepares Ubuntu 24.04 on WSL2 and installs Core in that environment. Approve the Windows administrator prompt if WSL is not already installed. If Windows requests a restart, restart and run the installer again. After installation, use the desktop shortcut to open the HybridOps terminal.

2. Verify the CLI

Open a new terminal and run:

hyops --help

A successful result prints the command help and confirms that the runtime is available in the current terminal.

3. Inspect a shipped operation locally

Validate the authoritative-foundation blueprint and display its dependency-aware execution plan:

hyops blueprint validate --ref onprem/authoritative-foundation@v1
hyops blueprint plan --ref onprem/authoritative-foundation@v1

These commands resolve and inspect the shipped contracts without applying infrastructure changes. You can now see the ordered operation before supplying credentials or preparing a target.

4. Prepare a real target

Run the setup command for the intended target:

hyops setup gcp
hyops setup azure
hyops setup proxmox

Setup requests administrator approval when system changes are required.

5. Initialise a target environment

Replace <env> with a name for the environment, choose the command for your target, and use that name consistently:

hyops init gcp --env <env>
hyops init azure --env <env>
hyops init proxmox --env <env>
hyops init hetzner --env <env>

Confirm that the environment is ready:

hyops preflight --env <env>

6. Choose a workflow

Use a blueprint for a complete, dependency-aware lifecycle or a module for an individual capability. Then follow the linked runbook for the supported operating procedure.

To see complete lifecycles before operating your own environment, browse the Reference Scenarios. For environment requirements, see network prerequisites and secrets lifecycle.