Skip to content
CantelopBeta

Environments

App configuration is shared by the Edge API and newly started Sessions. Declare it in cantelop.json, using the credential names your provider expects:

cantelop.json
{
  "app": "hello",
  "api": "src/api.ts",
  "session": "src/session.ts",
  "environment": {
    "LOG_LEVEL": { "default": "info", "required": true },
    "CODEX_API_KEY": { "secret": true, "required": true }
  }
}
  • default supplies a local value. It cannot be used for secrets.
  • secret declares an encrypted production secret.
  • required tells cantelop doctor to check the name and storage kind in production.

These declarations never set production values. Locally, cantelop dev reads .env beside the manifest; its values override defaults and are never uploaded. Names beginning with CANTELOP_ are reserved.

After cantelop login, find your App ID with cantelop app list, then configure it:

Terminal
$ cantelop app env set APP_ID LOG_LEVEL=info
$ printf %s "$CODEX_API_KEY" | cantelop app secret set APP_ID CODEX_API_KEY
$ cantelop doctor

Replace APP_ID with your App's ID. doctor checks the App named in the manifest and exits non-zero if a check fails.

See the CLI reference for listing, updating, and removing values, then continue to deployment.