Skip to main content

Getting Started

Quickstart

Move from install to the first validated render with the supported CLI flow.

Quickstart

This is the shortest supported path from install to a rendered environment.

1. Create Or Select A Profile

bin/opsd config profile create work
bin/opsd config profile use work

If you already have a profile, use bin/opsd config profile current to verify it.

2. Inspect The Catalog

OPSD_PROFILE=work bin/opsd list blueprints
OPSD_PROFILE=work bin/opsd describe blueprint backend-api-db

3. Initialize A Manifest

OPSD_PROFILE=work bin/opsd init blueprint backend-api-db demo.yaml --variant vm

4. Validate And Render

OPSD_PROFILE=work bin/opsd validate manifest demo.yaml
OPSD_PROFILE=work bin/opsd render manifest demo.yaml --output live/

5. Hand Off To OpenTofu

cd live
tofu init -backend=false -input=false
tofu validate

If you are using a workspace, set OPSD_WORKSPACE_ROOT to the directory that contains modules/<provider>/* before running the commands above.