Skip to content
Docs

'hyve config'

The hyve config command group reads and updates hyve.yaml at the root of your state repository — the same object GET/PATCH /config exposes over HTTP, and that Hyve Studio’s Configuration section reads and writes through.

Commands

hyve config get

Print the resolved hyve.yaml as YAML. If the file doesn’t exist yet, prints the defaults hyve would otherwise fall back to.

Terminal window
hyve config get

Example:

Terminal window
hyve config get

Output:

reconcile:
mode: local
strictDelete: false
strictResourceDelete: false
server:
port: 8080
env:
file: local.env

hyve config set

Set a single field in hyve.yaml by dotted key, save it, then commit and push — mirroring PATCH /config’s behavior exactly, including its soft-fail commit (a failed push is logged, not fatal — your local hyve.yaml is already updated and usable regardless).

Terminal window
hyve config set <key> <value>
key string required

Dotted path to the field to set. See the supported keys below.

value string required

The new value. Booleans and integers are parsed from plain text (true/false, 8080) — there’s no separate --type flag.

Supported keys:

KeyTypeDescription
env.filestringPath, relative to the repo root, to a local env file — see Configuration
reconcile.modestringlocal or cicd
reconcile.strictDeleteboolWarn about untracked cloud clusters
reconcile.strictResourceDeleteboolAuto-prune orphaned spec.resources entries
server.portintPort hyve serve listens on
server.frontendUrlstringURL hyve serve --open navigates to
server.auth.modestringnone or forward
server.auth.forward.validateUrlstringForward-auth validator endpoint
server.auth.forward.timeoutstringForward-auth timeout (Go duration string, e.g. 3s)

Example:

Terminal window
# Point reconciles/workflows at a local env file
hyve config set env.file local.env
# Switch to CI/CD mode
hyve config set reconcile.mode cicd
# Change the server port hyve serve listens on
hyve config set server.port 9090

Output:

Set env.file = local.env

  • hyve serve — reads server.* and env.file from hyve.yaml at startup
  • hyve reconcile — reads reconcile.* and env.file from hyve.yaml on every run