Docs

zitadel deploy

Apply your local configuration to Zitadel.

Builds a release from .zitadel/ and deploys it to the project. Use --dry-run to preview what would change.

Usage

npx @zitadel/cli@latest deploy [flags]

Flags

FlagDescription
-m, --message <value>A short summary of what this release changes. Defaults to the pull request's title or the current commit's subject.
-e, --env <value>Environment to run against, e.g. production. Defaults to ZITADEL_ENV, then the hosting platform's build (VERCEL_ENV, or Netlify's CONTEXT), then development.
--env-file <value>Read ZITADEL_* values from this file ahead of the process environment. A relative path is read from the current directory, not from --cwd. Cannot be combined with --env.

It also takes the global flags.

Examples

npx @zitadel/cli@latest deploy -m 'add phone_number to human-user'
npx @zitadel/cli@latest deploy --dry-run

API

It calls Build a release from files, POST /releases/build, in the Releases API.

Was this helpful?