Command line

Envarna can output your settings definitions in a number of formats. Call envarna from the command line (usually with npx)

--help

Here is the output of npx envarna --help

envarna <command>

Commands:
  envarna list         Display settings details
  envarna env          Write ".env.template"
  envarna md           Write "SETTINGS.md"
  envarna values       Write "values.yaml"
  envarna compose      Display docker-compose style environment yaml
  envarna k8s          Display kubernetes style env var structure
  envarna json [root]  Display JSON settings structure
  envarna yaml [root]  Display YAML settings structure
  envarna raw          Display the raw structure extracted from the settings classes used to power the other formats

Options:
  --version   Show version number                                       [boolean]
  --skip-dev  Exclude fields marked @devOnly (default: false)           [boolean]
  --help      Show help                                                 [boolean]

Flags

• --skip-dev: omit fields decorated with @devOnly().
• json --root <name>: wrap output under a root object (or omit for flat).
• json --flat: flatten output (no group nesting under root).
• json --code: use field names as keys instead of ENVAR names.
• yaml --root/--flat/--code: same as JSON for YAML output.

Defaults

• json: root defaults to none (top-level object of groups/fields)
• yaml: root defaults to settings

list

Display settings details

env

Write .env.template

md

Write SETTINGS.md

values

Write values.yaml

compose

Display docker-compose style environment yaml

k8s

Display Kubernetes-style env var structure

json

Display JSON settings structure [root] --flat (default: false) --code (default: false)

yaml

Display YAML settings structure [root] --flat (default: false) --code (default: false)

raw

Raw output of the structure used to create the above

Example: list

app (contains secrets)
===
Env Var            Alias                 Usual Path                 Type             Default
-------            -----                 ----------                 ----             -------
APP_NAME                                 settings.app.name          string           my-app
APP_DEBUG                               settings.app.debug         boolean          
APP_API_KEY (secret)  GOOGLE_API_KEY     settings.app.apiKey        string           

smtp
====
Env Var                 Usual Path                 Type     Default
-------                 ----------                 ----     -------
SMTP_HOST               settings.smtp.host         string   localhost
SMTP_PORT               settings.smtp.port         number   25
SMTP_FROM_EMAIL         settings.smtp.fromEmail    string   noreply@example.org

Discovery

• Scans the project for classes extending BaseSettings (excluding node_modules, dist, and coverage).
• --skip-dev omits fields decorated with @devOnly().