@zitadel/cli
v0.7.0
Published
Agent-friendly Zitadel CLI
Readme
@zitadel/cli
Scaffolds Zitadel auth (login, register, profile, middleware/proxy) into a Next.js, Nuxt, SvelteKit, SolidStart, Qwik Router, TanStack Start, React, Vue, Angular, Solid, Svelte, or Qwik app.
npx @zitadel/cli@latest start
npx @zitadel/cli@latest setup --server localUse an exact version (npx @zitadel/[email protected]) in bug reports and automation
when reproducibility matters.
Preview. This is the next-generation Zitadel, a ground-up rewrite of the platform. It is distinct from the established Zitadel at github.com/zitadel/zitadel. APIs and CLI flags will change: until 1.0.0, a breaking change ships in a minor version, and its release note marks it Breaking:.
Requirements
- Node from the supported range in
package.json#engines(currently ≥ 24) - Docker only when using the optional Docker runtime backend
- An app in one of the supported frameworks, or an empty directory where setup can scaffold one
Quickstart
mkdir my-app
cd my-app
npx @zitadel/cli@latest doctor
npx @zitadel/cli@latest start
npx @zitadel/cli@latest setup --server local
npm run devstart runs the @zitadel/server npm binary by default and stores runtime data
under .zitadel/local/ (SQLite by default). Remote-server setup can use
--server <url> without starting a local runtime. Use --runtime docker,
--image, or ZITADEL_LOCAL_IMAGE for advanced Docker backend debugging.
start also creates a local admin, [email protected], and ends by
printing a one-time sign-in link for the management console.
setup --server local creates a project on that local server, asks which
framework to scaffold when the directory is fresh, writes the app into the
current directory, and scaffolds the framework's
idiomatic auth routes plus the proxy layer — for Next.js that means
app/login, app/register, app/profile, and proxy.ts for Next 16+ or
middleware.ts for older versions; other frameworks get their equivalents
from the same patcher system. In a pre-existing app, setup derives the
embedding posture from the app instead of assuming a fresh skeleton: the
scaffolded pages take the variant="widget" posture inside your app's own
shell, recorded in the scaffold manifest and verified by doctor. Fresh
scaffolds also replace the starter home page with a redirect to /login.
Against a local server started with the default platform bootstrap, setup also
attaches the new project to the local admin's team, so the project is owned
from the start and zitadel claim reports it as already owned. If you opted
out with NEXTGEN_PLATFORM_BOOTSTRAP_PROJECT=false, there is no local admin
and the project has no owning team; that server cannot claim projects.
Setup writes .env.local, .env.development.local and .zitadel/, and installs
dependencies with the detected package manager. Pass --skip-install to install
them yourself. The project's default user schema and login flow come from
versioned local defaults; setup writes editable copies into
.zitadel/schemas/default-human-user.json and
.zitadel/flows/default-login.json, and its first deploy publishes them.
Open the dev server URL printed by your framework, register a user, log out,
log back in, and end on the signed-in profile page. That user is an end user
of your app. The management console is a separate sign-in: run
zitadel console for a fresh one-time link as the local admin.
For a reproducible tester report, use the exact version from the GitHub Release:
npx @zitadel/[email protected] doctor
npx @zitadel/[email protected] start
npx @zitadel/[email protected] setup --server localThe default project flow supports password registration/login, passkey registration/login, and optional passkey setup after password registration. Users who skip passkey setup can still sign in with password; users who add a passkey can sign in with either credential.
Repo config is authoritative: edit zitadel.json, .zitadel/schemas/*.json,
.zitadel/flows/*.json, or .zitadel/branding/ (a branding.json descriptor
plus a login.liquid LiquidJS template), then run zitadel deploy
(--dry-run previews it). Server-provisioned defaults remain a fallback for non-CLI
project creation, but CLI-created projects are authored from local files first.
Login templates are supported: scaffold them with the branding eject command
(--design centered|minimal); setup never does;
every edit publishes a new immutable branding revision and the login serves
the newest one. Flows work the same way: every edit publishes a new immutable
flow revision, and the deployed release pins it. A page that pins flow-name
gets that flow's pinned revision. A page without a pin gets the newest unscoped
flow the release pins, whatever its name, so revising a flow can make it the
default.
For agent scripts, pass --non-interactive --json and capture stdout and stderr
separately. The CLI contract is one parseable JSON object on stdout; terminals
and agent UIs may display stderr package-manager progress together with stdout.
Other commands
zitadel claim: claim the project to make it permanent (opens the claim page, polls for completion; the claim then shows insetup,status, anddoctor)zitadel console: print a fresh one-time sign-in link for the local console as[email protected]and open it in a browser (--no-openprints the link only)zitadel doctor: verify the CLI's version, the local runtime and generated project files (including scaffold drift and dependency-version alignment), grouped by category;-vlists every checkzitadel upgrade: move the project's exactly-pinned@zitadel/*packages to the latest release and refresh generated files (--dry-runpreviews only)zitadel status: summarise the local runtime and projectzitadel deploy: build a release from.zitadel/and deploy it to the project's primary origins (--dry-runvalidates and previews only)zitadel pull: rebuild.zitadel/from the revisions a released snapshot pins — the inverse of deploy — forlatest, a release id, or a deployment idzitadel branding eject: scaffold an editable login template from a designzitadel schema list: list the project's user schemaszitadel variable set|get|list|rm: manage the project's variables and secrets (--previewfor a preview override);zitadel variable resolveshows what a deployment froze, the live one by defaultzitadel origin add|list|rm: manage the origin patterns the project admits (--kind primary|preview)zitadel eject: remove what setup wrote (alias:zitadel uninstall)zitadel start|stop|logs|reset: manage the local runtime
The full agent-facing contract (JSON envelope, posture rules, claim flow,
doctor repair) is SKILL.md,
which ships in this package.
Reference
zitadel api [OPERATION]zitadel api ls [FILTER]zitadel auth-method passkey disablezitadel auth-method passkey enablezitadel auth-method password disablezitadel auth-method password enablezitadel auth-method sso disablezitadel auth-method sso enablezitadel autocomplete [SHELL]zitadel branding ejectzitadel branding get IDzitadel branding listzitadel claimzitadel commandszitadel consolezitadel deployzitadel deployment createzitadel deployment get DEPLOYMENT_IDzitadel deployment listzitadel deployment rollback [DEPLOYMENT_ID]zitadel doctorzitadel ejectzitadel envzitadel env add NAMEzitadel env listzitadel event get IDzitadel event listzitadel flow-definition get FLOWzitadel flow-definition listzitadel grant createzitadel grant delete IDzitadel grant get IDzitadel grant listzitadel help [COMMAND]zitadel idp createzitadel idp get IDzitadel idp listzitadel logszitadel origin add PATTERNzitadel origin listzitadel origin rm PATTERNzitadel policy get POLICYzitadel policy listzitadel policy test [OPERATION]zitadel previewzitadel preview listzitadel preview rm URLzitadel project get IDzitadel project listzitadel project update IDzitadel pull [TARGET]zitadel release createzitadel release get IDzitadel release listzitadel release revoke RELEASE_IDzitadel resetzitadel resourceszitadel schema get SCHEMAzitadel schema listzitadel searchzitadel session get IDzitadel session listzitadel session revoke IDzitadel setupzitadel skills addzitadel startzitadel statuszitadel stopzitadel team createzitadel team deactivate IDzitadel team get IDzitadel team listzitadel team update IDzitadel tests addzitadel uninstallzitadel upgradezitadel user createzitadel user delete IDzitadel user get IDzitadel user listzitadel user update IDzitadel variable get NAMEzitadel variable listzitadel variable resolve [DEPLOYMENT_ID]zitadel variable rm NAMEzitadel variable set NAME [VALUE]zitadel versionzitadel which
zitadel api [OPERATION]
Call any operation of the Zitadel API, with this project's server and project secret.
USAGE
$ zitadel api [OPERATION...] [--json] [-c <value>] [-s <value>] [-n] [--dry-run] [-v] [--debug]
[--color] [--telemetry] [-e <value>] [--env-file <value>] [-X GET|POST|PUT|PATCH|DELETE] [-F <value>...] [--input
<value>] [--paginate] [-f]
ARGUMENTS
[OPERATION...] An operationId (queryUsers) or a path (/users/query), then the path parameters. Omit it to choose one.
FLAGS
-F, --field=<value>... A field: name=value, or name:=json for JSON, typed by the operation's schema.
A query parameter's name sets it; any other name is a dot path into the body.
Repeatable.
-X, --method=GET|POST|PUT|PATCH|DELETE The HTTP method, to choose among a path's operations.
-c, --cwd=<value> Project directory to operate on.
-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.
-f, --force Call an operation that deletes, revokes or rolls back without the confirmation
prompt. Required when non-interactive.
-n, --non-interactive Disable prompts. Required when scripting or running as an agent.
-s, --server=<value> Override the resolved server URL.
-v, --verbose Verbose logging.
--[no-]color Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are
honored too.
--debug Debug logging.
--dry-run Preview without mutating files or the platform.
--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.
--input=<value> Read the JSON body from a file, or from stdin with -. --field lays over it.
--paginate Follow next_page_token to the last page, and answer with every page's items in
one list.
--[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Call any operation of the Zitadel API, with this project's server and project secret.
EXAMPLES
$ zitadel api queryUsers -F limit=5
$ zitadel api getUser user_01JZ8Y3V4Q0K7N2M5P6R8S9T0W
$ zitadel api /users/user_01JZ8Y3V4Q0K7N2M5P6R8S9T0W/passkeys --json
$ zitadel api listEvents -F category=auth --paginate --json
$ zitadel api createTeam -F name=Support --dry-run
$ zitadel api createTeam --input - < team.jsonzitadel api ls [FILTER]
List the operations of the Zitadel API that the api command calls.
USAGE
$ zitadel api ls [FILTER] [--json] [-c <value>] [-s <value>] [-n] [--dry-run] [-v] [--debug] [--color]
[--telemetry] [--tag <value>] [--plain]
ARGUMENTS
[FILTER] Only operations whose id, path, summary or tag contains this text.
FLAGS
-c, --cwd=<value> Project directory to operate on.
-n, --non-interactive Disable prompts. Required when scripting or running as an agent.
-s, --server=<value> Override the resolved server URL.
-v, --verbose Verbose logging.
--[no-]color Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are honored too.
--debug Debug logging.
--dry-run Preview without mutating files or the platform.
--plain Tab-separated rows with no header, for piping. Implied when stdout is not a terminal.
--tag=<value> Only the operations of this part of the API (Users, Teams, …).
--[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List the operations of the Zitadel API that the api command calls.
EXAMPLES
$ zitadel api ls
$ zitadel api ls passkey
$ zitadel api ls --tag Users --json
$ zitadel api ls --json | jq -r '.data.operations[] | select(.command == null) | .id'zitadel auth-method passkey disable
Disable passkey sign-in for a user schema.
USAGE
$ zitadel auth-method passkey disable [-c <value>] [-s <value>] [-n] [--dry-run] [-v] [--debug] [--color] [--telemetry]
[--schema <value>] [-f]
FLAGS
-c, --cwd=<value> Project directory to operate on.
-f, --force Disable the schema's last way to sign in. Its users can then only be managed through the API.
-n, --non-interactive Disable prompts. Required when scripting or running as an agent.
-s, --server=<value> Override the resolved server URL.
-v, --verbose Verbose logging.
--[no-]color Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are honored too.
--debug Debug logging.
--dry-run Preview without mutating files or the platform.
--schema=<value> User schema to change, by file name or objectType. Required when the project has more than one.
--[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
DESCRIPTION
Disable passkey sign-in for a user schema.
EXAMPLES
$ zitadel auth-method passkey disable
$ zitadel auth-method passkey disable --schema customerszitadel auth-method passkey enable
Enable passkey sign-in for a user schema.
USAGE
$ zitadel auth-method passkey enable [-c <value>] [-s <value>] [-n] [--dry-run] [-v] [--debug] [--color] [--telemetry]
[--schema <value>]
FLAGS
-c, --cwd=<value> Project directory to operate on.
-n, --non-interactive Disable prompts. Required when scripting or running as an agent.
-s, --server=<value> Override the resolved server URL.
-v, --verbose Verbose logging.
--[no-]color Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are honored too.
--debug Debug logging.
--dry-run Preview without mutating files or the platform.
--schema=<value> User schema to change, by file name or objectType. Required when the project has more than one.
--[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
DESCRIPTION
Enable passkey sign-in for a user schema.
EXAMPLES
$ zitadel auth-method passkey enable
$ zitadel auth-method passkey enable --schema customerszitadel auth-method password disable
Disable password sign-in for a user schema.
USAGE
$ zitadel auth-method password disable [-c <value>] [-s <value>] [-n] [--dry-run] [-v] [--debug] [--color] [--telemetry]
[--schema <value>] [-f]
FLAGS
-c, --cwd=<value> Project directory to operate on.
-f, --force Disable the schema's last way to sign in. Its users can then only be managed through the API.
-n, --non-interactive Disable prompts. Required when scripting or running as an agent.
-s, --server=<value> Override the resolved server URL.
-v, --verbose Verbose logging.
--[no-]color Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are honored too.
--debug Debug logging.
--dry-run Preview without mutating files or the platform.
--schema=<value> User schema to change, by file name or objectType. Required when the project has more than one.
--[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
DESCRIPTION
Disable password sign-in for a user schema.
EXAMPLES
$ zitadel auth-method password disable
$ zitadel auth-method password disable --schema customerszitadel auth-method password enable
Enable password sign-in for a user schema.
USAGE
$ zitadel auth-method password enable [-c <value>] [-s <value>] [-n] [--dry-run] [-v] [--debug] [--color] [--telemetry]
[--schema <value>]
FLAGS
-c, --cwd=<value> Project directory to operate on.
-n, --non-interactive Disable prompts. Required when scripting or running as an agent.
-s, --server=<value> Override the resolved server URL.
-v, --verbose Verbose logging.
--[no-]color Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are honored too.
--debug Debug logging.
--dry-run Preview without mutating files or the platform.
--schema=<value> User schema to change, by file name or objectType. Required when the project has more than one.
--[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
DESCRIPTION
Enable password sign-in for a user schema.
EXAMPLES
$ zitadel auth-method password enable
$ zitadel auth-method password enable --schema customerszitadel auth-method sso disable
Remove an identity provider from a user schema.
USAGE
$ zitadel auth-method sso disable [-c <value>] [-s <value>] [-n] [--dry-run] [-v] [--debug] [--color] [--telemetry]
[--schema <value>] [--provider <value>] [-f]
FLAGS
-c, --cwd=<value> Project directory to operate on.
-f, --force Disable the schema's last way to sign in. Its users can then only be managed through the API.
-n, --non-interactive Disable prompts. Required when scripting or running as an agent.
-s, --server=<value> Override the resolved server URL.
-v, --verbose Verbose logging.
--[no-]color Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are honored too.
--debug Debug logging.
--dry-run Preview without mutating files or the platform.
--provider=<value> Identity provider to remove.
--schema=<value> User schema to change, by file name or objectType. Required when the project has more than
one.
--[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
DESCRIPTION
Remove an identity provider from a user schema.
EXAMPLES
$ zitadel auth-method sso disable --provider google
$ zitadel auth-method sso disable --provider google --schema customerszitadel auth-method sso enable
Add an identity provider to a user schema.
USAGE
$ zitadel auth-method sso enable [-c <value>] [-s <value>] [-n] [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e
<value>] [--env-file <value>] [--schema <value>] [--provider google|custom] [--slug <value>] [--display-name
<value>] [--issuer <value>] [--scopes <value>] [--client-id <value>]
FLAGS
-c, --cwd=<value> Project directory to operate on.
-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.
-n, --non-interactive Disable prompts. Required when scripting or running as an agent.
-s, --server=<value> Override the resolved server URL.
-v, --verbose Verbose logging.
--client-id=<value> Client id of the application registered with the provider.
--[no-]color Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are honored too.
--debug Debug logging.
--display-name=<value> Name shown on the custom connection's sign-in button.
--dry-run Preview without mutating files or the platform.
--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.
--issuer=<value> Issuer URL of the custom provider. Its endpoints are found by OIDC discovery.
--provider=<option> Identity provider to enable, or "custom" for a custom OpenID Connect (OIDC) provider.
<options: google|custom>
--schema=<value> User schema to change, by file name or objectType. Required when the project has more than
one.
--scopes=<value> Scopes the custom connection requests, separated by spaces or commas. Must include openid.
Default: openid profile email.
--slug=<value> Name of the custom connection. Schemas and flows refer to it by this.
--[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
DESCRIPTION
Add an identity provider to a user schema.
EXAMPLES
$ zitadel auth-method sso enable --provider google
$ zitadel auth-method sso enable --provider google --schema customers
$ zitadel auth-method sso enable --provider google --client-id 1234-abc.apps.googleusercontent.com --non-interactive < secret.txt
$ zitadel auth-method sso enable --provider custom --slug acme-sso --display-name 'Acme SSO' --issuer https://sso.acme.example
$ zitadel auth-method sso enable --provider custom --slug acme-sso --display-name 'Acme SSO' --issuer https://sso.acme.example --scopes 'openid profile email groups' --client-id abc123 --non-interactive < secret.txtzitadel autocomplete [SHELL]
Display autocomplete installation instructions.
USAGE
$ zitadel autocomplete [SHELL] [-r]
ARGUMENTS
[SHELL] (zsh|bash|powershell) Shell type
FLAGS
-r, --refresh-cache Refresh cache (ignores displaying instructions)
DESCRIPTION
Display autocomplete installation instructions.
EXAMPLES
$ zitadel autocomplete
$ zitadel autocomplete bash
$ zitadel autocomplete zsh
$ zitadel autocomplete powershell
$ zitadel autocomplete --refresh-cacheSee code: @oclif/plugin-autocomplete
zitadel branding eject
Take ownership of the login template: scaffold .zitadel/branding/ from a shipped design.
USAGE
$ zitadel branding eject [--json] [-c <value>] [-s <value>] [-n] [--dry-run] [-v] [--debug] [--color]
[--telemetry] [-f] [--design <value>]
FLAGS
-c, --cwd=<value> Project directory to operate on.
-f, --force Overwrite an existing branding file.
-n, --non-interactive Disable prompts. Required when scripting or running as an agent.
-s, --server=<value> Override the resolved server URL.
-v, --verbose Verbose logging.
--[no-]color Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are honored too.
--debug Debug logging.
--design=<value> Design to start from: centered or minimal (default: centered).
--dry-run Preview without mutating files or the platform.
--[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Take ownership of the login template: scaffold .zitadel/branding/ from a shipped design.zitadel branding get ID
Get one branding revision by id.
USAGE
$ zitadel branding get ID [--json] [-c <value>] [-s <value>] [-n] [--dry-run] [-v] [--debug] [--color]
[--telemetry] [-e <value>] [--env-file <value>] [--fields <value>]
ARGUMENTS
ID branding revision id
FLAGS
-c, --cwd=<value> Project directory to operate on.
-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.
-n, --non-interactive Disable prompts. Required when scripting or running as an agent.
-s, --server=<value> Override the resolved server URL.
-v, --verbose Verbose logging.
--[no-]color Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are honored too.
--debug Debug logging.
--dry-run Preview without mutating files or the platform.
--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.
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to the resource's own; `--json` is
unaffected.
--[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Get one branding revision by id.
EXAMPLES
$ zitadel branding get <id>
$ zitadel branding get <id> --jsonzitadel branding list
List branding revisions.
USAGE
$ zitadel branding list [--json] [-c <value>] [-s <value>] [-n] [--dry-run] [-v] [--debug] [--color]
[--telemetry] [-e <value>] [--env-file <value>] [--limit <value>] [-a | --page-token <value>] [--fields <value>]
[--plain]
FLAGS
-a, --all Fetch every page instead of one.
-c, --cwd=<value> Project directory to operate on.
-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.
-n, --non-interactive Disable prompts. Required when scripting or running as an agent.
-s, --server=<value> Override the resolved server URL.
-v, --verbose Verbose logging.
--[no-]color Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are honored too.
--debug Debug logging.
--dry-run Preview without mutating files or the platform.
--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.
--fields=<value> Columns to show, comma-separated dot-paths (e.g. id,attributes.email). Defaults to the
resource's own columns; `--json` is unaffected.
--limit=<value> Page size (server default 20, max 100).
--page-token=<value> Continue from a previous page's next_page_token.
--plain Tab-separated rows with no header, for piping. Implied when stdout is not a terminal.
--[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List branding revisions.
EXAMPLES
$ zitadel branding list --json
$ zitadel branding list --all --jsonzitadel claim
Claim this project to make it permanent. Opens a browser to create an account or sign in.
USAGE
$ zitadel claim [--json] [-c <value>] [-s <value>] [-n] [--dry-run] [-v] [--debug] [--color]
[--telemetry] [-e <value>] [--env-file <value>] [--no-open] [--no-wait | --challenge-id <value> | --timeout <value>]
FLAGS
-c, --cwd=<value> Project directory to operate on.
-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.
-n, --non-interactive Disable prompts. Required when scripting or running as an agent.
-s, --server=<value> Override the resolved server URL.
-v, --verbose Verbose logging.
--challenge-id=<value> Wait for the link a --no-wait run printed, instead of creating a new one.
--[no-]color Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are honored too.
--debug Debug logging.
--dry-run Preview without mutating files or the platform.
--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.
--no-open Print the link instead of opening a browser.
--no-wait Print the link and exit, without opening a browser or waiting for the browser step. The
result names the command that waits for it.
--[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
--timeout=<value> Seconds to wait for the browser step. Defaults to the link's own expiry (10 minutes).
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Claim this project to make it permanent. Opens a browser to create an account or sign in.
EXAMPLES
$ zitadel claim
$ zitadel claim --no-open
$ zitadel claim --timeout 120
$ zitadel claim --no-wait
$ zitadel claim --challenge-id ch_01J0Z9KX7Y0Q2Y7JX5M9K2YF3Czitadel commands
List all zitadel commands.
USAGE
$ zitadel commands [--json] [-c id|plugin|summary|type... | --tree] [--deprecated] [-x | ] [--hidden]
[--no-truncate | ] [--sort id|plugin|summary|type | ]
FLAGS
-c, --columns=<option>... Only show provided columns (comma-separated).
<options: id|plugin|summary|type>
-x, --extended Show extra columns.
--deprecated Show deprecated commands.
--hidden Show hidden commands.
--no-truncate Do not truncate output.
--sort=<option> [default: id] Property to sort by.
<options: id|plugin|summary|type>
--tree Show tree of commands.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List all zitadel commands.See code: @oclif/plugin-commands
zitadel console
Open the console of the server the project uses.
USAGE
$ zitadel console [--json] [-c <value>] [-s <value>] [-n] [--dry-run] [-v] [--debug] [--color]
[--telemetry] [--no-open]
FLAGS
-c, --cwd=<value> Project directory to operate on.
-n, --non-interactive Disable prompts. Required when scripting or running as an agent.
-s, --server=<value> Override the resolved server URL.
-v, --verbose Verbose logging.
--[no-]color Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are honored too.
--debug Debug logging.
--dry-run Preview without mutating files or the platform.
--no-open Print the link instead of opening a browser.
--[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Open the console of the server the project uses.
Where a local server was started, the console opens signed in as the local admin the start command created: run this
in the directory it ran in, or one inside it, since the local admin is read from the nearest .zitadel/local/ on the
way up. Otherwise a project on a cloud or self-hosted server opens that server's console, where you sign in yourself.
EXAMPLES
$ zitadel console
$ zitadel console --no-openzitadel deploy
Apply your local configuration to Zitadel.
USAGE
$ zitadel deploy [--json] [-c <value>] [-s <value>] [-n] [--dry-run] [-v] [--debug] [--color]
[--telemetry] [-e <value>] [--env-file <value>] [-f] [-m <value>]
FLAGS
-c, --cwd=<value> Project directory to operate on.
-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.
-f, --force Deploy even when the release leaves existing users unable to sign in, without asking. Required
for that when non-interactive.
-m, --message=<value> A short summary of what this release changes. Defaults to the pull request's title or the
current commit's subject.
-n, --non-interactive Disable prompts. Required when scripting or running as an agent.
-s, --server=<value> Override the resolved server URL.
-v, --verbose Verbose logging.
--[no-]color Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are honored too.
--debug Debug logging.
--dry-run Preview without mutating files or the platform.
--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.
--[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
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.
EXAMPLES
$ zitadel deploy -m 'add phone_number to human-user'
$ zitadel deploy --dry-run
$ zitadel deploy -m 'move users to the new schema' --forcezitadel deployment create
Deploy an existing release to the project's origins.
USAGE
$ zitadel deployment create --release <value> [--json] [-c <value>] [-s <value>] [-n] [--dry-run] [-v] [--debug]
[--color] [--telemetry] [-e <value>] [--env-file <value>] [-m <value>]
FLAGS
-c, --cwd=<value> Project directory to operate on.
-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.
-m, --message=<value> A short summary of why this deploys.
-n, --non-interactive Disable prompts. Required when scripting or running as an agent.
-s, --server=<value> Override the resolved server URL.
-v, --verbose Verbose logging.
--[no-]color Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are honored too.
--debug Debug logging.
--dry-run Preview without mutating files or the platform.
--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.
--release=<value> (required) The release id to deploy.
--[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Deploy an existing release to the project's origins.
EXAMPLES
$ zitadel deployment create --release rel_01KX3RG8A7F0N9WD3P2E4YM5C1zitadel deployment get DEPLOYMENT_ID
Read one deployment by id.
USAGE
$ zitadel deployment get DEPLOYMENT_ID [--json] [-c <value>] [-s <value>] [-n] [--dry-run] [-v] [--debug]
[--color] [--telemetry] [-e <value>] [--env-file <value>]
ARGUMENTS
DEPLOYMENT_ID The deployment to read.
FLAGS
-c, --cwd=<value> Project directory to operate on.
-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.
-n, --non-interactive Disable prompts. Required when scripting or running as an agent.
-s, --server=<value> Override the resolved server URL.
-v, --verbose Verbose logging.
--[no-]color Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are honored too.
--debug Debug logging.
--dry-run Preview without mutating files or the platform.
--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.
--[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Read one deployment by id.
EXAMPLES
$ zitadel deployment get dep_01KX5N7C9D2E7F0N9WD3P2E4YM6zitadel deployment list
List the project's deployments, newest first.
USAGE
$ zitadel deployment list [--json] [-c <value>] [-s <value>] [-n] [--dry-run] [-v] [--debug] [--color]
[--telemetry] [-e <value>] [--env-file <value>] [--origin <value>] [--live] [--limit <value>] [-a | --page-token
<value>] [--plain]
FLAGS
-a, --all Fetch every page instead of one.
-c, --cwd=<value> Project directory to operate on.
-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.
-n, --non-interactive Disable prompts. Required when scripting or running as an agent.
-s, --server=<value> Override the resolved server URL.
-v, --verbose Verbose logging.
--[no-]color Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are honored too.
--debug Debug logging.
--dry-run Preview without mutating files or the platform.
--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.
--limit=<value> Page size (server default 20, max 100).
--live What each target serves now, not the full history.
--origin=<value> Only deployments that targeted this origin.
--page-token=<value> Continue from a previous page's next_page_token.
--plain Tab-separated rows with no header, for piping. Implied when stdout is not a terminal.
--[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List the project's deployments, newest first.
EXAMPLES
$ zitadel deployment list
$ zitadel deployment list --all
$ zitadel deployment list --live
$ zitadel deployment list --origin https://app.acme.comzitadel deployment rollback [DEPLOYMENT_ID]
Roll back to an earlier deployment.
USAGE
$ zitadel deployment rollback [DEPLOYMENT_ID] [--json] [-c <value>] [-s <value>] [-n] [--dry-run] [-v] [--debug]
[--color] [--telemetry] [-e <value>] [--env-file <value>] [-f] [-m <value>]
ARGUMENTS
[DEPLOYMENT_ID] The deployment to roll back to. Omit to undo the last deploy.
FLAGS
-c, --cwd=<value> Project directory to operate on.
-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.
-f, --force Roll back to the deployment without the confirmation prompt. Required when non-interactive.
-m, --message=<value> A short summary of why this rolls back.
-n, --non-interactive Disable prompts. Required when scripting or running as an agent.
-s, --server=<value> Override the resolved server URL.
-v, --verbose Verbose logging.
--[no-]color Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are honored too.
--debug Debug logging.
--dry-run Preview without mutating files or the platform.
--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.
--[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Roll back to an earlier deployment.
EXAMPLES
$ zitadel deployment rollback
$ zitadel deployment rollback dep_01KX5N7C9D2E7F0N9WD3P2E4YM6
$ zitadel deployment rollback --forcezitadel doctor
Verify local runtime and project state.
USAGE
$ zitadel doctor [--json] [-c <value>] [-s <value>] [-n] [--dry-run] [-v] [--debug] [--color]
[--telemetry] [-f --fix] [--image <value>] [--port <value>] [--runtime binary|docker] [-e <value>] [--env-file
<value>]
FLAGS
-c, --cwd=<value> Project directory to operate on.
-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.
-f, --force With --fix, make repairs that replace an origin without the confirmation prompt. Required when
non-interactive.
-n, --non-interactive Disable prompts. Required when scripting or running as an agent.
-s, --server=<value> Override the resolved server URL.
-v, --verbose Verbose logging.
--[no-]color Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are honored too.
--debug Debug logging.
--dry-run Preview without mutating files or the platform.
--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.
--fix Repair missing files and stale managed wiring.
--image=<value> Container image to check.
--port=<value> Local HTTP port to check. Defaults to the port this directory's server uses.
--runtime=<option> Local runtime backend.
<options: binary|docker>
--[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Verify local runtime and project state.zitadel eject
Remove managed files and local Zitadel state.
USAGE
$ zitadel eject [--json] [-c <value>] [-s <value>] [-n] [--dry-run] [-v] [--debug] [--color]
[--telemetry] [-f]
FLAGS
-c, --cwd=<value> Project directory to operate on.
-f, --force Remove the managed files and local state without the confirmation prompt. Required when
non-interactive.
-n, --non-interactive Disable prompts. Required when scripting or running as an agent.
-s, --server=<value> Override the resolved server URL.
-v, --verbose Verbose logging.
--[no-]color Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are honored too.
--debug Debug logging.
--dry-run Preview without mutating files or the platform.
--[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Remove managed files and local Zitadel state.
ALIASES
$ zitadel uninstallzitadel env
Show which server and project resolve, and where each value came from.
USAGE
$ zitadel env [--json] [-c <value>] [-s <value>] [-n] [--dry-run] [-v] [--debug] [--color]
[--telemetry] [-e <value>] [--env-file <value>]
FLAGS
-c, --cwd=<value> Project directory to operate on.
-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.
-n, --non-interactive Disable prompts. Required when scripting or running as an agent.
-s, --server=<value> Override the resolved server URL.
-v, --verbose Verbose logging.
--[no-]color Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are honored too.
--debug Debug logging.
--dry-run Preview without mutating files or the platform.
--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.
--[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Show which server and project resolve, and where each value came from.
EXAMPLES
$ zitadel env
$ zitadel env --env production
$ zitadel env --env-file ./infra/acme-staging.envzitadel env add NAME
Bind an environment to a project, creating the project if needed.
USAGE
$ zitadel env add NAME [--json] [-c <value>] [-s <value>] [-n] [--dry-run] [-v] [--debug] [--color]
[--telemetry] [--project <value>] [--app-url <value>] [--force]
ARGUMENTS
NAME The environment name, e.g. production.
FLAGS
-c, --cwd=<value> Project directory to operate on.
-n, --non-interactive Disable prompts. Required when scripting or running as an agent.
-s, --server=<value> Override the resolved server URL.
-v, --verbose Verbose logging.
--app-url=<value> The URL this environment's app is served from. It becomes ZITADEL_ISSUER and is registered with
a new project.
--[no-]color Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are honored too.
--debug Debug logging.
--dry-run Preview without mutating files or the platform.
--force Overwrite an existing .env.<name>.local.
--project=<value> Bind this existing project instead of creating one. Its secrets come from
ZITADEL_PROJECT_SECRET and ZITADEL_PREVIEW_TOKEN in the process environment.
--[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Bind an environment to a project, creating the project if needed.
EXAMPLES
$ zitadel env add production --server https://api.zitadel.cloud --app-url https://app.acme.com
$ zitadel env add staging --server https://api.zitadel.cloud --project proj_01K9AA9M3K7E2QX8VB4Tzitadel env list
List the environments bound in this directory's .env files.
USAGE
$ zitadel env list [--json] [-c <value>] [-s <value>] [-n] [--dry-run] [-v] [--debug] [--color]
[--telemetry] [-e <value>] [--env-file <value>] [--plain]
FLAGS
-c, --cwd=<value> Project directory to operate on.
-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.
-n, --non-interactive Disable prompts. Required when scripting or running as an agent.
-s, --server=<value> Override the resolved server URL.
-v, --verbose Verbose logging.
--[no-]color Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are honored too.
--debug Debug logging.
--dry-run Preview without mutating files or the platform.
--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.
--plain Tab-separated rows with no header, for piping. Implied when stdout is not a terminal.
--[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List the environments bound in this directory's .env files.
EXAMPLES
$ zitadel env list
$ zitadel env list --plainzitadel event get ID
Get one event by id.
USAGE
$ zitadel event get ID [--json] [-c <value>] [-s <value>] [-n] [--dry-run] [-v] [--debug] [--color]
[--telemetry] [-e <value>] [--env-file <value>] [--fields <value>]
ARGUMENTS
ID event id
FLAGS
-c, --cwd=<value> Project directory to operate on.
-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.
-n, --non-interactive Disable prompts. Required when scripting or running as an agent.
-s, --server=<value> Override the resolved server URL.
-v, --verbose Verbose logging.
--[no-]color Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are honored too.
--debug Debug logging.
--dry-run Preview without mutating files or the platform.
--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.
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to the resource's own; `--json` is
unaffected.
--[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Get one event by id.
EXAMPLES
$ zitadel event get <id>
$ zitadel event get <id> --jsonzitadel event list
List events.
USAGE
$ zitadel event list [--json] [-c <value>] [-s <value>] [-n] [--dry-run] [-v] [--debug] [--color]
[--telemetry] [-e <value>] [--env-file <value>] [--limit <value>] [-a | --page-token <value>] [--fields <value>]
[--filter <value>...] [--sort <value>] [--plain]
FLAGS
-a, --all
Fetch every page instead of one.
-c, --cwd=<value>
Project directory to operate on.
-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.
-n, --non-interactive
Disable prompts. Required when scripting or running as an agent.
-s, --server=<value>
Override the resolved server URL.
-v, --verbose
Verbose logging.
--[no-]color
Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are honored too.
--debug
Debug logging.
--dry-run
Preview without mutating files or the platform.
--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.
--fields=<value>
Columns to show, comma-separated dot-paths (e.g. id,attributes.email). Defaults to the resource's own columns;
`--json` is unaffected.
--filter=<value>...
Filter as field=operation:value (operation defaults to equals). Fields: category (equals; values
request|auth|session|admin|entity|signal; repeats widen), event_type (equals; repeats widen), actor_id (equals),
user_id (equals), session_id (equals), flow_id (equals), request_id (equals), entity_type (equals), entity_id
(equals), team_id (equals), operation_id (equals; repeats widen), status_class (equals; values 1xx|2xx|3xx|4xx|5xx;
repeats widen), created_at (greater_than_or_equal|less_than).
--limit=<value>
Page size (server default 20, max 100).
--page-token=<value>
Continue from a previous page's next_page_token.
--plain
Tab-separated rows with no header, for piping. Implied when stdout is not a terminal.
--sort=<value>
Sort as field:direction (asc|desc). Fields: occurred_at.
--[no-]telemetry
Send anonymous usage analytics. Disable with --no-telemetry.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List events.
EXAMPLES
$ zitadel event list --json
$ zitadel event list --all --json
$ zitadel event list --filter category=equals:<value> --sort occurred_at:desczitadel flow-definition get FLOW
Get one flow definition by flow name (newest revision) or revision id.
USAGE
$ zitadel flow-definition get FLOW [--json] [-c <value>] [-s <value>] [-n] [--dry-run] [-v] [--debug] [--color]
[--telemetry] [-e <value>] [--env-file <value>] [--fields <value>]
ARGUMENTS
FLOW flow name (newest revision) or revision id
FLAGS
-c, --cwd=<value> Project directory to operate on.
-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.
-n, --non-interactive Disable prompts. Required when scripting or running as an agent.
-s, --server=<value> Override the resolved server URL.
-v, --verbose Verbose logging.
--[no-]color Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are honored too.
--debug Debug logging.
--dry-run Preview without mutating files or the platform.
--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.
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to the resource's own; `--json` is
unaffected.
--[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Get one flow definition by flow name (newest revision) or revision id.
EXAMPLES
$ zitadel flow-definition get <flow>
$ zitadel flow-definition get <flow> --jsonzitadel flow-definition list
List flow definitions.
USAGE
$ zitadel flow-definition list [--json] [-c <value>] [-s <value>] [-n] [--dry-run] [-v] [--debug] [--color]
[--telemetry] [-e <value>] [--env-file <value>] [--limit <value>] [-a | --page-token <value>] [--fields <value>]
[--filter <value>...] [--plain]
FLAGS
-a, --all Fetch every page instead of one.
-c, --cwd=<value> Project directory to operate on.
-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.
-n, --non-interactive Disable prompts. Required when scripting or running as an agent.
-s, --server=<value> Override the resolved server URL.
-v, --verbose Verbose logging.
--[no-]color Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are honored too.
--debug Debug logging.
--dry-run Preview without mutating files or the platform.
--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.
--fields=<value> Columns to show, comma-separated dot-paths (e.g. id,attributes.email). Defaults to the
resource's own columns; `--json` is unaffected.
--filter=<value>... Filter as field=operation:value (operation defaults to equals). Fields: name (equals),
purpose (equals), revisions (equals; values all|latest).
--limit=<value> Page size (server default 20, max 100).
--page-token=<value> Continue from a previous page's next_page_token.
--plain Tab-separated rows with no header, for piping. Implied when stdout is not a terminal.
--[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List flow definitions.
EXAMPLES
$ zitadel flow-definition list --json
$ zitadel flow-definition list --all --json
$ zitadel flow-definition list --filter name=equals:<value>zitadel grant create
Create a grant.
USAGE
$ zitadel grant create [--json] [-c <value>] [-s <value>] [-n] [--dry-run] [-v] [--debug] [--color]
[--telemetry] [-e <value>] [--env-file <value>] [--relation viewer|editor|admin] [--expires-at <value>]
[--user-user-id <value>] [--user-identifier <value>] [--team-team-id <value>] [--team-name <value>] [--data <value>
| --file <value>] [--set <value>...]
FLAGS
-c, --cwd=<value> Project directory to operate on.
-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.
-n, --non-interactive Disable prompts. Required when scripting or running as an agent.
-s, --server=<value> Override the resolved server URL.
-v, --verbose Verbose logging.
--[no-]color Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are honored too.
--debug Debug logging.
--dry-run Preview without mutating files or the platform.
--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.
--[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
RAW BODY FLAGS
--data=<value> Whole body as a JSON object. Field flags and --set apply over it.
--file=<value> Read the body from a JSON file; `-` reads stdin. Field flags and --set apply over it.
--set=<value>... Set one field by its dot path: path=value, or path:=json for JSON. Repeatable; applied after the
field flags, in order. A key that contains a dot is set through its parent: --set
'parent:={"a.b":"x"}'.
OPTIONAL FIELD FLAGS
--expires-at=<value> Optional expiry.
GLOBAL FLAGS
--json Format output as json.
REQUIRED FIELD FLAGS
--relation=<option> (required) The role on the project (`object_type` `project`).
<options: viewer|editor|admin>
TEAM FIELD FLAGS
--team-name=<value> Team name, unique per project case-insensitively.
--team-team-id=<value>
USER FIELD FLAGS
--user-identifier=<value> The user schema's designated identifier (`x-identifier`), looked up in the platform
project.
--user-user-id=<value>
DESCRIPTION
Create a grant.
EXAMPLES
$ zitadel grant create --relation viewer --user-identifier [email protected] --json
$ zitadel grant create --data '{...}' --json
$ zitadel grant create --file ./grant.jsonzitadel grant delete ID
Delete a grant by id.
USAGE
$ zitadel grant delete ID [--json] [-c <value>] [-s <value>] [-n] [--dry-run] [-v] [--debug] [--color]
[--telemetry] [-e <value>] [--env-file <value>] [-f]
ARGUMENTS
ID grant id
FLAGS
-c, --cwd=<value> Project directory to operate on.
-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.
-f, --force Delete the grant without the confirmation prompt. Required when non-interactive.
-n, --non-interactive Disable prompts. Required when scripting or running as an agent.
-s, --server=<value> Override the resolved server URL.
-v, --verbose Verbose logging.
--[no-]color Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are honored too.
--debug Debug logging.
--dry-run Preview without mutating files or the platform.
--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.
--[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Delete a grant by id.
EXAMPLES
$ zitadel grant delete <id> --force --jsonzitadel grant get ID
Get one grant by id.
USAGE
$ zitadel grant get ID [--json] [-c <value>] [-s <value>] [-n] [--dry-run] [-v] [--debug] [--color]
[--telemetry] [-e <value>] [--env-file <value>] [--fields <value>]
ARGUMENTS
ID grant id
FLAGS
-c, --cwd=<value> Project directory to operate on.
-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.
-n, --non-interactive Disable prompts. Required when scripting or running as an agent.
-s, --server=<value> Override the resolved server URL.
-v, --verbose Verbose logging.
--[no-]color Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are honored too.
--debug Debug logging.
--dry-run 