Install

Audience: builders trying Ophiolite locally
Status: Preview

Ophiolite’s public automation path is the Rust CLI plus the thin ophiolite_automation Python wrapper. Source installs remain the contributor path.

Before installing, check the system requirements.

Current prerequisites

• Rust toolchain
• Python 3.10, 3.11, or 3.12
• Git

Build the CLI

git clone https://github.com/scrooijmans/ophiolite.git
cd ophiolite
cargo build -p ophiolite-cli

Install Python automation from source

python -m pip install -e .\python

The install exposes the user-facing ophiolite console script, the explicit ophiolite-automation console script, and the ophiolite_automation Python package. It does not expose a separate domain SDK.

Verify the install

ophiolite doctor
ophiolite auth status

The doctor output is JSON so CI logs and support tickets can refer to stable check codes. A missing preview certificate is a warning in the current build; other failures should be treated as install issues.

For preview testing with a signed local certificate JSON file:

ophiolite auth import .\license.json
ophiolite doctor

Inspect the operation catalog

cargo run --quiet --manifest-path Cargo.toml -p ophiolite-cli -- operation-catalog
ophiolite-automation verify-surface-contracts

Verify Python Automation

from ophiolite_automation import OphioliteApp

app = OphioliteApp()
print(app.operation_catalog()["catalog_name"])

Current Caveat

The public install story is real, but still early. The Workbench installer is not yet live, and Python intentionally mirrors the CLI JSON surface rather than adding its own product model.

For failed installs or activation issues, continue to Troubleshooting and Support and Diagnostics.

When you are finished testing from a virtual environment, run deactivate.

Next: 10-minute quickstart