Environment Variables

The env map declares app-owned environment variables. Each value is a string (shorthand for default value) or an object.

Field	Type	Required	Description
`default`	`string \| number \| boolean`	no	Default value
`description`	`string`	no	Human description (supports markdown)
`label`	`string`	no	Short label for CLI prompts
`required`	`boolean`	no	App cannot start without this value
`example`	`string`	no	Example value showing expected format
`generator`	`enum`	no	Auto-generate: `secret`, `uuid`, `port`
`sensitive`	`boolean`	no	Store in a secrets manager

A bare scalar (PORT: "8080") is shorthand for { default: "8080" }. Booleans and numbers work too.

When generator: secret is set, sensitive: true is implied — the platform should store the generated value in a secrets manager and mask it in logs and UI.

env:
  PORT:
    default: "8080"
  API_KEY:
    required: true
    description: "Third-party API key"
    example: "sk-live-abc123..."
  SESSION_SECRET:
    generator: secret
    sensitive: true

Real-world examples: See how WordPress and Gitea wire environment variables from resources. Browse all apps →