Skip to content

Getting started

This guide explains how to install and run the dump-config CLI.

For role-specific paths, see Onboarding. For an EOEPCA multi-application example, see EOEPCA extra config tutorial.

Install

From the project root:

hatch env create
hatch run dump-config --help

Or install editable:

pip install -e .
dump-config --help

Generate a configuration

1
2
3
4
dump-config \
  --profiles coder_app,gpu_coder_app \
  --groups group-a,group-b \
  --output config.yaml

Validate output

Inspect the generated YAML:

yq '.profiles[].definition.slug' config.yaml

List available profiles

dump-config --list-profiles

Inspect a profile

dump-config --describe-profile coder_app

Common environment variables

All CLI options support envvars:

  • ENABLED_PROFILES
  • GROUPS
  • OUTPUT_FILE
  • STORAGE_CLASS_RWO
  • STORAGE_CLASS_RWX

Example:

1
2
3
export ENABLED_PROFILES="coder_app,gpu_coder_app"
export GROUPS="group-a,group-b"
dump-config