CLI Reference

How to read this page

• The Usage line is the canonical command shape.
• The tables mirror the help rows embedded in lib/opsd/cli.rb.
• For runtime-specific examples, use opsd help <command> in the matching release.

Basics

help

Usage: opsd <command>

Item	Description
help	Show help for commands
version	Print the CLI version
completion	Generate shell completion scripts or install a loader
config	Manage OPSd CLI context such as active provider
list	Browse blueprint catalog data discovered from workspace modules
describe	Show details for a specific blueprint
init	Create starter manifests from blueprints
validate	Validate a manifest
render	Render a manifest into a runnable OpenTofu stack
add	Add supported resources to an existing manifest
resize	Resize supported resources in an existing manifest
scale	Scale supported replicated resources
attach	Attach supported resources to each other
detach	Detach supported resources from each other
remove	Remove supported resources from an existing manifest

completion

Usage: opsd completion <bash|zsh|fish>

Item	Description
install	Install a completion loader or snapshot
bash	Generate Bash completion
zsh	Generate Zsh completion
fish	Generate Fish completion

config

Usage: opsd config <command>

Item	Description
profile	Manage named profiles and profile configuration

Discovery

list blueprints

Usage: opsd list blueprints

Item	Description
blueprints	Browse blueprint catalog data discovered from workspace modules

describe blueprint

Usage: opsd describe blueprint <blueprint> [--variant <variant>]

Item	Description
--variant <variant>	Select a blueprint variant

Workflow

init blueprint

Usage: opsd init blueprint <blueprint> [output.yaml] [--variant <variant>]

Item	Description
--variant <variant>	Choose the blueprint variant to seed

validate manifest

Usage: opsd validate manifest <manifest.yaml>

Item	Description
check	Check the manifest before rendering

render manifest

Usage: opsd render manifest <manifest.yaml> --output <directory>

Item	Description
--output <directory>	Write the runnable OpenTofu stack to this directory

Mutations

add

Usage: opsd add <resource> <manifest.yaml> [options...]

Item	Description
compute-group	Add a compute group to a manifest
database	Add a database to a manifest
cache	Add a cache to a manifest
object-storage	Add object storage to a manifest
cdn-endpoint	Add a CDN endpoint to a manifest
load-balancer	Add a load balancer to a manifest
node	Add a node to a manifest

resize

Usage: opsd resize <resource> <manifest.yaml> <resource-id> --profile <profile>

Item	Description
compute-group	Resize a compute group
cache	Resize a cache
database	Resize a database

scale

Usage: opsd scale compute-group <manifest.yaml> <compute-group-id> --replicas <count>

Item	Description
--replicas <count>	Desired replica count

attach

Usage: opsd attach compute-group <manifest.yaml> <compute-group-id> --to <load-balancer-id>

Item	Description
--to <load-balancer-id>	Attach to a load balancer

detach

Usage: opsd detach compute-group <manifest.yaml> <compute-group-id> --from <load-balancer-id>

Item	Description
--from <load-balancer-id>	Detach from a load balancer

remove

Usage: opsd remove <resource> <manifest.yaml> <resource-id>

Item	Description
compute-group	Remove a compute group from a manifest
database	Remove a database from a manifest
cache	Remove a cache from a manifest
object-storage	Remove object storage from a manifest
load-balancer	Remove a load balancer from a manifest
cdn-endpoint	Remove a CDN endpoint from a manifest
node	Remove a node from a manifest

Config profile

config profile

Usage: opsd config profile <command>

Item	Description
list	List configured profiles
show	Show profile details and status
create	Create a new profile
edit	Edit an existing profile
use	Select the current profile
current	Show the current profile

config profile use

Usage: opsd config profile use <profile>

Profile names are resolved from the active CLI configuration at runtime.

config profile current

Usage: opsd config profile current

Completion install

completion install

Usage: opsd completion install [--snapshot] <bash|zsh|fish>

Item	Description
--snapshot	Write a one-time completion snapshot
bash	Install Bash completion
zsh	Install Zsh completion
fish	Install Fish completion