Skip to content

Quickstart

Get HybridOps.Core installed, a target initialised, and your first module running.

1. Download

Download the latest release bundle from GitHub:

curl -LO https://github.com/hybridops-tech/hybridops-core/releases/latest/download/hybridops-core.tar.gz
tar -xzf hybridops-core.tar.gz
cd hybridops-core

2. Install

Run the installer. It creates an isolated runtime under ~/.hybridops/core and puts hyops on your path:

./install.sh

The installer requires Python 3.11+ and sudo for the global hyops symlink at /usr/local/bin/hyops. To skip the system-wide symlink:

./install.sh --no-system-link

Verify the install:

hyops --help

3. Install required tools

Check which tools your workstation needs:

hyops setup check

Install base system dependencies (Terraform, Packer, kubectl, and common tooling):

hyops setup base --sudo

For cloud-specific tools, install only what you need:

hyops setup cloud-gcp --sudo    # gcloud + GKE auth plugin
hyops setup cloud-azure --sudo  # Azure CLI
hyops setup ansible             # Ansible + Galaxy collections

Drivers and modules do not install dependencies automatically: they fail fast and tell you exactly which hyops setup command to run.

4. Initialise a target environment

Initialise a named environment for the infrastructure you want to automate. This writes the environment state, credentials, and readiness markers to ~/.hybridops/:

hyops init proxmox --env dev     # on-prem Proxmox
hyops init hetzner --env dev     # Hetzner Cloud
hyops init gcp --env dev         # GCP project
hyops init azure --env dev       # Azure subscription

Run preflight to confirm the environment and toolchain are ready for the modules you intend to use:

hyops preflight --env dev

The runtime root defaults to ~/.hybridops. Override with --root <path> or $HYOPS_RUNTIME_ROOT.

5. Run a module

hyops apply --env dev --module org/gcp/project-factory
hyops apply --env dev --module platform/onprem/postgresql-ha

Every run writes structured, non-secret run records to:

~/.hybridops/logs/module/<module_id>/<run_id>/

Use hyops blueprint to run an ordered sequence of modules:

hyops blueprint deploy --env dev --ref onprem/postgresql-ha@v1 --execute

Next steps