@zitadel/cli 0.1.0 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (13) hide show
  1. package/README.md +2102 -836
  2. package/dist/index.mjs +8674 -9700
  3. package/dist/index.mjs.map +1 -1
  4. package/dist/lib/oclif/help.mjs +66 -20
  5. package/dist/lib/oclif/help.mjs.map +1 -1
  6. package/dist/skills-hint-CBoak9HL.mjs +4348 -0
  7. package/dist/skills-hint-CBoak9HL.mjs.map +1 -0
  8. package/oclif.manifest.json +4022 -1230
  9. package/package.json +49 -18
  10. package/skills/zitadel-cli/SKILL.md +151 -55
  11. package/skills/zitadel-cli/references/driving-login-ui.md +35 -15
  12. package/dist/skills-hint-BSspFzhr.mjs +0 -173
  13. package/dist/skills-hint-BSspFzhr.mjs.map +0 -1
package/README.md CHANGED
@@ -106,12 +106,17 @@ and agent UIs may display stderr package-manager progress together with stdout.
106
106
  - `zitadel doctor`: verify the local runtime and generated project files
107
107
  (including scaffold drift and dependency-version alignment)
108
108
  - `zitadel status`: summarise the local runtime and project
109
- - `zitadel plan`: validate config and preview sync changes without mutation
110
- - `zitadel apply`: validate and upload repo config to Zitadel
109
+ - `zitadel deploy`: build a release from `.zitadel/` and deploy it to the
110
+ project's primary origins (`--dry-run` validates and previews only)
111
+ - `zitadel pull`: rebuild `.zitadel/` from the revisions a released snapshot
112
+ pins — the inverse of deploy — for `latest`, a release id, or a deployment id
111
113
  - `zitadel branding eject`: scaffold an editable login template from a design
112
114
  - `zitadel schemas list`: list the project's user schemas
113
- - `zitadel variables list|get|set|delete`: manage the project's variables and
114
- secrets (`--project-level`)
115
+ - `zitadel variable set|get|list|rm`: manage the project's variables and secrets
116
+ (`--preview` for a preview override); `zitadel variable resolve` shows what a
117
+ target's live deployment runs
118
+ - `zitadel origin add|list|rm`: manage the origin patterns the project admits
119
+ (`--kind primary|preview`)
115
120
  - `zitadel eject`: remove what setup wrote (alias: `zitadel uninstall`)
116
121
  - `zitadel start|stop|logs|reset`: manage the local runtime
117
122
 
@@ -125,7 +130,8 @@ which ships in this package.
125
130
  <summary>Full command reference</summary>
126
131
 
127
132
  <!-- commands -->
128
- * [`zitadel apply`](#zitadel-apply)
133
+ * [`zitadel api [OPERATION]`](#zitadel-api-operation)
134
+ * [`zitadel api ls [FILTER]`](#zitadel-api-ls-filter)
129
135
  * [`zitadel auth-method passkey disable`](#zitadel-auth-method-passkey-disable)
130
136
  * [`zitadel auth-method passkey enable`](#zitadel-auth-method-passkey-enable)
131
137
  * [`zitadel auth-method password disable`](#zitadel-auth-method-password-disable)
@@ -139,8 +145,16 @@ which ships in this package.
139
145
  * [`zitadel claim`](#zitadel-claim)
140
146
  * [`zitadel commands`](#zitadel-commands)
141
147
  * [`zitadel console`](#zitadel-console)
148
+ * [`zitadel deploy`](#zitadel-deploy)
149
+ * [`zitadel deployment create`](#zitadel-deployment-create)
150
+ * [`zitadel deployment get DEPLOYMENT_ID`](#zitadel-deployment-get-deployment_id)
151
+ * [`zitadel deployment list`](#zitadel-deployment-list)
152
+ * [`zitadel deployment rollback [DEPLOYMENT_ID]`](#zitadel-deployment-rollback-deployment_id)
142
153
  * [`zitadel doctor`](#zitadel-doctor)
143
154
  * [`zitadel eject`](#zitadel-eject)
155
+ * [`zitadel env`](#zitadel-env)
156
+ * [`zitadel env add NAME`](#zitadel-env-add-name)
157
+ * [`zitadel env list`](#zitadel-env-list)
144
158
  * [`zitadel events get ID`](#zitadel-events-get-id)
145
159
  * [`zitadel events list`](#zitadel-events-list)
146
160
  * [`zitadel flow-definitions get FLOW`](#zitadel-flow-definitions-get-flow)
@@ -154,12 +168,22 @@ which ships in this package.
154
168
  * [`zitadel idps get ID`](#zitadel-idps-get-id)
155
169
  * [`zitadel idps list`](#zitadel-idps-list)
156
170
  * [`zitadel logs`](#zitadel-logs)
157
- * [`zitadel plan`](#zitadel-plan)
171
+ * [`zitadel origin add PATTERN`](#zitadel-origin-add-pattern)
172
+ * [`zitadel origin list`](#zitadel-origin-list)
173
+ * [`zitadel origin rm PATTERN`](#zitadel-origin-rm-pattern)
174
+ * [`zitadel policies get POLICY`](#zitadel-policies-get-policy)
175
+ * [`zitadel policies list`](#zitadel-policies-list)
176
+ * [`zitadel preview`](#zitadel-preview)
177
+ * [`zitadel preview list`](#zitadel-preview-list)
178
+ * [`zitadel preview rm URL`](#zitadel-preview-rm-url)
158
179
  * [`zitadel projects get ID`](#zitadel-projects-get-id)
159
180
  * [`zitadel projects list`](#zitadel-projects-list)
160
181
  * [`zitadel projects update ID`](#zitadel-projects-update-id)
161
- * [`zitadel releases get ID`](#zitadel-releases-get-id)
162
- * [`zitadel releases list`](#zitadel-releases-list)
182
+ * [`zitadel pull [TARGET]`](#zitadel-pull-target)
183
+ * [`zitadel release create`](#zitadel-release-create)
184
+ * [`zitadel release get ID`](#zitadel-release-get-id)
185
+ * [`zitadel release list`](#zitadel-release-list)
186
+ * [`zitadel release revoke RELEASE_ID`](#zitadel-release-revoke-release_id)
163
187
  * [`zitadel reset`](#zitadel-reset)
164
188
  * [`zitadel resources`](#zitadel-resources)
165
189
  * [`zitadel schemas get SCHEMA`](#zitadel-schemas-get-schema)
@@ -183,21 +207,88 @@ which ships in this package.
183
207
  * [`zitadel users get ID`](#zitadel-users-get-id)
184
208
  * [`zitadel users list`](#zitadel-users-list)
185
209
  * [`zitadel users update ID`](#zitadel-users-update-id)
186
- * [`zitadel variables delete NAME`](#zitadel-variables-delete-name)
187
- * [`zitadel variables get NAME`](#zitadel-variables-get-name)
188
- * [`zitadel variables list`](#zitadel-variables-list)
189
- * [`zitadel variables set NAME`](#zitadel-variables-set-name)
210
+ * [`zitadel variable get NAME`](#zitadel-variable-get-name)
211
+ * [`zitadel variable list`](#zitadel-variable-list)
212
+ * [`zitadel variable resolve`](#zitadel-variable-resolve)
213
+ * [`zitadel variable rm NAME`](#zitadel-variable-rm-name)
214
+ * [`zitadel variable set NAME [VALUE]`](#zitadel-variable-set-name-value)
190
215
  * [`zitadel version`](#zitadel-version)
191
216
  * [`zitadel which`](#zitadel-which)
192
217
 
193
- ## `zitadel apply`
218
+ ## `zitadel api [OPERATION]`
194
219
 
195
- Validate and upload repo config to the platform.
220
+ Call any operation of the Zitadel API, with this project's server and project secret.
196
221
 
197
222
  ```
198
223
  USAGE
199
- $ zitadel apply [--json] [-c <value>] [-s <value>] [-n]
200
- [--dry-run] [-v] [--debug] [--color] [--telemetry]
224
+ $ zitadel api [OPERATION...] [--json] [-c <value>] [-s <value>]
225
+ [-n] [--dry-run] [-v] [--debug] [--color] [--telemetry] [-X
226
+ GET|POST|PUT|PATCH|DELETE] [-F <value>...] [--input <value>] [--paginate]
227
+
228
+ ARGUMENTS
229
+ [OPERATION...] An operationId (queryUsers) or a path (/users/query), then the
230
+ path parameters. Omit it to choose one.
231
+
232
+ FLAGS
233
+ -F, --field=<value>... A field: name=value, or name:=json for
234
+ JSON, typed by the operation's schema.
235
+ A query parameter's name sets it; any
236
+ other name is a dot path into the
237
+ body. Repeatable.
238
+ -X, --method=GET|POST|PUT|PATCH|DELETE The HTTP method, to choose among a
239
+ path's operations.
240
+ -c, --cwd=<value> Project directory to operate on.
241
+ -n, --non-interactive Disable prompts. Required when
242
+ scripting or running as an agent.
243
+ -s, --server=<value> Override the resolved server URL.
244
+ -v, --verbose Verbose logging.
245
+ --[no-]color Colorize human output. Disable with
246
+ --no-color; NO_COLOR and FORCE_COLOR
247
+ are honored too.
248
+ --debug Debug logging.
249
+ --dry-run Preview without mutating files or the
250
+ platform.
251
+ --input=<value> Read the JSON body from a file, or
252
+ from stdin with -. --field lays over
253
+ it.
254
+ --paginate Follow next_page_token to the last
255
+ page, and answer with every page's
256
+ items in one list.
257
+ --[no-]telemetry Send anonymous usage analytics.
258
+ Disable with --no-telemetry.
259
+
260
+ GLOBAL FLAGS
261
+ --json Format output as json.
262
+
263
+ DESCRIPTION
264
+ Call any operation of the Zitadel API, with this project's server and project
265
+ secret.
266
+
267
+ EXAMPLES
268
+ $ zitadel api queryUsers -F limit=5
269
+
270
+ $ zitadel api GetUserByID user_01JZ8Y3V4Q0K7N2M5P6R8S9T0W
271
+
272
+ $ zitadel api /users/user_01JZ8Y3V4Q0K7N2M5P6R8S9T0W/passkeys --json
273
+
274
+ $ zitadel api listEvents -F category=auth --paginate --json
275
+
276
+ $ zitadel api createTeam -F name=Support --dry-run
277
+
278
+ $ zitadel api createTeam --input - < team.json
279
+ ```
280
+
281
+ ## `zitadel api ls [FILTER]`
282
+
283
+ List the operations of the Zitadel API that `zitadel api` calls.
284
+
285
+ ```
286
+ USAGE
287
+ $ zitadel api ls [FILTER] [--json] [-c <value>] [-s <value>] [-n]
288
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--tag <value>]
289
+
290
+ ARGUMENTS
291
+ [FILTER] Only operations whose id, path, summary or tag contains this text.
201
292
 
202
293
  FLAGS
203
294
  -c, --cwd=<value> Project directory to operate on.
@@ -209,6 +300,8 @@ FLAGS
209
300
  NO_COLOR and FORCE_COLOR are honored too.
210
301
  --debug Debug logging.
211
302
  --dry-run Preview without mutating files or the platform.
303
+ --tag=<value> Only the operations of this part of the API (Users,
304
+ Teams, …).
212
305
  --[no-]telemetry Send anonymous usage analytics. Disable with
213
306
  --no-telemetry.
214
307
 
@@ -216,7 +309,16 @@ GLOBAL FLAGS
216
309
  --json Format output as json.
217
310
 
218
311
  DESCRIPTION
219
- Validate and upload repo config to the platform.
312
+ List the operations of the Zitadel API that `zitadel api` calls.
313
+
314
+ EXAMPLES
315
+ $ zitadel api ls
316
+
317
+ $ zitadel api ls passkey
318
+
319
+ $ zitadel api ls --tag Users --json
320
+
321
+ $ zitadel api ls --json | jq -r '.data.operations[] | select(.command == null) | .id'
220
322
  ```
221
323
 
222
324
  ## `zitadel auth-method passkey disable`
@@ -225,8 +327,8 @@ Disable passkey sign-in for a user schema.
225
327
 
226
328
  ```
227
329
  USAGE
228
- $ zitadel auth-method passkey disable [--json] [-c <value>] [-s <value>] [-n]
229
- [--dry-run] [-v] [--debug] [--color] [--telemetry] [--schema <value>] [-f]
330
+ $ zitadel auth-method passkey disable [-c <value>] [-s <value>] [-n] [--dry-run] [-v]
331
+ [--debug] [--color] [--telemetry] [--schema <value>] [-f]
230
332
 
231
333
  FLAGS
232
334
  -c, --cwd=<value> Project directory to operate on.
@@ -245,9 +347,6 @@ FLAGS
245
347
  --[no-]telemetry Send anonymous usage analytics. Disable with
246
348
  --no-telemetry.
247
349
 
248
- GLOBAL FLAGS
249
- --json Format output as json.
250
-
251
350
  DESCRIPTION
252
351
  Disable passkey sign-in for a user schema.
253
352
 
@@ -263,8 +362,8 @@ Enable passkey sign-in for a user schema.
263
362
 
264
363
  ```
265
364
  USAGE
266
- $ zitadel auth-method passkey enable [--json] [-c <value>] [-s <value>] [-n]
267
- [--dry-run] [-v] [--debug] [--color] [--telemetry] [--schema <value>]
365
+ $ zitadel auth-method passkey enable [-c <value>] [-s <value>] [-n] [--dry-run] [-v]
366
+ [--debug] [--color] [--telemetry] [--schema <value>]
268
367
 
269
368
  FLAGS
270
369
  -c, --cwd=<value> Project directory to operate on.
@@ -281,9 +380,6 @@ FLAGS
281
380
  --[no-]telemetry Send anonymous usage analytics. Disable with
282
381
  --no-telemetry.
283
382
 
284
- GLOBAL FLAGS
285
- --json Format output as json.
286
-
287
383
  DESCRIPTION
288
384
  Enable passkey sign-in for a user schema.
289
385
 
@@ -299,8 +395,8 @@ Disable password sign-in for a user schema.
299
395
 
300
396
  ```
301
397
  USAGE
302
- $ zitadel auth-method password disable [--json] [-c <value>] [-s <value>] [-n]
303
- [--dry-run] [-v] [--debug] [--color] [--telemetry] [--schema <value>] [-f]
398
+ $ zitadel auth-method password disable [-c <value>] [-s <value>] [-n] [--dry-run] [-v]
399
+ [--debug] [--color] [--telemetry] [--schema <value>] [-f]
304
400
 
305
401
  FLAGS
306
402
  -c, --cwd=<value> Project directory to operate on.
@@ -319,9 +415,6 @@ FLAGS
319
415
  --[no-]telemetry Send anonymous usage analytics. Disable with
320
416
  --no-telemetry.
321
417
 
322
- GLOBAL FLAGS
323
- --json Format output as json.
324
-
325
418
  DESCRIPTION
326
419
  Disable password sign-in for a user schema.
327
420
 
@@ -337,8 +430,8 @@ Enable password sign-in for a user schema.
337
430
 
338
431
  ```
339
432
  USAGE
340
- $ zitadel auth-method password enable [--json] [-c <value>] [-s <value>] [-n]
341
- [--dry-run] [-v] [--debug] [--color] [--telemetry] [--schema <value>]
433
+ $ zitadel auth-method password enable [-c <value>] [-s <value>] [-n] [--dry-run] [-v]
434
+ [--debug] [--color] [--telemetry] [--schema <value>]
342
435
 
343
436
  FLAGS
344
437
  -c, --cwd=<value> Project directory to operate on.
@@ -355,9 +448,6 @@ FLAGS
355
448
  --[no-]telemetry Send anonymous usage analytics. Disable with
356
449
  --no-telemetry.
357
450
 
358
- GLOBAL FLAGS
359
- --json Format output as json.
360
-
361
451
  DESCRIPTION
362
452
  Enable password sign-in for a user schema.
363
453
 
@@ -373,9 +463,9 @@ Remove an identity provider from a user schema.
373
463
 
374
464
  ```
375
465
  USAGE
376
- $ zitadel auth-method sso disable [--json] [-c <value>] [-s <value>] [-n]
377
- [--dry-run] [-v] [--debug] [--color] [--telemetry] [--schema <value>]
378
- [--provider <value>] [-f]
466
+ $ zitadel auth-method sso disable [-c <value>] [-s <value>] [-n] [--dry-run] [-v]
467
+ [--debug] [--color] [--telemetry] [--schema <value>] [--provider <value>]
468
+ [-f]
379
469
 
380
470
  FLAGS
381
471
  -c, --cwd=<value> Project directory to operate on.
@@ -395,9 +485,6 @@ FLAGS
395
485
  --[no-]telemetry Send anonymous usage analytics. Disable with
396
486
  --no-telemetry.
397
487
 
398
- GLOBAL FLAGS
399
- --json Format output as json.
400
-
401
488
  DESCRIPTION
402
489
  Remove an identity provider from a user schema.
403
490
 
@@ -413,13 +500,18 @@ Add an identity provider to a user schema.
413
500
 
414
501
  ```
415
502
  USAGE
416
- $ zitadel auth-method sso enable [--json] [-c <value>] [-s <value>] [-n]
417
- [--dry-run] [-v] [--debug] [--color] [--telemetry] [--schema <value>]
418
- [--provider google|custom] [--slug <value>] [--display-name <value>]
419
- [--issuer <value>] [--scopes <value>] [--client-id <value>]
503
+ $ zitadel auth-method sso enable [-c <value>] [-s <value>] [-n] [--dry-run] [-v]
504
+ [--debug] [--color] [--telemetry] [-e <value>] [--env-file <value>]
505
+ [--schema <value>] [--provider google|custom] [--slug <value>]
506
+ [--display-name <value>] [--issuer <value>] [--scopes <value>] [--client-id
507
+ <value>]
420
508
 
421
509
  FLAGS
422
510
  -c, --cwd=<value> Project directory to operate on.
511
+ -e, --env=<value> Environment to run against, e.g. production.
512
+ Defaults to ZITADEL_ENV, then the hosting
513
+ platform's build (VERCEL_ENV, or Netlify's
514
+ CONTEXT), then development.
423
515
  -n, --non-interactive Disable prompts. Required when scripting or
424
516
  running as an agent.
425
517
  -s, --server=<value> Override the resolved server URL.
@@ -432,10 +524,13 @@ FLAGS
432
524
  --display-name=<value> Name shown on the custom connection's sign-in
433
525
  button.
434
526
  --dry-run Preview without mutating files or the platform.
527
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
528
+ process environment. Cannot be combined with
529
+ --env.
435
530
  --issuer=<value> Issuer URL of the custom provider. Its endpoints
436
531
  are found by OIDC discovery.
437
- --provider=<option> Identity provider to enable, or "custom" for any
438
- other OpenID Connect provider.
532
+ --provider=<option> Identity provider to enable, or "custom" for a
533
+ custom OpenID Connect (OIDC) provider.
439
534
  <options: google|custom>
440
535
  --schema=<value> User schema to change. Required when the Project
441
536
  has more than one.
@@ -447,9 +542,6 @@ FLAGS
447
542
  --[no-]telemetry Send anonymous usage analytics. Disable with
448
543
  --no-telemetry.
449
544
 
450
- GLOBAL FLAGS
451
- --json Format output as json.
452
-
453
545
  DESCRIPTION
454
546
  Add an identity provider to a user schema.
455
547
 
@@ -536,25 +628,31 @@ Get one branding revision by id.
536
628
  ```
537
629
  USAGE
538
630
  $ zitadel branding get ID [--json] [-c <value>] [-s <value>] [-n]
539
- [--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
631
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
632
+ <value>] [--fields <value>]
540
633
 
541
634
  ARGUMENTS
542
635
  ID branding revision id
543
636
 
544
637
  FLAGS
545
- -c, --cwd=<value> Project directory to operate on.
546
- -n, --non-interactive Disable prompts. Required when scripting or running as
547
- an agent.
548
- -s, --server=<value> Override the resolved server URL.
549
- -v, --verbose Verbose logging.
550
- --[no-]color Colorize human output. Disable with --no-color;
551
- NO_COLOR and FORCE_COLOR are honored too.
552
- --debug Debug logging.
553
- --dry-run Preview without mutating files or the platform.
554
- --fields=<value> Fields to show, comma-separated dot-paths. Defaults to
555
- the resource's own; `--json` is unaffected.
556
- --[no-]telemetry Send anonymous usage analytics. Disable with
557
- --no-telemetry.
638
+ -c, --cwd=<value> Project directory to operate on.
639
+ -e, --env=<value> Environment to run against, e.g. production. Defaults
640
+ to ZITADEL_ENV, then the hosting platform's build
641
+ (VERCEL_ENV, or Netlify's CONTEXT), then development.
642
+ -n, --non-interactive Disable prompts. Required when scripting or running as
643
+ an agent.
644
+ -s, --server=<value> Override the resolved server URL.
645
+ -v, --verbose Verbose logging.
646
+ --[no-]color Colorize human output. Disable with --no-color;
647
+ NO_COLOR and FORCE_COLOR are honored too.
648
+ --debug Debug logging.
649
+ --dry-run Preview without mutating files or the platform.
650
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
651
+ process environment. Cannot be combined with --env.
652
+ --fields=<value> Fields to show, comma-separated dot-paths. Defaults to
653
+ the resource's own; `--json` is unaffected.
654
+ --[no-]telemetry Send anonymous usage analytics. Disable with
655
+ --no-telemetry.
558
656
 
559
657
  GLOBAL FLAGS
560
658
  --json Format output as json.
@@ -575,26 +673,31 @@ List branding.
575
673
  ```
576
674
  USAGE
577
675
  $ zitadel branding list [--json] [-c <value>] [-s <value>] [-n]
578
- [--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
579
- [--plain]
676
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
677
+ <value>] [--fields <value>] [--plain]
580
678
 
581
679
  FLAGS
582
- -c, --cwd=<value> Project directory to operate on.
583
- -n, --non-interactive Disable prompts. Required when scripting or running as
584
- an agent.
585
- -s, --server=<value> Override the resolved server URL.
586
- -v, --verbose Verbose logging.
587
- --[no-]color Colorize human output. Disable with --no-color;
588
- NO_COLOR and FORCE_COLOR are honored too.
589
- --debug Debug logging.
590
- --dry-run Preview without mutating files or the platform.
591
- --fields=<value> Columns to show, comma-separated dot-paths (e.g.
592
- id,attributes.email). Defaults to the resource's own
593
- columns; `--json` is unaffected.
594
- --plain Tab-separated rows with no header, for piping. Implied
595
- when stdout is not a terminal.
596
- --[no-]telemetry Send anonymous usage analytics. Disable with
597
- --no-telemetry.
680
+ -c, --cwd=<value> Project directory to operate on.
681
+ -e, --env=<value> Environment to run against, e.g. production. Defaults
682
+ to ZITADEL_ENV, then the hosting platform's build
683
+ (VERCEL_ENV, or Netlify's CONTEXT), then development.
684
+ -n, --non-interactive Disable prompts. Required when scripting or running as
685
+ an agent.
686
+ -s, --server=<value> Override the resolved server URL.
687
+ -v, --verbose Verbose logging.
688
+ --[no-]color Colorize human output. Disable with --no-color;
689
+ NO_COLOR and FORCE_COLOR are honored too.
690
+ --debug Debug logging.
691
+ --dry-run Preview without mutating files or the platform.
692
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
693
+ process environment. Cannot be combined with --env.
694
+ --fields=<value> Columns to show, comma-separated dot-paths (e.g.
695
+ id,attributes.email). Defaults to the resource's own
696
+ columns; `--json` is unaffected.
697
+ --plain Tab-separated rows with no header, for piping. Implied
698
+ when stdout is not a terminal.
699
+ --[no-]telemetry Send anonymous usage analytics. Disable with
700
+ --no-telemetry.
598
701
 
599
702
  GLOBAL FLAGS
600
703
  --json Format output as json.
@@ -613,24 +716,37 @@ Claim this project to make it permanent. Opens a browser to create an account or
613
716
  ```
614
717
  USAGE
615
718
  $ zitadel claim [--json] [-c <value>] [-s <value>] [-n]
616
- [--dry-run] [-v] [--debug] [--color] [--telemetry] [--no-open] [--timeout
719
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
720
+ <value>] [--no-open] [--no-wait | --challenge-id <value> | --timeout
617
721
  <value>]
618
722
 
619
723
  FLAGS
620
- -c, --cwd=<value> Project directory to operate on.
621
- -n, --non-interactive Disable prompts. Required when scripting or running as
622
- an agent.
623
- -s, --server=<value> Override the resolved server URL.
624
- -v, --verbose Verbose logging.
625
- --[no-]color Colorize human output. Disable with --no-color;
626
- NO_COLOR and FORCE_COLOR are honored too.
627
- --debug Debug logging.
628
- --dry-run Preview without mutating files or the platform.
629
- --no-open Print the link instead of opening a browser.
630
- --[no-]telemetry Send anonymous usage analytics. Disable with
631
- --no-telemetry.
632
- --timeout=<value> Seconds to wait for the browser step. Defaults to the
633
- link's own expiry (10 minutes).
724
+ -c, --cwd=<value> Project directory to operate on.
725
+ -e, --env=<value> Environment to run against, e.g. production.
726
+ Defaults to ZITADEL_ENV, then the hosting
727
+ platform's build (VERCEL_ENV, or Netlify's
728
+ CONTEXT), then development.
729
+ -n, --non-interactive Disable prompts. Required when scripting or
730
+ running as an agent.
731
+ -s, --server=<value> Override the resolved server URL.
732
+ -v, --verbose Verbose logging.
733
+ --challenge-id=<value> Wait for the link a --no-wait run printed, instead
734
+ of creating a new one.
735
+ --[no-]color Colorize human output. Disable with --no-color;
736
+ NO_COLOR and FORCE_COLOR are honored too.
737
+ --debug Debug logging.
738
+ --dry-run Preview without mutating files or the platform.
739
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
740
+ process environment. Cannot be combined with
741
+ --env.
742
+ --no-open Print the link instead of opening a browser.
743
+ --no-wait Print the link and exit, without opening a browser
744
+ or waiting for the browser step. The result names
745
+ the command that waits for it.
746
+ --[no-]telemetry Send anonymous usage analytics. Disable with
747
+ --no-telemetry.
748
+ --timeout=<value> Seconds to wait for the browser step. Defaults to
749
+ the link's own expiry (10 minutes).
634
750
 
635
751
  GLOBAL FLAGS
636
752
  --json Format output as json.
@@ -645,6 +761,10 @@ EXAMPLES
645
761
  $ zitadel claim --no-open
646
762
 
647
763
  $ zitadel claim --timeout 120
764
+
765
+ $ zitadel claim --no-wait
766
+
767
+ $ zitadel claim --challenge-id ch_01J0Z9KX7Y0Q2Y7JX5M9K2YF3C
648
768
  ```
649
769
 
650
770
  ## `zitadel commands`
@@ -679,7 +799,7 @@ _See code: [@oclif/plugin-commands](https://github.com/oclif/plugin-commands/blo
679
799
 
680
800
  ## `zitadel console`
681
801
 
682
- Open the local console, signed in as the local admin created by `zitadel start`.
802
+ Open the local console, signed in as the local admin.
683
803
 
684
804
  ```
685
805
  USAGE
@@ -704,11 +824,11 @@ GLOBAL FLAGS
704
824
  --json Format output as json.
705
825
 
706
826
  DESCRIPTION
707
- Open the local console, signed in as the local admin created by `zitadel
708
- start`.
827
+ Open the local console, signed in as the local admin.
709
828
 
710
- Run it in the directory `zitadel start` ran in, or one inside it: the local
711
- admin is read from the nearest `.zitadel/local/` on the way up.
829
+ The local admin is the one `zitadel start` created. Run this in the directory
830
+ `zitadel start` ran in, or one inside it: the local admin is read from the
831
+ nearest `.zitadel/local/` on the way up.
712
832
 
713
833
  EXAMPLES
714
834
  $ zitadel console
@@ -716,18 +836,22 @@ EXAMPLES
716
836
  $ zitadel console --no-open
717
837
  ```
718
838
 
719
- ## `zitadel doctor`
839
+ ## `zitadel deploy`
720
840
 
721
- Verify local runtime and project state.
841
+ Apply your local configuration to Zitadel.
722
842
 
723
843
  ```
724
844
  USAGE
725
- $ zitadel doctor [--json] [-c <value>] [-s <value>] [-n]
726
- [--dry-run] [-v] [--debug] [--color] [--telemetry] [--fix] [--image <value>]
727
- [--port <value>] [--runtime binary|docker]
845
+ $ zitadel deploy [--json] [-c <value>] [-s <value>] [-n]
846
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
847
+ <value>] [-m <value>]
728
848
 
729
849
  FLAGS
730
850
  -c, --cwd=<value> Project directory to operate on.
851
+ -e, --env=<value> Environment to run against, e.g. production. Defaults
852
+ to ZITADEL_ENV, then the hosting platform's build
853
+ (VERCEL_ENV, or Netlify's CONTEXT), then development.
854
+ -m, --message=<value> A short summary of what this release changes.
731
855
  -n, --non-interactive Disable prompts. Required when scripting or running as
732
856
  an agent.
733
857
  -s, --server=<value> Override the resolved server URL.
@@ -736,12 +860,8 @@ FLAGS
736
860
  NO_COLOR and FORCE_COLOR are honored too.
737
861
  --debug Debug logging.
738
862
  --dry-run Preview without mutating files or the platform.
739
- --fix Repair missing files and stale managed wiring.
740
- --image=<value> Container image to check.
741
- --port=<value> Local HTTP port to check. Defaults to the port this
742
- directory's server uses.
743
- --runtime=<option> Local runtime backend.
744
- <options: binary|docker>
863
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
864
+ process environment. Cannot be combined with --env.
745
865
  --[no-]telemetry Send anonymous usage analytics. Disable with
746
866
  --no-telemetry.
747
867
 
@@ -749,175 +869,252 @@ GLOBAL FLAGS
749
869
  --json Format output as json.
750
870
 
751
871
  DESCRIPTION
752
- Verify local runtime and project state.
872
+ Apply your local configuration to Zitadel.
873
+
874
+ Builds a release from .zitadel/ and deploys it to the project. Use --dry-run
875
+ to preview what would change.
876
+
877
+ EXAMPLES
878
+ $ zitadel deploy -m 'add phone_number to human-user'
879
+
880
+ $ zitadel deploy --dry-run
753
881
  ```
754
882
 
755
- ## `zitadel eject`
883
+ ## `zitadel deployment create`
756
884
 
757
- Remove managed files and local Zitadel state.
885
+ Deploy an existing release to the project's origins.
758
886
 
759
887
  ```
760
888
  USAGE
761
- $ zitadel eject [--json] [-c <value>] [-s <value>] [-n]
762
- [--dry-run] [-v] [--debug] [--color] [--telemetry] [-f]
889
+ $ zitadel deployment create --release <value> [--json] [-c <value>] [-s
890
+ <value>] [-n] [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e
891
+ <value>] [--env-file <value>] [-m <value>]
763
892
 
764
893
  FLAGS
765
- -c, --cwd=<value> Project directory to operate on.
766
- -f, --force Remove the managed files without the confirmation
767
- prompt.
768
- -n, --non-interactive Disable prompts. Required when scripting or running as
769
- an agent.
770
- -s, --server=<value> Override the resolved server URL.
771
- -v, --verbose Verbose logging.
772
- --[no-]color Colorize human output. Disable with --no-color;
773
- NO_COLOR and FORCE_COLOR are honored too.
774
- --debug Debug logging.
775
- --dry-run Preview without mutating files or the platform.
776
- --[no-]telemetry Send anonymous usage analytics. Disable with
777
- --no-telemetry.
894
+ -c, --cwd=<value> Project directory to operate on.
895
+ -e, --env=<value> Environment to run against, e.g. production. Defaults
896
+ to ZITADEL_ENV, then the hosting platform's build
897
+ (VERCEL_ENV, or Netlify's CONTEXT), then development.
898
+ -m, --message=<value> A short summary of why this deploys.
899
+ -n, --non-interactive Disable prompts. Required when scripting or running as
900
+ an agent.
901
+ -s, --server=<value> Override the resolved server URL.
902
+ -v, --verbose Verbose logging.
903
+ --[no-]color Colorize human output. Disable with --no-color;
904
+ NO_COLOR and FORCE_COLOR are honored too.
905
+ --debug Debug logging.
906
+ --dry-run Preview without mutating files or the platform.
907
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
908
+ process environment. Cannot be combined with --env.
909
+ --release=<value> (required) The release id to deploy.
910
+ --[no-]telemetry Send anonymous usage analytics. Disable with
911
+ --no-telemetry.
778
912
 
779
913
  GLOBAL FLAGS
780
914
  --json Format output as json.
781
915
 
782
916
  DESCRIPTION
783
- Remove managed files and local Zitadel state.
917
+ Deploy an existing release to the project's origins.
784
918
 
785
- ALIASES
786
- $ zitadel uninstall
919
+ EXAMPLES
920
+ $ zitadel deployment create --release rel_01KX3RG8A7F0N9WD3P2E4YM5C1
787
921
  ```
788
922
 
789
- ## `zitadel events get ID`
923
+ ## `zitadel deployment get DEPLOYMENT_ID`
790
924
 
791
- Get one event by id.
925
+ Read one deployment by id.
792
926
 
793
927
  ```
794
928
  USAGE
795
- $ zitadel events get ID [--json] [-c <value>] [-s <value>] [-n]
796
- [--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
929
+ $ zitadel deployment get DEPLOYMENT_ID [--json] [-c <value>] [-s <value>]
930
+ [-n] [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>]
931
+ [--env-file <value>]
797
932
 
798
933
  ARGUMENTS
799
- ID event id
934
+ DEPLOYMENT_ID The deployment to read.
800
935
 
801
936
  FLAGS
802
- -c, --cwd=<value> Project directory to operate on.
803
- -n, --non-interactive Disable prompts. Required when scripting or running as
804
- an agent.
805
- -s, --server=<value> Override the resolved server URL.
806
- -v, --verbose Verbose logging.
807
- --[no-]color Colorize human output. Disable with --no-color;
808
- NO_COLOR and FORCE_COLOR are honored too.
809
- --debug Debug logging.
810
- --dry-run Preview without mutating files or the platform.
811
- --fields=<value> Fields to show, comma-separated dot-paths. Defaults to
812
- the resource's own; `--json` is unaffected.
813
- --[no-]telemetry Send anonymous usage analytics. Disable with
814
- --no-telemetry.
937
+ -c, --cwd=<value> Project directory to operate on.
938
+ -e, --env=<value> Environment to run against, e.g. production. Defaults
939
+ to ZITADEL_ENV, then the hosting platform's build
940
+ (VERCEL_ENV, or Netlify's CONTEXT), then development.
941
+ -n, --non-interactive Disable prompts. Required when scripting or running as
942
+ an agent.
943
+ -s, --server=<value> Override the resolved server URL.
944
+ -v, --verbose Verbose logging.
945
+ --[no-]color Colorize human output. Disable with --no-color;
946
+ NO_COLOR and FORCE_COLOR are honored too.
947
+ --debug Debug logging.
948
+ --dry-run Preview without mutating files or the platform.
949
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
950
+ process environment. Cannot be combined with --env.
951
+ --[no-]telemetry Send anonymous usage analytics. Disable with
952
+ --no-telemetry.
815
953
 
816
954
  GLOBAL FLAGS
817
955
  --json Format output as json.
818
956
 
819
957
  DESCRIPTION
820
- Get one event by id.
958
+ Read one deployment by id.
821
959
 
822
960
  EXAMPLES
823
- $ zitadel events get <id>
824
-
825
- $ zitadel events get <id> --json
961
+ $ zitadel deployment get dep_01KX5N7C9D2E7F0N9WD3P2E4YM6
826
962
  ```
827
963
 
828
- ## `zitadel events list`
964
+ ## `zitadel deployment list`
829
965
 
830
- List events.
966
+ List the project's deployments, newest first.
831
967
 
832
968
  ```
833
969
  USAGE
834
- $ zitadel events list [--json] [-c <value>] [-s <value>] [-n]
835
- [--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
836
- --page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
837
- [--sort <value>]
970
+ $ zitadel deployment list [--json] [-c <value>] [-s <value>] [-n]
971
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
972
+ <value>] [--origin <value>] [--live] [--limit <value>] [-a | --page-token
973
+ <value>] [--plain]
838
974
 
839
975
  FLAGS
840
- -a, --all
841
- Fetch every page instead of one.
842
-
843
- -c, --cwd=<value>
844
- Project directory to operate on.
976
+ -a, --all Fetch every page instead of one.
977
+ -c, --cwd=<value> Project directory to operate on.
978
+ -e, --env=<value> Environment to run against, e.g. production.
979
+ Defaults to ZITADEL_ENV, then the hosting platform's
980
+ build (VERCEL_ENV, or Netlify's CONTEXT), then
981
+ development.
982
+ -n, --non-interactive Disable prompts. Required when scripting or running
983
+ as an agent.
984
+ -s, --server=<value> Override the resolved server URL.
985
+ -v, --verbose Verbose logging.
986
+ --[no-]color Colorize human output. Disable with --no-color;
987
+ NO_COLOR and FORCE_COLOR are honored too.
988
+ --debug Debug logging.
989
+ --dry-run Preview without mutating files or the platform.
990
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
991
+ process environment. Cannot be combined with --env.
992
+ --limit=<value> Page size (server default 20, max 100).
993
+ --live What each target serves now, not the full history.
994
+ --origin=<value> Only deployments that targeted this origin.
995
+ --page-token=<value> Continue from a previous page's next_page_token.
996
+ --plain Tab-separated rows with no header, for piping.
997
+ Implied when stdout is not a terminal.
998
+ --[no-]telemetry Send anonymous usage analytics. Disable with
999
+ --no-telemetry.
845
1000
 
846
- -n, --non-interactive
847
- Disable prompts. Required when scripting or running as an agent.
1001
+ GLOBAL FLAGS
1002
+ --json Format output as json.
848
1003
 
849
- -s, --server=<value>
850
- Override the resolved server URL.
1004
+ DESCRIPTION
1005
+ List the project's deployments, newest first.
851
1006
 
852
- -v, --verbose
853
- Verbose logging.
1007
+ EXAMPLES
1008
+ $ zitadel deployment list
854
1009
 
855
- --[no-]color
856
- Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are
857
- honored too.
1010
+ $ zitadel deployment list --all
858
1011
 
859
- --debug
860
- Debug logging.
1012
+ $ zitadel deployment list --live
861
1013
 
862
- --dry-run
863
- Preview without mutating files or the platform.
1014
+ $ zitadel deployment list --origin https://app.acme.com
1015
+ ```
864
1016
 
865
- --fields=<value>
866
- Columns to show, comma-separated dot-paths (e.g. id,attributes.email).
867
- Defaults to the resource's own columns; `--json` is unaffected.
1017
+ ## `zitadel deployment rollback [DEPLOYMENT_ID]`
868
1018
 
869
- --filter=<value>...
870
- Filter as field=operation:value (operation defaults to equals). Fields:
871
- category (equals; values request|auth|session|admin|entity|signal; repeats
872
- widen), event_type (equals; repeats widen), actor_id (equals), session_id
873
- (equals), flow_id (equals), request_id (equals), entity_type (equals),
874
- entity_id (equals), team_id (equals), created_at
875
- (greater_than_or_equal|less_than).
1019
+ Roll back to an earlier deployment.
876
1020
 
877
- --limit=<value>
878
- Page size (server default 20, max 100).
1021
+ ```
1022
+ USAGE
1023
+ $ zitadel deployment rollback [DEPLOYMENT_ID] [--json] [-c <value>] [-s
1024
+ <value>] [-n] [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e
1025
+ <value>] [--env-file <value>] [-f]
879
1026
 
880
- --page-token=<value>
881
- Continue from a previous page's next_page_token.
1027
+ ARGUMENTS
1028
+ [DEPLOYMENT_ID] The deployment to re-apply. Omit to undo the last deploy.
882
1029
 
883
- --plain
884
- Tab-separated rows with no header, for piping. Implied when stdout is not a
885
- terminal.
886
-
887
- --sort=<value>
888
- Sort as field:direction (asc|desc). Fields: occurred_at.
889
-
890
- --[no-]telemetry
891
- Send anonymous usage analytics. Disable with --no-telemetry.
1030
+ FLAGS
1031
+ -c, --cwd=<value> Project directory to operate on.
1032
+ -e, --env=<value> Environment to run against, e.g. production. Defaults
1033
+ to ZITADEL_ENV, then the hosting platform's build
1034
+ (VERCEL_ENV, or Netlify's CONTEXT), then development.
1035
+ -f, --force Roll back without the confirmation prompt. Required
1036
+ when non-interactive.
1037
+ -n, --non-interactive Disable prompts. Required when scripting or running as
1038
+ an agent.
1039
+ -s, --server=<value> Override the resolved server URL.
1040
+ -v, --verbose Verbose logging.
1041
+ --[no-]color Colorize human output. Disable with --no-color;
1042
+ NO_COLOR and FORCE_COLOR are honored too.
1043
+ --debug Debug logging.
1044
+ --dry-run Preview without mutating files or the platform.
1045
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
1046
+ process environment. Cannot be combined with --env.
1047
+ --[no-]telemetry Send anonymous usage analytics. Disable with
1048
+ --no-telemetry.
892
1049
 
893
1050
  GLOBAL FLAGS
894
1051
  --json Format output as json.
895
1052
 
896
1053
  DESCRIPTION
897
- List events.
1054
+ Roll back to an earlier deployment.
898
1055
 
899
1056
  EXAMPLES
900
- $ zitadel events list --json
1057
+ $ zitadel deployment rollback
901
1058
 
902
- $ zitadel events list --all --json
1059
+ $ zitadel deployment rollback dep_01KX5N7C9D2E7F0N9WD3P2E4YM6
903
1060
 
904
- $ zitadel events list --filter category=equals:<value> --sort occurred_at:desc
1061
+ $ zitadel deployment rollback --force
905
1062
  ```
906
1063
 
907
- ## `zitadel flow-definitions get FLOW`
1064
+ ## `zitadel doctor`
908
1065
 
909
- Get one flow definition by id.
1066
+ Verify local runtime and project state.
910
1067
 
911
1068
  ```
912
1069
  USAGE
913
- $ zitadel flow-definitions get FLOW [--json] [-c <value>] [-s <value>] [-n]
914
- [--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
1070
+ $ zitadel doctor [--json] [-c <value>] [-s <value>] [-n]
1071
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--fix] [--image <value>]
1072
+ [--port <value>] [--runtime binary|docker] [-e <value>] [--env-file <value>]
915
1073
 
916
- ARGUMENTS
917
- FLOW flow name (newest revision) or revision id
1074
+ FLAGS
1075
+ -c, --cwd=<value> Project directory to operate on.
1076
+ -e, --env=<value> Environment to run against, e.g. production. Defaults
1077
+ to ZITADEL_ENV, then the hosting platform's build
1078
+ (VERCEL_ENV, or Netlify's CONTEXT), then development.
1079
+ -n, --non-interactive Disable prompts. Required when scripting or running as
1080
+ an agent.
1081
+ -s, --server=<value> Override the resolved server URL.
1082
+ -v, --verbose Verbose logging.
1083
+ --[no-]color Colorize human output. Disable with --no-color;
1084
+ NO_COLOR and FORCE_COLOR are honored too.
1085
+ --debug Debug logging.
1086
+ --dry-run Preview without mutating files or the platform.
1087
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
1088
+ process environment. Cannot be combined with --env.
1089
+ --fix Repair missing files and stale managed wiring.
1090
+ --image=<value> Container image to check.
1091
+ --port=<value> Local HTTP port to check. Defaults to the port this
1092
+ directory's server uses.
1093
+ --runtime=<option> Local runtime backend.
1094
+ <options: binary|docker>
1095
+ --[no-]telemetry Send anonymous usage analytics. Disable with
1096
+ --no-telemetry.
1097
+
1098
+ GLOBAL FLAGS
1099
+ --json Format output as json.
1100
+
1101
+ DESCRIPTION
1102
+ Verify local runtime and project state.
1103
+ ```
1104
+
1105
+ ## `zitadel eject`
1106
+
1107
+ Remove managed files and local Zitadel state.
1108
+
1109
+ ```
1110
+ USAGE
1111
+ $ zitadel eject [--json] [-c <value>] [-s <value>] [-n]
1112
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-f]
918
1113
 
919
1114
  FLAGS
920
1115
  -c, --cwd=<value> Project directory to operate on.
1116
+ -f, --force Remove the managed files without the confirmation
1117
+ prompt.
921
1118
  -n, --non-interactive Disable prompts. Required when scripting or running as
922
1119
  an agent.
923
1120
  -s, --server=<value> Override the resolved server URL.
@@ -926,8 +1123,6 @@ FLAGS
926
1123
  NO_COLOR and FORCE_COLOR are honored too.
927
1124
  --debug Debug logging.
928
1125
  --dry-run Preview without mutating files or the platform.
929
- --fields=<value> Fields to show, comma-separated dot-paths. Defaults to
930
- the resource's own; `--json` is unaffected.
931
1126
  --[no-]telemetry Send anonymous usage analytics. Disable with
932
1127
  --no-telemetry.
933
1128
 
@@ -935,73 +1130,66 @@ GLOBAL FLAGS
935
1130
  --json Format output as json.
936
1131
 
937
1132
  DESCRIPTION
938
- Get one flow definition by id.
939
-
940
- EXAMPLES
941
- $ zitadel flow-definitions get <id>
1133
+ Remove managed files and local Zitadel state.
942
1134
 
943
- $ zitadel flow-definitions get <id> --json
1135
+ ALIASES
1136
+ $ zitadel uninstall
944
1137
  ```
945
1138
 
946
- ## `zitadel flow-definitions list`
1139
+ ## `zitadel env`
947
1140
 
948
- List flow-definitions.
1141
+ Show which server and project resolve, and where each value came from.
949
1142
 
950
1143
  ```
951
1144
  USAGE
952
- $ zitadel flow-definitions list [--json] [-c <value>] [-s <value>] [-n]
953
- [--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
954
- --page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
1145
+ $ zitadel env [--json] [-c <value>] [-s <value>] [-n]
1146
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
1147
+ <value>]
955
1148
 
956
1149
  FLAGS
957
- -a, --all Fetch every page instead of one.
958
- -c, --cwd=<value> Project directory to operate on.
959
- -n, --non-interactive Disable prompts. Required when scripting or running
960
- as an agent.
961
- -s, --server=<value> Override the resolved server URL.
962
- -v, --verbose Verbose logging.
963
- --[no-]color Colorize human output. Disable with --no-color;
964
- NO_COLOR and FORCE_COLOR are honored too.
965
- --debug Debug logging.
966
- --dry-run Preview without mutating files or the platform.
967
- --fields=<value> Columns to show, comma-separated dot-paths (e.g.
968
- id,attributes.email). Defaults to the resource's own
969
- columns; `--json` is unaffected.
970
- --filter=<value>... Filter as field=operation:value (operation defaults
971
- to equals). Fields: name (equals), purpose (equals),
972
- revisions (equals; values all|latest).
973
- --limit=<value> Page size (server default 20, max 100).
974
- --page-token=<value> Continue from a previous page's next_page_token.
975
- --plain Tab-separated rows with no header, for piping.
976
- Implied when stdout is not a terminal.
977
- --[no-]telemetry Send anonymous usage analytics. Disable with
978
- --no-telemetry.
1150
+ -c, --cwd=<value> Project directory to operate on.
1151
+ -e, --env=<value> Environment to run against, e.g. production. Defaults
1152
+ to ZITADEL_ENV, then the hosting platform's build
1153
+ (VERCEL_ENV, or Netlify's CONTEXT), then development.
1154
+ -n, --non-interactive Disable prompts. Required when scripting or running as
1155
+ an agent.
1156
+ -s, --server=<value> Override the resolved server URL.
1157
+ -v, --verbose Verbose logging.
1158
+ --[no-]color Colorize human output. Disable with --no-color;
1159
+ NO_COLOR and FORCE_COLOR are honored too.
1160
+ --debug Debug logging.
1161
+ --dry-run Preview without mutating files or the platform.
1162
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
1163
+ process environment. Cannot be combined with --env.
1164
+ --[no-]telemetry Send anonymous usage analytics. Disable with
1165
+ --no-telemetry.
979
1166
 
980
1167
  GLOBAL FLAGS
981
1168
  --json Format output as json.
982
1169
 
983
1170
  DESCRIPTION
984
- List flow-definitions.
1171
+ Show which server and project resolve, and where each value came from.
985
1172
 
986
1173
  EXAMPLES
987
- $ zitadel flow-definitions list --json
1174
+ $ zitadel env
988
1175
 
989
- $ zitadel flow-definitions list --all --json
1176
+ $ zitadel env --env production
990
1177
 
991
- $ zitadel flow-definitions list --filter name=equals:<value>
1178
+ $ zitadel env --env-file ./infra/acme-staging.env
992
1179
  ```
993
1180
 
994
- ## `zitadel grants create`
1181
+ ## `zitadel env add NAME`
995
1182
 
996
- Create a grant.
1183
+ Bind an environment to a project, creating the project if needed.
997
1184
 
998
1185
  ```
999
1186
  USAGE
1000
- $ zitadel grants create [--json] [-c <value>] [-s <value>] [-n]
1001
- [--dry-run] [-v] [--debug] [--color] [--telemetry] [--relation
1002
- viewer|editor|admin] [--expires-at <value>] [--user-user-id <value>]
1003
- [--user-identifier <value>] [--team-team-id <value>] [--team-name <value>]
1004
- [--data <value> | --file <value>] [--set <value>...]
1187
+ $ zitadel env add NAME [--json] [-c <value>] [-s <value>] [-n]
1188
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--project <value>]
1189
+ [--app-url <value>] [--force]
1190
+
1191
+ ARGUMENTS
1192
+ NAME The environment name, e.g. production.
1005
1193
 
1006
1194
  FLAGS
1007
1195
  -c, --cwd=<value> Project directory to operate on.
@@ -1009,140 +1197,129 @@ FLAGS
1009
1197
  an agent.
1010
1198
  -s, --server=<value> Override the resolved server URL.
1011
1199
  -v, --verbose Verbose logging.
1200
+ --app-url=<value> The URL this environment's app is served from. It
1201
+ becomes ZITADEL_ISSUER and is registered with a new
1202
+ project.
1012
1203
  --[no-]color Colorize human output. Disable with --no-color;
1013
1204
  NO_COLOR and FORCE_COLOR are honored too.
1014
1205
  --debug Debug logging.
1015
1206
  --dry-run Preview without mutating files or the platform.
1207
+ --force Overwrite an existing .env.<name>.local.
1208
+ --project=<value> Bind this existing project instead of creating one. Its
1209
+ secrets come from ZITADEL_PROJECT_SECRET and
1210
+ ZITADEL_PREVIEW_TOKEN in the process environment.
1016
1211
  --[no-]telemetry Send anonymous usage analytics. Disable with
1017
1212
  --no-telemetry.
1018
1213
 
1019
- RAW BODY FLAGS
1020
- --data=<value> Whole body as a JSON object. Field flags and --set apply
1021
- over it.
1022
- --file=<value> Read the body from a JSON file; `-` reads stdin. Field flags
1023
- and --set apply over it.
1024
- --set=<value>... Set one field by its dot path: path=value, or path:=json for
1025
- JSON. Repeatable; applied after the field flags, in order. A
1026
- key that contains a dot is set through its parent: --set
1027
- 'parent:={"a.b":"x"}'.
1028
-
1029
- OPTIONAL FIELD FLAGS
1030
- --expires-at=<value> Optional expiry.
1031
-
1032
1214
  GLOBAL FLAGS
1033
1215
  --json Format output as json.
1034
1216
 
1035
- REQUIRED FIELD FLAGS
1036
- --relation=<option> (required) Catalog relation on `object_type` `project`.
1037
- <options: viewer|editor|admin>
1038
-
1039
- TEAM FIELD FLAGS
1040
- --team-name=<value> Team name, unique per project case-insensitively.
1041
- --team-team-id=<value>
1042
-
1043
- USER FIELD FLAGS
1044
- --user-identifier=<value> The user schema's designated identifier
1045
- (`x-identifier`), looked up in the platform
1046
- project.
1047
- --user-user-id=<value>
1048
-
1049
1217
  DESCRIPTION
1050
- Create a grant.
1218
+ Bind an environment to a project, creating the project if needed.
1051
1219
 
1052
1220
  EXAMPLES
1053
- $ zitadel grants create --relation viewer --user-identifier alice@acme.com --json
1221
+ $ zitadel env add production --server https://api.zitadel.cloud --app-url https://app.acme.com
1054
1222
 
1055
- $ zitadel grants create --data '{...}' --json
1056
-
1057
- $ zitadel grants create --file ./grant.json
1223
+ $ zitadel env add staging --server https://api.zitadel.cloud --project proj_01K9AA9M3K7E2QX8VB4T
1058
1224
  ```
1059
1225
 
1060
- ## `zitadel grants delete ID`
1226
+ ## `zitadel env list`
1061
1227
 
1062
- Delete a grant by id.
1228
+ List the environments bound in this directory's .env files.
1063
1229
 
1064
1230
  ```
1065
1231
  USAGE
1066
- $ zitadel grants delete ID [--json] [-c <value>] [-s <value>] [-n]
1067
- [--dry-run] [-v] [--debug] [--color] [--telemetry] [-f]
1068
-
1069
- ARGUMENTS
1070
- ID grant id
1232
+ $ zitadel env list [--json] [-c <value>] [-s <value>] [-n]
1233
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
1234
+ <value>] [--plain]
1071
1235
 
1072
1236
  FLAGS
1073
- -c, --cwd=<value> Project directory to operate on.
1074
- -f, --force Delete the grant without the confirmation prompt.
1075
- Required when non-interactive.
1076
- -n, --non-interactive Disable prompts. Required when scripting or running as
1077
- an agent.
1078
- -s, --server=<value> Override the resolved server URL.
1079
- -v, --verbose Verbose logging.
1080
- --[no-]color Colorize human output. Disable with --no-color;
1081
- NO_COLOR and FORCE_COLOR are honored too.
1082
- --debug Debug logging.
1083
- --dry-run Preview without mutating files or the platform.
1084
- --[no-]telemetry Send anonymous usage analytics. Disable with
1085
- --no-telemetry.
1237
+ -c, --cwd=<value> Project directory to operate on.
1238
+ -e, --env=<value> Environment to run against, e.g. production. Defaults
1239
+ to ZITADEL_ENV, then the hosting platform's build
1240
+ (VERCEL_ENV, or Netlify's CONTEXT), then development.
1241
+ -n, --non-interactive Disable prompts. Required when scripting or running as
1242
+ an agent.
1243
+ -s, --server=<value> Override the resolved server URL.
1244
+ -v, --verbose Verbose logging.
1245
+ --[no-]color Colorize human output. Disable with --no-color;
1246
+ NO_COLOR and FORCE_COLOR are honored too.
1247
+ --debug Debug logging.
1248
+ --dry-run Preview without mutating files or the platform.
1249
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
1250
+ process environment. Cannot be combined with --env.
1251
+ --plain Tab-separated rows with no header, for piping. Implied
1252
+ when stdout is not a terminal.
1253
+ --[no-]telemetry Send anonymous usage analytics. Disable with
1254
+ --no-telemetry.
1086
1255
 
1087
1256
  GLOBAL FLAGS
1088
1257
  --json Format output as json.
1089
1258
 
1090
1259
  DESCRIPTION
1091
- Delete a grant by id.
1260
+ List the environments bound in this directory's .env files.
1092
1261
 
1093
1262
  EXAMPLES
1094
- $ zitadel grants delete <id> --force --json
1263
+ $ zitadel env list
1264
+
1265
+ $ zitadel env list --plain
1095
1266
  ```
1096
1267
 
1097
- ## `zitadel grants get ID`
1268
+ ## `zitadel events get ID`
1098
1269
 
1099
- Get one grant by id.
1270
+ Get one event by id.
1100
1271
 
1101
1272
  ```
1102
1273
  USAGE
1103
- $ zitadel grants get ID [--json] [-c <value>] [-s <value>] [-n]
1104
- [--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
1274
+ $ zitadel events get ID [--json] [-c <value>] [-s <value>] [-n]
1275
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
1276
+ <value>] [--fields <value>]
1105
1277
 
1106
1278
  ARGUMENTS
1107
- ID grant id
1279
+ ID event id
1108
1280
 
1109
1281
  FLAGS
1110
- -c, --cwd=<value> Project directory to operate on.
1111
- -n, --non-interactive Disable prompts. Required when scripting or running as
1112
- an agent.
1113
- -s, --server=<value> Override the resolved server URL.
1114
- -v, --verbose Verbose logging.
1115
- --[no-]color Colorize human output. Disable with --no-color;
1116
- NO_COLOR and FORCE_COLOR are honored too.
1117
- --debug Debug logging.
1118
- --dry-run Preview without mutating files or the platform.
1119
- --fields=<value> Fields to show, comma-separated dot-paths. Defaults to
1120
- the resource's own; `--json` is unaffected.
1121
- --[no-]telemetry Send anonymous usage analytics. Disable with
1122
- --no-telemetry.
1282
+ -c, --cwd=<value> Project directory to operate on.
1283
+ -e, --env=<value> Environment to run against, e.g. production. Defaults
1284
+ to ZITADEL_ENV, then the hosting platform's build
1285
+ (VERCEL_ENV, or Netlify's CONTEXT), then development.
1286
+ -n, --non-interactive Disable prompts. Required when scripting or running as
1287
+ an agent.
1288
+ -s, --server=<value> Override the resolved server URL.
1289
+ -v, --verbose Verbose logging.
1290
+ --[no-]color Colorize human output. Disable with --no-color;
1291
+ NO_COLOR and FORCE_COLOR are honored too.
1292
+ --debug Debug logging.
1293
+ --dry-run Preview without mutating files or the platform.
1294
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
1295
+ process environment. Cannot be combined with --env.
1296
+ --fields=<value> Fields to show, comma-separated dot-paths. Defaults to
1297
+ the resource's own; `--json` is unaffected.
1298
+ --[no-]telemetry Send anonymous usage analytics. Disable with
1299
+ --no-telemetry.
1123
1300
 
1124
1301
  GLOBAL FLAGS
1125
1302
  --json Format output as json.
1126
1303
 
1127
1304
  DESCRIPTION
1128
- Get one grant by id.
1305
+ Get one event by id.
1129
1306
 
1130
1307
  EXAMPLES
1131
- $ zitadel grants get <id>
1308
+ $ zitadel events get <id>
1132
1309
 
1133
- $ zitadel grants get <id> --json
1310
+ $ zitadel events get <id> --json
1134
1311
  ```
1135
1312
 
1136
- ## `zitadel grants list`
1313
+ ## `zitadel events list`
1137
1314
 
1138
- List grants.
1315
+ List events.
1139
1316
 
1140
1317
  ```
1141
1318
  USAGE
1142
- $ zitadel grants list [--json] [-c <value>] [-s <value>] [-n]
1143
- [--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
1144
- --page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
1145
- [--sort <value>]
1319
+ $ zitadel events list [--json] [-c <value>] [-s <value>] [-n]
1320
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
1321
+ <value>] [--limit <value>] [-a | --page-token <value>] [--fields <value>]
1322
+ [--plain] [--filter <value>...] [--sort <value>]
1146
1323
 
1147
1324
  FLAGS
1148
1325
  -a, --all
@@ -1151,6 +1328,11 @@ FLAGS
1151
1328
  -c, --cwd=<value>
1152
1329
  Project directory to operate on.
1153
1330
 
1331
+ -e, --env=<value>
1332
+ Environment to run against, e.g. production. Defaults to ZITADEL_ENV, then
1333
+ the hosting platform's build (VERCEL_ENV, or Netlify's CONTEXT), then
1334
+ development.
1335
+
1154
1336
  -n, --non-interactive
1155
1337
  Disable prompts. Required when scripting or running as an agent.
1156
1338
 
@@ -1170,21 +1352,21 @@ FLAGS
1170
1352
  --dry-run
1171
1353
  Preview without mutating files or the platform.
1172
1354
 
1355
+ --env-file=<value>
1356
+ Read ZITADEL_* values from this file ahead of the process environment.
1357
+ Cannot be combined with --env.
1358
+
1173
1359
  --fields=<value>
1174
1360
  Columns to show, comma-separated dot-paths (e.g. id,attributes.email).
1175
1361
  Defaults to the resource's own columns; `--json` is unaffected.
1176
1362
 
1177
1363
  --filter=<value>...
1178
1364
  Filter as field=operation:value (operation defaults to equals). Fields:
1179
- created_at (equals|not_equals|contains|not_contains|less_than|less_than_or_e
1180
- qual|greater_than|greater_than_or_equal), user_id
1181
- (equals|not_equals|contains|not_contains|less_than|less_than_or_equal|greate
1182
- r_than|greater_than_or_equal), team_id (equals|not_equals|contains|not_conta
1183
- ins|less_than|less_than_or_equal|greater_than|greater_than_or_equal),
1184
- relation (equals|not_equals|contains|not_contains|less_than|less_than_or_equ
1185
- al|greater_than|greater_than_or_equal), expires_at
1186
- (equals|not_equals|contains|not_contains|less_than|less_than_or_equal|greate
1187
- r_than|greater_than_or_equal).
1365
+ category (equals; values request|auth|session|admin|entity|signal; repeats
1366
+ widen), event_type (equals; repeats widen), actor_id (equals), session_id
1367
+ (equals), flow_id (equals), request_id (equals), entity_type (equals),
1368
+ entity_id (equals), team_id (equals), created_at
1369
+ (greater_than_or_equal|less_than).
1188
1370
 
1189
1371
  --limit=<value>
1190
1372
  Page size (server default 20, max 100).
@@ -1197,7 +1379,7 @@ FLAGS
1197
1379
  terminal.
1198
1380
 
1199
1381
  --sort=<value>
1200
- Sort as field:direction (asc|desc). Fields: created_at, expires_at, id.
1382
+ Sort as field:direction (asc|desc). Fields: occurred_at.
1201
1383
 
1202
1384
  --[no-]telemetry
1203
1385
  Send anonymous usage analytics. Disable with --no-telemetry.
@@ -1206,23 +1388,375 @@ GLOBAL FLAGS
1206
1388
  --json Format output as json.
1207
1389
 
1208
1390
  DESCRIPTION
1209
- List grants.
1391
+ List events.
1210
1392
 
1211
1393
  EXAMPLES
1212
- $ zitadel grants list --json
1394
+ $ zitadel events list --json
1213
1395
 
1214
- $ zitadel grants list --all --json
1396
+ $ zitadel events list --all --json
1215
1397
 
1216
- $ zitadel grants list --filter created_at=equals:<value> --sort created_at:desc
1398
+ $ zitadel events list --filter category=equals:<value> --sort occurred_at:desc
1217
1399
  ```
1218
1400
 
1219
- ## `zitadel help [COMMAND]`
1401
+ ## `zitadel flow-definitions get FLOW`
1220
1402
 
1221
- Display help for zitadel.
1403
+ Get one flow definition by flow name (newest revision) or revision id.
1222
1404
 
1223
1405
  ```
1224
1406
  USAGE
1225
- $ zitadel help [COMMAND...] [-n]
1407
+ $ zitadel flow-definitions get FLOW [--json] [-c <value>] [-s <value>] [-n]
1408
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
1409
+ <value>] [--fields <value>]
1410
+
1411
+ ARGUMENTS
1412
+ FLOW flow name (newest revision) or revision id
1413
+
1414
+ FLAGS
1415
+ -c, --cwd=<value> Project directory to operate on.
1416
+ -e, --env=<value> Environment to run against, e.g. production. Defaults
1417
+ to ZITADEL_ENV, then the hosting platform's build
1418
+ (VERCEL_ENV, or Netlify's CONTEXT), then development.
1419
+ -n, --non-interactive Disable prompts. Required when scripting or running as
1420
+ an agent.
1421
+ -s, --server=<value> Override the resolved server URL.
1422
+ -v, --verbose Verbose logging.
1423
+ --[no-]color Colorize human output. Disable with --no-color;
1424
+ NO_COLOR and FORCE_COLOR are honored too.
1425
+ --debug Debug logging.
1426
+ --dry-run Preview without mutating files or the platform.
1427
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
1428
+ process environment. Cannot be combined with --env.
1429
+ --fields=<value> Fields to show, comma-separated dot-paths. Defaults to
1430
+ the resource's own; `--json` is unaffected.
1431
+ --[no-]telemetry Send anonymous usage analytics. Disable with
1432
+ --no-telemetry.
1433
+
1434
+ GLOBAL FLAGS
1435
+ --json Format output as json.
1436
+
1437
+ DESCRIPTION
1438
+ Get one flow definition by flow name (newest revision) or revision id.
1439
+
1440
+ EXAMPLES
1441
+ $ zitadel flow-definitions get <flow>
1442
+
1443
+ $ zitadel flow-definitions get <flow> --json
1444
+ ```
1445
+
1446
+ ## `zitadel flow-definitions list`
1447
+
1448
+ List flow-definitions.
1449
+
1450
+ ```
1451
+ USAGE
1452
+ $ zitadel flow-definitions list [--json] [-c <value>] [-s <value>] [-n]
1453
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
1454
+ <value>] [--limit <value>] [-a | --page-token <value>] [--fields <value>]
1455
+ [--plain] [--filter <value>...]
1456
+
1457
+ FLAGS
1458
+ -a, --all Fetch every page instead of one.
1459
+ -c, --cwd=<value> Project directory to operate on.
1460
+ -e, --env=<value> Environment to run against, e.g. production.
1461
+ Defaults to ZITADEL_ENV, then the hosting platform's
1462
+ build (VERCEL_ENV, or Netlify's CONTEXT), then
1463
+ development.
1464
+ -n, --non-interactive Disable prompts. Required when scripting or running
1465
+ as an agent.
1466
+ -s, --server=<value> Override the resolved server URL.
1467
+ -v, --verbose Verbose logging.
1468
+ --[no-]color Colorize human output. Disable with --no-color;
1469
+ NO_COLOR and FORCE_COLOR are honored too.
1470
+ --debug Debug logging.
1471
+ --dry-run Preview without mutating files or the platform.
1472
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
1473
+ process environment. Cannot be combined with --env.
1474
+ --fields=<value> Columns to show, comma-separated dot-paths (e.g.
1475
+ id,attributes.email). Defaults to the resource's own
1476
+ columns; `--json` is unaffected.
1477
+ --filter=<value>... Filter as field=operation:value (operation defaults
1478
+ to equals). Fields: name (equals), purpose (equals),
1479
+ revisions (equals; values all|latest).
1480
+ --limit=<value> Page size (server default 20, max 100).
1481
+ --page-token=<value> Continue from a previous page's next_page_token.
1482
+ --plain Tab-separated rows with no header, for piping.
1483
+ Implied when stdout is not a terminal.
1484
+ --[no-]telemetry Send anonymous usage analytics. Disable with
1485
+ --no-telemetry.
1486
+
1487
+ GLOBAL FLAGS
1488
+ --json Format output as json.
1489
+
1490
+ DESCRIPTION
1491
+ List flow-definitions.
1492
+
1493
+ EXAMPLES
1494
+ $ zitadel flow-definitions list --json
1495
+
1496
+ $ zitadel flow-definitions list --all --json
1497
+
1498
+ $ zitadel flow-definitions list --filter name=equals:<value>
1499
+ ```
1500
+
1501
+ ## `zitadel grants create`
1502
+
1503
+ Create a grant.
1504
+
1505
+ ```
1506
+ USAGE
1507
+ $ zitadel grants create [--json] [-c <value>] [-s <value>] [-n]
1508
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
1509
+ <value>] [--relation viewer|editor|admin] [--expires-at <value>]
1510
+ [--user-user-id <value>] [--user-identifier <value>] [--team-team-id
1511
+ <value>] [--team-name <value>] [--data <value> | --file <value>] [--set
1512
+ <value>...]
1513
+
1514
+ FLAGS
1515
+ -c, --cwd=<value> Project directory to operate on.
1516
+ -e, --env=<value> Environment to run against, e.g. production. Defaults
1517
+ to ZITADEL_ENV, then the hosting platform's build
1518
+ (VERCEL_ENV, or Netlify's CONTEXT), then development.
1519
+ -n, --non-interactive Disable prompts. Required when scripting or running as
1520
+ an agent.
1521
+ -s, --server=<value> Override the resolved server URL.
1522
+ -v, --verbose Verbose logging.
1523
+ --[no-]color Colorize human output. Disable with --no-color;
1524
+ NO_COLOR and FORCE_COLOR are honored too.
1525
+ --debug Debug logging.
1526
+ --dry-run Preview without mutating files or the platform.
1527
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
1528
+ process environment. Cannot be combined with --env.
1529
+ --[no-]telemetry Send anonymous usage analytics. Disable with
1530
+ --no-telemetry.
1531
+
1532
+ RAW BODY FLAGS
1533
+ --data=<value> Whole body as a JSON object. Field flags and --set apply
1534
+ over it.
1535
+ --file=<value> Read the body from a JSON file; `-` reads stdin. Field flags
1536
+ and --set apply over it.
1537
+ --set=<value>... Set one field by its dot path: path=value, or path:=json for
1538
+ JSON. Repeatable; applied after the field flags, in order. A
1539
+ key that contains a dot is set through its parent: --set
1540
+ 'parent:={"a.b":"x"}'.
1541
+
1542
+ OPTIONAL FIELD FLAGS
1543
+ --expires-at=<value> Optional expiry.
1544
+
1545
+ GLOBAL FLAGS
1546
+ --json Format output as json.
1547
+
1548
+ REQUIRED FIELD FLAGS
1549
+ --relation=<option> (required) Catalog relation on `object_type` `project`.
1550
+ <options: viewer|editor|admin>
1551
+
1552
+ TEAM FIELD FLAGS
1553
+ --team-name=<value> Team name, unique per project case-insensitively.
1554
+ --team-team-id=<value>
1555
+
1556
+ USER FIELD FLAGS
1557
+ --user-identifier=<value> The user schema's designated identifier
1558
+ (`x-identifier`), looked up in the platform
1559
+ project.
1560
+ --user-user-id=<value>
1561
+
1562
+ DESCRIPTION
1563
+ Create a grant.
1564
+
1565
+ EXAMPLES
1566
+ $ zitadel grants create --relation viewer --user-identifier alice@acme.com --json
1567
+
1568
+ $ zitadel grants create --data '{...}' --json
1569
+
1570
+ $ zitadel grants create --file ./grant.json
1571
+ ```
1572
+
1573
+ ## `zitadel grants delete ID`
1574
+
1575
+ Delete a grant by id.
1576
+
1577
+ ```
1578
+ USAGE
1579
+ $ zitadel grants delete ID [--json] [-c <value>] [-s <value>] [-n]
1580
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
1581
+ <value>] [-f]
1582
+
1583
+ ARGUMENTS
1584
+ ID grant id
1585
+
1586
+ FLAGS
1587
+ -c, --cwd=<value> Project directory to operate on.
1588
+ -e, --env=<value> Environment to run against, e.g. production. Defaults
1589
+ to ZITADEL_ENV, then the hosting platform's build
1590
+ (VERCEL_ENV, or Netlify's CONTEXT), then development.
1591
+ -f, --force Delete the grant without the confirmation prompt.
1592
+ Required when non-interactive.
1593
+ -n, --non-interactive Disable prompts. Required when scripting or running as
1594
+ an agent.
1595
+ -s, --server=<value> Override the resolved server URL.
1596
+ -v, --verbose Verbose logging.
1597
+ --[no-]color Colorize human output. Disable with --no-color;
1598
+ NO_COLOR and FORCE_COLOR are honored too.
1599
+ --debug Debug logging.
1600
+ --dry-run Preview without mutating files or the platform.
1601
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
1602
+ process environment. Cannot be combined with --env.
1603
+ --[no-]telemetry Send anonymous usage analytics. Disable with
1604
+ --no-telemetry.
1605
+
1606
+ GLOBAL FLAGS
1607
+ --json Format output as json.
1608
+
1609
+ DESCRIPTION
1610
+ Delete a grant by id.
1611
+
1612
+ EXAMPLES
1613
+ $ zitadel grants delete <id> --force --json
1614
+ ```
1615
+
1616
+ ## `zitadel grants get ID`
1617
+
1618
+ Get one grant by id.
1619
+
1620
+ ```
1621
+ USAGE
1622
+ $ zitadel grants get ID [--json] [-c <value>] [-s <value>] [-n]
1623
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
1624
+ <value>] [--fields <value>]
1625
+
1626
+ ARGUMENTS
1627
+ ID grant id
1628
+
1629
+ FLAGS
1630
+ -c, --cwd=<value> Project directory to operate on.
1631
+ -e, --env=<value> Environment to run against, e.g. production. Defaults
1632
+ to ZITADEL_ENV, then the hosting platform's build
1633
+ (VERCEL_ENV, or Netlify's CONTEXT), then development.
1634
+ -n, --non-interactive Disable prompts. Required when scripting or running as
1635
+ an agent.
1636
+ -s, --server=<value> Override the resolved server URL.
1637
+ -v, --verbose Verbose logging.
1638
+ --[no-]color Colorize human output. Disable with --no-color;
1639
+ NO_COLOR and FORCE_COLOR are honored too.
1640
+ --debug Debug logging.
1641
+ --dry-run Preview without mutating files or the platform.
1642
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
1643
+ process environment. Cannot be combined with --env.
1644
+ --fields=<value> Fields to show, comma-separated dot-paths. Defaults to
1645
+ the resource's own; `--json` is unaffected.
1646
+ --[no-]telemetry Send anonymous usage analytics. Disable with
1647
+ --no-telemetry.
1648
+
1649
+ GLOBAL FLAGS
1650
+ --json Format output as json.
1651
+
1652
+ DESCRIPTION
1653
+ Get one grant by id.
1654
+
1655
+ EXAMPLES
1656
+ $ zitadel grants get <id>
1657
+
1658
+ $ zitadel grants get <id> --json
1659
+ ```
1660
+
1661
+ ## `zitadel grants list`
1662
+
1663
+ List grants.
1664
+
1665
+ ```
1666
+ USAGE
1667
+ $ zitadel grants list [--json] [-c <value>] [-s <value>] [-n]
1668
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
1669
+ <value>] [--limit <value>] [-a | --page-token <value>] [--fields <value>]
1670
+ [--plain] [--filter <value>...] [--sort <value>]
1671
+
1672
+ FLAGS
1673
+ -a, --all
1674
+ Fetch every page instead of one.
1675
+
1676
+ -c, --cwd=<value>
1677
+ Project directory to operate on.
1678
+
1679
+ -e, --env=<value>
1680
+ Environment to run against, e.g. production. Defaults to ZITADEL_ENV, then
1681
+ the hosting platform's build (VERCEL_ENV, or Netlify's CONTEXT), then
1682
+ development.
1683
+
1684
+ -n, --non-interactive
1685
+ Disable prompts. Required when scripting or running as an agent.
1686
+
1687
+ -s, --server=<value>
1688
+ Override the resolved server URL.
1689
+
1690
+ -v, --verbose
1691
+ Verbose logging.
1692
+
1693
+ --[no-]color
1694
+ Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are
1695
+ honored too.
1696
+
1697
+ --debug
1698
+ Debug logging.
1699
+
1700
+ --dry-run
1701
+ Preview without mutating files or the platform.
1702
+
1703
+ --env-file=<value>
1704
+ Read ZITADEL_* values from this file ahead of the process environment.
1705
+ Cannot be combined with --env.
1706
+
1707
+ --fields=<value>
1708
+ Columns to show, comma-separated dot-paths (e.g. id,attributes.email).
1709
+ Defaults to the resource's own columns; `--json` is unaffected.
1710
+
1711
+ --filter=<value>...
1712
+ Filter as field=operation:value (operation defaults to equals). Fields:
1713
+ created_at (equals|not_equals|contains|not_contains|less_than|less_than_or_e
1714
+ qual|greater_than|greater_than_or_equal), user_id
1715
+ (equals|not_equals|contains|not_contains|less_than|less_than_or_equal|greate
1716
+ r_than|greater_than_or_equal), team_id (equals|not_equals|contains|not_conta
1717
+ ins|less_than|less_than_or_equal|greater_than|greater_than_or_equal),
1718
+ relation (equals|not_equals|contains|not_contains|less_than|less_than_or_equ
1719
+ al|greater_than|greater_than_or_equal), expires_at
1720
+ (equals|not_equals|contains|not_contains|less_than|less_than_or_equal|greate
1721
+ r_than|greater_than_or_equal).
1722
+
1723
+ --limit=<value>
1724
+ Page size (server default 20, max 100).
1725
+
1726
+ --page-token=<value>
1727
+ Continue from a previous page's next_page_token.
1728
+
1729
+ --plain
1730
+ Tab-separated rows with no header, for piping. Implied when stdout is not a
1731
+ terminal.
1732
+
1733
+ --sort=<value>
1734
+ Sort as field:direction (asc|desc). Fields: created_at, expires_at, id.
1735
+
1736
+ --[no-]telemetry
1737
+ Send anonymous usage analytics. Disable with --no-telemetry.
1738
+
1739
+ GLOBAL FLAGS
1740
+ --json Format output as json.
1741
+
1742
+ DESCRIPTION
1743
+ List grants.
1744
+
1745
+ EXAMPLES
1746
+ $ zitadel grants list --json
1747
+
1748
+ $ zitadel grants list --all --json
1749
+
1750
+ $ zitadel grants list --filter created_at=equals:<value> --sort created_at:desc
1751
+ ```
1752
+
1753
+ ## `zitadel help [COMMAND]`
1754
+
1755
+ Display help for zitadel.
1756
+
1757
+ ```
1758
+ USAGE
1759
+ $ zitadel help [COMMAND...] [-n]
1226
1760
 
1227
1761
  ARGUMENTS
1228
1762
  [COMMAND...] Command to show help for.
@@ -1243,30 +1777,36 @@ Create an identity provider connection.
1243
1777
  ```
1244
1778
  USAGE
1245
1779
  $ zitadel idps create [--json] [-c <value>] [-s <value>] [-n]
1246
- [--dry-run] [-v] [--debug] [--color] [--telemetry] [--slug <value>]
1247
- [--protocol oidc] [--template <value>] [--display-name <value>]
1248
- [--subject-claim <value>] [--claim-mapping <value>...] [--verified-claims
1249
- <value>...] [--provisioning-creation disabled|auto] [--oidc-issuer <value>]
1250
- [--oidc-jwks-uri <value>] [--oidc-id-token-mapping]
1251
- [--oidc-authorization-endpoint <value>] [--oidc-token-endpoint <value>]
1252
- [--oidc-userinfo-endpoint <value>] [--oidc-client-id <value>]
1253
- [--oidc-client-secret <value>] [--oidc-token-endpoint-auth-method
1254
- client_secret_basic|client_secret_post] [--oidc-scopes <value>...]
1255
- [--oidc-pkce-enabled] [--oidc-static-authorize-parameters <value>...]
1256
- [--data <value> | --file <value>] [--set <value>...]
1780
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
1781
+ <value>] [--slug <value>] [--protocol oidc] [--template <value>]
1782
+ [--display-name <value>] [--subject-claim <value>] [--claim-mapping
1783
+ <value>...] [--verified-claims <value>...] [--provisioning-creation
1784
+ disabled|auto] [--oidc-issuer <value>] [--oidc-jwks-uri <value>]
1785
+ [--oidc-id-token-mapping] [--oidc-authorization-endpoint <value>]
1786
+ [--oidc-token-endpoint <value>] [--oidc-userinfo-endpoint <value>]
1787
+ [--oidc-client-id <value>] [--oidc-client-secret <value>]
1788
+ [--oidc-token-endpoint-auth-method client_secret_basic|client_secret_post]
1789
+ [--oidc-scopes <value>...] [--oidc-pkce-enabled]
1790
+ [--oidc-static-authorize-parameters <value>...] [--data <value> | --file
1791
+ <value>] [--set <value>...]
1257
1792
 
1258
1793
  FLAGS
1259
- -c, --cwd=<value> Project directory to operate on.
1260
- -n, --non-interactive Disable prompts. Required when scripting or running as
1261
- an agent.
1262
- -s, --server=<value> Override the resolved server URL.
1263
- -v, --verbose Verbose logging.
1264
- --[no-]color Colorize human output. Disable with --no-color;
1265
- NO_COLOR and FORCE_COLOR are honored too.
1266
- --debug Debug logging.
1267
- --dry-run Preview without mutating files or the platform.
1268
- --[no-]telemetry Send anonymous usage analytics. Disable with
1269
- --no-telemetry.
1794
+ -c, --cwd=<value> Project directory to operate on.
1795
+ -e, --env=<value> Environment to run against, e.g. production. Defaults
1796
+ to ZITADEL_ENV, then the hosting platform's build
1797
+ (VERCEL_ENV, or Netlify's CONTEXT), then development.
1798
+ -n, --non-interactive Disable prompts. Required when scripting or running as
1799
+ an agent.
1800
+ -s, --server=<value> Override the resolved server URL.
1801
+ -v, --verbose Verbose logging.
1802
+ --[no-]color Colorize human output. Disable with --no-color;
1803
+ NO_COLOR and FORCE_COLOR are honored too.
1804
+ --debug Debug logging.
1805
+ --dry-run Preview without mutating files or the platform.
1806
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
1807
+ process environment. Cannot be combined with --env.
1808
+ --[no-]telemetry Send anonymous usage analytics. Disable with
1809
+ --no-telemetry.
1270
1810
 
1271
1811
  OPTIONAL FIELD FLAGS
1272
1812
  --claim-mapping=<value>... Repeatable claim_mapping entry: key=value for a
@@ -1368,11 +1908,140 @@ Get one identity provider connection by id.
1368
1908
  ```
1369
1909
  USAGE
1370
1910
  $ zitadel idps get ID [--json] [-c <value>] [-s <value>] [-n]
1371
- [--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
1911
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
1912
+ <value>] [--fields <value>]
1372
1913
 
1373
1914
  ARGUMENTS
1374
1915
  ID identity provider connection id
1375
1916
 
1917
+ FLAGS
1918
+ -c, --cwd=<value> Project directory to operate on.
1919
+ -e, --env=<value> Environment to run against, e.g. production. Defaults
1920
+ to ZITADEL_ENV, then the hosting platform's build
1921
+ (VERCEL_ENV, or Netlify's CONTEXT), then development.
1922
+ -n, --non-interactive Disable prompts. Required when scripting or running as
1923
+ an agent.
1924
+ -s, --server=<value> Override the resolved server URL.
1925
+ -v, --verbose Verbose logging.
1926
+ --[no-]color Colorize human output. Disable with --no-color;
1927
+ NO_COLOR and FORCE_COLOR are honored too.
1928
+ --debug Debug logging.
1929
+ --dry-run Preview without mutating files or the platform.
1930
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
1931
+ process environment. Cannot be combined with --env.
1932
+ --fields=<value> Fields to show, comma-separated dot-paths. Defaults to
1933
+ the resource's own; `--json` is unaffected.
1934
+ --[no-]telemetry Send anonymous usage analytics. Disable with
1935
+ --no-telemetry.
1936
+
1937
+ GLOBAL FLAGS
1938
+ --json Format output as json.
1939
+
1940
+ DESCRIPTION
1941
+ Get one identity provider connection by id.
1942
+
1943
+ EXAMPLES
1944
+ $ zitadel idps get <id>
1945
+
1946
+ $ zitadel idps get <id> --json
1947
+ ```
1948
+
1949
+ ## `zitadel idps list`
1950
+
1951
+ List idps.
1952
+
1953
+ ```
1954
+ USAGE
1955
+ $ zitadel idps list [--json] [-c <value>] [-s <value>] [-n]
1956
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
1957
+ <value>] [--limit <value>] [-a | --page-token <value>] [--fields <value>]
1958
+ [--plain] [--filter <value>...] [--sort <value>]
1959
+
1960
+ FLAGS
1961
+ -a, --all
1962
+ Fetch every page instead of one.
1963
+
1964
+ -c, --cwd=<value>
1965
+ Project directory to operate on.
1966
+
1967
+ -e, --env=<value>
1968
+ Environment to run against, e.g. production. Defaults to ZITADEL_ENV, then
1969
+ the hosting platform's build (VERCEL_ENV, or Netlify's CONTEXT), then
1970
+ development.
1971
+
1972
+ -n, --non-interactive
1973
+ Disable prompts. Required when scripting or running as an agent.
1974
+
1975
+ -s, --server=<value>
1976
+ Override the resolved server URL.
1977
+
1978
+ -v, --verbose
1979
+ Verbose logging.
1980
+
1981
+ --[no-]color
1982
+ Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are
1983
+ honored too.
1984
+
1985
+ --debug
1986
+ Debug logging.
1987
+
1988
+ --dry-run
1989
+ Preview without mutating files or the platform.
1990
+
1991
+ --env-file=<value>
1992
+ Read ZITADEL_* values from this file ahead of the process environment.
1993
+ Cannot be combined with --env.
1994
+
1995
+ --fields=<value>
1996
+ Columns to show, comma-separated dot-paths (e.g. id,attributes.email).
1997
+ Defaults to the resource's own columns; `--json` is unaffected.
1998
+
1999
+ --filter=<value>...
2000
+ Filter as field=operation:value (operation defaults to equals). Fields: slug
2001
+ (equals|not_equals|contains|not_contains|less_than|less_than_or_equal|greate
2002
+ r_than|greater_than_or_equal), created_at (equals|not_equals|contains|not_co
2003
+ ntains|less_than|less_than_or_equal|greater_than|greater_than_or_equal).
2004
+
2005
+ --limit=<value>
2006
+ Page size (server default 20, max 100).
2007
+
2008
+ --page-token=<value>
2009
+ Continue from a previous page's next_page_token.
2010
+
2011
+ --plain
2012
+ Tab-separated rows with no header, for piping. Implied when stdout is not a
2013
+ terminal.
2014
+
2015
+ --sort=<value>
2016
+ Sort as field:direction (asc|desc). Fields: slug, created_at.
2017
+
2018
+ --[no-]telemetry
2019
+ Send anonymous usage analytics. Disable with --no-telemetry.
2020
+
2021
+ GLOBAL FLAGS
2022
+ --json Format output as json.
2023
+
2024
+ DESCRIPTION
2025
+ List idps.
2026
+
2027
+ EXAMPLES
2028
+ $ zitadel idps list --json
2029
+
2030
+ $ zitadel idps list --all --json
2031
+
2032
+ $ zitadel idps list --filter slug=equals:<value> --sort slug:desc
2033
+ ```
2034
+
2035
+ ## `zitadel logs`
2036
+
2037
+ Show local Zitadel server logs.
2038
+
2039
+ ```
2040
+ USAGE
2041
+ $ zitadel logs [--json] [-c <value>] [-s <value>] [-n]
2042
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--follow] [--level
2043
+ debug|info|warn|error] [--tail <value>]
2044
+
1376
2045
  FLAGS
1377
2046
  -c, --cwd=<value> Project directory to operate on.
1378
2047
  -n, --non-interactive Disable prompts. Required when scripting or running as
@@ -1383,8 +2052,11 @@ FLAGS
1383
2052
  NO_COLOR and FORCE_COLOR are honored too.
1384
2053
  --debug Debug logging.
1385
2054
  --dry-run Preview without mutating files or the platform.
1386
- --fields=<value> Fields to show, comma-separated dot-paths. Defaults to
1387
- the resource's own; `--json` is unaffected.
2055
+ --follow Keep printing lines as the server writes them.
2056
+ --level=<option> Show only lines at this level or above.
2057
+ <options: debug|info|warn|error>
2058
+ --tail=<value> [default: 200] Number of lines to show, counting only
2059
+ those --level shows.
1388
2060
  --[no-]telemetry Send anonymous usage analytics. Disable with
1389
2061
  --no-telemetry.
1390
2062
 
@@ -1392,150 +2064,389 @@ GLOBAL FLAGS
1392
2064
  --json Format output as json.
1393
2065
 
1394
2066
  DESCRIPTION
1395
- Get one identity provider connection by id.
2067
+ Show local Zitadel server logs.
2068
+
2069
+ On a terminal, warnings are yellow and errors red. Run it in the directory
2070
+ `zitadel start` ran in, or one inside it: the server is found from the nearest
2071
+ `.zitadel/local/` on the way up.
2072
+
2073
+ EXAMPLES
2074
+ $ zitadel logs --follow
2075
+
2076
+ $ zitadel logs --level warn
2077
+ ```
2078
+
2079
+ ## `zitadel origin add PATTERN`
2080
+
2081
+ Add an origin pattern to the project.
2082
+
2083
+ ```
2084
+ USAGE
2085
+ $ zitadel origin add PATTERN --kind primary|preview [--json] [-c
2086
+ <value>] [-s <value>] [-n] [--dry-run] [-v] [--debug] [--color]
2087
+ [--telemetry] [-e <value>] [--env-file <value>]
2088
+
2089
+ ARGUMENTS
2090
+ PATTERN The origin pattern to add.
2091
+
2092
+ FLAGS
2093
+ -c, --cwd=<value> Project directory to operate on.
2094
+ -e, --env=<value> Environment to run against, e.g. production. Defaults
2095
+ to ZITADEL_ENV, then the hosting platform's build
2096
+ (VERCEL_ENV, or Netlify's CONTEXT), then development.
2097
+ -n, --non-interactive Disable prompts. Required when scripting or running as
2098
+ an agent.
2099
+ -s, --server=<value> Override the resolved server URL.
2100
+ -v, --verbose Verbose logging.
2101
+ --[no-]color Colorize human output. Disable with --no-color;
2102
+ NO_COLOR and FORCE_COLOR are honored too.
2103
+ --debug Debug logging.
2104
+ --dry-run Preview without mutating files or the platform.
2105
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
2106
+ process environment. Cannot be combined with --env.
2107
+ --kind=<option> (required) What the pattern is for.
2108
+ <options: primary|preview>
2109
+ --[no-]telemetry Send anonymous usage analytics. Disable with
2110
+ --no-telemetry.
2111
+
2112
+ GLOBAL FLAGS
2113
+ --json Format output as json.
2114
+
2115
+ DESCRIPTION
2116
+ Add an origin pattern to the project.
2117
+
2118
+ EXAMPLES
2119
+ $ zitadel origin add https://app.acme.com --kind primary
2120
+
2121
+ $ zitadel origin add 'https://*-acme.vercel.app' --kind preview
2122
+ ```
2123
+
2124
+ ## `zitadel origin list`
2125
+
2126
+ List the origin patterns on the project.
2127
+
2128
+ ```
2129
+ USAGE
2130
+ $ zitadel origin list [--json] [-c <value>] [-s <value>] [-n]
2131
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
2132
+ <value>] [--plain]
2133
+
2134
+ FLAGS
2135
+ -c, --cwd=<value> Project directory to operate on.
2136
+ -e, --env=<value> Environment to run against, e.g. production. Defaults
2137
+ to ZITADEL_ENV, then the hosting platform's build
2138
+ (VERCEL_ENV, or Netlify's CONTEXT), then development.
2139
+ -n, --non-interactive Disable prompts. Required when scripting or running as
2140
+ an agent.
2141
+ -s, --server=<value> Override the resolved server URL.
2142
+ -v, --verbose Verbose logging.
2143
+ --[no-]color Colorize human output. Disable with --no-color;
2144
+ NO_COLOR and FORCE_COLOR are honored too.
2145
+ --debug Debug logging.
2146
+ --dry-run Preview without mutating files or the platform.
2147
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
2148
+ process environment. Cannot be combined with --env.
2149
+ --plain Tab-separated rows with no header, for piping. Implied
2150
+ when stdout is not a terminal.
2151
+ --[no-]telemetry Send anonymous usage analytics. Disable with
2152
+ --no-telemetry.
2153
+
2154
+ GLOBAL FLAGS
2155
+ --json Format output as json.
2156
+
2157
+ DESCRIPTION
2158
+ List the origin patterns on the project.
2159
+
2160
+ EXAMPLES
2161
+ $ zitadel origin list
2162
+
2163
+ $ zitadel origin list --plain
2164
+ ```
2165
+
2166
+ ## `zitadel origin rm PATTERN`
2167
+
2168
+ Remove an origin pattern from the project.
2169
+
2170
+ ```
2171
+ USAGE
2172
+ $ zitadel origin rm PATTERN [--json] [-c <value>] [-s <value>] [-n]
2173
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
2174
+ <value>] [-f]
2175
+
2176
+ ARGUMENTS
2177
+ PATTERN The origin pattern to remove.
2178
+
2179
+ FLAGS
2180
+ -c, --cwd=<value> Project directory to operate on.
2181
+ -e, --env=<value> Environment to run against, e.g. production. Defaults
2182
+ to ZITADEL_ENV, then the hosting platform's build
2183
+ (VERCEL_ENV, or Netlify's CONTEXT), then development.
2184
+ -f, --force Remove the pattern without the confirmation prompt.
2185
+ Required when non-interactive.
2186
+ -n, --non-interactive Disable prompts. Required when scripting or running as
2187
+ an agent.
2188
+ -s, --server=<value> Override the resolved server URL.
2189
+ -v, --verbose Verbose logging.
2190
+ --[no-]color Colorize human output. Disable with --no-color;
2191
+ NO_COLOR and FORCE_COLOR are honored too.
2192
+ --debug Debug logging.
2193
+ --dry-run Preview without mutating files or the platform.
2194
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
2195
+ process environment. Cannot be combined with --env.
2196
+ --[no-]telemetry Send anonymous usage analytics. Disable with
2197
+ --no-telemetry.
2198
+
2199
+ GLOBAL FLAGS
2200
+ --json Format output as json.
2201
+
2202
+ DESCRIPTION
2203
+ Remove an origin pattern from the project.
2204
+
2205
+ EXAMPLES
2206
+ $ zitadel origin rm https://app.acme.com
2207
+
2208
+ $ zitadel origin rm https://app.acme.com --force
2209
+ ```
2210
+
2211
+ ## `zitadel policies get POLICY`
2212
+
2213
+ Get one policy by policy id or operation.
2214
+
2215
+ ```
2216
+ USAGE
2217
+ $ zitadel policies get POLICY [--json] [-c <value>] [-s <value>] [-n]
2218
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
2219
+ <value>] [--fields <value>]
2220
+
2221
+ ARGUMENTS
2222
+ POLICY policy id or operation
2223
+
2224
+ FLAGS
2225
+ -c, --cwd=<value> Project directory to operate on.
2226
+ -e, --env=<value> Environment to run against, e.g. production. Defaults
2227
+ to ZITADEL_ENV, then the hosting platform's build
2228
+ (VERCEL_ENV, or Netlify's CONTEXT), then development.
2229
+ -n, --non-interactive Disable prompts. Required when scripting or running as
2230
+ an agent.
2231
+ -s, --server=<value> Override the resolved server URL.
2232
+ -v, --verbose Verbose logging.
2233
+ --[no-]color Colorize human output. Disable with --no-color;
2234
+ NO_COLOR and FORCE_COLOR are honored too.
2235
+ --debug Debug logging.
2236
+ --dry-run Preview without mutating files or the platform.
2237
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
2238
+ process environment. Cannot be combined with --env.
2239
+ --fields=<value> Fields to show, comma-separated dot-paths. Defaults to
2240
+ the resource's own; `--json` is unaffected.
2241
+ --[no-]telemetry Send anonymous usage analytics. Disable with
2242
+ --no-telemetry.
2243
+
2244
+ GLOBAL FLAGS
2245
+ --json Format output as json.
2246
+
2247
+ DESCRIPTION
2248
+ Get one policy by policy id or operation.
1396
2249
 
1397
2250
  EXAMPLES
1398
- $ zitadel idps get <id>
2251
+ $ zitadel policies get <policy>
1399
2252
 
1400
- $ zitadel idps get <id> --json
2253
+ $ zitadel policies get <policy> --json
1401
2254
  ```
1402
2255
 
1403
- ## `zitadel idps list`
2256
+ ## `zitadel policies list`
1404
2257
 
1405
- List idps.
2258
+ List policies.
1406
2259
 
1407
2260
  ```
1408
2261
  USAGE
1409
- $ zitadel idps list [--json] [-c <value>] [-s <value>] [-n]
1410
- [--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
1411
- --page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
1412
- [--sort <value>]
2262
+ $ zitadel policies list [--json] [-c <value>] [-s <value>] [-n]
2263
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
2264
+ <value>] [--limit <value>] [-a | --page-token <value>] [--fields <value>]
2265
+ [--plain] [--filter <value>...]
1413
2266
 
1414
2267
  FLAGS
1415
- -a, --all
1416
- Fetch every page instead of one.
1417
-
1418
- -c, --cwd=<value>
1419
- Project directory to operate on.
1420
-
1421
- -n, --non-interactive
1422
- Disable prompts. Required when scripting or running as an agent.
1423
-
1424
- -s, --server=<value>
1425
- Override the resolved server URL.
1426
-
1427
- -v, --verbose
1428
- Verbose logging.
1429
-
1430
- --[no-]color
1431
- Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are
1432
- honored too.
2268
+ -a, --all Fetch every page instead of one.
2269
+ -c, --cwd=<value> Project directory to operate on.
2270
+ -e, --env=<value> Environment to run against, e.g. production.
2271
+ Defaults to ZITADEL_ENV, then the hosting platform's
2272
+ build (VERCEL_ENV, or Netlify's CONTEXT), then
2273
+ development.
2274
+ -n, --non-interactive Disable prompts. Required when scripting or running
2275
+ as an agent.
2276
+ -s, --server=<value> Override the resolved server URL.
2277
+ -v, --verbose Verbose logging.
2278
+ --[no-]color Colorize human output. Disable with --no-color;
2279
+ NO_COLOR and FORCE_COLOR are honored too.
2280
+ --debug Debug logging.
2281
+ --dry-run Preview without mutating files or the platform.
2282
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
2283
+ process environment. Cannot be combined with --env.
2284
+ --fields=<value> Columns to show, comma-separated dot-paths (e.g.
2285
+ id,attributes.email). Defaults to the resource's own
2286
+ columns; `--json` is unaffected.
2287
+ --filter=<value>... Filter as field=operation:value (operation defaults
2288
+ to equals). Fields: operation (equals).
2289
+ --limit=<value> Page size (server default 20, max 100).
2290
+ --page-token=<value> Continue from a previous page's next_page_token.
2291
+ --plain Tab-separated rows with no header, for piping.
2292
+ Implied when stdout is not a terminal.
2293
+ --[no-]telemetry Send anonymous usage analytics. Disable with
2294
+ --no-telemetry.
1433
2295
 
1434
- --debug
1435
- Debug logging.
2296
+ GLOBAL FLAGS
2297
+ --json Format output as json.
1436
2298
 
1437
- --dry-run
1438
- Preview without mutating files or the platform.
2299
+ DESCRIPTION
2300
+ List policies.
1439
2301
 
1440
- --fields=<value>
1441
- Columns to show, comma-separated dot-paths (e.g. id,attributes.email).
1442
- Defaults to the resource's own columns; `--json` is unaffected.
2302
+ EXAMPLES
2303
+ $ zitadel policies list --json
1443
2304
 
1444
- --filter=<value>...
1445
- Filter as field=operation:value (operation defaults to equals). Fields: slug
1446
- (equals|not_equals|contains|not_contains|less_than|less_than_or_equal|greate
1447
- r_than|greater_than_or_equal), created_at (equals|not_equals|contains|not_co
1448
- ntains|less_than|less_than_or_equal|greater_than|greater_than_or_equal).
2305
+ $ zitadel policies list --all --json
1449
2306
 
1450
- --limit=<value>
1451
- Page size (server default 20, max 100).
2307
+ $ zitadel policies list --filter operation=equals:<value>
2308
+ ```
1452
2309
 
1453
- --page-token=<value>
1454
- Continue from a previous page's next_page_token.
2310
+ ## `zitadel preview`
1455
2311
 
1456
- --plain
1457
- Tab-separated rows with no header, for piping. Implied when stdout is not a
1458
- terminal.
2312
+ Deploy a release from .zitadel/ to a pull-request build's preview URLs.
1459
2313
 
1460
- --sort=<value>
1461
- Sort as field:direction (asc|desc). Fields: slug, created_at.
2314
+ ```
2315
+ USAGE
2316
+ $ zitadel preview [--json] [-c <value>] [-s <value>] [-n]
2317
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
2318
+ <value>] [--origin <value>...] [--ttl <value>] [--strict]
1462
2319
 
1463
- --[no-]telemetry
1464
- Send anonymous usage analytics. Disable with --no-telemetry.
2320
+ FLAGS
2321
+ -c, --cwd=<value> Project directory to operate on.
2322
+ -e, --env=<value> Environment to run against, e.g. production. Defaults
2323
+ to ZITADEL_ENV, then the hosting platform's build
2324
+ (VERCEL_ENV, or Netlify's CONTEXT), then development.
2325
+ -n, --non-interactive Disable prompts. Required when scripting or running
2326
+ as an agent.
2327
+ -s, --server=<value> Override the resolved server URL.
2328
+ -v, --verbose Verbose logging.
2329
+ --[no-]color Colorize human output. Disable with --no-color;
2330
+ NO_COLOR and FORCE_COLOR are honored too.
2331
+ --debug Debug logging.
2332
+ --dry-run Preview without mutating files or the platform.
2333
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
2334
+ process environment. Cannot be combined with --env.
2335
+ --origin=<value>... A preview URL to deploy to, instead of detecting them
2336
+ from the platform build. Repeatable.
2337
+ --strict Fail instead of warning when no preview credential
2338
+ (ZITADEL_PROJECT_SECRET) is set.
2339
+ --[no-]telemetry Send anonymous usage analytics. Disable with
2340
+ --no-telemetry.
2341
+ --ttl=<value> How long each preview stays live, e.g. 7d, 12h or
2342
+ 90m. Between 60s and 365d. Omitted, the project's
2343
+ default applies.
1465
2344
 
1466
2345
  GLOBAL FLAGS
1467
2346
  --json Format output as json.
1468
2347
 
1469
2348
  DESCRIPTION
1470
- List idps.
2349
+ Deploy a release from .zitadel/ to a pull-request build's preview URLs.
1471
2350
 
1472
2351
  EXAMPLES
1473
- $ zitadel idps list --json
2352
+ $ zitadel preview
1474
2353
 
1475
- $ zitadel idps list --all --json
2354
+ $ zitadel preview --origin https://acme-git-sso-acmeinc.vercel.app
1476
2355
 
1477
- $ zitadel idps list --filter slug=equals:<value> --sort slug:desc
2356
+ $ zitadel preview --ttl 24h
1478
2357
  ```
1479
2358
 
1480
- ## `zitadel logs`
2359
+ ## `zitadel preview list`
1481
2360
 
1482
- Show local Zitadel server logs.
2361
+ List the project's live previews, newest first.
1483
2362
 
1484
2363
  ```
1485
2364
  USAGE
1486
- $ zitadel logs [--json] [-c <value>] [-s <value>] [-n]
1487
- [--dry-run] [-v] [--debug] [--color] [--telemetry] [--follow] [--tail
1488
- <value>]
2365
+ $ zitadel preview list [--json] [-c <value>] [-s <value>] [-n]
2366
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
2367
+ <value>] [--limit <value>] [-a | --page-token <value>] [--plain]
1489
2368
 
1490
2369
  FLAGS
1491
- -c, --cwd=<value> Project directory to operate on.
1492
- -n, --non-interactive Disable prompts. Required when scripting or running as
1493
- an agent.
1494
- -s, --server=<value> Override the resolved server URL.
1495
- -v, --verbose Verbose logging.
1496
- --[no-]color Colorize human output. Disable with --no-color;
1497
- NO_COLOR and FORCE_COLOR are honored too.
1498
- --debug Debug logging.
1499
- --dry-run Preview without mutating files or the platform.
1500
- --follow Follow logs.
1501
- --tail=<value> [default: 200] Number of lines to show.
1502
- --[no-]telemetry Send anonymous usage analytics. Disable with
1503
- --no-telemetry.
2370
+ -a, --all Fetch every page instead of one.
2371
+ -c, --cwd=<value> Project directory to operate on.
2372
+ -e, --env=<value> Environment to run against, e.g. production.
2373
+ Defaults to ZITADEL_ENV, then the hosting platform's
2374
+ build (VERCEL_ENV, or Netlify's CONTEXT), then
2375
+ development.
2376
+ -n, --non-interactive Disable prompts. Required when scripting or running
2377
+ as an agent.
2378
+ -s, --server=<value> Override the resolved server URL.
2379
+ -v, --verbose Verbose logging.
2380
+ --[no-]color Colorize human output. Disable with --no-color;
2381
+ NO_COLOR and FORCE_COLOR are honored too.
2382
+ --debug Debug logging.
2383
+ --dry-run Preview without mutating files or the platform.
2384
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
2385
+ process environment. Cannot be combined with --env.
2386
+ --limit=<value> Page size (server default 20, max 100).
2387
+ --page-token=<value> Continue from a previous page's next_page_token.
2388
+ --plain Tab-separated rows with no header, for piping.
2389
+ Implied when stdout is not a terminal.
2390
+ --[no-]telemetry Send anonymous usage analytics. Disable with
2391
+ --no-telemetry.
1504
2392
 
1505
2393
  GLOBAL FLAGS
1506
2394
  --json Format output as json.
1507
2395
 
1508
2396
  DESCRIPTION
1509
- Show local Zitadel server logs.
2397
+ List the project's live previews, newest first.
2398
+
2399
+ EXAMPLES
2400
+ $ zitadel preview list
2401
+
2402
+ $ zitadel preview list --all
2403
+
2404
+ $ zitadel preview list --plain
1510
2405
  ```
1511
2406
 
1512
- ## `zitadel plan`
2407
+ ## `zitadel preview rm URL`
1513
2408
 
1514
- Validate config without mutation and preview the sync diff.
2409
+ Remove a live preview from the project.
1515
2410
 
1516
2411
  ```
1517
2412
  USAGE
1518
- $ zitadel plan [--json] [-c <value>] [-s <value>] [-n]
1519
- [--dry-run] [-v] [--debug] [--color] [--telemetry]
2413
+ $ zitadel preview rm URL [--json] [-c <value>] [-s <value>] [-n]
2414
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
2415
+ <value>] [-f]
2416
+
2417
+ ARGUMENTS
2418
+ URL The preview URL to remove.
1520
2419
 
1521
2420
  FLAGS
1522
- -c, --cwd=<value> Project directory to operate on.
1523
- -n, --non-interactive Disable prompts. Required when scripting or running as
1524
- an agent.
1525
- -s, --server=<value> Override the resolved server URL.
1526
- -v, --verbose Verbose logging.
1527
- --[no-]color Colorize human output. Disable with --no-color;
1528
- NO_COLOR and FORCE_COLOR are honored too.
1529
- --debug Debug logging.
1530
- --dry-run Preview without mutating files or the platform.
1531
- --[no-]telemetry Send anonymous usage analytics. Disable with
1532
- --no-telemetry.
2421
+ -c, --cwd=<value> Project directory to operate on.
2422
+ -e, --env=<value> Environment to run against, e.g. production. Defaults
2423
+ to ZITADEL_ENV, then the hosting platform's build
2424
+ (VERCEL_ENV, or Netlify's CONTEXT), then development.
2425
+ -f, --force Remove the preview without the confirmation prompt.
2426
+ Required when non-interactive.
2427
+ -n, --non-interactive Disable prompts. Required when scripting or running as
2428
+ an agent.
2429
+ -s, --server=<value> Override the resolved server URL.
2430
+ -v, --verbose Verbose logging.
2431
+ --[no-]color Colorize human output. Disable with --no-color;
2432
+ NO_COLOR and FORCE_COLOR are honored too.
2433
+ --debug Debug logging.
2434
+ --dry-run Preview without mutating files or the platform.
2435
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
2436
+ process environment. Cannot be combined with --env.
2437
+ --[no-]telemetry Send anonymous usage analytics. Disable with
2438
+ --no-telemetry.
1533
2439
 
1534
2440
  GLOBAL FLAGS
1535
2441
  --json Format output as json.
1536
2442
 
1537
2443
  DESCRIPTION
1538
- Validate config without mutation and preview the sync diff.
2444
+ Remove a live preview from the project.
2445
+
2446
+ EXAMPLES
2447
+ $ zitadel preview rm https://acme-git-sso-acmeinc.vercel.app
2448
+
2449
+ $ zitadel preview rm https://acme-git-sso-acmeinc.vercel.app --force
1539
2450
  ```
1540
2451
 
1541
2452
  ## `zitadel projects get ID`
@@ -1545,25 +2456,31 @@ Get one project by id.
1545
2456
  ```
1546
2457
  USAGE
1547
2458
  $ zitadel projects get ID [--json] [-c <value>] [-s <value>] [-n]
1548
- [--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
2459
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
2460
+ <value>] [--fields <value>]
1549
2461
 
1550
2462
  ARGUMENTS
1551
2463
  ID project id
1552
2464
 
1553
2465
  FLAGS
1554
- -c, --cwd=<value> Project directory to operate on.
1555
- -n, --non-interactive Disable prompts. Required when scripting or running as
1556
- an agent.
1557
- -s, --server=<value> Override the resolved server URL.
1558
- -v, --verbose Verbose logging.
1559
- --[no-]color Colorize human output. Disable with --no-color;
1560
- NO_COLOR and FORCE_COLOR are honored too.
1561
- --debug Debug logging.
1562
- --dry-run Preview without mutating files or the platform.
1563
- --fields=<value> Fields to show, comma-separated dot-paths. Defaults to
1564
- the resource's own; `--json` is unaffected.
1565
- --[no-]telemetry Send anonymous usage analytics. Disable with
1566
- --no-telemetry.
2466
+ -c, --cwd=<value> Project directory to operate on.
2467
+ -e, --env=<value> Environment to run against, e.g. production. Defaults
2468
+ to ZITADEL_ENV, then the hosting platform's build
2469
+ (VERCEL_ENV, or Netlify's CONTEXT), then development.
2470
+ -n, --non-interactive Disable prompts. Required when scripting or running as
2471
+ an agent.
2472
+ -s, --server=<value> Override the resolved server URL.
2473
+ -v, --verbose Verbose logging.
2474
+ --[no-]color Colorize human output. Disable with --no-color;
2475
+ NO_COLOR and FORCE_COLOR are honored too.
2476
+ --debug Debug logging.
2477
+ --dry-run Preview without mutating files or the platform.
2478
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
2479
+ process environment. Cannot be combined with --env.
2480
+ --fields=<value> Fields to show, comma-separated dot-paths. Defaults to
2481
+ the resource's own; `--json` is unaffected.
2482
+ --[no-]telemetry Send anonymous usage analytics. Disable with
2483
+ --no-telemetry.
1567
2484
 
1568
2485
  GLOBAL FLAGS
1569
2486
  --json Format output as json.
@@ -1584,13 +2501,17 @@ List projects.
1584
2501
  ```
1585
2502
  USAGE
1586
2503
  $ zitadel projects list [--json] [-c <value>] [-s <value>] [-n]
1587
- [--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
1588
- --page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
1589
- [--sort <value>]
2504
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
2505
+ <value>] [--limit <value>] [-a | --page-token <value>] [--fields <value>]
2506
+ [--plain] [--filter <value>...] [--sort <value>]
1590
2507
 
1591
2508
  FLAGS
1592
2509
  -a, --all Fetch every page instead of one.
1593
2510
  -c, --cwd=<value> Project directory to operate on.
2511
+ -e, --env=<value> Environment to run against, e.g. production.
2512
+ Defaults to ZITADEL_ENV, then the hosting platform's
2513
+ build (VERCEL_ENV, or Netlify's CONTEXT), then
2514
+ development.
1594
2515
  -n, --non-interactive Disable prompts. Required when scripting or running
1595
2516
  as an agent.
1596
2517
  -s, --server=<value> Override the resolved server URL.
@@ -1599,6 +2520,8 @@ FLAGS
1599
2520
  NO_COLOR and FORCE_COLOR are honored too.
1600
2521
  --debug Debug logging.
1601
2522
  --dry-run Preview without mutating files or the platform.
2523
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
2524
+ process environment. Cannot be combined with --env.
1602
2525
  --fields=<value> Columns to show, comma-separated dot-paths (e.g.
1603
2526
  id,attributes.email). Defaults to the resource's own
1604
2527
  columns; `--json` is unaffected.
@@ -1636,29 +2559,35 @@ Update a project by id.
1636
2559
  ```
1637
2560
  USAGE
1638
2561
  $ zitadel projects update ID [--json] [-c <value>] [-s <value>] [-n]
1639
- [--dry-run] [-v] [--debug] [--color] [--telemetry] [--name <value>]
1640
- [--password-hash-algorithm argon2i|argon2id|bcrypt|scrypt|pbkdf2|sha2]
1641
- [--password-hash-params-time <value>] [--password-hash-params-memory
1642
- <value>] [--password-hash-params-threads <value>]
1643
- [--password-hash-params-cost <value>] [--password-hash-params-rounds
1644
- <value>] [--password-hash-params-hash sha1|sha224|sha256|sha384|sha512]
1645
- [--data <value> | --file <value>] [--set <value>...]
2562
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
2563
+ <value>] [--name <value>] [--password-hash-algorithm
2564
+ argon2i|argon2id|bcrypt|scrypt|pbkdf2|sha2] [--password-hash-params-time
2565
+ <value>] [--password-hash-params-memory <value>]
2566
+ [--password-hash-params-threads <value>] [--password-hash-params-cost
2567
+ <value>] [--password-hash-params-rounds <value>]
2568
+ [--password-hash-params-hash sha1|sha224|sha256|sha384|sha512] [--data
2569
+ <value> | --file <value>] [--set <value>...]
1646
2570
 
1647
2571
  ARGUMENTS
1648
2572
  ID project id
1649
2573
 
1650
2574
  FLAGS
1651
- -c, --cwd=<value> Project directory to operate on.
1652
- -n, --non-interactive Disable prompts. Required when scripting or running as
1653
- an agent.
1654
- -s, --server=<value> Override the resolved server URL.
1655
- -v, --verbose Verbose logging.
1656
- --[no-]color Colorize human output. Disable with --no-color;
1657
- NO_COLOR and FORCE_COLOR are honored too.
1658
- --debug Debug logging.
1659
- --dry-run Preview without mutating files or the platform.
1660
- --[no-]telemetry Send anonymous usage analytics. Disable with
1661
- --no-telemetry.
2575
+ -c, --cwd=<value> Project directory to operate on.
2576
+ -e, --env=<value> Environment to run against, e.g. production. Defaults
2577
+ to ZITADEL_ENV, then the hosting platform's build
2578
+ (VERCEL_ENV, or Netlify's CONTEXT), then development.
2579
+ -n, --non-interactive Disable prompts. Required when scripting or running as
2580
+ an agent.
2581
+ -s, --server=<value> Override the resolved server URL.
2582
+ -v, --verbose Verbose logging.
2583
+ --[no-]color Colorize human output. Disable with --no-color;
2584
+ NO_COLOR and FORCE_COLOR are honored too.
2585
+ --debug Debug logging.
2586
+ --dry-run Preview without mutating files or the platform.
2587
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
2588
+ process environment. Cannot be combined with --env.
2589
+ --[no-]telemetry Send anonymous usage analytics. Disable with
2590
+ --no-telemetry.
1662
2591
 
1663
2592
  RAW BODY FLAGS
1664
2593
  --data=<value> Whole body as a JSON object. Field flags and --set apply
@@ -1670,62 +2599,157 @@ RAW BODY FLAGS
1670
2599
  key that contains a dot is set through its parent: --set
1671
2600
  'parent:={"a.b":"x"}'.
1672
2601
 
1673
- GLOBAL FLAGS
1674
- --json Format output as json.
2602
+ GLOBAL FLAGS
2603
+ --json Format output as json.
2604
+
2605
+ OPTIONAL FIELD FLAGS
2606
+ --name=<value> The name of the project.
2607
+
2608
+ PASSWORD HASH FIELD FLAGS
2609
+ --password-hash-algorithm=<option> (required with password_hash.*) The
2610
+ hashing algorithm.
2611
+ <options: argon2i|argon2id|bcrypt|scry
2612
+ pt|pbkdf2|sha2>
2613
+ --password-hash-params-cost=<value> bcrypt cost, or scrypt's log2 of the
2614
+ CPU/memory cost.
2615
+ --password-hash-params-hash=<option> The underlying hash.
2616
+ <options:
2617
+ sha1|sha224|sha256|sha384|sha512>
2618
+ --password-hash-params-memory=<value> argon2 memory in KiB.
2619
+ --password-hash-params-rounds=<value> pbkdf2 or sha2 iteration count.
2620
+ --password-hash-params-threads=<value> argon2 lanes.
2621
+ --password-hash-params-time=<value> argon2 passes over memory.
2622
+
2623
+ DESCRIPTION
2624
+ Update a project by id.
2625
+
2626
+ EXAMPLES
2627
+ $ zitadel projects update <id> --data '{...}' --json
2628
+
2629
+ $ zitadel projects update <id> --file ./project.json
2630
+ ```
2631
+
2632
+ ## `zitadel pull [TARGET]`
2633
+
2634
+ Rebuild your .zitadel/ files from a release.
2635
+
2636
+ ```
2637
+ USAGE
2638
+ $ zitadel pull [TARGET] [--json] [-c <value>] [-s <value>] [-n]
2639
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
2640
+ <value>]
2641
+
2642
+ ARGUMENTS
2643
+ [TARGET] [default: latest] What to pull: 'latest' (the live release), a
2644
+ release id (rel_…), or a deployment id (dep_…).
2645
+
2646
+ FLAGS
2647
+ -c, --cwd=<value> Project directory to operate on.
2648
+ -e, --env=<value> Environment to run against, e.g. production. Defaults
2649
+ to ZITADEL_ENV, then the hosting platform's build
2650
+ (VERCEL_ENV, or Netlify's CONTEXT), then development.
2651
+ -n, --non-interactive Disable prompts. Required when scripting or running as
2652
+ an agent.
2653
+ -s, --server=<value> Override the resolved server URL.
2654
+ -v, --verbose Verbose logging.
2655
+ --[no-]color Colorize human output. Disable with --no-color;
2656
+ NO_COLOR and FORCE_COLOR are honored too.
2657
+ --debug Debug logging.
2658
+ --dry-run Preview without mutating files or the platform.
2659
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
2660
+ process environment. Cannot be combined with --env.
2661
+ --[no-]telemetry Send anonymous usage analytics. Disable with
2662
+ --no-telemetry.
2663
+
2664
+ GLOBAL FLAGS
2665
+ --json Format output as json.
2666
+
2667
+ DESCRIPTION
2668
+ Rebuild your .zitadel/ files from a release.
2669
+
2670
+ Writes .zitadel/ from the revisions a released snapshot pins.
2671
+
2672
+ EXAMPLES
2673
+ $ zitadel pull
2674
+
2675
+ $ zitadel pull rel_01KX3RG8A7F0N9WD3P2E4YM5C1
2676
+
2677
+ $ zitadel pull dep_01KX5N7C9D2E7F0N9WD3P2E4YM6
2678
+ ```
1675
2679
 
1676
- OPTIONAL FIELD FLAGS
1677
- --name=<value> The name of the project.
2680
+ ## `zitadel release create`
1678
2681
 
1679
- PASSWORD HASH FIELD FLAGS
1680
- --password-hash-algorithm=<option> (required with password_hash.*) The
1681
- hashing algorithm.
1682
- <options: argon2i|argon2id|bcrypt|scry
1683
- pt|pbkdf2|sha2>
1684
- --password-hash-params-cost=<value> bcrypt cost, or scrypt's log2 of the
1685
- CPU/memory cost.
1686
- --password-hash-params-hash=<option> The underlying hash.
1687
- <options:
1688
- sha1|sha224|sha256|sha384|sha512>
1689
- --password-hash-params-memory=<value> argon2 memory in KiB.
1690
- --password-hash-params-rounds=<value> pbkdf2 or sha2 iteration count.
1691
- --password-hash-params-threads=<value> argon2 lanes.
1692
- --password-hash-params-time=<value> argon2 passes over memory.
2682
+ Build a release from .zitadel/ without deploying it.
2683
+
2684
+ ```
2685
+ USAGE
2686
+ $ zitadel release create [--json] [-c <value>] [-s <value>] [-n]
2687
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
2688
+ <value>] [-m <value>]
2689
+
2690
+ FLAGS
2691
+ -c, --cwd=<value> Project directory to operate on.
2692
+ -e, --env=<value> Environment to run against, e.g. production. Defaults
2693
+ to ZITADEL_ENV, then the hosting platform's build
2694
+ (VERCEL_ENV, or Netlify's CONTEXT), then development.
2695
+ -m, --message=<value> A short summary of what this release changes.
2696
+ -n, --non-interactive Disable prompts. Required when scripting or running as
2697
+ an agent.
2698
+ -s, --server=<value> Override the resolved server URL.
2699
+ -v, --verbose Verbose logging.
2700
+ --[no-]color Colorize human output. Disable with --no-color;
2701
+ NO_COLOR and FORCE_COLOR are honored too.
2702
+ --debug Debug logging.
2703
+ --dry-run Preview without mutating files or the platform.
2704
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
2705
+ process environment. Cannot be combined with --env.
2706
+ --[no-]telemetry Send anonymous usage analytics. Disable with
2707
+ --no-telemetry.
2708
+
2709
+ GLOBAL FLAGS
2710
+ --json Format output as json.
1693
2711
 
1694
2712
  DESCRIPTION
1695
- Update a project by id.
2713
+ Build a release from .zitadel/ without deploying it.
1696
2714
 
1697
2715
  EXAMPLES
1698
- $ zitadel projects update <id> --data '{...}' --json
2716
+ $ zitadel release create
1699
2717
 
1700
- $ zitadel projects update <id> --file ./project.json
2718
+ $ zitadel release create -m 'add phone_number to human-user'
1701
2719
  ```
1702
2720
 
1703
- ## `zitadel releases get ID`
2721
+ ## `zitadel release get ID`
1704
2722
 
1705
2723
  Get one release by id.
1706
2724
 
1707
2725
  ```
1708
2726
  USAGE
1709
- $ zitadel releases get ID [--json] [-c <value>] [-s <value>] [-n]
1710
- [--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
2727
+ $ zitadel release get ID [--json] [-c <value>] [-s <value>] [-n]
2728
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
2729
+ <value>] [--fields <value>]
1711
2730
 
1712
2731
  ARGUMENTS
1713
2732
  ID release id
1714
2733
 
1715
2734
  FLAGS
1716
- -c, --cwd=<value> Project directory to operate on.
1717
- -n, --non-interactive Disable prompts. Required when scripting or running as
1718
- an agent.
1719
- -s, --server=<value> Override the resolved server URL.
1720
- -v, --verbose Verbose logging.
1721
- --[no-]color Colorize human output. Disable with --no-color;
1722
- NO_COLOR and FORCE_COLOR are honored too.
1723
- --debug Debug logging.
1724
- --dry-run Preview without mutating files or the platform.
1725
- --fields=<value> Fields to show, comma-separated dot-paths. Defaults to
1726
- the resource's own; `--json` is unaffected.
1727
- --[no-]telemetry Send anonymous usage analytics. Disable with
1728
- --no-telemetry.
2735
+ -c, --cwd=<value> Project directory to operate on.
2736
+ -e, --env=<value> Environment to run against, e.g. production. Defaults
2737
+ to ZITADEL_ENV, then the hosting platform's build
2738
+ (VERCEL_ENV, or Netlify's CONTEXT), then development.
2739
+ -n, --non-interactive Disable prompts. Required when scripting or running as
2740
+ an agent.
2741
+ -s, --server=<value> Override the resolved server URL.
2742
+ -v, --verbose Verbose logging.
2743
+ --[no-]color Colorize human output. Disable with --no-color;
2744
+ NO_COLOR and FORCE_COLOR are honored too.
2745
+ --debug Debug logging.
2746
+ --dry-run Preview without mutating files or the platform.
2747
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
2748
+ process environment. Cannot be combined with --env.
2749
+ --fields=<value> Fields to show, comma-separated dot-paths. Defaults to
2750
+ the resource's own; `--json` is unaffected.
2751
+ --[no-]telemetry Send anonymous usage analytics. Disable with
2752
+ --no-telemetry.
1729
2753
 
1730
2754
  GLOBAL FLAGS
1731
2755
  --json Format output as json.
@@ -1734,24 +2758,29 @@ DESCRIPTION
1734
2758
  Get one release by id.
1735
2759
 
1736
2760
  EXAMPLES
1737
- $ zitadel releases get <id>
2761
+ $ zitadel release get <id>
1738
2762
 
1739
- $ zitadel releases get <id> --json
2763
+ $ zitadel release get <id> --json
1740
2764
  ```
1741
2765
 
1742
- ## `zitadel releases list`
2766
+ ## `zitadel release list`
1743
2767
 
1744
- List releases.
2768
+ List release.
1745
2769
 
1746
2770
  ```
1747
2771
  USAGE
1748
- $ zitadel releases list [--json] [-c <value>] [-s <value>] [-n]
1749
- [--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
1750
- --page-token <value>] [--fields <value>] [--plain]
2772
+ $ zitadel release list [--json] [-c <value>] [-s <value>] [-n]
2773
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
2774
+ <value>] [--limit <value>] [-a | --page-token <value>] [--fields <value>]
2775
+ [--plain]
1751
2776
 
1752
2777
  FLAGS
1753
2778
  -a, --all Fetch every page instead of one.
1754
2779
  -c, --cwd=<value> Project directory to operate on.
2780
+ -e, --env=<value> Environment to run against, e.g. production.
2781
+ Defaults to ZITADEL_ENV, then the hosting platform's
2782
+ build (VERCEL_ENV, or Netlify's CONTEXT), then
2783
+ development.
1755
2784
  -n, --non-interactive Disable prompts. Required when scripting or running
1756
2785
  as an agent.
1757
2786
  -s, --server=<value> Override the resolved server URL.
@@ -1760,6 +2789,8 @@ FLAGS
1760
2789
  NO_COLOR and FORCE_COLOR are honored too.
1761
2790
  --debug Debug logging.
1762
2791
  --dry-run Preview without mutating files or the platform.
2792
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
2793
+ process environment. Cannot be combined with --env.
1763
2794
  --fields=<value> Columns to show, comma-separated dot-paths (e.g.
1764
2795
  id,attributes.email). Defaults to the resource's own
1765
2796
  columns; `--json` is unaffected.
@@ -1774,12 +2805,57 @@ GLOBAL FLAGS
1774
2805
  --json Format output as json.
1775
2806
 
1776
2807
  DESCRIPTION
1777
- List releases.
2808
+ List release.
1778
2809
 
1779
2810
  EXAMPLES
1780
- $ zitadel releases list --json
2811
+ $ zitadel release list --json
1781
2812
 
1782
- $ zitadel releases list --all --json
2813
+ $ zitadel release list --all --json
2814
+ ```
2815
+
2816
+ ## `zitadel release revoke RELEASE_ID`
2817
+
2818
+ Revoke a release so its content is never served again.
2819
+
2820
+ ```
2821
+ USAGE
2822
+ $ zitadel release revoke RELEASE_ID [--json] [-c <value>] [-s <value>]
2823
+ [-n] [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>]
2824
+ [--env-file <value>] [-f]
2825
+
2826
+ ARGUMENTS
2827
+ RELEASE_ID The release to revoke.
2828
+
2829
+ FLAGS
2830
+ -c, --cwd=<value> Project directory to operate on.
2831
+ -e, --env=<value> Environment to run against, e.g. production. Defaults
2832
+ to ZITADEL_ENV, then the hosting platform's build
2833
+ (VERCEL_ENV, or Netlify's CONTEXT), then development.
2834
+ -f, --force Revoke without the confirmation prompt. Required when
2835
+ non-interactive.
2836
+ -n, --non-interactive Disable prompts. Required when scripting or running as
2837
+ an agent.
2838
+ -s, --server=<value> Override the resolved server URL.
2839
+ -v, --verbose Verbose logging.
2840
+ --[no-]color Colorize human output. Disable with --no-color;
2841
+ NO_COLOR and FORCE_COLOR are honored too.
2842
+ --debug Debug logging.
2843
+ --dry-run Preview without mutating files or the platform.
2844
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
2845
+ process environment. Cannot be combined with --env.
2846
+ --[no-]telemetry Send anonymous usage analytics. Disable with
2847
+ --no-telemetry.
2848
+
2849
+ GLOBAL FLAGS
2850
+ --json Format output as json.
2851
+
2852
+ DESCRIPTION
2853
+ Revoke a release so its content is never served again.
2854
+
2855
+ EXAMPLES
2856
+ $ zitadel release revoke rel_01KX3RG8A7F0N9WD3P2E4YM5C1
2857
+
2858
+ $ zitadel release revoke rel_01KX3RG8A7F0N9WD3P2E4YM5C1 --force
1783
2859
  ```
1784
2860
 
1785
2861
  ## `zitadel reset`
@@ -1815,12 +2891,12 @@ DESCRIPTION
1815
2891
 
1816
2892
  ## `zitadel resources`
1817
2893
 
1818
- List the resources this CLI manages and what can be done to each.
2894
+ List the resources this CLI manages.
1819
2895
 
1820
2896
  ```
1821
2897
  USAGE
1822
2898
  $ zitadel resources [--json] [-c <value>] [-s <value>] [-n]
1823
- [--dry-run] [-v] [--debug] [--color] [--telemetry]
2899
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--plain]
1824
2900
 
1825
2901
  FLAGS
1826
2902
  -c, --cwd=<value> Project directory to operate on.
@@ -1832,6 +2908,8 @@ FLAGS
1832
2908
  NO_COLOR and FORCE_COLOR are honored too.
1833
2909
  --debug Debug logging.
1834
2910
  --dry-run Preview without mutating files or the platform.
2911
+ --plain Tab-separated rows with no header, for piping. Implied
2912
+ when stdout is not a terminal.
1835
2913
  --[no-]telemetry Send anonymous usage analytics. Disable with
1836
2914
  --no-telemetry.
1837
2915
 
@@ -1839,53 +2917,61 @@ GLOBAL FLAGS
1839
2917
  --json Format output as json.
1840
2918
 
1841
2919
  DESCRIPTION
1842
- List the resources this CLI manages and what can be done to each.
2920
+ List the resources this CLI manages.
2921
+
2922
+ Shows what can be done to each.
1843
2923
 
1844
2924
  EXAMPLES
1845
2925
  $ zitadel resources
1846
2926
 
1847
2927
  $ zitadel resources --json
1848
2928
 
1849
- $ zitadel resources --json | jq -r '.data.resources[] | "\(.topic): \(.verbs | join(", "))"'
2929
+ $ zitadel resources --json | jq -r '.data.items[] | "\(.topic): \(.verbs | join(", "))"'
1850
2930
  ```
1851
2931
 
1852
2932
  ## `zitadel schemas get SCHEMA`
1853
2933
 
1854
- Get one schema by id.
2934
+ Get one schema by object type (current revision) or revision id.
1855
2935
 
1856
2936
  ```
1857
2937
  USAGE
1858
2938
  $ zitadel schemas get SCHEMA [--json] [-c <value>] [-s <value>] [-n]
1859
- [--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
2939
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
2940
+ <value>] [--fields <value>]
1860
2941
 
1861
2942
  ARGUMENTS
1862
2943
  SCHEMA object type (current revision) or revision id
1863
2944
 
1864
2945
  FLAGS
1865
- -c, --cwd=<value> Project directory to operate on.
1866
- -n, --non-interactive Disable prompts. Required when scripting or running as
1867
- an agent.
1868
- -s, --server=<value> Override the resolved server URL.
1869
- -v, --verbose Verbose logging.
1870
- --[no-]color Colorize human output. Disable with --no-color;
1871
- NO_COLOR and FORCE_COLOR are honored too.
1872
- --debug Debug logging.
1873
- --dry-run Preview without mutating files or the platform.
1874
- --fields=<value> Fields to show, comma-separated dot-paths. Defaults to
1875
- the resource's own; `--json` is unaffected.
1876
- --[no-]telemetry Send anonymous usage analytics. Disable with
1877
- --no-telemetry.
2946
+ -c, --cwd=<value> Project directory to operate on.
2947
+ -e, --env=<value> Environment to run against, e.g. production. Defaults
2948
+ to ZITADEL_ENV, then the hosting platform's build
2949
+ (VERCEL_ENV, or Netlify's CONTEXT), then development.
2950
+ -n, --non-interactive Disable prompts. Required when scripting or running as
2951
+ an agent.
2952
+ -s, --server=<value> Override the resolved server URL.
2953
+ -v, --verbose Verbose logging.
2954
+ --[no-]color Colorize human output. Disable with --no-color;
2955
+ NO_COLOR and FORCE_COLOR are honored too.
2956
+ --debug Debug logging.
2957
+ --dry-run Preview without mutating files or the platform.
2958
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
2959
+ process environment. Cannot be combined with --env.
2960
+ --fields=<value> Fields to show, comma-separated dot-paths. Defaults to
2961
+ the resource's own; `--json` is unaffected.
2962
+ --[no-]telemetry Send anonymous usage analytics. Disable with
2963
+ --no-telemetry.
1878
2964
 
1879
2965
  GLOBAL FLAGS
1880
2966
  --json Format output as json.
1881
2967
 
1882
2968
  DESCRIPTION
1883
- Get one schema by id.
2969
+ Get one schema by object type (current revision) or revision id.
1884
2970
 
1885
2971
  EXAMPLES
1886
- $ zitadel schemas get <id>
2972
+ $ zitadel schemas get <schema>
1887
2973
 
1888
- $ zitadel schemas get <id> --json
2974
+ $ zitadel schemas get <schema> --json
1889
2975
  ```
1890
2976
 
1891
2977
  ## `zitadel schemas list`
@@ -1895,12 +2981,17 @@ List schemas.
1895
2981
  ```
1896
2982
  USAGE
1897
2983
  $ zitadel schemas list [--json] [-c <value>] [-s <value>] [-n]
1898
- [--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
1899
- --page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
2984
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
2985
+ <value>] [--limit <value>] [-a | --page-token <value>] [--fields <value>]
2986
+ [--plain] [--filter <value>...]
1900
2987
 
1901
2988
  FLAGS
1902
2989
  -a, --all Fetch every page instead of one.
1903
2990
  -c, --cwd=<value> Project directory to operate on.
2991
+ -e, --env=<value> Environment to run against, e.g. production.
2992
+ Defaults to ZITADEL_ENV, then the hosting platform's
2993
+ build (VERCEL_ENV, or Netlify's CONTEXT), then
2994
+ development.
1904
2995
  -n, --non-interactive Disable prompts. Required when scripting or running
1905
2996
  as an agent.
1906
2997
  -s, --server=<value> Override the resolved server URL.
@@ -1909,6 +3000,8 @@ FLAGS
1909
3000
  NO_COLOR and FORCE_COLOR are honored too.
1910
3001
  --debug Debug logging.
1911
3002
  --dry-run Preview without mutating files or the platform.
3003
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
3004
+ process environment. Cannot be combined with --env.
1912
3005
  --fields=<value> Columns to show, comma-separated dot-paths (e.g.
1913
3006
  id,attributes.email). Defaults to the resource's own
1914
3007
  columns; `--json` is unaffected.
@@ -1960,25 +3053,31 @@ Get one session by id.
1960
3053
  ```
1961
3054
  USAGE
1962
3055
  $ zitadel sessions get ID [--json] [-c <value>] [-s <value>] [-n]
1963
- [--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
3056
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
3057
+ <value>] [--fields <value>]
1964
3058
 
1965
3059
  ARGUMENTS
1966
3060
  ID session id
1967
3061
 
1968
3062
  FLAGS
1969
- -c, --cwd=<value> Project directory to operate on.
1970
- -n, --non-interactive Disable prompts. Required when scripting or running as
1971
- an agent.
1972
- -s, --server=<value> Override the resolved server URL.
1973
- -v, --verbose Verbose logging.
1974
- --[no-]color Colorize human output. Disable with --no-color;
1975
- NO_COLOR and FORCE_COLOR are honored too.
1976
- --debug Debug logging.
1977
- --dry-run Preview without mutating files or the platform.
1978
- --fields=<value> Fields to show, comma-separated dot-paths. Defaults to
1979
- the resource's own; `--json` is unaffected.
1980
- --[no-]telemetry Send anonymous usage analytics. Disable with
1981
- --no-telemetry.
3063
+ -c, --cwd=<value> Project directory to operate on.
3064
+ -e, --env=<value> Environment to run against, e.g. production. Defaults
3065
+ to ZITADEL_ENV, then the hosting platform's build
3066
+ (VERCEL_ENV, or Netlify's CONTEXT), then development.
3067
+ -n, --non-interactive Disable prompts. Required when scripting or running as
3068
+ an agent.
3069
+ -s, --server=<value> Override the resolved server URL.
3070
+ -v, --verbose Verbose logging.
3071
+ --[no-]color Colorize human output. Disable with --no-color;
3072
+ NO_COLOR and FORCE_COLOR are honored too.
3073
+ --debug Debug logging.
3074
+ --dry-run Preview without mutating files or the platform.
3075
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
3076
+ process environment. Cannot be combined with --env.
3077
+ --fields=<value> Fields to show, comma-separated dot-paths. Defaults to
3078
+ the resource's own; `--json` is unaffected.
3079
+ --[no-]telemetry Send anonymous usage analytics. Disable with
3080
+ --no-telemetry.
1982
3081
 
1983
3082
  GLOBAL FLAGS
1984
3083
  --json Format output as json.
@@ -1999,9 +3098,9 @@ List sessions.
1999
3098
  ```
2000
3099
  USAGE
2001
3100
  $ zitadel sessions list [--json] [-c <value>] [-s <value>] [-n]
2002
- [--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
2003
- --page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
2004
- [--sort <value>]
3101
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
3102
+ <value>] [--limit <value>] [-a | --page-token <value>] [--fields <value>]
3103
+ [--plain] [--filter <value>...] [--sort <value>]
2005
3104
 
2006
3105
  FLAGS
2007
3106
  -a, --all
@@ -2010,6 +3109,11 @@ FLAGS
2010
3109
  -c, --cwd=<value>
2011
3110
  Project directory to operate on.
2012
3111
 
3112
+ -e, --env=<value>
3113
+ Environment to run against, e.g. production. Defaults to ZITADEL_ENV, then
3114
+ the hosting platform's build (VERCEL_ENV, or Netlify's CONTEXT), then
3115
+ development.
3116
+
2013
3117
  -n, --non-interactive
2014
3118
  Disable prompts. Required when scripting or running as an agent.
2015
3119
 
@@ -2029,6 +3133,10 @@ FLAGS
2029
3133
  --dry-run
2030
3134
  Preview without mutating files or the platform.
2031
3135
 
3136
+ --env-file=<value>
3137
+ Read ZITADEL_* values from this file ahead of the process environment.
3138
+ Cannot be combined with --env.
3139
+
2032
3140
  --fields=<value>
2033
3141
  Columns to show, comma-separated dot-paths (e.g. id,attributes.email).
2034
3142
  Defaults to the resource's own columns; `--json` is unaffected.
@@ -2080,25 +3188,31 @@ Revoke a session by id.
2080
3188
  ```
2081
3189
  USAGE
2082
3190
  $ zitadel sessions revoke ID [--json] [-c <value>] [-s <value>] [-n]
2083
- [--dry-run] [-v] [--debug] [--color] [--telemetry] [-f]
3191
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
3192
+ <value>] [-f]
2084
3193
 
2085
3194
  ARGUMENTS
2086
3195
  ID session id
2087
3196
 
2088
3197
  FLAGS
2089
- -c, --cwd=<value> Project directory to operate on.
2090
- -f, --force Revoke the session without the confirmation prompt.
2091
- Required when non-interactive.
2092
- -n, --non-interactive Disable prompts. Required when scripting or running as
2093
- an agent.
2094
- -s, --server=<value> Override the resolved server URL.
2095
- -v, --verbose Verbose logging.
2096
- --[no-]color Colorize human output. Disable with --no-color;
2097
- NO_COLOR and FORCE_COLOR are honored too.
2098
- --debug Debug logging.
2099
- --dry-run Preview without mutating files or the platform.
2100
- --[no-]telemetry Send anonymous usage analytics. Disable with
2101
- --no-telemetry.
3198
+ -c, --cwd=<value> Project directory to operate on.
3199
+ -e, --env=<value> Environment to run against, e.g. production. Defaults
3200
+ to ZITADEL_ENV, then the hosting platform's build
3201
+ (VERCEL_ENV, or Netlify's CONTEXT), then development.
3202
+ -f, --force Revoke the session without the confirmation prompt.
3203
+ Required when non-interactive.
3204
+ -n, --non-interactive Disable prompts. Required when scripting or running as
3205
+ an agent.
3206
+ -s, --server=<value> Override the resolved server URL.
3207
+ -v, --verbose Verbose logging.
3208
+ --[no-]color Colorize human output. Disable with --no-color;
3209
+ NO_COLOR and FORCE_COLOR are honored too.
3210
+ --debug Debug logging.
3211
+ --dry-run Preview without mutating files or the platform.
3212
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
3213
+ process environment. Cannot be combined with --env.
3214
+ --[no-]telemetry Send anonymous usage analytics. Disable with
3215
+ --no-telemetry.
2102
3216
 
2103
3217
  GLOBAL FLAGS
2104
3218
  --json Format output as json.
@@ -2112,7 +3226,7 @@ EXAMPLES
2112
3226
 
2113
3227
  ## `zitadel setup`
2114
3228
 
2115
- Create a Zitadel project and scaffold local auth.
3229
+ Create a Zitadel project and scaffold local auth. An interactive setup ends with a note about the Zitadel agent skills, shown once per machine; set NO_SKILLS_PROMPT=1 to hide it.
2116
3230
 
2117
3231
  ```
2118
3232
  USAGE
@@ -2121,9 +3235,9 @@ USAGE
2121
3235
  next|nuxt|tanstack-start|react|vue|solid-start|solid|sveltekit|svelte|qwik-r
2122
3236
  outer|qwik|angular] [--renderer react] [--dev-port <value>] [--skip-install]
2123
3237
  [--preset password-first|passkey-first] [--use-case
2124
- minimal|consumer|business] [--sso google|custom] [--sso-client-id <value>]
2125
- [--sso-slug <value>] [--sso-display-name <value>] [--sso-issuer <value>]
2126
- [--sso-scopes <value>]
3238
+ minimal|consumer|business] [--password-min-length <value>] [--sso
3239
+ google|custom] [--sso-client-id <value>] [--sso-slug <value>]
3240
+ [--sso-display-name <value>] [--sso-issuer <value>] [--sso-scopes <value>]
2127
3241
 
2128
3242
  FLAGS
2129
3243
  -c, --cwd=<value>
@@ -2152,7 +3266,8 @@ FLAGS
2152
3266
  --dev-port=<value>
2153
3267
  Dev-server port; also the issuer origin registered with Zitadel. Defaults to
2154
3268
  the detected port. Use distinct ports to run several scaffolded apps side by
2155
- side.
3269
+ side. In an app already set up, moves it to this port: the dev script,
3270
+ ZITADEL_ISSUER and the allowed origin.
2156
3271
 
2157
3272
  --dry-run
2158
3273
  Preview without mutating files or the platform.
@@ -2162,6 +3277,11 @@ FLAGS
2162
3277
  <options: next|nuxt|tanstack-start|react|vue|solid-start|solid|sveltekit|sve
2163
3278
  lte|qwik-router|qwik|angular>
2164
3279
 
3280
+ --password-min-length=<value>
3281
+ Minimum password length for the project's password policy, for example 12; 0
3282
+ sets none. Without it, setup sets 15, the NIST minimum for password-only
3283
+ sign-in; change it in .zitadel/policies/ later.
3284
+
2165
3285
  --preset=<option>
2166
3286
  Sign-in preset for the scaffolded schema and login flow (default:
2167
3287
  password-first).
@@ -2211,7 +3331,9 @@ GLOBAL FLAGS
2211
3331
  --json Format output as json.
2212
3332
 
2213
3333
  DESCRIPTION
2214
- Create a Zitadel project and scaffold local auth.
3334
+ Create a Zitadel project and scaffold local auth. An interactive setup ends
3335
+ with a note about the Zitadel agent skills, shown once per machine; set
3336
+ NO_SKILLS_PROMPT=1 to hide it.
2215
3337
 
2216
3338
  EXAMPLES
2217
3339
  $ zitadel setup --framework next
@@ -2261,20 +3383,26 @@ Summarize the local Zitadel server and project state.
2261
3383
  ```
2262
3384
  USAGE
2263
3385
  $ zitadel status [--json] [-c <value>] [-s <value>] [-n]
2264
- [--dry-run] [-v] [--debug] [--color] [--telemetry]
3386
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
3387
+ <value>]
2265
3388
 
2266
3389
  FLAGS
2267
- -c, --cwd=<value> Project directory to operate on.
2268
- -n, --non-interactive Disable prompts. Required when scripting or running as
2269
- an agent.
2270
- -s, --server=<value> Override the resolved server URL.
2271
- -v, --verbose Verbose logging.
2272
- --[no-]color Colorize human output. Disable with --no-color;
2273
- NO_COLOR and FORCE_COLOR are honored too.
2274
- --debug Debug logging.
2275
- --dry-run Preview without mutating files or the platform.
2276
- --[no-]telemetry Send anonymous usage analytics. Disable with
2277
- --no-telemetry.
3390
+ -c, --cwd=<value> Project directory to operate on.
3391
+ -e, --env=<value> Environment to run against, e.g. production. Defaults
3392
+ to ZITADEL_ENV, then the hosting platform's build
3393
+ (VERCEL_ENV, or Netlify's CONTEXT), then development.
3394
+ -n, --non-interactive Disable prompts. Required when scripting or running as
3395
+ an agent.
3396
+ -s, --server=<value> Override the resolved server URL.
3397
+ -v, --verbose Verbose logging.
3398
+ --[no-]color Colorize human output. Disable with --no-color;
3399
+ NO_COLOR and FORCE_COLOR are honored too.
3400
+ --debug Debug logging.
3401
+ --dry-run Preview without mutating files or the platform.
3402
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
3403
+ process environment. Cannot be combined with --env.
3404
+ --[no-]telemetry Send anonymous usage analytics. Disable with
3405
+ --no-telemetry.
2278
3406
 
2279
3407
  GLOBAL FLAGS
2280
3408
  --json Format output as json.
@@ -2321,21 +3449,27 @@ Create a team.
2321
3449
  ```
2322
3450
  USAGE
2323
3451
  $ zitadel teams create [--json] [-c <value>] [-s <value>] [-n]
2324
- [--dry-run] [-v] [--debug] [--color] [--telemetry] [--name <value>] [--data
2325
- <value> | --file <value>] [--set <value>...]
3452
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
3453
+ <value>] [--name <value>] [--data <value> | --file <value>] [--set
3454
+ <value>...]
2326
3455
 
2327
3456
  FLAGS
2328
- -c, --cwd=<value> Project directory to operate on.
2329
- -n, --non-interactive Disable prompts. Required when scripting or running as
2330
- an agent.
2331
- -s, --server=<value> Override the resolved server URL.
2332
- -v, --verbose Verbose logging.
2333
- --[no-]color Colorize human output. Disable with --no-color;
2334
- NO_COLOR and FORCE_COLOR are honored too.
2335
- --debug Debug logging.
2336
- --dry-run Preview without mutating files or the platform.
2337
- --[no-]telemetry Send anonymous usage analytics. Disable with
2338
- --no-telemetry.
3457
+ -c, --cwd=<value> Project directory to operate on.
3458
+ -e, --env=<value> Environment to run against, e.g. production. Defaults
3459
+ to ZITADEL_ENV, then the hosting platform's build
3460
+ (VERCEL_ENV, or Netlify's CONTEXT), then development.
3461
+ -n, --non-interactive Disable prompts. Required when scripting or running as
3462
+ an agent.
3463
+ -s, --server=<value> Override the resolved server URL.
3464
+ -v, --verbose Verbose logging.
3465
+ --[no-]color Colorize human output. Disable with --no-color;
3466
+ NO_COLOR and FORCE_COLOR are honored too.
3467
+ --debug Debug logging.
3468
+ --dry-run Preview without mutating files or the platform.
3469
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
3470
+ process environment. Cannot be combined with --env.
3471
+ --[no-]telemetry Send anonymous usage analytics. Disable with
3472
+ --no-telemetry.
2339
3473
 
2340
3474
  RAW BODY FLAGS
2341
3475
  --data=<value> Whole body as a JSON object. Field flags and --set apply
@@ -2371,25 +3505,31 @@ Deactivate a team by id.
2371
3505
  ```
2372
3506
  USAGE
2373
3507
  $ zitadel teams deactivate ID [--json] [-c <value>] [-s <value>] [-n]
2374
- [--dry-run] [-v] [--debug] [--color] [--telemetry] [-f]
3508
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
3509
+ <value>] [-f]
2375
3510
 
2376
3511
  ARGUMENTS
2377
3512
  ID team id
2378
3513
 
2379
3514
  FLAGS
2380
- -c, --cwd=<value> Project directory to operate on.
2381
- -f, --force Deactivate the team without the confirmation prompt.
2382
- Required when non-interactive.
2383
- -n, --non-interactive Disable prompts. Required when scripting or running as
2384
- an agent.
2385
- -s, --server=<value> Override the resolved server URL.
2386
- -v, --verbose Verbose logging.
2387
- --[no-]color Colorize human output. Disable with --no-color;
2388
- NO_COLOR and FORCE_COLOR are honored too.
2389
- --debug Debug logging.
2390
- --dry-run Preview without mutating files or the platform.
2391
- --[no-]telemetry Send anonymous usage analytics. Disable with
2392
- --no-telemetry.
3515
+ -c, --cwd=<value> Project directory to operate on.
3516
+ -e, --env=<value> Environment to run against, e.g. production. Defaults
3517
+ to ZITADEL_ENV, then the hosting platform's build
3518
+ (VERCEL_ENV, or Netlify's CONTEXT), then development.
3519
+ -f, --force Deactivate the team without the confirmation prompt.
3520
+ Required when non-interactive.
3521
+ -n, --non-interactive Disable prompts. Required when scripting or running as
3522
+ an agent.
3523
+ -s, --server=<value> Override the resolved server URL.
3524
+ -v, --verbose Verbose logging.
3525
+ --[no-]color Colorize human output. Disable with --no-color;
3526
+ NO_COLOR and FORCE_COLOR are honored too.
3527
+ --debug Debug logging.
3528
+ --dry-run Preview without mutating files or the platform.
3529
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
3530
+ process environment. Cannot be combined with --env.
3531
+ --[no-]telemetry Send anonymous usage analytics. Disable with
3532
+ --no-telemetry.
2393
3533
 
2394
3534
  GLOBAL FLAGS
2395
3535
  --json Format output as json.
@@ -2408,25 +3548,31 @@ Get one team by id.
2408
3548
  ```
2409
3549
  USAGE
2410
3550
  $ zitadel teams get ID [--json] [-c <value>] [-s <value>] [-n]
2411
- [--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
3551
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
3552
+ <value>] [--fields <value>]
2412
3553
 
2413
3554
  ARGUMENTS
2414
3555
  ID team id
2415
3556
 
2416
3557
  FLAGS
2417
- -c, --cwd=<value> Project directory to operate on.
2418
- -n, --non-interactive Disable prompts. Required when scripting or running as
2419
- an agent.
2420
- -s, --server=<value> Override the resolved server URL.
2421
- -v, --verbose Verbose logging.
2422
- --[no-]color Colorize human output. Disable with --no-color;
2423
- NO_COLOR and FORCE_COLOR are honored too.
2424
- --debug Debug logging.
2425
- --dry-run Preview without mutating files or the platform.
2426
- --fields=<value> Fields to show, comma-separated dot-paths. Defaults to
2427
- the resource's own; `--json` is unaffected.
2428
- --[no-]telemetry Send anonymous usage analytics. Disable with
2429
- --no-telemetry.
3558
+ -c, --cwd=<value> Project directory to operate on.
3559
+ -e, --env=<value> Environment to run against, e.g. production. Defaults
3560
+ to ZITADEL_ENV, then the hosting platform's build
3561
+ (VERCEL_ENV, or Netlify's CONTEXT), then development.
3562
+ -n, --non-interactive Disable prompts. Required when scripting or running as
3563
+ an agent.
3564
+ -s, --server=<value> Override the resolved server URL.
3565
+ -v, --verbose Verbose logging.
3566
+ --[no-]color Colorize human output. Disable with --no-color;
3567
+ NO_COLOR and FORCE_COLOR are honored too.
3568
+ --debug Debug logging.
3569
+ --dry-run Preview without mutating files or the platform.
3570
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
3571
+ process environment. Cannot be combined with --env.
3572
+ --fields=<value> Fields to show, comma-separated dot-paths. Defaults to
3573
+ the resource's own; `--json` is unaffected.
3574
+ --[no-]telemetry Send anonymous usage analytics. Disable with
3575
+ --no-telemetry.
2430
3576
 
2431
3577
  GLOBAL FLAGS
2432
3578
  --json Format output as json.
@@ -2447,9 +3593,9 @@ List teams.
2447
3593
  ```
2448
3594
  USAGE
2449
3595
  $ zitadel teams list [--json] [-c <value>] [-s <value>] [-n]
2450
- [--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
2451
- --page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
2452
- [--sort <value>]
3596
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
3597
+ <value>] [--limit <value>] [-a | --page-token <value>] [--fields <value>]
3598
+ [--plain] [--filter <value>...] [--sort <value>]
2453
3599
 
2454
3600
  FLAGS
2455
3601
  -a, --all
@@ -2458,6 +3604,11 @@ FLAGS
2458
3604
  -c, --cwd=<value>
2459
3605
  Project directory to operate on.
2460
3606
 
3607
+ -e, --env=<value>
3608
+ Environment to run against, e.g. production. Defaults to ZITADEL_ENV, then
3609
+ the hosting platform's build (VERCEL_ENV, or Netlify's CONTEXT), then
3610
+ development.
3611
+
2461
3612
  -n, --non-interactive
2462
3613
  Disable prompts. Required when scripting or running as an agent.
2463
3614
 
@@ -2477,6 +3628,10 @@ FLAGS
2477
3628
  --dry-run
2478
3629
  Preview without mutating files or the platform.
2479
3630
 
3631
+ --env-file=<value>
3632
+ Read ZITADEL_* values from this file ahead of the process environment.
3633
+ Cannot be combined with --env.
3634
+
2480
3635
  --fields=<value>
2481
3636
  Columns to show, comma-separated dot-paths (e.g. id,attributes.email).
2482
3637
  Defaults to the resource's own columns; `--json` is unaffected.
@@ -2526,24 +3681,30 @@ Update a team by id.
2526
3681
  ```
2527
3682
  USAGE
2528
3683
  $ zitadel teams update ID [--json] [-c <value>] [-s <value>] [-n]
2529
- [--dry-run] [-v] [--debug] [--color] [--telemetry] [--name <value>] [--data
2530
- <value> | --file <value>] [--set <value>...]
3684
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
3685
+ <value>] [--name <value>] [--data <value> | --file <value>] [--set
3686
+ <value>...]
2531
3687
 
2532
3688
  ARGUMENTS
2533
3689
  ID team id
2534
3690
 
2535
3691
  FLAGS
2536
- -c, --cwd=<value> Project directory to operate on.
2537
- -n, --non-interactive Disable prompts. Required when scripting or running as
2538
- an agent.
2539
- -s, --server=<value> Override the resolved server URL.
2540
- -v, --verbose Verbose logging.
2541
- --[no-]color Colorize human output. Disable with --no-color;
2542
- NO_COLOR and FORCE_COLOR are honored too.
2543
- --debug Debug logging.
2544
- --dry-run Preview without mutating files or the platform.
2545
- --[no-]telemetry Send anonymous usage analytics. Disable with
2546
- --no-telemetry.
3692
+ -c, --cwd=<value> Project directory to operate on.
3693
+ -e, --env=<value> Environment to run against, e.g. production. Defaults
3694
+ to ZITADEL_ENV, then the hosting platform's build
3695
+ (VERCEL_ENV, or Netlify's CONTEXT), then development.
3696
+ -n, --non-interactive Disable prompts. Required when scripting or running as
3697
+ an agent.
3698
+ -s, --server=<value> Override the resolved server URL.
3699
+ -v, --verbose Verbose logging.
3700
+ --[no-]color Colorize human output. Disable with --no-color;
3701
+ NO_COLOR and FORCE_COLOR are honored too.
3702
+ --debug Debug logging.
3703
+ --dry-run Preview without mutating files or the platform.
3704
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
3705
+ process environment. Cannot be combined with --env.
3706
+ --[no-]telemetry Send anonymous usage analytics. Disable with
3707
+ --no-telemetry.
2547
3708
 
2548
3709
  RAW BODY FLAGS
2549
3710
  --data=<value> Whole body as a JSON object. Field flags and --set apply
@@ -2611,22 +3772,27 @@ Create a user.
2611
3772
  ```
2612
3773
  USAGE
2613
3774
  $ zitadel users create [--json] [-c <value>] [-s <value>] [-n]
2614
- [--dry-run] [-v] [--debug] [--color] [--telemetry] [--schema <value>]
2615
- [--attributes <value>...] [--data <value> | --file <value>] [--set
2616
- <value>...]
3775
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
3776
+ <value>] [--schema <value>] [--attributes <value>...] [--data <value> |
3777
+ --file <value>] [--set <value>...]
2617
3778
 
2618
3779
  FLAGS
2619
- -c, --cwd=<value> Project directory to operate on.
2620
- -n, --non-interactive Disable prompts. Required when scripting or running as
2621
- an agent.
2622
- -s, --server=<value> Override the resolved server URL.
2623
- -v, --verbose Verbose logging.
2624
- --[no-]color Colorize human output. Disable with --no-color;
2625
- NO_COLOR and FORCE_COLOR are honored too.
2626
- --debug Debug logging.
2627
- --dry-run Preview without mutating files or the platform.
2628
- --[no-]telemetry Send anonymous usage analytics. Disable with
2629
- --no-telemetry.
3780
+ -c, --cwd=<value> Project directory to operate on.
3781
+ -e, --env=<value> Environment to run against, e.g. production. Defaults
3782
+ to ZITADEL_ENV, then the hosting platform's build
3783
+ (VERCEL_ENV, or Netlify's CONTEXT), then development.
3784
+ -n, --non-interactive Disable prompts. Required when scripting or running as
3785
+ an agent.
3786
+ -s, --server=<value> Override the resolved server URL.
3787
+ -v, --verbose Verbose logging.
3788
+ --[no-]color Colorize human output. Disable with --no-color;
3789
+ NO_COLOR and FORCE_COLOR are honored too.
3790
+ --debug Debug logging.
3791
+ --dry-run Preview without mutating files or the platform.
3792
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
3793
+ process environment. Cannot be combined with --env.
3794
+ --[no-]telemetry Send anonymous usage analytics. Disable with
3795
+ --no-telemetry.
2630
3796
 
2631
3797
  REQUIRED FIELD FLAGS
2632
3798
  --attributes=<value>... (required) Repeatable attributes entry: key=value for
@@ -2666,25 +3832,31 @@ Delete a user by id.
2666
3832
  ```
2667
3833
  USAGE
2668
3834
  $ zitadel users delete ID [--json] [-c <value>] [-s <value>] [-n]
2669
- [--dry-run] [-v] [--debug] [--color] [--telemetry] [-f]
3835
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
3836
+ <value>] [-f]
2670
3837
 
2671
3838
  ARGUMENTS
2672
3839
  ID user id
2673
3840
 
2674
3841
  FLAGS
2675
- -c, --cwd=<value> Project directory to operate on.
2676
- -f, --force Delete the user without the confirmation prompt.
2677
- Required when non-interactive.
2678
- -n, --non-interactive Disable prompts. Required when scripting or running as
2679
- an agent.
2680
- -s, --server=<value> Override the resolved server URL.
2681
- -v, --verbose Verbose logging.
2682
- --[no-]color Colorize human output. Disable with --no-color;
2683
- NO_COLOR and FORCE_COLOR are honored too.
2684
- --debug Debug logging.
2685
- --dry-run Preview without mutating files or the platform.
2686
- --[no-]telemetry Send anonymous usage analytics. Disable with
2687
- --no-telemetry.
3842
+ -c, --cwd=<value> Project directory to operate on.
3843
+ -e, --env=<value> Environment to run against, e.g. production. Defaults
3844
+ to ZITADEL_ENV, then the hosting platform's build
3845
+ (VERCEL_ENV, or Netlify's CONTEXT), then development.
3846
+ -f, --force Delete the user without the confirmation prompt.
3847
+ Required when non-interactive.
3848
+ -n, --non-interactive Disable prompts. Required when scripting or running as
3849
+ an agent.
3850
+ -s, --server=<value> Override the resolved server URL.
3851
+ -v, --verbose Verbose logging.
3852
+ --[no-]color Colorize human output. Disable with --no-color;
3853
+ NO_COLOR and FORCE_COLOR are honored too.
3854
+ --debug Debug logging.
3855
+ --dry-run Preview without mutating files or the platform.
3856
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
3857
+ process environment. Cannot be combined with --env.
3858
+ --[no-]telemetry Send anonymous usage analytics. Disable with
3859
+ --no-telemetry.
2688
3860
 
2689
3861
  GLOBAL FLAGS
2690
3862
  --json Format output as json.
@@ -2703,25 +3875,31 @@ Get one user by id.
2703
3875
  ```
2704
3876
  USAGE
2705
3877
  $ zitadel users get ID [--json] [-c <value>] [-s <value>] [-n]
2706
- [--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
3878
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
3879
+ <value>] [--fields <value>]
2707
3880
 
2708
3881
  ARGUMENTS
2709
3882
  ID user id
2710
3883
 
2711
3884
  FLAGS
2712
- -c, --cwd=<value> Project directory to operate on.
2713
- -n, --non-interactive Disable prompts. Required when scripting or running as
2714
- an agent.
2715
- -s, --server=<value> Override the resolved server URL.
2716
- -v, --verbose Verbose logging.
2717
- --[no-]color Colorize human output. Disable with --no-color;
2718
- NO_COLOR and FORCE_COLOR are honored too.
2719
- --debug Debug logging.
2720
- --dry-run Preview without mutating files or the platform.
2721
- --fields=<value> Fields to show, comma-separated dot-paths. Defaults to
2722
- the resource's own; `--json` is unaffected.
2723
- --[no-]telemetry Send anonymous usage analytics. Disable with
2724
- --no-telemetry.
3885
+ -c, --cwd=<value> Project directory to operate on.
3886
+ -e, --env=<value> Environment to run against, e.g. production. Defaults
3887
+ to ZITADEL_ENV, then the hosting platform's build
3888
+ (VERCEL_ENV, or Netlify's CONTEXT), then development.
3889
+ -n, --non-interactive Disable prompts. Required when scripting or running as
3890
+ an agent.
3891
+ -s, --server=<value> Override the resolved server URL.
3892
+ -v, --verbose Verbose logging.
3893
+ --[no-]color Colorize human output. Disable with --no-color;
3894
+ NO_COLOR and FORCE_COLOR are honored too.
3895
+ --debug Debug logging.
3896
+ --dry-run Preview without mutating files or the platform.
3897
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
3898
+ process environment. Cannot be combined with --env.
3899
+ --fields=<value> Fields to show, comma-separated dot-paths. Defaults to
3900
+ the resource's own; `--json` is unaffected.
3901
+ --[no-]telemetry Send anonymous usage analytics. Disable with
3902
+ --no-telemetry.
2725
3903
 
2726
3904
  GLOBAL FLAGS
2727
3905
  --json Format output as json.
@@ -2742,9 +3920,9 @@ List users.
2742
3920
  ```
2743
3921
  USAGE
2744
3922
  $ zitadel users list [--json] [-c <value>] [-s <value>] [-n]
2745
- [--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
2746
- --page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
2747
- [--sort <value>]
3923
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
3924
+ <value>] [--limit <value>] [-a | --page-token <value>] [--fields <value>]
3925
+ [--plain] [--filter <value>...] [--sort <value>]
2748
3926
 
2749
3927
  FLAGS
2750
3928
  -a, --all
@@ -2753,6 +3931,11 @@ FLAGS
2753
3931
  -c, --cwd=<value>
2754
3932
  Project directory to operate on.
2755
3933
 
3934
+ -e, --env=<value>
3935
+ Environment to run against, e.g. production. Defaults to ZITADEL_ENV, then
3936
+ the hosting platform's build (VERCEL_ENV, or Netlify's CONTEXT), then
3937
+ development.
3938
+
2756
3939
  -n, --non-interactive
2757
3940
  Disable prompts. Required when scripting or running as an agent.
2758
3941
 
@@ -2772,6 +3955,10 @@ FLAGS
2772
3955
  --dry-run
2773
3956
  Preview without mutating files or the platform.
2774
3957
 
3958
+ --env-file=<value>
3959
+ Read ZITADEL_* values from this file ahead of the process environment.
3960
+ Cannot be combined with --env.
3961
+
2775
3962
  --fields=<value>
2776
3963
  Columns to show, comma-separated dot-paths (e.g. id,attributes.email).
2777
3964
  Defaults to the resource's own columns; `--json` is unaffected.
@@ -2827,25 +4014,30 @@ Update a user by id.
2827
4014
  ```
2828
4015
  USAGE
2829
4016
  $ zitadel users update ID [--json] [-c <value>] [-s <value>] [-n]
2830
- [--dry-run] [-v] [--debug] [--color] [--telemetry] [--schema <value>]
2831
- [--attributes <value>...] [--data <value> | --file <value>] [--set
2832
- <value>...]
4017
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
4018
+ <value>] [--schema <value>] [--attributes <value>...] [--data <value> |
4019
+ --file <value>] [--set <value>...]
2833
4020
 
2834
4021
  ARGUMENTS
2835
4022
  ID user id
2836
4023
 
2837
4024
  FLAGS
2838
- -c, --cwd=<value> Project directory to operate on.
2839
- -n, --non-interactive Disable prompts. Required when scripting or running as
2840
- an agent.
2841
- -s, --server=<value> Override the resolved server URL.
2842
- -v, --verbose Verbose logging.
2843
- --[no-]color Colorize human output. Disable with --no-color;
2844
- NO_COLOR and FORCE_COLOR are honored too.
2845
- --debug Debug logging.
2846
- --dry-run Preview without mutating files or the platform.
2847
- --[no-]telemetry Send anonymous usage analytics. Disable with
2848
- --no-telemetry.
4025
+ -c, --cwd=<value> Project directory to operate on.
4026
+ -e, --env=<value> Environment to run against, e.g. production. Defaults
4027
+ to ZITADEL_ENV, then the hosting platform's build
4028
+ (VERCEL_ENV, or Netlify's CONTEXT), then development.
4029
+ -n, --non-interactive Disable prompts. Required when scripting or running as
4030
+ an agent.
4031
+ -s, --server=<value> Override the resolved server URL.
4032
+ -v, --verbose Verbose logging.
4033
+ --[no-]color Colorize human output. Disable with --no-color;
4034
+ NO_COLOR and FORCE_COLOR are honored too.
4035
+ --debug Debug logging.
4036
+ --dry-run Preview without mutating files or the platform.
4037
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
4038
+ process environment. Cannot be combined with --env.
4039
+ --[no-]telemetry Send anonymous usage analytics. Disable with
4040
+ --no-telemetry.
2849
4041
 
2850
4042
  OPTIONAL FIELD FLAGS
2851
4043
  --attributes=<value>... Repeatable attributes entry: key=value for a string,
@@ -2874,156 +4066,228 @@ EXAMPLES
2874
4066
  $ zitadel users update <id> --file ./user.json
2875
4067
  ```
2876
4068
 
2877
- ## `zitadel variables delete NAME`
4069
+ ## `zitadel variable get NAME`
2878
4070
 
2879
- Delete one variable from the project.
4071
+ Get one variable from the project.
2880
4072
 
2881
4073
  ```
2882
4074
  USAGE
2883
- $ zitadel variables delete NAME [--json] [-c <value>] [-s <value>] [-n]
2884
- [--dry-run] [-v] [--debug] [--color] [--telemetry] [--project-level] [-f]
4075
+ $ zitadel variable get NAME [--json] [-c <value>] [-s <value>] [-n]
4076
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
4077
+ <value>] [--preview]
2885
4078
 
2886
4079
  ARGUMENTS
2887
- NAME Variable name to delete.
4080
+ NAME Variable name to read.
2888
4081
 
2889
4082
  FLAGS
2890
- -c, --cwd=<value> Project directory to operate on.
2891
- -f, --force Delete the variable without the confirmation prompt.
2892
- Required when non-interactive.
2893
- -n, --non-interactive Disable prompts. Required when scripting or running as
2894
- an agent.
2895
- -s, --server=<value> Override the resolved server URL.
2896
- -v, --verbose Verbose logging.
2897
- --[no-]color Colorize human output. Disable with --no-color;
2898
- NO_COLOR and FORCE_COLOR are honored too.
2899
- --debug Debug logging.
2900
- --dry-run Preview without mutating files or the platform.
2901
- --project-level Address the project level. Required: it is the only
2902
- owner the CLI can address today.
2903
- --[no-]telemetry Send anonymous usage analytics. Disable with
2904
- --no-telemetry.
4083
+ -c, --cwd=<value> Project directory to operate on.
4084
+ -e, --env=<value> Environment to run against, e.g. production. Defaults
4085
+ to ZITADEL_ENV, then the hosting platform's build
4086
+ (VERCEL_ENV, or Netlify's CONTEXT), then development.
4087
+ -n, --non-interactive Disable prompts. Required when scripting or running as
4088
+ an agent.
4089
+ -s, --server=<value> Override the resolved server URL.
4090
+ -v, --verbose Verbose logging.
4091
+ --[no-]color Colorize human output. Disable with --no-color;
4092
+ NO_COLOR and FORCE_COLOR are honored too.
4093
+ --debug Debug logging.
4094
+ --dry-run Preview without mutating files or the platform.
4095
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
4096
+ process environment. Cannot be combined with --env.
4097
+ --preview Read the preview value instead of the primary one.
4098
+ --[no-]telemetry Send anonymous usage analytics. Disable with
4099
+ --no-telemetry.
2905
4100
 
2906
4101
  GLOBAL FLAGS
2907
4102
  --json Format output as json.
2908
4103
 
2909
4104
  DESCRIPTION
2910
- Delete one variable from the project.
4105
+ Get one variable from the project.
2911
4106
 
2912
4107
  EXAMPLES
2913
- $ zitadel variables delete GOOGLE_CLIENT_ID --project-level
4108
+ $ zitadel variable get GOOGLE_CLIENT_ID
2914
4109
 
2915
- $ zitadel variables delete GOOGLE_CLIENT_ID --project-level --force
4110
+ $ zitadel variable get API_URL --preview
4111
+
4112
+ $ zitadel variable get GOOGLE_CLIENT_ID --json
2916
4113
  ```
2917
4114
 
2918
- ## `zitadel variables get NAME`
4115
+ ## `zitadel variable list`
2919
4116
 
2920
- Get one variable from the project.
4117
+ List the variables entered on the project.
2921
4118
 
2922
4119
  ```
2923
4120
  USAGE
2924
- $ zitadel variables get NAME [--json] [-c <value>] [-s <value>] [-n]
2925
- [--dry-run] [-v] [--debug] [--color] [--telemetry] [--project-level]
4121
+ $ zitadel variable list [--json] [-c <value>] [-s <value>] [-n]
4122
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
4123
+ <value>] [--preview] [--plain]
2926
4124
 
2927
- ARGUMENTS
2928
- NAME Variable name to read.
4125
+ FLAGS
4126
+ -c, --cwd=<value> Project directory to operate on.
4127
+ -e, --env=<value> Environment to run against, e.g. production. Defaults
4128
+ to ZITADEL_ENV, then the hosting platform's build
4129
+ (VERCEL_ENV, or Netlify's CONTEXT), then development.
4130
+ -n, --non-interactive Disable prompts. Required when scripting or running as
4131
+ an agent.
4132
+ -s, --server=<value> Override the resolved server URL.
4133
+ -v, --verbose Verbose logging.
4134
+ --[no-]color Colorize human output. Disable with --no-color;
4135
+ NO_COLOR and FORCE_COLOR are honored too.
4136
+ --debug Debug logging.
4137
+ --dry-run Preview without mutating files or the platform.
4138
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
4139
+ process environment. Cannot be combined with --env.
4140
+ --plain Tab-separated rows with no header, for piping. Implied
4141
+ when stdout is not a terminal.
4142
+ --preview List the preview values instead of the primary ones.
4143
+ --[no-]telemetry Send anonymous usage analytics. Disable with
4144
+ --no-telemetry.
4145
+
4146
+ GLOBAL FLAGS
4147
+ --json Format output as json.
4148
+
4149
+ DESCRIPTION
4150
+ List the variables entered on the project.
4151
+
4152
+ EXAMPLES
4153
+ $ zitadel variable list
4154
+
4155
+ $ zitadel variable list --preview
4156
+
4157
+ $ zitadel variable list --json
4158
+ ```
4159
+
4160
+ ## `zitadel variable resolve`
4161
+
4162
+ Show the variables the live deployment froze for a target.
4163
+
4164
+ ```
4165
+ USAGE
4166
+ $ zitadel variable resolve [--json] [-c <value>] [-s <value>] [-n]
4167
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
4168
+ <value>] [--origin <value>] [--plain]
2929
4169
 
2930
4170
  FLAGS
2931
- -c, --cwd=<value> Project directory to operate on.
2932
- -n, --non-interactive Disable prompts. Required when scripting or running as
2933
- an agent.
2934
- -s, --server=<value> Override the resolved server URL.
2935
- -v, --verbose Verbose logging.
2936
- --[no-]color Colorize human output. Disable with --no-color;
2937
- NO_COLOR and FORCE_COLOR are honored too.
2938
- --debug Debug logging.
2939
- --dry-run Preview without mutating files or the platform.
2940
- --project-level Address the project level. Required: it is the only
2941
- owner the CLI can address today.
2942
- --[no-]telemetry Send anonymous usage analytics. Disable with
2943
- --no-telemetry.
4171
+ -c, --cwd=<value> Project directory to operate on.
4172
+ -e, --env=<value> Environment to run against, e.g. production. Defaults
4173
+ to ZITADEL_ENV, then the hosting platform's build
4174
+ (VERCEL_ENV, or Netlify's CONTEXT), then development.
4175
+ -n, --non-interactive Disable prompts. Required when scripting or running as
4176
+ an agent.
4177
+ -s, --server=<value> Override the resolved server URL.
4178
+ -v, --verbose Verbose logging.
4179
+ --[no-]color Colorize human output. Disable with --no-color;
4180
+ NO_COLOR and FORCE_COLOR are honored too.
4181
+ --debug Debug logging.
4182
+ --dry-run Preview without mutating files or the platform.
4183
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
4184
+ process environment. Cannot be combined with --env.
4185
+ --origin=<value> The origin whose live deployment to read.
4186
+ --plain Tab-separated rows with no header, for piping. Implied
4187
+ when stdout is not a terminal.
4188
+ --[no-]telemetry Send anonymous usage analytics. Disable with
4189
+ --no-telemetry.
2944
4190
 
2945
4191
  GLOBAL FLAGS
2946
4192
  --json Format output as json.
2947
4193
 
2948
4194
  DESCRIPTION
2949
- Get one variable from the project.
4195
+ Show the variables the live deployment froze for a target.
2950
4196
 
2951
4197
  EXAMPLES
2952
- $ zitadel variables get GOOGLE_CLIENT_ID --project-level
4198
+ $ zitadel variable resolve
2953
4199
 
2954
- $ zitadel variables get GOOGLE_CLIENT_ID --project-level --json
4200
+ $ zitadel variable resolve --origin https://app.acme.com
4201
+
4202
+ $ zitadel variable resolve --json
2955
4203
  ```
2956
4204
 
2957
- ## `zitadel variables list`
4205
+ ## `zitadel variable rm NAME`
2958
4206
 
2959
- List the variables entered on the project.
4207
+ Remove one variable from the project.
2960
4208
 
2961
4209
  ```
2962
4210
  USAGE
2963
- $ zitadel variables list [--json] [-c <value>] [-s <value>] [-n]
2964
- [--dry-run] [-v] [--debug] [--color] [--telemetry] [--project-level]
2965
- [--plain]
4211
+ $ zitadel variable rm NAME [--json] [-c <value>] [-s <value>] [-n]
4212
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
4213
+ <value>] [--preview] [-f]
4214
+
4215
+ ARGUMENTS
4216
+ NAME Variable name to remove.
2966
4217
 
2967
4218
  FLAGS
2968
- -c, --cwd=<value> Project directory to operate on.
2969
- -n, --non-interactive Disable prompts. Required when scripting or running as
2970
- an agent.
2971
- -s, --server=<value> Override the resolved server URL.
2972
- -v, --verbose Verbose logging.
2973
- --[no-]color Colorize human output. Disable with --no-color;
2974
- NO_COLOR and FORCE_COLOR are honored too.
2975
- --debug Debug logging.
2976
- --dry-run Preview without mutating files or the platform.
2977
- --plain Tab-separated rows with no header, for piping. Implied
2978
- when stdout is not a terminal.
2979
- --project-level Address the project level. Required: it is the only
2980
- owner the CLI can address today.
2981
- --[no-]telemetry Send anonymous usage analytics. Disable with
2982
- --no-telemetry.
4219
+ -c, --cwd=<value> Project directory to operate on.
4220
+ -e, --env=<value> Environment to run against, e.g. production. Defaults
4221
+ to ZITADEL_ENV, then the hosting platform's build
4222
+ (VERCEL_ENV, or Netlify's CONTEXT), then development.
4223
+ -f, --force Remove the variable without the confirmation prompt.
4224
+ Required when non-interactive.
4225
+ -n, --non-interactive Disable prompts. Required when scripting or running as
4226
+ an agent.
4227
+ -s, --server=<value> Override the resolved server URL.
4228
+ -v, --verbose Verbose logging.
4229
+ --[no-]color Colorize human output. Disable with --no-color;
4230
+ NO_COLOR and FORCE_COLOR are honored too.
4231
+ --debug Debug logging.
4232
+ --dry-run Preview without mutating files or the platform.
4233
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
4234
+ process environment. Cannot be combined with --env.
4235
+ --preview Remove the preview value alone, leaving the primary
4236
+ one standing.
4237
+ --[no-]telemetry Send anonymous usage analytics. Disable with
4238
+ --no-telemetry.
2983
4239
 
2984
4240
  GLOBAL FLAGS
2985
4241
  --json Format output as json.
2986
4242
 
2987
4243
  DESCRIPTION
2988
- List the variables entered on the project.
4244
+ Remove one variable from the project.
2989
4245
 
2990
4246
  EXAMPLES
2991
- $ zitadel variables list --project-level
4247
+ $ zitadel variable rm GOOGLE_CLIENT_ID
2992
4248
 
2993
- $ zitadel variables list --project-level --json
4249
+ $ zitadel variable rm API_URL --preview
4250
+
4251
+ $ zitadel variable rm GOOGLE_CLIENT_ID --force
2994
4252
  ```
2995
4253
 
2996
- ## `zitadel variables set NAME`
4254
+ ## `zitadel variable set NAME [VALUE]`
2997
4255
 
2998
4256
  Set one variable on the project.
2999
4257
 
3000
4258
  ```
3001
4259
  USAGE
3002
- $ zitadel variables set NAME [--json] [-c <value>] [-s <value>] [-n]
3003
- [--dry-run] [-v] [--debug] [--color] [--telemetry] [--project-level]
3004
- [--secret] [--as string|number|boolean]
4260
+ $ zitadel variable set NAME [VALUE] [--json] [-c <value>] [-s <value>]
4261
+ [-n] [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>]
4262
+ [--env-file <value>] [--secret] [--as string|number|boolean] [--preview]
3005
4263
 
3006
4264
  ARGUMENTS
3007
- NAME Variable name (letters, digits and underscores).
4265
+ NAME Variable name (letters, digits and underscores).
4266
+ [VALUE] The value, for a plain (non-secret) variable.
3008
4267
 
3009
4268
  FLAGS
3010
- -c, --cwd=<value> Project directory to operate on.
3011
- -n, --non-interactive Disable prompts. Required when scripting or running as
3012
- an agent.
3013
- -s, --server=<value> Override the resolved server URL.
3014
- -v, --verbose Verbose logging.
3015
- --as=<option> [default: string] Store the value as this JSON type.
3016
- <options: string|number|boolean>
3017
- --[no-]color Colorize human output. Disable with --no-color;
3018
- NO_COLOR and FORCE_COLOR are honored too.
3019
- --debug Debug logging.
3020
- --dry-run Preview without mutating files or the platform.
3021
- --project-level Address the project level. Required: it is the only
3022
- owner the CLI can address today.
3023
- --secret Store the value encrypted. It can be replaced later but
3024
- never read back.
3025
- --[no-]telemetry Send anonymous usage analytics. Disable with
3026
- --no-telemetry.
4269
+ -c, --cwd=<value> Project directory to operate on.
4270
+ -e, --env=<value> Environment to run against, e.g. production. Defaults
4271
+ to ZITADEL_ENV, then the hosting platform's build
4272
+ (VERCEL_ENV, or Netlify's CONTEXT), then development.
4273
+ -n, --non-interactive Disable prompts. Required when scripting or running as
4274
+ an agent.
4275
+ -s, --server=<value> Override the resolved server URL.
4276
+ -v, --verbose Verbose logging.
4277
+ --as=<option> [default: string] Store the value as this JSON type.
4278
+ <options: string|number|boolean>
4279
+ --[no-]color Colorize human output. Disable with --no-color;
4280
+ NO_COLOR and FORCE_COLOR are honored too.
4281
+ --debug Debug logging.
4282
+ --dry-run Preview without mutating files or the platform.
4283
+ --env-file=<value> Read ZITADEL_* values from this file ahead of the
4284
+ process environment. Cannot be combined with --env.
4285
+ --preview Write the preview value alone, leaving the primary one
4286
+ as it is.
4287
+ --secret Store the value encrypted. It can be replaced later
4288
+ but never read back.
4289
+ --[no-]telemetry Send anonymous usage analytics. Disable with
4290
+ --no-telemetry.
3027
4291
 
3028
4292
  GLOBAL FLAGS
3029
4293
  --json Format output as json.
@@ -3032,11 +4296,13 @@ DESCRIPTION
3032
4296
  Set one variable on the project.
3033
4297
 
3034
4298
  EXAMPLES
3035
- $ zitadel variables set GOOGLE_CLIENT_ID --project-level
4299
+ $ zitadel variable set GOOGLE_CLIENT_ID 1234.apps.googleusercontent.com
4300
+
4301
+ $ zitadel variable set GOOGLE_CLIENT_SECRET --secret < secret.txt
3036
4302
 
3037
- $ zitadel variables set GOOGLE_CLIENT_SECRET --project-level --secret < secret.txt
4303
+ $ zitadel variable set SESSION_TTL 3600 --as number
3038
4304
 
3039
- $ zitadel variables set SESSION_TTL --project-level --as number
4305
+ $ zitadel variable set API_URL https://preview.acme.com --preview
3040
4306
  ```
3041
4307
 
3042
4308
  ## `zitadel version`