Docs

zitadel preview

Deploy a release from .zitadel/ to a pull-request build's preview URLs.

Usage

npx @zitadel/cli@latest preview [flags]

Flags

FlagDescription
--origin <value>A preview URL to deploy to, instead of detecting them from the platform build. Repeatable. Can be given more than once.
--ttl <value>How long each preview stays live, e.g. 7d, 12h or 90m. Between 60s and 365d. Omitted, the project's default applies.
-m, --message <value>A short summary of what this release changes. Defaults to the pull request's title or the current commit's subject.
--strictFail instead of warning when no preview credential (ZITADEL_PROJECT_SECRET) is set.
-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 preview
npx @zitadel/cli@latest preview --origin https://acme-git-sso-acmeinc.vercel.app
npx @zitadel/cli@latest preview --ttl 24h
npx @zitadel/cli@latest preview -m 'add phone_number to human-user'

Was this helpful?

On this page