@zitadel/cli 1.0.0-alpha.22 → 1.0.0-alpha.23

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 (66) hide show
  1. package/README.md +2248 -227
  2. package/SKILLS.md +237 -65
  3. package/dist/groups-CMB0fMzE.mjs +22 -0
  4. package/dist/groups-CMB0fMzE.mjs.map +1 -0
  5. package/dist/index.mjs +16027 -0
  6. package/dist/index.mjs.map +1 -0
  7. package/dist/lib/oclif/help.mjs +67 -0
  8. package/dist/lib/oclif/help.mjs.map +1 -0
  9. package/oclif.manifest.json +4577 -185
  10. package/package.json +40 -8
  11. package/dist/box-B_mwKole.mjs +0 -35
  12. package/dist/box-B_mwKole.mjs.map +0 -1
  13. package/dist/branding-DvoH8e0D.mjs +0 -79
  14. package/dist/branding-DvoH8e0D.mjs.map +0 -1
  15. package/dist/claim-state-B6ZSKmhW.mjs +0 -125
  16. package/dist/claim-state-B6ZSKmhW.mjs.map +0 -1
  17. package/dist/commands/apply.mjs +0 -81
  18. package/dist/commands/apply.mjs.map +0 -1
  19. package/dist/commands/branding/eject.mjs +0 -104
  20. package/dist/commands/branding/eject.mjs.map +0 -1
  21. package/dist/commands/claim.mjs +0 -445
  22. package/dist/commands/claim.mjs.map +0 -1
  23. package/dist/commands/doctor.mjs +0 -1138
  24. package/dist/commands/doctor.mjs.map +0 -1
  25. package/dist/commands/eject.mjs +0 -157
  26. package/dist/commands/eject.mjs.map +0 -1
  27. package/dist/commands/logs.mjs +0 -58
  28. package/dist/commands/logs.mjs.map +0 -1
  29. package/dist/commands/plan.mjs +0 -65
  30. package/dist/commands/plan.mjs.map +0 -1
  31. package/dist/commands/reset.mjs +0 -79
  32. package/dist/commands/reset.mjs.map +0 -1
  33. package/dist/commands/schemas/list.mjs +0 -146
  34. package/dist/commands/schemas/list.mjs.map +0 -1
  35. package/dist/commands/setup.mjs +0 -1309
  36. package/dist/commands/setup.mjs.map +0 -1
  37. package/dist/commands/start.mjs +0 -288
  38. package/dist/commands/start.mjs.map +0 -1
  39. package/dist/commands/status.mjs +0 -151
  40. package/dist/commands/status.mjs.map +0 -1
  41. package/dist/commands/stop.mjs +0 -105
  42. package/dist/commands/stop.mjs.map +0 -1
  43. package/dist/designs-Ckz18Dpo.mjs +0 -38
  44. package/dist/designs-Ckz18Dpo.mjs.map +0 -1
  45. package/dist/docker-B1MjOMFo.mjs +0 -436
  46. package/dist/docker-B1MjOMFo.mjs.map +0 -1
  47. package/dist/environment-fibXmzM8.mjs +0 -17
  48. package/dist/environment-fibXmzM8.mjs.map +0 -1
  49. package/dist/journey-guidance-C9MxJNTg.mjs +0 -40
  50. package/dist/journey-guidance-C9MxJNTg.mjs.map +0 -1
  51. package/dist/oclif-JlsN1lfO.mjs +0 -1769
  52. package/dist/oclif-JlsN1lfO.mjs.map +0 -1
  53. package/dist/orca-CPMHzmg3.mjs +0 -3917
  54. package/dist/orca-CPMHzmg3.mjs.map +0 -1
  55. package/dist/package-manager-CDUsoGBy.mjs +0 -194
  56. package/dist/package-manager-CDUsoGBy.mjs.map +0 -1
  57. package/dist/ports-hidBnSW-.mjs +0 -116
  58. package/dist/ports-hidBnSW-.mjs.map +0 -1
  59. package/dist/processes-Cv19mJ2I.mjs +0 -120
  60. package/dist/processes-Cv19mJ2I.mjs.map +0 -1
  61. package/dist/project-Ba0nriNm.mjs +0 -140
  62. package/dist/project-Ba0nriNm.mjs.map +0 -1
  63. package/dist/sync-ChlLQ4vZ.mjs +0 -1633
  64. package/dist/sync-ChlLQ4vZ.mjs.map +0 -1
  65. package/dist/user-schema-C2mC-JTN.mjs +0 -91
  66. package/dist/user-schema-C2mC-JTN.mjs.map +0 -1
package/README.md CHANGED
@@ -78,8 +78,10 @@ project creation, but CLI-created projects are authored from local files first.
78
78
  Login templates are supported: scaffold them with the `branding eject` command
79
79
  (`--design centered|split|split-right|hero|minimal`) or `setup --design <name>`;
80
80
  every edit publishes a new immutable branding revision and the login serves
81
- the newest one. Flow create, read, list, update, and delete are available; the
82
- server enforces flow lifecycle rules such as draft-only edits.
81
+ the newest one. Flows work the same way: every edit publishes a new immutable
82
+ flow revision. A page that pins `flow-name` gets that flow's newest revision. A
83
+ page without a pin gets the project's newest active unscoped flow, whatever its
84
+ name, so revising a flow can make it the default.
83
85
 
84
86
  For agent scripts, pass `--non-interactive --json` and capture stdout and stderr
85
87
  separately. The CLI contract is one parseable JSON object on stdout; terminals
@@ -87,8 +89,8 @@ and agent UIs may display stderr package-manager progress together with stdout.
87
89
 
88
90
  ## Other commands
89
91
 
90
- - `zitadel claim` — attach the project to your team (opens the claim page,
91
- polls for completion; team attachment then shows in `setup`, `status`, and
92
+ - `zitadel claim` — claim the project to make it permanent (opens the claim
93
+ page, polls for completion; the claim then shows in `setup`, `status`, and
92
94
  `doctor`)
93
95
  - `zitadel doctor` — verify the local runtime and generated project files
94
96
  (including scaffold drift and dependency-version alignment)
@@ -113,21 +115,61 @@ which ships in this package.
113
115
  * [`zitadel apply`](#zitadel-apply)
114
116
  * [`zitadel autocomplete [SHELL]`](#zitadel-autocomplete-shell)
115
117
  * [`zitadel branding eject`](#zitadel-branding-eject)
118
+ * [`zitadel branding get ID`](#zitadel-branding-get-id)
119
+ * [`zitadel branding list`](#zitadel-branding-list)
116
120
  * [`zitadel claim`](#zitadel-claim)
117
121
  * [`zitadel commands`](#zitadel-commands)
122
+ * [`zitadel console`](#zitadel-console)
118
123
  * [`zitadel doctor`](#zitadel-doctor)
119
124
  * [`zitadel eject`](#zitadel-eject)
125
+ * [`zitadel environments get NAME`](#zitadel-environments-get-name)
126
+ * [`zitadel environments list`](#zitadel-environments-list)
127
+ * [`zitadel events get ID`](#zitadel-events-get-id)
128
+ * [`zitadel events list`](#zitadel-events-list)
129
+ * [`zitadel flow-definitions get FLOW`](#zitadel-flow-definitions-get-flow)
130
+ * [`zitadel flow-definitions list`](#zitadel-flow-definitions-list)
131
+ * [`zitadel grants create`](#zitadel-grants-create)
132
+ * [`zitadel grants delete ID`](#zitadel-grants-delete-id)
133
+ * [`zitadel grants get ID`](#zitadel-grants-get-id)
134
+ * [`zitadel grants list`](#zitadel-grants-list)
120
135
  * [`zitadel help [COMMAND]`](#zitadel-help-command)
136
+ * [`zitadel idps create`](#zitadel-idps-create)
137
+ * [`zitadel idps get ID`](#zitadel-idps-get-id)
138
+ * [`zitadel idps list`](#zitadel-idps-list)
121
139
  * [`zitadel logs`](#zitadel-logs)
122
140
  * [`zitadel plan`](#zitadel-plan)
141
+ * [`zitadel projects get ID`](#zitadel-projects-get-id)
142
+ * [`zitadel projects list`](#zitadel-projects-list)
143
+ * [`zitadel projects update ID`](#zitadel-projects-update-id)
144
+ * [`zitadel releases get ID`](#zitadel-releases-get-id)
145
+ * [`zitadel releases list`](#zitadel-releases-list)
123
146
  * [`zitadel reset`](#zitadel-reset)
147
+ * [`zitadel resources`](#zitadel-resources)
148
+ * [`zitadel schemas get SCHEMA`](#zitadel-schemas-get-schema)
124
149
  * [`zitadel schemas list`](#zitadel-schemas-list)
125
150
  * [`zitadel search`](#zitadel-search)
151
+ * [`zitadel sessions get ID`](#zitadel-sessions-get-id)
152
+ * [`zitadel sessions list`](#zitadel-sessions-list)
153
+ * [`zitadel sessions revoke ID`](#zitadel-sessions-revoke-id)
126
154
  * [`zitadel setup`](#zitadel-setup)
127
155
  * [`zitadel start`](#zitadel-start)
128
156
  * [`zitadel status`](#zitadel-status)
129
157
  * [`zitadel stop`](#zitadel-stop)
158
+ * [`zitadel teams create`](#zitadel-teams-create)
159
+ * [`zitadel teams deactivate ID`](#zitadel-teams-deactivate-id)
160
+ * [`zitadel teams get ID`](#zitadel-teams-get-id)
161
+ * [`zitadel teams list`](#zitadel-teams-list)
162
+ * [`zitadel teams update ID`](#zitadel-teams-update-id)
130
163
  * [`zitadel uninstall`](#zitadel-uninstall)
164
+ * [`zitadel users create`](#zitadel-users-create)
165
+ * [`zitadel users delete ID`](#zitadel-users-delete-id)
166
+ * [`zitadel users get ID`](#zitadel-users-get-id)
167
+ * [`zitadel users list`](#zitadel-users-list)
168
+ * [`zitadel users update ID`](#zitadel-users-update-id)
169
+ * [`zitadel variables delete NAME`](#zitadel-variables-delete-name)
170
+ * [`zitadel variables get NAME`](#zitadel-variables-get-name)
171
+ * [`zitadel variables list`](#zitadel-variables-list)
172
+ * [`zitadel variables set NAME`](#zitadel-variables-set-name)
131
173
  * [`zitadel version`](#zitadel-version)
132
174
  * [`zitadel which`](#zitadel-which)
133
175
 
@@ -137,19 +179,21 @@ Validate and upload repo config to the platform.
137
179
 
138
180
  ```
139
181
  USAGE
140
- $ zitadel apply [--json] [-c <value>] [-s <value>] [-n] [-f] [--dry-run] [--verbose] [--debug]
141
- [--telemetry] [-e development|preview|production]
182
+ $ zitadel apply [--json] [-c <value>] [-s <value>] [-n]
183
+ [--dry-run] [--verbose] [--debug] [--telemetry] [-e
184
+ development|preview|production]
142
185
 
143
186
  FLAGS
144
187
  -c, --cwd=<value> Project directory to operate on.
145
188
  -e, --environment=<option> Target environment (default: development).
146
189
  <options: development|preview|production>
147
- -f, --force Overwrite protected files on conflict.
148
- -n, --non-interactive Disable prompts. Required when scripting or running as an agent.
190
+ -n, --non-interactive Disable prompts. Required when scripting or
191
+ running as an agent.
149
192
  -s, --server=<value> Override the resolved server URL.
150
193
  --debug Debug logging.
151
194
  --dry-run Preview without mutating files or the platform.
152
- --[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
195
+ --[no-]telemetry Send anonymous usage analytics. Disable with
196
+ --no-telemetry.
153
197
  --verbose Verbose logging.
154
198
 
155
199
  GLOBAL FLAGS
@@ -196,54 +240,141 @@ Take ownership of the login template: scaffold .zitadel/branding/ from a shipped
196
240
 
197
241
  ```
198
242
  USAGE
199
- $ zitadel branding eject [--json] [-c <value>] [-s <value>] [-n] [-f] [--dry-run] [--verbose] [--debug]
200
- [--telemetry] [--design centered|split|split-right|hero|minimal]
243
+ $ zitadel branding eject [--json] [-c <value>] [-s <value>] [-n]
244
+ [--dry-run] [--verbose] [--debug] [--telemetry] [-f] [--design
245
+ centered|split|split-right|hero|minimal]
201
246
 
202
247
  FLAGS
203
248
  -c, --cwd=<value> Project directory to operate on.
204
- -f, --force Overwrite protected files on conflict.
205
- -n, --non-interactive Disable prompts. Required when scripting or running as an agent.
249
+ -f, --force Overwrite an existing branding file.
250
+ -n, --non-interactive Disable prompts. Required when scripting or running as
251
+ an agent.
206
252
  -s, --server=<value> Override the resolved server URL.
207
253
  --debug Debug logging.
208
254
  --design=<option> Design to start from (default: centered).
209
255
  <options: centered|split|split-right|hero|minimal>
210
256
  --dry-run Preview without mutating files or the platform.
211
- --[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
257
+ --[no-]telemetry Send anonymous usage analytics. Disable with
258
+ --no-telemetry.
212
259
  --verbose Verbose logging.
213
260
 
214
261
  GLOBAL FLAGS
215
262
  --json Format output as json.
216
263
 
217
264
  DESCRIPTION
218
- Take ownership of the login template: scaffold .zitadel/branding/ from a shipped design.
265
+ Take ownership of the login template: scaffold .zitadel/branding/ from a
266
+ shipped design.
267
+ ```
268
+
269
+ ## `zitadel branding get ID`
270
+
271
+ Get one branding revision by id.
272
+
273
+ ```
274
+ USAGE
275
+ $ zitadel branding get ID [--json] [-c <value>] [-s <value>] [-n]
276
+ [--dry-run] [--verbose] [--debug] [--telemetry] [--fields <value>] [-e
277
+ development|preview|production]
278
+
279
+ ARGUMENTS
280
+ ID branding revision id
281
+
282
+ FLAGS
283
+ -c, --cwd=<value> Project directory to operate on.
284
+ -e, --environment=<option> Target environment (default: development).
285
+ <options: development|preview|production>
286
+ -n, --non-interactive Disable prompts. Required when scripting or
287
+ running as an agent.
288
+ -s, --server=<value> Override the resolved server URL.
289
+ --debug Debug logging.
290
+ --dry-run Preview without mutating files or the platform.
291
+ --fields=<value> Fields to show, comma-separated dot-paths.
292
+ Defaults to the resource's own; `--json` is
293
+ unaffected.
294
+ --[no-]telemetry Send anonymous usage analytics. Disable with
295
+ --no-telemetry.
296
+ --verbose Verbose logging.
297
+
298
+ GLOBAL FLAGS
299
+ --json Format output as json.
300
+
301
+ DESCRIPTION
302
+ Get one branding revision by id.
303
+
304
+ EXAMPLES
305
+ $ zitadel branding get <id>
306
+
307
+ $ zitadel branding get <id> --json
308
+ ```
309
+
310
+ ## `zitadel branding list`
311
+
312
+ List branding.
313
+
314
+ ```
315
+ USAGE
316
+ $ zitadel branding list [--json] [-c <value>] [-s <value>] [-n]
317
+ [--dry-run] [--verbose] [--debug] [--telemetry] [--fields <value>] [--plain]
318
+ [-e development|preview|production]
319
+
320
+ FLAGS
321
+ -c, --cwd=<value> Project directory to operate on.
322
+ -e, --environment=<option> Target environment (default: development).
323
+ <options: development|preview|production>
324
+ -n, --non-interactive Disable prompts. Required when scripting or
325
+ running as an agent.
326
+ -s, --server=<value> Override the resolved server URL.
327
+ --debug Debug logging.
328
+ --dry-run Preview without mutating files or the platform.
329
+ --fields=<value> Columns to show, comma-separated dot-paths (e.g.
330
+ id,attributes.email). Defaults to the resource's
331
+ own columns; `--json` is unaffected.
332
+ --plain Tab-separated rows with no header, for piping.
333
+ Implied when stdout is not a terminal.
334
+ --[no-]telemetry Send anonymous usage analytics. Disable with
335
+ --no-telemetry.
336
+ --verbose Verbose logging.
337
+
338
+ GLOBAL FLAGS
339
+ --json Format output as json.
340
+
341
+ DESCRIPTION
342
+ List branding.
343
+
344
+ EXAMPLES
345
+ $ zitadel branding list --json
219
346
  ```
220
347
 
221
348
  ## `zitadel claim`
222
349
 
223
- Attach this project to a team so it becomes permanent. Opens a browser to finish signing in.
350
+ Claim this project to make it permanent. Opens a browser to create an account or sign in.
224
351
 
225
352
  ```
226
353
  USAGE
227
- $ zitadel claim [--json] [-c <value>] [-s <value>] [-n] [-f] [--dry-run] [--verbose] [--debug]
228
- [--telemetry] [--no-open] [--timeout <value>]
354
+ $ zitadel claim [--json] [-c <value>] [-s <value>] [-n]
355
+ [--dry-run] [--verbose] [--debug] [--telemetry] [--no-open] [--timeout
356
+ <value>]
229
357
 
230
358
  FLAGS
231
359
  -c, --cwd=<value> Project directory to operate on.
232
- -f, --force Overwrite protected files on conflict.
233
- -n, --non-interactive Disable prompts. Required when scripting or running as an agent.
360
+ -n, --non-interactive Disable prompts. Required when scripting or running as
361
+ an agent.
234
362
  -s, --server=<value> Override the resolved server URL.
235
363
  --debug Debug logging.
236
364
  --dry-run Preview without mutating files or the platform.
237
365
  --no-open Print the link instead of opening a browser.
238
- --[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
239
- --timeout=<value> Seconds to wait for the browser step. Defaults to the link's own expiry (10 minutes).
366
+ --[no-]telemetry Send anonymous usage analytics. Disable with
367
+ --no-telemetry.
368
+ --timeout=<value> Seconds to wait for the browser step. Defaults to the
369
+ link's own expiry (10 minutes).
240
370
  --verbose Verbose logging.
241
371
 
242
372
  GLOBAL FLAGS
243
373
  --json Format output as json.
244
374
 
245
375
  DESCRIPTION
246
- Attach this project to a team so it becomes permanent. Opens a browser to finish signing in.
376
+ Claim this project to make it permanent. Opens a browser to create an account
377
+ or sign in.
247
378
 
248
379
  EXAMPLES
249
380
  $ zitadel claim
@@ -259,8 +390,9 @@ List all zitadel commands.
259
390
 
260
391
  ```
261
392
  USAGE
262
- $ zitadel commands [--json] [-c id|plugin|summary|type... | --tree] [--deprecated] [-x | ] [--hidden]
263
- [--no-truncate | ] [--sort id|plugin|summary|type | ]
393
+ $ zitadel commands [--json] [-c id|plugin|summary|type... | --tree]
394
+ [--deprecated] [-x | ] [--hidden] [--no-truncate | ] [--sort
395
+ id|plugin|summary|type | ]
264
396
 
265
397
  FLAGS
266
398
  -c, --columns=<option>... Only show provided columns (comma-separated).
@@ -282,19 +414,54 @@ DESCRIPTION
282
414
 
283
415
  _See code: [@oclif/plugin-commands](https://github.com/oclif/plugin-commands/blob/4.1.55/src/commands/commands.ts)_
284
416
 
417
+ ## `zitadel console`
418
+
419
+ Open the local console, signed in as the local admin created by `zitadel start`.
420
+
421
+ ```
422
+ USAGE
423
+ $ zitadel console [--json] [-c <value>] [-s <value>] [-n]
424
+ [--dry-run] [--verbose] [--debug] [--telemetry] [--no-open]
425
+
426
+ FLAGS
427
+ -c, --cwd=<value> Project directory to operate on.
428
+ -n, --non-interactive Disable prompts. Required when scripting or running as
429
+ an agent.
430
+ -s, --server=<value> Override the resolved server URL.
431
+ --debug Debug logging.
432
+ --dry-run Preview without mutating files or the platform.
433
+ --no-open Print the sign-in link instead of opening a browser.
434
+ --[no-]telemetry Send anonymous usage analytics. Disable with
435
+ --no-telemetry.
436
+ --verbose Verbose logging.
437
+
438
+ GLOBAL FLAGS
439
+ --json Format output as json.
440
+
441
+ DESCRIPTION
442
+ Open the local console, signed in as the local admin created by `zitadel
443
+ start`.
444
+
445
+ EXAMPLES
446
+ $ zitadel console
447
+
448
+ $ zitadel console --no-open
449
+ ```
450
+
285
451
  ## `zitadel doctor`
286
452
 
287
453
  Verify local runtime and project state.
288
454
 
289
455
  ```
290
456
  USAGE
291
- $ zitadel doctor [--json] [-c <value>] [-s <value>] [-n] [-f] [--dry-run] [--verbose] [--debug]
292
- [--telemetry] [--fix] [--image <value>] [--port <value>] [--runtime binary|docker]
457
+ $ zitadel doctor [--json] [-c <value>] [-s <value>] [-n]
458
+ [--dry-run] [--verbose] [--debug] [--telemetry] [--fix] [--image <value>]
459
+ [--port <value>] [--runtime binary|docker]
293
460
 
294
461
  FLAGS
295
462
  -c, --cwd=<value> Project directory to operate on.
296
- -f, --force Overwrite protected files on conflict.
297
- -n, --non-interactive Disable prompts. Required when scripting or running as an agent.
463
+ -n, --non-interactive Disable prompts. Required when scripting or running as
464
+ an agent.
298
465
  -s, --server=<value> Override the resolved server URL.
299
466
  --debug Debug logging.
300
467
  --dry-run Preview without mutating files or the platform.
@@ -303,7 +470,8 @@ FLAGS
303
470
  --port=<value> [default: 8080] Local HTTP port.
304
471
  --runtime=<option> Local runtime backend.
305
472
  <options: binary|docker>
306
- --[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
473
+ --[no-]telemetry Send anonymous usage analytics. Disable with
474
+ --no-telemetry.
307
475
  --verbose Verbose logging.
308
476
 
309
477
  GLOBAL FLAGS
@@ -319,17 +487,20 @@ Remove managed files and local Zitadel state.
319
487
 
320
488
  ```
321
489
  USAGE
322
- $ zitadel eject [--json] [-c <value>] [-s <value>] [-n] [-f] [--dry-run] [--verbose] [--debug]
323
- [--telemetry]
490
+ $ zitadel eject [--json] [-c <value>] [-s <value>] [-n]
491
+ [--dry-run] [--verbose] [--debug] [--telemetry] [-f]
324
492
 
325
493
  FLAGS
326
494
  -c, --cwd=<value> Project directory to operate on.
327
- -f, --force Overwrite protected files on conflict.
328
- -n, --non-interactive Disable prompts. Required when scripting or running as an agent.
495
+ -f, --force Remove the managed files without the confirmation
496
+ prompt.
497
+ -n, --non-interactive Disable prompts. Required when scripting or running as
498
+ an agent.
329
499
  -s, --server=<value> Override the resolved server URL.
330
500
  --debug Debug logging.
331
501
  --dry-run Preview without mutating files or the platform.
332
- --[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
502
+ --[no-]telemetry Send anonymous usage analytics. Disable with
503
+ --no-telemetry.
333
504
  --verbose Verbose logging.
334
505
 
335
506
  GLOBAL FLAGS
@@ -342,170 +513,153 @@ ALIASES
342
513
  $ zitadel uninstall
343
514
  ```
344
515
 
345
- ## `zitadel help [COMMAND]`
516
+ ## `zitadel environments get NAME`
346
517
 
347
- Display help for zitadel.
518
+ Get one environment by id.
348
519
 
349
520
  ```
350
521
  USAGE
351
- $ zitadel help [COMMAND...] [-n]
522
+ $ zitadel environments get NAME [--json] [-c <value>] [-s <value>] [-n]
523
+ [--dry-run] [--verbose] [--debug] [--telemetry] [--fields <value>] [-e
524
+ development|preview|production]
352
525
 
353
526
  ARGUMENTS
354
- [COMMAND...] Command to show help for.
355
-
356
- FLAGS
357
- -n, --nested-commands Include all nested commands in the output.
358
-
359
- DESCRIPTION
360
- Display help for zitadel.
361
- ```
362
-
363
- _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/6.2.49/src/commands/help.ts)_
364
-
365
- ## `zitadel logs`
366
-
367
- Show local Zitadel server logs.
368
-
369
- ```
370
- USAGE
371
- $ zitadel logs [--json] [-c <value>] [-s <value>] [-n] [-f] [--dry-run] [--verbose] [--debug]
372
- [--telemetry] [--follow] [--tail <value>]
527
+ NAME environment name
373
528
 
374
529
  FLAGS
375
- -c, --cwd=<value> Project directory to operate on.
376
- -f, --force Overwrite protected files on conflict.
377
- -n, --non-interactive Disable prompts. Required when scripting or running as an agent.
378
- -s, --server=<value> Override the resolved server URL.
379
- --debug Debug logging.
380
- --dry-run Preview without mutating files or the platform.
381
- --follow Follow logs.
382
- --tail=<value> [default: 200] Number of lines to show.
383
- --[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
384
- --verbose Verbose logging.
530
+ -c, --cwd=<value> Project directory to operate on.
531
+ -e, --environment=<option> Target environment (default: development).
532
+ <options: development|preview|production>
533
+ -n, --non-interactive Disable prompts. Required when scripting or
534
+ running as an agent.
535
+ -s, --server=<value> Override the resolved server URL.
536
+ --debug Debug logging.
537
+ --dry-run Preview without mutating files or the platform.
538
+ --fields=<value> Fields to show, comma-separated dot-paths.
539
+ Defaults to the resource's own; `--json` is
540
+ unaffected.
541
+ --[no-]telemetry Send anonymous usage analytics. Disable with
542
+ --no-telemetry.
543
+ --verbose Verbose logging.
385
544
 
386
545
  GLOBAL FLAGS
387
546
  --json Format output as json.
388
547
 
389
548
  DESCRIPTION
390
- Show local Zitadel server logs.
549
+ Get one environment by id.
550
+
551
+ EXAMPLES
552
+ $ zitadel environments get <id>
553
+
554
+ $ zitadel environments get <id> --json
391
555
  ```
392
556
 
393
- ## `zitadel plan`
557
+ ## `zitadel environments list`
394
558
 
395
- Validate config without mutation and preview the sync diff.
559
+ List environments.
396
560
 
397
561
  ```
398
562
  USAGE
399
- $ zitadel plan [--json] [-c <value>] [-s <value>] [-n] [-f] [--dry-run] [--verbose] [--debug]
400
- [--telemetry] [-e development|preview|production]
563
+ $ zitadel environments list [--json] [-c <value>] [-s <value>] [-n]
564
+ [--dry-run] [--verbose] [--debug] [--telemetry] [--limit <value>] [-a |
565
+ --page-token <value>] [--fields <value>] [--plain] [-e
566
+ development|preview|production]
401
567
 
402
568
  FLAGS
569
+ -a, --all Fetch every page instead of one.
403
570
  -c, --cwd=<value> Project directory to operate on.
404
571
  -e, --environment=<option> Target environment (default: development).
405
572
  <options: development|preview|production>
406
- -f, --force Overwrite protected files on conflict.
407
- -n, --non-interactive Disable prompts. Required when scripting or running as an agent.
573
+ -n, --non-interactive Disable prompts. Required when scripting or
574
+ running as an agent.
408
575
  -s, --server=<value> Override the resolved server URL.
409
576
  --debug Debug logging.
410
577
  --dry-run Preview without mutating files or the platform.
411
- --[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
578
+ --fields=<value> Columns to show, comma-separated dot-paths (e.g.
579
+ id,attributes.email). Defaults to the resource's
580
+ own columns; `--json` is unaffected.
581
+ --limit=<value> Page size (server default 20, max 100).
582
+ --page-token=<value> Continue from a previous page's next_page_token.
583
+ --plain Tab-separated rows with no header, for piping.
584
+ Implied when stdout is not a terminal.
585
+ --[no-]telemetry Send anonymous usage analytics. Disable with
586
+ --no-telemetry.
412
587
  --verbose Verbose logging.
413
588
 
414
589
  GLOBAL FLAGS
415
590
  --json Format output as json.
416
591
 
417
592
  DESCRIPTION
418
- Validate config without mutation and preview the sync diff.
419
- ```
420
-
421
- ## `zitadel reset`
422
-
423
- Delete the local Zitadel server runtime and data.
424
-
425
- ```
426
- USAGE
427
- $ zitadel reset [--json] [-c <value>] [-s <value>] [-n] [-f] [--dry-run] [--verbose] [--debug]
428
- [--telemetry]
429
-
430
- FLAGS
431
- -c, --cwd=<value> Project directory to operate on.
432
- -f, --force Overwrite protected files on conflict.
433
- -n, --non-interactive Disable prompts. Required when scripting or running as an agent.
434
- -s, --server=<value> Override the resolved server URL.
435
- --debug Debug logging.
436
- --dry-run Preview without mutating files or the platform.
437
- --[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
438
- --verbose Verbose logging.
593
+ List environments.
439
594
 
440
- GLOBAL FLAGS
441
- --json Format output as json.
595
+ EXAMPLES
596
+ $ zitadel environments list --json
442
597
 
443
- DESCRIPTION
444
- Delete the local Zitadel server runtime and data.
598
+ $ zitadel environments list --all --json
445
599
  ```
446
600
 
447
- ## `zitadel schemas list`
601
+ ## `zitadel events get ID`
448
602
 
449
- List revisions of a user-schema by objectType.
603
+ Get one event by id.
450
604
 
451
605
  ```
452
606
  USAGE
453
- $ zitadel schemas list -t <value> [--json] [-c <value>] [-s <value>] [-n] [-f] [--dry-run] [--verbose] [--debug]
454
- [--telemetry] [-e development|preview|production]
607
+ $ zitadel events get ID [--json] [-c <value>] [-s <value>] [-n]
608
+ [--dry-run] [--verbose] [--debug] [--telemetry] [--fields <value>] [-e
609
+ development|preview|production]
610
+
611
+ ARGUMENTS
612
+ ID event id
455
613
 
456
614
  FLAGS
457
615
  -c, --cwd=<value> Project directory to operate on.
458
616
  -e, --environment=<option> Target environment (default: development).
459
617
  <options: development|preview|production>
460
- -f, --force Overwrite protected files on conflict.
461
- -n, --non-interactive Disable prompts. Required when scripting or running as an agent.
618
+ -n, --non-interactive Disable prompts. Required when scripting or
619
+ running as an agent.
462
620
  -s, --server=<value> Override the resolved server URL.
463
- -t, --object-type=<value> (required) Filter revisions by objectType (e.g. human-user).
464
621
  --debug Debug logging.
465
622
  --dry-run Preview without mutating files or the platform.
466
- --[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
623
+ --fields=<value> Fields to show, comma-separated dot-paths.
624
+ Defaults to the resource's own; `--json` is
625
+ unaffected.
626
+ --[no-]telemetry Send anonymous usage analytics. Disable with
627
+ --no-telemetry.
467
628
  --verbose Verbose logging.
468
629
 
469
630
  GLOBAL FLAGS
470
631
  --json Format output as json.
471
632
 
472
633
  DESCRIPTION
473
- List revisions of a user-schema by objectType.
474
- ```
475
-
476
- ## `zitadel search`
634
+ Get one event by id.
477
635
 
478
- Search for a command.
479
-
480
- ```
481
- USAGE
482
- $ zitadel search
483
-
484
- DESCRIPTION
485
- Search for a command.
636
+ EXAMPLES
637
+ $ zitadel events get <id>
486
638
 
487
- Once you select a command, hit enter and it will show the help for that command.
639
+ $ zitadel events get <id> --json
488
640
  ```
489
641
 
490
- _See code: [@oclif/plugin-search](https://github.com/oclif/plugin-search/blob/v1.2.50/src/commands/search.ts)_
491
-
492
- ## `zitadel setup`
642
+ ## `zitadel events list`
493
643
 
494
- Create a Zitadel project and scaffold local auth.
644
+ List events.
495
645
 
496
646
  ```
497
647
  USAGE
498
- $ zitadel setup [--json] [-c <value>] [-s <value>] [-n] [-f] [--dry-run] [--verbose] [--debug]
499
- [--telemetry] [--framework next|nuxt|react|vue|solid|svelte|qwik|angular] [--renderer react] [--dev-port <value>]
500
- [--skip-install] [--preset password-first|passkey-first] [--use-case minimal|consumer|business] [--design
501
- centered|split|split-right|hero|minimal]
648
+ $ zitadel events list [--json] [-c <value>] [-s <value>] [-n]
649
+ [--dry-run] [--verbose] [--debug] [--telemetry] [--limit <value>] [-a |
650
+ --page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
651
+ [--sort <value>] [-e development|preview|production]
502
652
 
503
653
  FLAGS
654
+ -a, --all
655
+ Fetch every page instead of one.
656
+
504
657
  -c, --cwd=<value>
505
658
  Project directory to operate on.
506
659
 
507
- -f, --force
508
- Overwrite protected files on conflict.
660
+ -e, --environment=<option>
661
+ Target environment (default: development).
662
+ <options: development|preview|production>
509
663
 
510
664
  -n, --non-interactive
511
665
  Disable prompts. Required when scripting or running as an agent.
@@ -516,43 +670,37 @@ FLAGS
516
670
  --debug
517
671
  Debug logging.
518
672
 
519
- --design=<option>
520
- Login design to eject into .zitadel/branding/ and publish as branding revision 1. Skips the wizard's design
521
- question. When omitted in non-interactive runs, the login uses the built-in template; run the `branding eject`
522
- command later to customize. Split-family designs (split, split-right, hero) collapse their brand pane by container
523
- width: narrow containers — including widget-posture embeds at card width — render the compact brand mark instead
524
- (logo_url, else hero_url, from .zitadel/branding/branding.json; hero falls back to editable text).
525
- <options: centered|split|split-right|hero|minimal>
526
-
527
- --dev-port=<value>
528
- Dev-server port; also the issuer origin registered with Zitadel. Defaults to the detected port. Use distinct ports
529
- to run several scaffolded apps side by side.
530
-
531
673
  --dry-run
532
674
  Preview without mutating files or the platform.
533
675
 
534
- --framework=<option>
535
- Framework to target.
536
- <options: next|nuxt|react|vue|solid|svelte|qwik|angular>
676
+ --fields=<value>
677
+ Columns to show, comma-separated dot-paths (e.g. id,attributes.email).
678
+ Defaults to the resource's own columns; `--json` is unaffected.
537
679
 
538
- --preset=<option>
539
- Sign-in preset for the scaffolded schema and login flow (default: password-first).
540
- <options: password-first|passkey-first>
680
+ --filter=<value>...
681
+ Filter as field=operation:value (operation defaults to equals). Fields:
682
+ category (equals; values request|auth|session|admin|entity|signal; repeats
683
+ widen), event_type (equals; repeats widen), actor_id (equals), session_id
684
+ (equals), flow_id (equals), request_id (equals), entity_type (equals),
685
+ entity_id (equals), team_id (equals), created_at
686
+ (greater_than_or_equal|less_than).
541
687
 
542
- --renderer=<option>
543
- Renderer (default: react). Not yet available: web-component.
544
- <options: react>
688
+ --limit=<value>
689
+ Page size (server default 20, max 100).
545
690
 
546
- --skip-install
547
- Do not install dependencies after setup updates package.json.
691
+ --page-token=<value>
692
+ Continue from a previous page's next_page_token.
693
+
694
+ --plain
695
+ Tab-separated rows with no header, for piping. Implied when stdout is not a
696
+ terminal.
697
+
698
+ --sort=<value>
699
+ Sort as field:direction (asc|desc). Fields: occurred_at.
548
700
 
549
701
  --[no-]telemetry
550
702
  Send anonymous usage analytics. Disable with --no-telemetry.
551
703
 
552
- --use-case=<option>
553
- Use case for the scaffolded schema fields: who signs in to the app (default: minimal).
554
- <options: minimal|consumer|business>
555
-
556
704
  --verbose
557
705
  Verbose logging.
558
706
 
@@ -560,124 +708,1996 @@ GLOBAL FLAGS
560
708
  --json Format output as json.
561
709
 
562
710
  DESCRIPTION
563
- Create a Zitadel project and scaffold local auth.
711
+ List events.
564
712
 
565
713
  EXAMPLES
566
- $ zitadel setup --framework next
714
+ $ zitadel events list --json
567
715
 
568
- $ zitadel setup --framework react --dev-port 3000
716
+ $ zitadel events list --all --json
717
+
718
+ $ zitadel events list --filter category=equals:<value> --sort occurred_at:desc
569
719
  ```
570
720
 
571
- ## `zitadel start`
721
+ ## `zitadel flow-definitions get FLOW`
572
722
 
573
- Start a local Zitadel server.
723
+ Get one flow definition by id.
574
724
 
575
725
  ```
576
726
  USAGE
577
- $ zitadel start [--json] [-c <value>] [-s <value>] [-n] [-f] [--dry-run] [--verbose] [--debug]
578
- [--telemetry] [--image <value>] [--port <value>] [--runtime binary|docker]
727
+ $ zitadel flow-definitions get FLOW [--json] [-c <value>] [-s <value>] [-n]
728
+ [--dry-run] [--verbose] [--debug] [--telemetry] [--fields <value>] [-e
729
+ development|preview|production]
730
+
731
+ ARGUMENTS
732
+ FLOW flow name (newest revision) or revision id
579
733
 
580
734
  FLAGS
581
- -c, --cwd=<value> Project directory to operate on.
582
- -f, --force Overwrite protected files on conflict.
583
- -n, --non-interactive Disable prompts. Required when scripting or running as an agent.
584
- -s, --server=<value> Override the resolved server URL.
585
- --debug Debug logging.
586
- --dry-run Preview without mutating files or the platform.
587
- --image=<value> Container image to run.
588
- --port=<value> [default: 8080] Local HTTP port.
589
- --runtime=<option> Local runtime backend.
590
- <options: binary|docker>
591
- --[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
592
- --verbose Verbose logging.
735
+ -c, --cwd=<value> Project directory to operate on.
736
+ -e, --environment=<option> Target environment (default: development).
737
+ <options: development|preview|production>
738
+ -n, --non-interactive Disable prompts. Required when scripting or
739
+ running as an agent.
740
+ -s, --server=<value> Override the resolved server URL.
741
+ --debug Debug logging.
742
+ --dry-run Preview without mutating files or the platform.
743
+ --fields=<value> Fields to show, comma-separated dot-paths.
744
+ Defaults to the resource's own; `--json` is
745
+ unaffected.
746
+ --[no-]telemetry Send anonymous usage analytics. Disable with
747
+ --no-telemetry.
748
+ --verbose Verbose logging.
593
749
 
594
750
  GLOBAL FLAGS
595
751
  --json Format output as json.
596
752
 
597
753
  DESCRIPTION
598
- Start a local Zitadel server.
754
+ Get one flow definition by id.
755
+
756
+ EXAMPLES
757
+ $ zitadel flow-definitions get <id>
758
+
759
+ $ zitadel flow-definitions get <id> --json
599
760
  ```
600
761
 
601
- ## `zitadel status`
762
+ ## `zitadel flow-definitions list`
602
763
 
603
- Summarize the local Zitadel server and project state.
764
+ List flow-definitions.
604
765
 
605
766
  ```
606
767
  USAGE
607
- $ zitadel status [--json] [-c <value>] [-s <value>] [-n] [-f] [--dry-run] [--verbose] [--debug]
608
- [--telemetry]
768
+ $ zitadel flow-definitions list [--json] [-c <value>] [-s <value>] [-n]
769
+ [--dry-run] [--verbose] [--debug] [--telemetry] [--limit <value>] [-a |
770
+ --page-token <value>] [--fields <value>] [--plain] [--filter <value>...] [-e
771
+ development|preview|production]
609
772
 
610
773
  FLAGS
611
- -c, --cwd=<value> Project directory to operate on.
612
- -f, --force Overwrite protected files on conflict.
613
- -n, --non-interactive Disable prompts. Required when scripting or running as an agent.
614
- -s, --server=<value> Override the resolved server URL.
615
- --debug Debug logging.
616
- --dry-run Preview without mutating files or the platform.
617
- --[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
618
- --verbose Verbose logging.
774
+ -a, --all Fetch every page instead of one.
775
+ -c, --cwd=<value> Project directory to operate on.
776
+ -e, --environment=<option> Target environment (default: development).
777
+ <options: development|preview|production>
778
+ -n, --non-interactive Disable prompts. Required when scripting or
779
+ running as an agent.
780
+ -s, --server=<value> Override the resolved server URL.
781
+ --debug Debug logging.
782
+ --dry-run Preview without mutating files or the platform.
783
+ --fields=<value> Columns to show, comma-separated dot-paths (e.g.
784
+ id,attributes.email). Defaults to the resource's
785
+ own columns; `--json` is unaffected.
786
+ --filter=<value>... Filter as field=operation:value (operation
787
+ defaults to equals). Fields: name (equals),
788
+ purpose (equals), revisions (equals; values
789
+ all|latest).
790
+ --limit=<value> Page size (server default 20, max 100).
791
+ --page-token=<value> Continue from a previous page's next_page_token.
792
+ --plain Tab-separated rows with no header, for piping.
793
+ Implied when stdout is not a terminal.
794
+ --[no-]telemetry Send anonymous usage analytics. Disable with
795
+ --no-telemetry.
796
+ --verbose Verbose logging.
619
797
 
620
798
  GLOBAL FLAGS
621
799
  --json Format output as json.
622
800
 
623
801
  DESCRIPTION
624
- Summarize the local Zitadel server and project state.
802
+ List flow-definitions.
803
+
804
+ EXAMPLES
805
+ $ zitadel flow-definitions list --json
806
+
807
+ $ zitadel flow-definitions list --all --json
808
+
809
+ $ zitadel flow-definitions list --filter name=equals:<value>
625
810
  ```
626
811
 
627
- ## `zitadel stop`
812
+ ## `zitadel grants create`
628
813
 
629
- Stop the local Zitadel server.
814
+ Create a grant.
630
815
 
631
816
  ```
632
817
  USAGE
633
- $ zitadel stop [--json] [-c <value>] [-s <value>] [-n] [-f] [--dry-run] [--verbose] [--debug]
634
- [--telemetry] [--all]
818
+ $ zitadel grants create [--json] [-c <value>] [-s <value>] [-n]
819
+ [--dry-run] [--verbose] [--debug] [--telemetry] [--principal-type user|team]
820
+ [--principal-id <value>] [--relation viewer|editor|admin] [--expires-at
821
+ <value>] [--data <value> | --file <value>] [-e
822
+ development|preview|production]
635
823
 
636
824
  FLAGS
637
- -c, --cwd=<value> Project directory to operate on.
638
- -f, --force Overwrite protected files on conflict.
639
- -n, --non-interactive Disable prompts. Required when scripting or running as an agent.
640
- -s, --server=<value> Override the resolved server URL.
641
- --all Stop all discovered CLI-managed local Zitadel runtime processes.
642
- --debug Debug logging.
643
- --dry-run Preview without mutating files or the platform.
644
- --[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
645
- --verbose Verbose logging.
825
+ -c, --cwd=<value> Project directory to operate on.
826
+ -e, --environment=<option> Target environment (default: development).
827
+ <options: development|preview|production>
828
+ -n, --non-interactive Disable prompts. Required when scripting or
829
+ running as an agent.
830
+ -s, --server=<value> Override the resolved server URL.
831
+ --debug Debug logging.
832
+ --dry-run Preview without mutating files or the platform.
833
+ --[no-]telemetry Send anonymous usage analytics. Disable with
834
+ --no-telemetry.
835
+ --verbose Verbose logging.
836
+
837
+ RAW BODY FLAGS
838
+ --data=<value> Whole body as a JSON object, instead of the field flags.
839
+ --file=<value> Read the body from a JSON file; `-` reads stdin.
840
+
841
+ OPTIONAL FIELD FLAGS
842
+ --expires-at=<value> Optional expiry.
646
843
 
647
844
  GLOBAL FLAGS
648
845
  --json Format output as json.
649
846
 
847
+ REQUIRED FIELD FLAGS
848
+ --principal-id=<value> (required) Principal id (`user_<opaque>` or
849
+ `team_<opaque>`).
850
+ --principal-type=<option> (required) Kind of principal to bind.
851
+ <options: user|team>
852
+ --relation=<option> (required) Catalog relation on `object_type`
853
+ `project`.
854
+ <options: viewer|editor|admin>
855
+
650
856
  DESCRIPTION
651
- Stop the local Zitadel server.
652
- ```
857
+ Create a grant.
653
858
 
654
- ## `zitadel uninstall`
859
+ EXAMPLES
860
+ $ zitadel grants create --principal-type user --principal-id <principal_id> --relation viewer --json
655
861
 
656
- Remove managed files and local Zitadel state.
862
+ $ zitadel grants create --data '{...}' --json
657
863
 
864
+ $ zitadel grants create --file ./grant.json
658
865
  ```
659
- USAGE
660
- $ zitadel uninstall [--json] [-c <value>] [-s <value>] [-n] [-f] [--dry-run] [--verbose] [--debug]
661
- [--telemetry]
662
866
 
663
- FLAGS
664
- -c, --cwd=<value> Project directory to operate on.
665
- -f, --force Overwrite protected files on conflict.
666
- -n, --non-interactive Disable prompts. Required when scripting or running as an agent.
667
- -s, --server=<value> Override the resolved server URL.
668
- --debug Debug logging.
669
- --dry-run Preview without mutating files or the platform.
670
- --[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
671
- --verbose Verbose logging.
867
+ ## `zitadel grants delete ID`
672
868
 
673
- GLOBAL FLAGS
674
- --json Format output as json.
869
+ Delete a grant by id.
675
870
 
676
- DESCRIPTION
677
- Remove managed files and local Zitadel state.
871
+ ```
872
+ USAGE
873
+ $ zitadel grants delete ID [--json] [-c <value>] [-s <value>] [-n]
874
+ [--dry-run] [--verbose] [--debug] [--telemetry] [-f] [-e
875
+ development|preview|production]
678
876
 
679
- ALIASES
680
- $ zitadel uninstall
877
+ ARGUMENTS
878
+ ID grant id
879
+
880
+ FLAGS
881
+ -c, --cwd=<value> Project directory to operate on.
882
+ -e, --environment=<option> Target environment (default: development).
883
+ <options: development|preview|production>
884
+ -f, --force Delete the grant without the confirmation prompt.
885
+ Required when non-interactive.
886
+ -n, --non-interactive Disable prompts. Required when scripting or
887
+ running as an agent.
888
+ -s, --server=<value> Override the resolved server URL.
889
+ --debug Debug logging.
890
+ --dry-run Preview without mutating files or the platform.
891
+ --[no-]telemetry Send anonymous usage analytics. Disable with
892
+ --no-telemetry.
893
+ --verbose Verbose logging.
894
+
895
+ GLOBAL FLAGS
896
+ --json Format output as json.
897
+
898
+ DESCRIPTION
899
+ Delete a grant by id.
900
+
901
+ EXAMPLES
902
+ $ zitadel grants delete <id> --force --json
903
+ ```
904
+
905
+ ## `zitadel grants get ID`
906
+
907
+ Get one grant by id.
908
+
909
+ ```
910
+ USAGE
911
+ $ zitadel grants get ID [--json] [-c <value>] [-s <value>] [-n]
912
+ [--dry-run] [--verbose] [--debug] [--telemetry] [--fields <value>] [-e
913
+ development|preview|production]
914
+
915
+ ARGUMENTS
916
+ ID grant id
917
+
918
+ FLAGS
919
+ -c, --cwd=<value> Project directory to operate on.
920
+ -e, --environment=<option> Target environment (default: development).
921
+ <options: development|preview|production>
922
+ -n, --non-interactive Disable prompts. Required when scripting or
923
+ running as an agent.
924
+ -s, --server=<value> Override the resolved server URL.
925
+ --debug Debug logging.
926
+ --dry-run Preview without mutating files or the platform.
927
+ --fields=<value> Fields to show, comma-separated dot-paths.
928
+ Defaults to the resource's own; `--json` is
929
+ unaffected.
930
+ --[no-]telemetry Send anonymous usage analytics. Disable with
931
+ --no-telemetry.
932
+ --verbose Verbose logging.
933
+
934
+ GLOBAL FLAGS
935
+ --json Format output as json.
936
+
937
+ DESCRIPTION
938
+ Get one grant by id.
939
+
940
+ EXAMPLES
941
+ $ zitadel grants get <id>
942
+
943
+ $ zitadel grants get <id> --json
944
+ ```
945
+
946
+ ## `zitadel grants list`
947
+
948
+ List grants.
949
+
950
+ ```
951
+ USAGE
952
+ $ zitadel grants list [--json] [-c <value>] [-s <value>] [-n]
953
+ [--dry-run] [--verbose] [--debug] [--telemetry] [--limit <value>] [-a |
954
+ --page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
955
+ [--sort <value>] [-e development|preview|production]
956
+
957
+ FLAGS
958
+ -a, --all
959
+ Fetch every page instead of one.
960
+
961
+ -c, --cwd=<value>
962
+ Project directory to operate on.
963
+
964
+ -e, --environment=<option>
965
+ Target environment (default: development).
966
+ <options: development|preview|production>
967
+
968
+ -n, --non-interactive
969
+ Disable prompts. Required when scripting or running as an agent.
970
+
971
+ -s, --server=<value>
972
+ Override the resolved server URL.
973
+
974
+ --debug
975
+ Debug logging.
976
+
977
+ --dry-run
978
+ Preview without mutating files or the platform.
979
+
980
+ --fields=<value>
981
+ Columns to show, comma-separated dot-paths (e.g. id,attributes.email).
982
+ Defaults to the resource's own columns; `--json` is unaffected.
983
+
984
+ --filter=<value>...
985
+ Filter as field=operation:value (operation defaults to equals). Fields:
986
+ created_at (equals|not_equals|contains|not_contains|less_than|less_than_or_e
987
+ qual|greater_than|greater_than_or_equal), principal_type
988
+ (equals|not_equals|contains|not_contains|less_than|less_than_or_equal|greate
989
+ r_than|greater_than_or_equal), principal_id (equals|not_equals|contains|not_
990
+ contains|less_than|less_than_or_equal|greater_than|greater_than_or_equal),
991
+ relation (equals|not_equals|contains|not_contains|less_than|less_than_or_equ
992
+ al|greater_than|greater_than_or_equal), expires_at
993
+ (equals|not_equals|contains|not_contains|less_than|less_than_or_equal|greate
994
+ r_than|greater_than_or_equal).
995
+
996
+ --limit=<value>
997
+ Page size (server default 20, max 100).
998
+
999
+ --page-token=<value>
1000
+ Continue from a previous page's next_page_token.
1001
+
1002
+ --plain
1003
+ Tab-separated rows with no header, for piping. Implied when stdout is not a
1004
+ terminal.
1005
+
1006
+ --sort=<value>
1007
+ Sort as field:direction (asc|desc). Fields: created_at, expires_at, id.
1008
+
1009
+ --[no-]telemetry
1010
+ Send anonymous usage analytics. Disable with --no-telemetry.
1011
+
1012
+ --verbose
1013
+ Verbose logging.
1014
+
1015
+ GLOBAL FLAGS
1016
+ --json Format output as json.
1017
+
1018
+ DESCRIPTION
1019
+ List grants.
1020
+
1021
+ EXAMPLES
1022
+ $ zitadel grants list --json
1023
+
1024
+ $ zitadel grants list --all --json
1025
+
1026
+ $ zitadel grants list --filter created_at=equals:<value> --sort created_at:desc
1027
+ ```
1028
+
1029
+ ## `zitadel help [COMMAND]`
1030
+
1031
+ Display help for zitadel.
1032
+
1033
+ ```
1034
+ USAGE
1035
+ $ zitadel help [COMMAND...] [-n]
1036
+
1037
+ ARGUMENTS
1038
+ [COMMAND...] Command to show help for.
1039
+
1040
+ FLAGS
1041
+ -n, --nested-commands Include all nested commands in the output.
1042
+
1043
+ DESCRIPTION
1044
+ Display help for zitadel.
1045
+ ```
1046
+
1047
+ _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/6.2.49/src/commands/help.ts)_
1048
+
1049
+ ## `zitadel idps create`
1050
+
1051
+ Create an identity provider connection.
1052
+
1053
+ ```
1054
+ USAGE
1055
+ $ zitadel idps create [--json] [-c <value>] [-s <value>] [-n]
1056
+ [--dry-run] [--verbose] [--debug] [--telemetry] [--data <value> | --file
1057
+ <value>] [-e development|preview|production]
1058
+
1059
+ FLAGS
1060
+ -c, --cwd=<value> Project directory to operate on.
1061
+ -e, --environment=<option> Target environment (default: development).
1062
+ <options: development|preview|production>
1063
+ -n, --non-interactive Disable prompts. Required when scripting or
1064
+ running as an agent.
1065
+ -s, --server=<value> Override the resolved server URL.
1066
+ --debug Debug logging.
1067
+ --dry-run Preview without mutating files or the platform.
1068
+ --[no-]telemetry Send anonymous usage analytics. Disable with
1069
+ --no-telemetry.
1070
+ --verbose Verbose logging.
1071
+
1072
+ RAW BODY FLAGS
1073
+ --data=<value> Whole body as a JSON object, instead of the field flags.
1074
+ --file=<value> Read the body from a JSON file; `-` reads stdin.
1075
+
1076
+ GLOBAL FLAGS
1077
+ --json Format output as json.
1078
+
1079
+ DESCRIPTION
1080
+ Create an identity provider connection.
1081
+
1082
+ EXAMPLES
1083
+ $ zitadel idps create --data '{...}' --json
1084
+
1085
+ $ zitadel idps create --file ./identity provider connection.json
1086
+ ```
1087
+
1088
+ ## `zitadel idps get ID`
1089
+
1090
+ Get one identity provider connection by id.
1091
+
1092
+ ```
1093
+ USAGE
1094
+ $ zitadel idps get ID [--json] [-c <value>] [-s <value>] [-n]
1095
+ [--dry-run] [--verbose] [--debug] [--telemetry] [--fields <value>] [-e
1096
+ development|preview|production]
1097
+
1098
+ ARGUMENTS
1099
+ ID identity provider connection id
1100
+
1101
+ FLAGS
1102
+ -c, --cwd=<value> Project directory to operate on.
1103
+ -e, --environment=<option> Target environment (default: development).
1104
+ <options: development|preview|production>
1105
+ -n, --non-interactive Disable prompts. Required when scripting or
1106
+ running as an agent.
1107
+ -s, --server=<value> Override the resolved server URL.
1108
+ --debug Debug logging.
1109
+ --dry-run Preview without mutating files or the platform.
1110
+ --fields=<value> Fields to show, comma-separated dot-paths.
1111
+ Defaults to the resource's own; `--json` is
1112
+ unaffected.
1113
+ --[no-]telemetry Send anonymous usage analytics. Disable with
1114
+ --no-telemetry.
1115
+ --verbose Verbose logging.
1116
+
1117
+ GLOBAL FLAGS
1118
+ --json Format output as json.
1119
+
1120
+ DESCRIPTION
1121
+ Get one identity provider connection by id.
1122
+
1123
+ EXAMPLES
1124
+ $ zitadel idps get <id>
1125
+
1126
+ $ zitadel idps get <id> --json
1127
+ ```
1128
+
1129
+ ## `zitadel idps list`
1130
+
1131
+ List idps.
1132
+
1133
+ ```
1134
+ USAGE
1135
+ $ zitadel idps list [--json] [-c <value>] [-s <value>] [-n]
1136
+ [--dry-run] [--verbose] [--debug] [--telemetry] [--limit <value>] [-a |
1137
+ --page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
1138
+ [--sort <value>] [-e development|preview|production]
1139
+
1140
+ FLAGS
1141
+ -a, --all
1142
+ Fetch every page instead of one.
1143
+
1144
+ -c, --cwd=<value>
1145
+ Project directory to operate on.
1146
+
1147
+ -e, --environment=<option>
1148
+ Target environment (default: development).
1149
+ <options: development|preview|production>
1150
+
1151
+ -n, --non-interactive
1152
+ Disable prompts. Required when scripting or running as an agent.
1153
+
1154
+ -s, --server=<value>
1155
+ Override the resolved server URL.
1156
+
1157
+ --debug
1158
+ Debug logging.
1159
+
1160
+ --dry-run
1161
+ Preview without mutating files or the platform.
1162
+
1163
+ --fields=<value>
1164
+ Columns to show, comma-separated dot-paths (e.g. id,attributes.email).
1165
+ Defaults to the resource's own columns; `--json` is unaffected.
1166
+
1167
+ --filter=<value>...
1168
+ Filter as field=operation:value (operation defaults to equals). Fields: slug
1169
+ (equals|not_equals|contains|not_contains|less_than|less_than_or_equal|greate
1170
+ r_than|greater_than_or_equal), created_at (equals|not_equals|contains|not_co
1171
+ ntains|less_than|less_than_or_equal|greater_than|greater_than_or_equal).
1172
+
1173
+ --limit=<value>
1174
+ Page size (server default 20, max 100).
1175
+
1176
+ --page-token=<value>
1177
+ Continue from a previous page's next_page_token.
1178
+
1179
+ --plain
1180
+ Tab-separated rows with no header, for piping. Implied when stdout is not a
1181
+ terminal.
1182
+
1183
+ --sort=<value>
1184
+ Sort as field:direction (asc|desc). Fields: slug, created_at.
1185
+
1186
+ --[no-]telemetry
1187
+ Send anonymous usage analytics. Disable with --no-telemetry.
1188
+
1189
+ --verbose
1190
+ Verbose logging.
1191
+
1192
+ GLOBAL FLAGS
1193
+ --json Format output as json.
1194
+
1195
+ DESCRIPTION
1196
+ List idps.
1197
+
1198
+ EXAMPLES
1199
+ $ zitadel idps list --json
1200
+
1201
+ $ zitadel idps list --all --json
1202
+
1203
+ $ zitadel idps list --filter slug=equals:<value> --sort slug:desc
1204
+ ```
1205
+
1206
+ ## `zitadel logs`
1207
+
1208
+ Show local Zitadel server logs.
1209
+
1210
+ ```
1211
+ USAGE
1212
+ $ zitadel logs [--json] [-c <value>] [-s <value>] [-n]
1213
+ [--dry-run] [--verbose] [--debug] [--telemetry] [--follow] [--tail <value>]
1214
+
1215
+ FLAGS
1216
+ -c, --cwd=<value> Project directory to operate on.
1217
+ -n, --non-interactive Disable prompts. Required when scripting or running as
1218
+ an agent.
1219
+ -s, --server=<value> Override the resolved server URL.
1220
+ --debug Debug logging.
1221
+ --dry-run Preview without mutating files or the platform.
1222
+ --follow Follow logs.
1223
+ --tail=<value> [default: 200] Number of lines to show.
1224
+ --[no-]telemetry Send anonymous usage analytics. Disable with
1225
+ --no-telemetry.
1226
+ --verbose Verbose logging.
1227
+
1228
+ GLOBAL FLAGS
1229
+ --json Format output as json.
1230
+
1231
+ DESCRIPTION
1232
+ Show local Zitadel server logs.
1233
+ ```
1234
+
1235
+ ## `zitadel plan`
1236
+
1237
+ Validate config without mutation and preview the sync diff.
1238
+
1239
+ ```
1240
+ USAGE
1241
+ $ zitadel plan [--json] [-c <value>] [-s <value>] [-n]
1242
+ [--dry-run] [--verbose] [--debug] [--telemetry] [-e
1243
+ development|preview|production]
1244
+
1245
+ FLAGS
1246
+ -c, --cwd=<value> Project directory to operate on.
1247
+ -e, --environment=<option> Target environment (default: development).
1248
+ <options: development|preview|production>
1249
+ -n, --non-interactive Disable prompts. Required when scripting or
1250
+ running as an agent.
1251
+ -s, --server=<value> Override the resolved server URL.
1252
+ --debug Debug logging.
1253
+ --dry-run Preview without mutating files or the platform.
1254
+ --[no-]telemetry Send anonymous usage analytics. Disable with
1255
+ --no-telemetry.
1256
+ --verbose Verbose logging.
1257
+
1258
+ GLOBAL FLAGS
1259
+ --json Format output as json.
1260
+
1261
+ DESCRIPTION
1262
+ Validate config without mutation and preview the sync diff.
1263
+ ```
1264
+
1265
+ ## `zitadel projects get ID`
1266
+
1267
+ Get one project by id.
1268
+
1269
+ ```
1270
+ USAGE
1271
+ $ zitadel projects get ID [--json] [-c <value>] [-s <value>] [-n]
1272
+ [--dry-run] [--verbose] [--debug] [--telemetry] [--fields <value>] [-e
1273
+ development|preview|production]
1274
+
1275
+ ARGUMENTS
1276
+ ID project id
1277
+
1278
+ FLAGS
1279
+ -c, --cwd=<value> Project directory to operate on.
1280
+ -e, --environment=<option> Target environment (default: development).
1281
+ <options: development|preview|production>
1282
+ -n, --non-interactive Disable prompts. Required when scripting or
1283
+ running as an agent.
1284
+ -s, --server=<value> Override the resolved server URL.
1285
+ --debug Debug logging.
1286
+ --dry-run Preview without mutating files or the platform.
1287
+ --fields=<value> Fields to show, comma-separated dot-paths.
1288
+ Defaults to the resource's own; `--json` is
1289
+ unaffected.
1290
+ --[no-]telemetry Send anonymous usage analytics. Disable with
1291
+ --no-telemetry.
1292
+ --verbose Verbose logging.
1293
+
1294
+ GLOBAL FLAGS
1295
+ --json Format output as json.
1296
+
1297
+ DESCRIPTION
1298
+ Get one project by id.
1299
+
1300
+ EXAMPLES
1301
+ $ zitadel projects get <id>
1302
+
1303
+ $ zitadel projects get <id> --json
1304
+ ```
1305
+
1306
+ ## `zitadel projects list`
1307
+
1308
+ List projects.
1309
+
1310
+ ```
1311
+ USAGE
1312
+ $ zitadel projects list [--json] [-c <value>] [-s <value>] [-n]
1313
+ [--dry-run] [--verbose] [--debug] [--telemetry] [--limit <value>] [-a |
1314
+ --page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
1315
+ [--sort <value>] [-e development|preview|production]
1316
+
1317
+ FLAGS
1318
+ -a, --all Fetch every page instead of one.
1319
+ -c, --cwd=<value> Project directory to operate on.
1320
+ -e, --environment=<option> Target environment (default: development).
1321
+ <options: development|preview|production>
1322
+ -n, --non-interactive Disable prompts. Required when scripting or
1323
+ running as an agent.
1324
+ -s, --server=<value> Override the resolved server URL.
1325
+ --debug Debug logging.
1326
+ --dry-run Preview without mutating files or the platform.
1327
+ --fields=<value> Columns to show, comma-separated dot-paths (e.g.
1328
+ id,attributes.email). Defaults to the resource's
1329
+ own columns; `--json` is unaffected.
1330
+ --filter=<value>... Filter as field=operation:value (operation
1331
+ defaults to equals). Fields: created_at (equals|no
1332
+ t_equals|contains|not_contains|less_than|less_than
1333
+ _or_equal|greater_than|greater_than_or_equal).
1334
+ --limit=<value> Page size (server default 20, max 100).
1335
+ --page-token=<value> Continue from a previous page's next_page_token.
1336
+ --plain Tab-separated rows with no header, for piping.
1337
+ Implied when stdout is not a terminal.
1338
+ --sort=<value> Sort as field:direction (asc|desc). Fields:
1339
+ created_at.
1340
+ --[no-]telemetry Send anonymous usage analytics. Disable with
1341
+ --no-telemetry.
1342
+ --verbose Verbose logging.
1343
+
1344
+ GLOBAL FLAGS
1345
+ --json Format output as json.
1346
+
1347
+ DESCRIPTION
1348
+ List projects.
1349
+
1350
+ EXAMPLES
1351
+ $ zitadel projects list --json
1352
+
1353
+ $ zitadel projects list --all --json
1354
+
1355
+ $ zitadel projects list --filter created_at=equals:<value> --sort created_at:desc
1356
+ ```
1357
+
1358
+ ## `zitadel projects update ID`
1359
+
1360
+ Update a project by id.
1361
+
1362
+ ```
1363
+ USAGE
1364
+ $ zitadel projects update ID [--json] [-c <value>] [-s <value>] [-n]
1365
+ [--dry-run] [--verbose] [--debug] [--telemetry] [--name <value>] [--data
1366
+ <value> | --file <value>] [-e development|preview|production]
1367
+
1368
+ ARGUMENTS
1369
+ ID project id
1370
+
1371
+ FLAGS
1372
+ -c, --cwd=<value> Project directory to operate on.
1373
+ -e, --environment=<option> Target environment (default: development).
1374
+ <options: development|preview|production>
1375
+ -n, --non-interactive Disable prompts. Required when scripting or
1376
+ running as an agent.
1377
+ -s, --server=<value> Override the resolved server URL.
1378
+ --debug Debug logging.
1379
+ --dry-run Preview without mutating files or the platform.
1380
+ --[no-]telemetry Send anonymous usage analytics. Disable with
1381
+ --no-telemetry.
1382
+ --verbose Verbose logging.
1383
+
1384
+ RAW BODY FLAGS
1385
+ --data=<value> Whole body as a JSON object, instead of the field flags.
1386
+ --file=<value> Read the body from a JSON file; `-` reads stdin.
1387
+
1388
+ GLOBAL FLAGS
1389
+ --json Format output as json.
1390
+
1391
+ OPTIONAL FIELD FLAGS
1392
+ --name=<value> The name of the project.
1393
+
1394
+ DESCRIPTION
1395
+ Update a project by id.
1396
+
1397
+ EXAMPLES
1398
+ $ zitadel projects update <id> --data '{...}' --json
1399
+
1400
+ $ zitadel projects update <id> --file ./project.json
1401
+ ```
1402
+
1403
+ ## `zitadel releases get ID`
1404
+
1405
+ Get one release by id.
1406
+
1407
+ ```
1408
+ USAGE
1409
+ $ zitadel releases get ID [--json] [-c <value>] [-s <value>] [-n]
1410
+ [--dry-run] [--verbose] [--debug] [--telemetry] [--fields <value>] [-e
1411
+ development|preview|production]
1412
+
1413
+ ARGUMENTS
1414
+ ID release id
1415
+
1416
+ FLAGS
1417
+ -c, --cwd=<value> Project directory to operate on.
1418
+ -e, --environment=<option> Target environment (default: development).
1419
+ <options: development|preview|production>
1420
+ -n, --non-interactive Disable prompts. Required when scripting or
1421
+ running as an agent.
1422
+ -s, --server=<value> Override the resolved server URL.
1423
+ --debug Debug logging.
1424
+ --dry-run Preview without mutating files or the platform.
1425
+ --fields=<value> Fields to show, comma-separated dot-paths.
1426
+ Defaults to the resource's own; `--json` is
1427
+ unaffected.
1428
+ --[no-]telemetry Send anonymous usage analytics. Disable with
1429
+ --no-telemetry.
1430
+ --verbose Verbose logging.
1431
+
1432
+ GLOBAL FLAGS
1433
+ --json Format output as json.
1434
+
1435
+ DESCRIPTION
1436
+ Get one release by id.
1437
+
1438
+ EXAMPLES
1439
+ $ zitadel releases get <id>
1440
+
1441
+ $ zitadel releases get <id> --json
1442
+ ```
1443
+
1444
+ ## `zitadel releases list`
1445
+
1446
+ List releases.
1447
+
1448
+ ```
1449
+ USAGE
1450
+ $ zitadel releases list [--json] [-c <value>] [-s <value>] [-n]
1451
+ [--dry-run] [--verbose] [--debug] [--telemetry] [--limit <value>] [-a |
1452
+ --page-token <value>] [--fields <value>] [--plain] [-e
1453
+ development|preview|production]
1454
+
1455
+ FLAGS
1456
+ -a, --all Fetch every page instead of one.
1457
+ -c, --cwd=<value> Project directory to operate on.
1458
+ -e, --environment=<option> Target environment (default: development).
1459
+ <options: development|preview|production>
1460
+ -n, --non-interactive Disable prompts. Required when scripting or
1461
+ running as an agent.
1462
+ -s, --server=<value> Override the resolved server URL.
1463
+ --debug Debug logging.
1464
+ --dry-run Preview without mutating files or the platform.
1465
+ --fields=<value> Columns to show, comma-separated dot-paths (e.g.
1466
+ id,attributes.email). Defaults to the resource's
1467
+ own columns; `--json` is unaffected.
1468
+ --limit=<value> Page size (server default 20, max 100).
1469
+ --page-token=<value> Continue from a previous page's next_page_token.
1470
+ --plain Tab-separated rows with no header, for piping.
1471
+ Implied when stdout is not a terminal.
1472
+ --[no-]telemetry Send anonymous usage analytics. Disable with
1473
+ --no-telemetry.
1474
+ --verbose Verbose logging.
1475
+
1476
+ GLOBAL FLAGS
1477
+ --json Format output as json.
1478
+
1479
+ DESCRIPTION
1480
+ List releases.
1481
+
1482
+ EXAMPLES
1483
+ $ zitadel releases list --json
1484
+
1485
+ $ zitadel releases list --all --json
1486
+ ```
1487
+
1488
+ ## `zitadel reset`
1489
+
1490
+ Delete the local Zitadel server runtime and data.
1491
+
1492
+ ```
1493
+ USAGE
1494
+ $ zitadel reset [--json] [-c <value>] [-s <value>] [-n]
1495
+ [--dry-run] [--verbose] [--debug] [--telemetry] [-f]
1496
+
1497
+ FLAGS
1498
+ -c, --cwd=<value> Project directory to operate on.
1499
+ -f, --force Delete the local runtime and its data without the
1500
+ confirmation prompt.
1501
+ -n, --non-interactive Disable prompts. Required when scripting or running as
1502
+ an agent.
1503
+ -s, --server=<value> Override the resolved server URL.
1504
+ --debug Debug logging.
1505
+ --dry-run Preview without mutating files or the platform.
1506
+ --[no-]telemetry Send anonymous usage analytics. Disable with
1507
+ --no-telemetry.
1508
+ --verbose Verbose logging.
1509
+
1510
+ GLOBAL FLAGS
1511
+ --json Format output as json.
1512
+
1513
+ DESCRIPTION
1514
+ Delete the local Zitadel server runtime and data.
1515
+ ```
1516
+
1517
+ ## `zitadel resources`
1518
+
1519
+ List the resources this CLI manages and what can be done to each.
1520
+
1521
+ ```
1522
+ USAGE
1523
+ $ zitadel resources [--json] [-c <value>] [-s <value>] [-n]
1524
+ [--dry-run] [--verbose] [--debug] [--telemetry]
1525
+
1526
+ FLAGS
1527
+ -c, --cwd=<value> Project directory to operate on.
1528
+ -n, --non-interactive Disable prompts. Required when scripting or running as
1529
+ an agent.
1530
+ -s, --server=<value> Override the resolved server URL.
1531
+ --debug Debug logging.
1532
+ --dry-run Preview without mutating files or the platform.
1533
+ --[no-]telemetry Send anonymous usage analytics. Disable with
1534
+ --no-telemetry.
1535
+ --verbose Verbose logging.
1536
+
1537
+ GLOBAL FLAGS
1538
+ --json Format output as json.
1539
+
1540
+ DESCRIPTION
1541
+ List the resources this CLI manages and what can be done to each.
1542
+
1543
+ EXAMPLES
1544
+ $ zitadel resources
1545
+
1546
+ $ zitadel resources --json
1547
+
1548
+ $ zitadel resources --json | jq -r '.data.resources[] | "\(.topic): \(.verbs | join(", "))"'
1549
+ ```
1550
+
1551
+ ## `zitadel schemas get SCHEMA`
1552
+
1553
+ Get one schema by id.
1554
+
1555
+ ```
1556
+ USAGE
1557
+ $ zitadel schemas get SCHEMA [--json] [-c <value>] [-s <value>] [-n]
1558
+ [--dry-run] [--verbose] [--debug] [--telemetry] [--fields <value>] [-e
1559
+ development|preview|production]
1560
+
1561
+ ARGUMENTS
1562
+ SCHEMA object type (current revision) or revision id
1563
+
1564
+ FLAGS
1565
+ -c, --cwd=<value> Project directory to operate on.
1566
+ -e, --environment=<option> Target environment (default: development).
1567
+ <options: development|preview|production>
1568
+ -n, --non-interactive Disable prompts. Required when scripting or
1569
+ running as an agent.
1570
+ -s, --server=<value> Override the resolved server URL.
1571
+ --debug Debug logging.
1572
+ --dry-run Preview without mutating files or the platform.
1573
+ --fields=<value> Fields to show, comma-separated dot-paths.
1574
+ Defaults to the resource's own; `--json` is
1575
+ unaffected.
1576
+ --[no-]telemetry Send anonymous usage analytics. Disable with
1577
+ --no-telemetry.
1578
+ --verbose Verbose logging.
1579
+
1580
+ GLOBAL FLAGS
1581
+ --json Format output as json.
1582
+
1583
+ DESCRIPTION
1584
+ Get one schema by id.
1585
+
1586
+ EXAMPLES
1587
+ $ zitadel schemas get <id>
1588
+
1589
+ $ zitadel schemas get <id> --json
1590
+ ```
1591
+
1592
+ ## `zitadel schemas list`
1593
+
1594
+ List schemas.
1595
+
1596
+ ```
1597
+ USAGE
1598
+ $ zitadel schemas list [--json] [-c <value>] [-s <value>] [-n]
1599
+ [--dry-run] [--verbose] [--debug] [--telemetry] [--limit <value>] [-a |
1600
+ --page-token <value>] [--fields <value>] [--plain] [--filter <value>...] [-e
1601
+ development|preview|production]
1602
+
1603
+ FLAGS
1604
+ -a, --all Fetch every page instead of one.
1605
+ -c, --cwd=<value> Project directory to operate on.
1606
+ -e, --environment=<option> Target environment (default: development).
1607
+ <options: development|preview|production>
1608
+ -n, --non-interactive Disable prompts. Required when scripting or
1609
+ running as an agent.
1610
+ -s, --server=<value> Override the resolved server URL.
1611
+ --debug Debug logging.
1612
+ --dry-run Preview without mutating files or the platform.
1613
+ --fields=<value> Columns to show, comma-separated dot-paths (e.g.
1614
+ id,attributes.email). Defaults to the resource's
1615
+ own columns; `--json` is unaffected.
1616
+ --filter=<value>... Filter as field=operation:value (operation
1617
+ defaults to equals). Fields: object_type (equals),
1618
+ kind (equals), revisions (equals; values
1619
+ all|latest).
1620
+ --limit=<value> Page size (server default 20, max 100).
1621
+ --page-token=<value> Continue from a previous page's next_page_token.
1622
+ --plain Tab-separated rows with no header, for piping.
1623
+ Implied when stdout is not a terminal.
1624
+ --[no-]telemetry Send anonymous usage analytics. Disable with
1625
+ --no-telemetry.
1626
+ --verbose Verbose logging.
1627
+
1628
+ GLOBAL FLAGS
1629
+ --json Format output as json.
1630
+
1631
+ DESCRIPTION
1632
+ List schemas.
1633
+
1634
+ EXAMPLES
1635
+ $ zitadel schemas list --json
1636
+
1637
+ $ zitadel schemas list --all --json
1638
+
1639
+ $ zitadel schemas list --filter object_type=equals:<value>
1640
+ ```
1641
+
1642
+ ## `zitadel search`
1643
+
1644
+ Search for a command.
1645
+
1646
+ ```
1647
+ USAGE
1648
+ $ zitadel search
1649
+
1650
+ DESCRIPTION
1651
+ Search for a command.
1652
+
1653
+ Once you select a command, hit enter and it will show the help for that
1654
+ command.
1655
+ ```
1656
+
1657
+ _See code: [@oclif/plugin-search](https://github.com/oclif/plugin-search/blob/v1.2.50/src/commands/search.ts)_
1658
+
1659
+ ## `zitadel sessions get ID`
1660
+
1661
+ Get one session by id.
1662
+
1663
+ ```
1664
+ USAGE
1665
+ $ zitadel sessions get ID [--json] [-c <value>] [-s <value>] [-n]
1666
+ [--dry-run] [--verbose] [--debug] [--telemetry] [--fields <value>] [-e
1667
+ development|preview|production]
1668
+
1669
+ ARGUMENTS
1670
+ ID session id
1671
+
1672
+ FLAGS
1673
+ -c, --cwd=<value> Project directory to operate on.
1674
+ -e, --environment=<option> Target environment (default: development).
1675
+ <options: development|preview|production>
1676
+ -n, --non-interactive Disable prompts. Required when scripting or
1677
+ running as an agent.
1678
+ -s, --server=<value> Override the resolved server URL.
1679
+ --debug Debug logging.
1680
+ --dry-run Preview without mutating files or the platform.
1681
+ --fields=<value> Fields to show, comma-separated dot-paths.
1682
+ Defaults to the resource's own; `--json` is
1683
+ unaffected.
1684
+ --[no-]telemetry Send anonymous usage analytics. Disable with
1685
+ --no-telemetry.
1686
+ --verbose Verbose logging.
1687
+
1688
+ GLOBAL FLAGS
1689
+ --json Format output as json.
1690
+
1691
+ DESCRIPTION
1692
+ Get one session by id.
1693
+
1694
+ EXAMPLES
1695
+ $ zitadel sessions get <id>
1696
+
1697
+ $ zitadel sessions get <id> --json
1698
+ ```
1699
+
1700
+ ## `zitadel sessions list`
1701
+
1702
+ List sessions.
1703
+
1704
+ ```
1705
+ USAGE
1706
+ $ zitadel sessions list [--json] [-c <value>] [-s <value>] [-n]
1707
+ [--dry-run] [--verbose] [--debug] [--telemetry] [--limit <value>] [-a |
1708
+ --page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
1709
+ [--sort <value>] [-e development|preview|production]
1710
+
1711
+ FLAGS
1712
+ -a, --all
1713
+ Fetch every page instead of one.
1714
+
1715
+ -c, --cwd=<value>
1716
+ Project directory to operate on.
1717
+
1718
+ -e, --environment=<option>
1719
+ Target environment (default: development).
1720
+ <options: development|preview|production>
1721
+
1722
+ -n, --non-interactive
1723
+ Disable prompts. Required when scripting or running as an agent.
1724
+
1725
+ -s, --server=<value>
1726
+ Override the resolved server URL.
1727
+
1728
+ --debug
1729
+ Debug logging.
1730
+
1731
+ --dry-run
1732
+ Preview without mutating files or the platform.
1733
+
1734
+ --fields=<value>
1735
+ Columns to show, comma-separated dot-paths (e.g. id,attributes.email).
1736
+ Defaults to the resource's own columns; `--json` is unaffected.
1737
+
1738
+ --filter=<value>...
1739
+ Filter as field=operation:value (operation defaults to equals). Fields:
1740
+ created_at (equals|not_equals|contains|not_contains|less_than|less_than_or_e
1741
+ qual|greater_than|greater_than_or_equal), user_id
1742
+ (equals|not_equals|contains|not_contains|less_than|less_than_or_equal|greate
1743
+ r_than|greater_than_or_equal), state (equals|not_equals|contains|not_contain
1744
+ s|less_than|less_than_or_equal|greater_than|greater_than_or_equal),
1745
+ lifecycle_owner_team_id (equals|not_equals|contains|not_contains|less_than|l
1746
+ ess_than_or_equal|greater_than|greater_than_or_equal).
1747
+
1748
+ --limit=<value>
1749
+ Page size (server default 20, max 100).
1750
+
1751
+ --page-token=<value>
1752
+ Continue from a previous page's next_page_token.
1753
+
1754
+ --plain
1755
+ Tab-separated rows with no header, for piping. Implied when stdout is not a
1756
+ terminal.
1757
+
1758
+ --sort=<value>
1759
+ Sort as field:direction (asc|desc). Fields: created_at, user_id.
1760
+
1761
+ --[no-]telemetry
1762
+ Send anonymous usage analytics. Disable with --no-telemetry.
1763
+
1764
+ --verbose
1765
+ Verbose logging.
1766
+
1767
+ GLOBAL FLAGS
1768
+ --json Format output as json.
1769
+
1770
+ DESCRIPTION
1771
+ List sessions.
1772
+
1773
+ EXAMPLES
1774
+ $ zitadel sessions list --json
1775
+
1776
+ $ zitadel sessions list --all --json
1777
+
1778
+ $ zitadel sessions list --filter created_at=equals:<value> --sort created_at:desc
1779
+ ```
1780
+
1781
+ ## `zitadel sessions revoke ID`
1782
+
1783
+ Revoke a session by id.
1784
+
1785
+ ```
1786
+ USAGE
1787
+ $ zitadel sessions revoke ID [--json] [-c <value>] [-s <value>] [-n]
1788
+ [--dry-run] [--verbose] [--debug] [--telemetry] [-f] [-e
1789
+ development|preview|production]
1790
+
1791
+ ARGUMENTS
1792
+ ID session id
1793
+
1794
+ FLAGS
1795
+ -c, --cwd=<value> Project directory to operate on.
1796
+ -e, --environment=<option> Target environment (default: development).
1797
+ <options: development|preview|production>
1798
+ -f, --force Revoke the session without the confirmation
1799
+ prompt. Required when non-interactive.
1800
+ -n, --non-interactive Disable prompts. Required when scripting or
1801
+ running as an agent.
1802
+ -s, --server=<value> Override the resolved server URL.
1803
+ --debug Debug logging.
1804
+ --dry-run Preview without mutating files or the platform.
1805
+ --[no-]telemetry Send anonymous usage analytics. Disable with
1806
+ --no-telemetry.
1807
+ --verbose Verbose logging.
1808
+
1809
+ GLOBAL FLAGS
1810
+ --json Format output as json.
1811
+
1812
+ DESCRIPTION
1813
+ Revoke a session by id.
1814
+
1815
+ EXAMPLES
1816
+ $ zitadel sessions revoke <id> --force --json
1817
+ ```
1818
+
1819
+ ## `zitadel setup`
1820
+
1821
+ Create a Zitadel project and scaffold local auth.
1822
+
1823
+ ```
1824
+ USAGE
1825
+ $ zitadel setup [--json] [-c <value>] [-s <value>] [-n]
1826
+ [--dry-run] [--verbose] [--debug] [--telemetry] [-f] [--framework
1827
+ next|nuxt|react|vue|solid|svelte|qwik|angular] [--renderer react]
1828
+ [--dev-port <value>] [--skip-install] [--preset
1829
+ password-first|passkey-first] [--use-case minimal|consumer|business]
1830
+ [--design centered|split|split-right|hero|minimal]
1831
+
1832
+ FLAGS
1833
+ -c, --cwd=<value>
1834
+ Project directory to operate on.
1835
+
1836
+ -f, --force
1837
+ Overwrite managed files that already exist.
1838
+
1839
+ -n, --non-interactive
1840
+ Disable prompts. Required when scripting or running as an agent.
1841
+
1842
+ -s, --server=<value>
1843
+ Override the resolved server URL.
1844
+
1845
+ --debug
1846
+ Debug logging.
1847
+
1848
+ --design=<option>
1849
+ Login design to eject into .zitadel/branding/ and publish as branding
1850
+ revision 1. Skips the wizard's design question. When omitted in
1851
+ non-interactive runs, the login uses the built-in template; run the
1852
+ `branding eject` command later to customize. Split-family designs (split,
1853
+ split-right, hero) collapse their brand pane by container width: narrow
1854
+ containers — including widget-posture embeds at card width — render the
1855
+ compact brand mark instead (logo_url, else hero_url, from
1856
+ .zitadel/branding/branding.json; hero falls back to editable text).
1857
+ <options: centered|split|split-right|hero|minimal>
1858
+
1859
+ --dev-port=<value>
1860
+ Dev-server port; also the issuer origin registered with Zitadel. Defaults to
1861
+ the detected port. Use distinct ports to run several scaffolded apps side by
1862
+ side.
1863
+
1864
+ --dry-run
1865
+ Preview without mutating files or the platform.
1866
+
1867
+ --framework=<option>
1868
+ Framework to target.
1869
+ <options: next|nuxt|react|vue|solid|svelte|qwik|angular>
1870
+
1871
+ --preset=<option>
1872
+ Sign-in preset for the scaffolded schema and login flow (default:
1873
+ password-first).
1874
+ <options: password-first|passkey-first>
1875
+
1876
+ --renderer=<option>
1877
+ Renderer (default: react). Not yet available: web-component.
1878
+ <options: react>
1879
+
1880
+ --skip-install
1881
+ Do not install dependencies after setup updates package.json.
1882
+
1883
+ --[no-]telemetry
1884
+ Send anonymous usage analytics. Disable with --no-telemetry.
1885
+
1886
+ --use-case=<option>
1887
+ Use case for the scaffolded schema fields: who signs in to the app (default:
1888
+ minimal).
1889
+ <options: minimal|consumer|business>
1890
+
1891
+ --verbose
1892
+ Verbose logging.
1893
+
1894
+ GLOBAL FLAGS
1895
+ --json Format output as json.
1896
+
1897
+ DESCRIPTION
1898
+ Create a Zitadel project and scaffold local auth.
1899
+
1900
+ EXAMPLES
1901
+ $ zitadel setup --framework next
1902
+
1903
+ $ zitadel setup --framework react --dev-port 3000
1904
+ ```
1905
+
1906
+ ## `zitadel start`
1907
+
1908
+ Start a local Zitadel server.
1909
+
1910
+ ```
1911
+ USAGE
1912
+ $ zitadel start [--json] [-c <value>] [-s <value>] [-n]
1913
+ [--dry-run] [--verbose] [--debug] [--telemetry] [--image <value>] [--port
1914
+ <value>] [--runtime binary|docker]
1915
+
1916
+ FLAGS
1917
+ -c, --cwd=<value> Project directory to operate on.
1918
+ -n, --non-interactive Disable prompts. Required when scripting or running as
1919
+ an agent.
1920
+ -s, --server=<value> Override the resolved server URL.
1921
+ --debug Debug logging.
1922
+ --dry-run Preview without mutating files or the platform.
1923
+ --image=<value> Container image to run.
1924
+ --port=<value> [default: 8080] Local HTTP port.
1925
+ --runtime=<option> Local runtime backend.
1926
+ <options: binary|docker>
1927
+ --[no-]telemetry Send anonymous usage analytics. Disable with
1928
+ --no-telemetry.
1929
+ --verbose Verbose logging.
1930
+
1931
+ GLOBAL FLAGS
1932
+ --json Format output as json.
1933
+
1934
+ DESCRIPTION
1935
+ Start a local Zitadel server.
1936
+ ```
1937
+
1938
+ ## `zitadel status`
1939
+
1940
+ Summarize the local Zitadel server and project state.
1941
+
1942
+ ```
1943
+ USAGE
1944
+ $ zitadel status [--json] [-c <value>] [-s <value>] [-n]
1945
+ [--dry-run] [--verbose] [--debug] [--telemetry]
1946
+
1947
+ FLAGS
1948
+ -c, --cwd=<value> Project directory to operate on.
1949
+ -n, --non-interactive Disable prompts. Required when scripting or running as
1950
+ an agent.
1951
+ -s, --server=<value> Override the resolved server URL.
1952
+ --debug Debug logging.
1953
+ --dry-run Preview without mutating files or the platform.
1954
+ --[no-]telemetry Send anonymous usage analytics. Disable with
1955
+ --no-telemetry.
1956
+ --verbose Verbose logging.
1957
+
1958
+ GLOBAL FLAGS
1959
+ --json Format output as json.
1960
+
1961
+ DESCRIPTION
1962
+ Summarize the local Zitadel server and project state.
1963
+ ```
1964
+
1965
+ ## `zitadel stop`
1966
+
1967
+ Stop the local Zitadel server.
1968
+
1969
+ ```
1970
+ USAGE
1971
+ $ zitadel stop [--json] [-c <value>] [-s <value>] [-n]
1972
+ [--dry-run] [--verbose] [--debug] [--telemetry] [--all]
1973
+
1974
+ FLAGS
1975
+ -c, --cwd=<value> Project directory to operate on.
1976
+ -n, --non-interactive Disable prompts. Required when scripting or running as
1977
+ an agent.
1978
+ -s, --server=<value> Override the resolved server URL.
1979
+ --all Stop all discovered CLI-managed local Zitadel runtime
1980
+ processes.
1981
+ --debug Debug logging.
1982
+ --dry-run Preview without mutating files or the platform.
1983
+ --[no-]telemetry Send anonymous usage analytics. Disable with
1984
+ --no-telemetry.
1985
+ --verbose Verbose logging.
1986
+
1987
+ GLOBAL FLAGS
1988
+ --json Format output as json.
1989
+
1990
+ DESCRIPTION
1991
+ Stop the local Zitadel server.
1992
+ ```
1993
+
1994
+ ## `zitadel teams create`
1995
+
1996
+ Create a team.
1997
+
1998
+ ```
1999
+ USAGE
2000
+ $ zitadel teams create [--json] [-c <value>] [-s <value>] [-n]
2001
+ [--dry-run] [--verbose] [--debug] [--telemetry] [--name <value>] [--data
2002
+ <value> | --file <value>] [-e development|preview|production]
2003
+
2004
+ FLAGS
2005
+ -c, --cwd=<value> Project directory to operate on.
2006
+ -e, --environment=<option> Target environment (default: development).
2007
+ <options: development|preview|production>
2008
+ -n, --non-interactive Disable prompts. Required when scripting or
2009
+ running as an agent.
2010
+ -s, --server=<value> Override the resolved server URL.
2011
+ --debug Debug logging.
2012
+ --dry-run Preview without mutating files or the platform.
2013
+ --[no-]telemetry Send anonymous usage analytics. Disable with
2014
+ --no-telemetry.
2015
+ --verbose Verbose logging.
2016
+
2017
+ RAW BODY FLAGS
2018
+ --data=<value> Whole body as a JSON object, instead of the field flags.
2019
+ --file=<value> Read the body from a JSON file; `-` reads stdin.
2020
+
2021
+ GLOBAL FLAGS
2022
+ --json Format output as json.
2023
+
2024
+ REQUIRED FIELD FLAGS
2025
+ --name=<value> (required) The name of the team.
2026
+
2027
+ DESCRIPTION
2028
+ Create a team.
2029
+
2030
+ EXAMPLES
2031
+ $ zitadel teams create --name <name> --json
2032
+
2033
+ $ zitadel teams create --data '{...}' --json
2034
+
2035
+ $ zitadel teams create --file ./team.json
2036
+ ```
2037
+
2038
+ ## `zitadel teams deactivate ID`
2039
+
2040
+ Deactivate a team by id.
2041
+
2042
+ ```
2043
+ USAGE
2044
+ $ zitadel teams deactivate ID [--json] [-c <value>] [-s <value>] [-n]
2045
+ [--dry-run] [--verbose] [--debug] [--telemetry] [-f] [-e
2046
+ development|preview|production]
2047
+
2048
+ ARGUMENTS
2049
+ ID team id
2050
+
2051
+ FLAGS
2052
+ -c, --cwd=<value> Project directory to operate on.
2053
+ -e, --environment=<option> Target environment (default: development).
2054
+ <options: development|preview|production>
2055
+ -f, --force Deactivate the team without the confirmation
2056
+ prompt. Required when non-interactive.
2057
+ -n, --non-interactive Disable prompts. Required when scripting or
2058
+ running as an agent.
2059
+ -s, --server=<value> Override the resolved server URL.
2060
+ --debug Debug logging.
2061
+ --dry-run Preview without mutating files or the platform.
2062
+ --[no-]telemetry Send anonymous usage analytics. Disable with
2063
+ --no-telemetry.
2064
+ --verbose Verbose logging.
2065
+
2066
+ GLOBAL FLAGS
2067
+ --json Format output as json.
2068
+
2069
+ DESCRIPTION
2070
+ Deactivate a team by id.
2071
+
2072
+ EXAMPLES
2073
+ $ zitadel teams deactivate <id> --force --json
2074
+ ```
2075
+
2076
+ ## `zitadel teams get ID`
2077
+
2078
+ Get one team by id.
2079
+
2080
+ ```
2081
+ USAGE
2082
+ $ zitadel teams get ID [--json] [-c <value>] [-s <value>] [-n]
2083
+ [--dry-run] [--verbose] [--debug] [--telemetry] [--fields <value>] [-e
2084
+ development|preview|production]
2085
+
2086
+ ARGUMENTS
2087
+ ID team id
2088
+
2089
+ FLAGS
2090
+ -c, --cwd=<value> Project directory to operate on.
2091
+ -e, --environment=<option> Target environment (default: development).
2092
+ <options: development|preview|production>
2093
+ -n, --non-interactive Disable prompts. Required when scripting or
2094
+ running as an agent.
2095
+ -s, --server=<value> Override the resolved server URL.
2096
+ --debug Debug logging.
2097
+ --dry-run Preview without mutating files or the platform.
2098
+ --fields=<value> Fields to show, comma-separated dot-paths.
2099
+ Defaults to the resource's own; `--json` is
2100
+ unaffected.
2101
+ --[no-]telemetry Send anonymous usage analytics. Disable with
2102
+ --no-telemetry.
2103
+ --verbose Verbose logging.
2104
+
2105
+ GLOBAL FLAGS
2106
+ --json Format output as json.
2107
+
2108
+ DESCRIPTION
2109
+ Get one team by id.
2110
+
2111
+ EXAMPLES
2112
+ $ zitadel teams get <id>
2113
+
2114
+ $ zitadel teams get <id> --json
2115
+ ```
2116
+
2117
+ ## `zitadel teams list`
2118
+
2119
+ List teams.
2120
+
2121
+ ```
2122
+ USAGE
2123
+ $ zitadel teams list [--json] [-c <value>] [-s <value>] [-n]
2124
+ [--dry-run] [--verbose] [--debug] [--telemetry] [--limit <value>] [-a |
2125
+ --page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
2126
+ [--sort <value>] [-e development|preview|production]
2127
+
2128
+ FLAGS
2129
+ -a, --all
2130
+ Fetch every page instead of one.
2131
+
2132
+ -c, --cwd=<value>
2133
+ Project directory to operate on.
2134
+
2135
+ -e, --environment=<option>
2136
+ Target environment (default: development).
2137
+ <options: development|preview|production>
2138
+
2139
+ -n, --non-interactive
2140
+ Disable prompts. Required when scripting or running as an agent.
2141
+
2142
+ -s, --server=<value>
2143
+ Override the resolved server URL.
2144
+
2145
+ --debug
2146
+ Debug logging.
2147
+
2148
+ --dry-run
2149
+ Preview without mutating files or the platform.
2150
+
2151
+ --fields=<value>
2152
+ Columns to show, comma-separated dot-paths (e.g. id,attributes.email).
2153
+ Defaults to the resource's own columns; `--json` is unaffected.
2154
+
2155
+ --filter=<value>...
2156
+ Filter as field=operation:value (operation defaults to equals). Fields:
2157
+ created_at (equals|not_equals|contains|not_contains|less_than|less_than_or_e
2158
+ qual|greater_than|greater_than_or_equal), name
2159
+ (equals|not_equals|contains|not_contains|less_than|less_than_or_equal|greate
2160
+ r_than|greater_than_or_equal), status (equals|not_equals|contains|not_contai
2161
+ ns|less_than|less_than_or_equal|greater_than|greater_than_or_equal).
2162
+
2163
+ --limit=<value>
2164
+ Page size (server default 20, max 100).
2165
+
2166
+ --page-token=<value>
2167
+ Continue from a previous page's next_page_token.
2168
+
2169
+ --plain
2170
+ Tab-separated rows with no header, for piping. Implied when stdout is not a
2171
+ terminal.
2172
+
2173
+ --sort=<value>
2174
+ Sort as field:direction (asc|desc). Fields: created_at, name, status.
2175
+
2176
+ --[no-]telemetry
2177
+ Send anonymous usage analytics. Disable with --no-telemetry.
2178
+
2179
+ --verbose
2180
+ Verbose logging.
2181
+
2182
+ GLOBAL FLAGS
2183
+ --json Format output as json.
2184
+
2185
+ DESCRIPTION
2186
+ List teams.
2187
+
2188
+ EXAMPLES
2189
+ $ zitadel teams list --json
2190
+
2191
+ $ zitadel teams list --all --json
2192
+
2193
+ $ zitadel teams list --filter created_at=equals:<value> --sort created_at:desc
2194
+ ```
2195
+
2196
+ ## `zitadel teams update ID`
2197
+
2198
+ Update a team by id.
2199
+
2200
+ ```
2201
+ USAGE
2202
+ $ zitadel teams update ID [--json] [-c <value>] [-s <value>] [-n]
2203
+ [--dry-run] [--verbose] [--debug] [--telemetry] [--name <value>] [--data
2204
+ <value> | --file <value>] [-e development|preview|production]
2205
+
2206
+ ARGUMENTS
2207
+ ID team id
2208
+
2209
+ FLAGS
2210
+ -c, --cwd=<value> Project directory to operate on.
2211
+ -e, --environment=<option> Target environment (default: development).
2212
+ <options: development|preview|production>
2213
+ -n, --non-interactive Disable prompts. Required when scripting or
2214
+ running as an agent.
2215
+ -s, --server=<value> Override the resolved server URL.
2216
+ --debug Debug logging.
2217
+ --dry-run Preview without mutating files or the platform.
2218
+ --[no-]telemetry Send anonymous usage analytics. Disable with
2219
+ --no-telemetry.
2220
+ --verbose Verbose logging.
2221
+
2222
+ RAW BODY FLAGS
2223
+ --data=<value> Whole body as a JSON object, instead of the field flags.
2224
+ --file=<value> Read the body from a JSON file; `-` reads stdin.
2225
+
2226
+ GLOBAL FLAGS
2227
+ --json Format output as json.
2228
+
2229
+ OPTIONAL FIELD FLAGS
2230
+ --name=<value> The name of the team.
2231
+
2232
+ DESCRIPTION
2233
+ Update a team by id.
2234
+
2235
+ EXAMPLES
2236
+ $ zitadel teams update <id> --data '{...}' --json
2237
+
2238
+ $ zitadel teams update <id> --file ./team.json
2239
+ ```
2240
+
2241
+ ## `zitadel uninstall`
2242
+
2243
+ Remove managed files and local Zitadel state.
2244
+
2245
+ ```
2246
+ USAGE
2247
+ $ zitadel uninstall [--json] [-c <value>] [-s <value>] [-n]
2248
+ [--dry-run] [--verbose] [--debug] [--telemetry] [-f]
2249
+
2250
+ FLAGS
2251
+ -c, --cwd=<value> Project directory to operate on.
2252
+ -f, --force Remove the managed files without the confirmation
2253
+ prompt.
2254
+ -n, --non-interactive Disable prompts. Required when scripting or running as
2255
+ an agent.
2256
+ -s, --server=<value> Override the resolved server URL.
2257
+ --debug Debug logging.
2258
+ --dry-run Preview without mutating files or the platform.
2259
+ --[no-]telemetry Send anonymous usage analytics. Disable with
2260
+ --no-telemetry.
2261
+ --verbose Verbose logging.
2262
+
2263
+ GLOBAL FLAGS
2264
+ --json Format output as json.
2265
+
2266
+ DESCRIPTION
2267
+ Remove managed files and local Zitadel state.
2268
+
2269
+ ALIASES
2270
+ $ zitadel uninstall
2271
+ ```
2272
+
2273
+ ## `zitadel users create`
2274
+
2275
+ Create an user.
2276
+
2277
+ ```
2278
+ USAGE
2279
+ $ zitadel users create [--json] [-c <value>] [-s <value>] [-n]
2280
+ [--dry-run] [--verbose] [--debug] [--telemetry] [--schema <value>]
2281
+ [--attributes <value>...] [--data <value> | --file <value>] [-e
2282
+ development|preview|production]
2283
+
2284
+ FLAGS
2285
+ -c, --cwd=<value> Project directory to operate on.
2286
+ -e, --environment=<option> Target environment (default: development).
2287
+ <options: development|preview|production>
2288
+ -n, --non-interactive Disable prompts. Required when scripting or
2289
+ running as an agent.
2290
+ -s, --server=<value> Override the resolved server URL.
2291
+ --debug Debug logging.
2292
+ --dry-run Preview without mutating files or the platform.
2293
+ --[no-]telemetry Send anonymous usage analytics. Disable with
2294
+ --no-telemetry.
2295
+ --verbose Verbose logging.
2296
+
2297
+ REQUIRED FIELD FLAGS
2298
+ --attributes=<value>... (required) Repeatable attributes entry: key=value for
2299
+ a string, key:=value for JSON. The user's
2300
+ schema-defined content.
2301
+ --schema=<value> (required) The schema that defines the content of
2302
+ `attributes`.
2303
+
2304
+ RAW BODY FLAGS
2305
+ --data=<value> Whole body as a JSON object, instead of the field flags.
2306
+ --file=<value> Read the body from a JSON file; `-` reads stdin.
2307
+
2308
+ GLOBAL FLAGS
2309
+ --json Format output as json.
2310
+
2311
+ DESCRIPTION
2312
+ Create an user.
2313
+
2314
+ EXAMPLES
2315
+ $ zitadel users create --schema <schema> --attributes <key>=<value> --json
2316
+
2317
+ $ zitadel users create --data '{...}' --json
2318
+
2319
+ $ zitadel users create --file ./user.json
2320
+ ```
2321
+
2322
+ ## `zitadel users delete ID`
2323
+
2324
+ Delete an user by id.
2325
+
2326
+ ```
2327
+ USAGE
2328
+ $ zitadel users delete ID [--json] [-c <value>] [-s <value>] [-n]
2329
+ [--dry-run] [--verbose] [--debug] [--telemetry] [-f] [-e
2330
+ development|preview|production]
2331
+
2332
+ ARGUMENTS
2333
+ ID user id
2334
+
2335
+ FLAGS
2336
+ -c, --cwd=<value> Project directory to operate on.
2337
+ -e, --environment=<option> Target environment (default: development).
2338
+ <options: development|preview|production>
2339
+ -f, --force Delete the user without the confirmation prompt.
2340
+ Required when non-interactive.
2341
+ -n, --non-interactive Disable prompts. Required when scripting or
2342
+ running as an agent.
2343
+ -s, --server=<value> Override the resolved server URL.
2344
+ --debug Debug logging.
2345
+ --dry-run Preview without mutating files or the platform.
2346
+ --[no-]telemetry Send anonymous usage analytics. Disable with
2347
+ --no-telemetry.
2348
+ --verbose Verbose logging.
2349
+
2350
+ GLOBAL FLAGS
2351
+ --json Format output as json.
2352
+
2353
+ DESCRIPTION
2354
+ Delete an user by id.
2355
+
2356
+ EXAMPLES
2357
+ $ zitadel users delete <id> --force --json
2358
+ ```
2359
+
2360
+ ## `zitadel users get ID`
2361
+
2362
+ Get one user by id.
2363
+
2364
+ ```
2365
+ USAGE
2366
+ $ zitadel users get ID [--json] [-c <value>] [-s <value>] [-n]
2367
+ [--dry-run] [--verbose] [--debug] [--telemetry] [--fields <value>] [-e
2368
+ development|preview|production]
2369
+
2370
+ ARGUMENTS
2371
+ ID user id
2372
+
2373
+ FLAGS
2374
+ -c, --cwd=<value> Project directory to operate on.
2375
+ -e, --environment=<option> Target environment (default: development).
2376
+ <options: development|preview|production>
2377
+ -n, --non-interactive Disable prompts. Required when scripting or
2378
+ running as an agent.
2379
+ -s, --server=<value> Override the resolved server URL.
2380
+ --debug Debug logging.
2381
+ --dry-run Preview without mutating files or the platform.
2382
+ --fields=<value> Fields to show, comma-separated dot-paths.
2383
+ Defaults to the resource's own; `--json` is
2384
+ unaffected.
2385
+ --[no-]telemetry Send anonymous usage analytics. Disable with
2386
+ --no-telemetry.
2387
+ --verbose Verbose logging.
2388
+
2389
+ GLOBAL FLAGS
2390
+ --json Format output as json.
2391
+
2392
+ DESCRIPTION
2393
+ Get one user by id.
2394
+
2395
+ EXAMPLES
2396
+ $ zitadel users get <id>
2397
+
2398
+ $ zitadel users get <id> --json
2399
+ ```
2400
+
2401
+ ## `zitadel users list`
2402
+
2403
+ List users.
2404
+
2405
+ ```
2406
+ USAGE
2407
+ $ zitadel users list [--json] [-c <value>] [-s <value>] [-n]
2408
+ [--dry-run] [--verbose] [--debug] [--telemetry] [--limit <value>] [-a |
2409
+ --page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
2410
+ [--sort <value>] [-e development|preview|production]
2411
+
2412
+ FLAGS
2413
+ -a, --all
2414
+ Fetch every page instead of one.
2415
+
2416
+ -c, --cwd=<value>
2417
+ Project directory to operate on.
2418
+
2419
+ -e, --environment=<option>
2420
+ Target environment (default: development).
2421
+ <options: development|preview|production>
2422
+
2423
+ -n, --non-interactive
2424
+ Disable prompts. Required when scripting or running as an agent.
2425
+
2426
+ -s, --server=<value>
2427
+ Override the resolved server URL.
2428
+
2429
+ --debug
2430
+ Debug logging.
2431
+
2432
+ --dry-run
2433
+ Preview without mutating files or the platform.
2434
+
2435
+ --fields=<value>
2436
+ Columns to show, comma-separated dot-paths (e.g. id,attributes.email).
2437
+ Defaults to the resource's own columns; `--json` is unaffected.
2438
+
2439
+ --filter=<value>...
2440
+ Filter as field=operation:value (operation defaults to equals). Fields:
2441
+ created_at (equals|not_equals|contains|not_contains|less_than|less_than_or_e
2442
+ qual|greater_than|greater_than_or_equal), id (equals|not_equals|contains|not
2443
+ _contains|less_than|less_than_or_equal|greater_than|greater_than_or_equal),
2444
+ schema (equals|not_equals|contains|not_contains|less_than|less_than_or_equal
2445
+ |greater_than|greater_than_or_equal), status (equals|not_equals|contains|not
2446
+ _contains|less_than|less_than_or_equal|greater_than|greater_than_or_equal),
2447
+ team_id (equals|not_equals|contains|not_contains|less_than|less_than_or_equa
2448
+ l|greater_than|greater_than_or_equal), lifecycle_owner_team_id
2449
+ (equals|not_equals|contains|not_contains|less_than|less_than_or_equal|greate
2450
+ r_than|greater_than_or_equal).
2451
+
2452
+ --limit=<value>
2453
+ Page size (server default 20, max 100).
2454
+
2455
+ --page-token=<value>
2456
+ Continue from a previous page's next_page_token.
2457
+
2458
+ --plain
2459
+ Tab-separated rows with no header, for piping. Implied when stdout is not a
2460
+ terminal.
2461
+
2462
+ --sort=<value>
2463
+ Sort as field:direction (asc|desc). Fields: created_at, id, schema, status,
2464
+ lifecycle_owner_team_id.
2465
+
2466
+ --[no-]telemetry
2467
+ Send anonymous usage analytics. Disable with --no-telemetry.
2468
+
2469
+ --verbose
2470
+ Verbose logging.
2471
+
2472
+ GLOBAL FLAGS
2473
+ --json Format output as json.
2474
+
2475
+ DESCRIPTION
2476
+ List users.
2477
+
2478
+ EXAMPLES
2479
+ $ zitadel users list --json
2480
+
2481
+ $ zitadel users list --all --json
2482
+
2483
+ $ zitadel users list --filter created_at=equals:<value> --sort created_at:desc
2484
+ ```
2485
+
2486
+ ## `zitadel users update ID`
2487
+
2488
+ Update an user by id.
2489
+
2490
+ ```
2491
+ USAGE
2492
+ $ zitadel users update ID [--json] [-c <value>] [-s <value>] [-n]
2493
+ [--dry-run] [--verbose] [--debug] [--telemetry] [--schema <value>]
2494
+ [--attributes <value>...] [--data <value> | --file <value>] [-e
2495
+ development|preview|production]
2496
+
2497
+ ARGUMENTS
2498
+ ID user id
2499
+
2500
+ FLAGS
2501
+ -c, --cwd=<value> Project directory to operate on.
2502
+ -e, --environment=<option> Target environment (default: development).
2503
+ <options: development|preview|production>
2504
+ -n, --non-interactive Disable prompts. Required when scripting or
2505
+ running as an agent.
2506
+ -s, --server=<value> Override the resolved server URL.
2507
+ --debug Debug logging.
2508
+ --dry-run Preview without mutating files or the platform.
2509
+ --[no-]telemetry Send anonymous usage analytics. Disable with
2510
+ --no-telemetry.
2511
+ --verbose Verbose logging.
2512
+
2513
+ OPTIONAL FIELD FLAGS
2514
+ --attributes=<value>... Repeatable attributes entry: key=value for a string,
2515
+ key:=value for JSON. The changed attributes only.
2516
+ --schema=<value> The schema the user follows after this patch.
2517
+
2518
+ RAW BODY FLAGS
2519
+ --data=<value> Whole body as a JSON object, instead of the field flags.
2520
+ --file=<value> Read the body from a JSON file; `-` reads stdin.
2521
+
2522
+ GLOBAL FLAGS
2523
+ --json Format output as json.
2524
+
2525
+ DESCRIPTION
2526
+ Update an user by id.
2527
+
2528
+ EXAMPLES
2529
+ $ zitadel users update <id> --data '{...}' --json
2530
+
2531
+ $ zitadel users update <id> --file ./user.json
2532
+ ```
2533
+
2534
+ ## `zitadel variables delete NAME`
2535
+
2536
+ Delete one variable from an environment or the project.
2537
+
2538
+ ```
2539
+ USAGE
2540
+ $ zitadel variables delete NAME [--json] [-c <value>] [-s <value>] [-n]
2541
+ [--dry-run] [--verbose] [--debug] [--telemetry] [-e <value> |
2542
+ --project-level] [-f]
2543
+
2544
+ ARGUMENTS
2545
+ NAME Variable name to delete.
2546
+
2547
+ FLAGS
2548
+ -c, --cwd=<value> Project directory to operate on.
2549
+ -e, --environment=<value> Environment to address, by name.
2550
+ -f, --force Delete the variable without the confirmation
2551
+ prompt. Required when non-interactive.
2552
+ -n, --non-interactive Disable prompts. Required when scripting or running
2553
+ as an agent.
2554
+ -s, --server=<value> Override the resolved server URL.
2555
+ --debug Debug logging.
2556
+ --dry-run Preview without mutating files or the platform.
2557
+ --project-level Address the project level instead of an
2558
+ environment. Environments do not inherit
2559
+ project-level values.
2560
+ --[no-]telemetry Send anonymous usage analytics. Disable with
2561
+ --no-telemetry.
2562
+ --verbose Verbose logging.
2563
+
2564
+ GLOBAL FLAGS
2565
+ --json Format output as json.
2566
+
2567
+ DESCRIPTION
2568
+ Delete one variable from an environment or the project.
2569
+
2570
+ EXAMPLES
2571
+ $ zitadel variables delete GOOGLE_CLIENT_ID --environment prod
2572
+
2573
+ $ zitadel variables delete GOOGLE_CLIENT_ID --project-level --force
2574
+ ```
2575
+
2576
+ ## `zitadel variables get NAME`
2577
+
2578
+ Get one variable from an environment or the project.
2579
+
2580
+ ```
2581
+ USAGE
2582
+ $ zitadel variables get NAME [--json] [-c <value>] [-s <value>] [-n]
2583
+ [--dry-run] [--verbose] [--debug] [--telemetry] [-e <value> |
2584
+ --project-level]
2585
+
2586
+ ARGUMENTS
2587
+ NAME Variable name to read.
2588
+
2589
+ FLAGS
2590
+ -c, --cwd=<value> Project directory to operate on.
2591
+ -e, --environment=<value> Environment to address, by name.
2592
+ -n, --non-interactive Disable prompts. Required when scripting or running
2593
+ as an agent.
2594
+ -s, --server=<value> Override the resolved server URL.
2595
+ --debug Debug logging.
2596
+ --dry-run Preview without mutating files or the platform.
2597
+ --project-level Address the project level instead of an
2598
+ environment. Environments do not inherit
2599
+ project-level values.
2600
+ --[no-]telemetry Send anonymous usage analytics. Disable with
2601
+ --no-telemetry.
2602
+ --verbose Verbose logging.
2603
+
2604
+ GLOBAL FLAGS
2605
+ --json Format output as json.
2606
+
2607
+ DESCRIPTION
2608
+ Get one variable from an environment or the project.
2609
+
2610
+ EXAMPLES
2611
+ $ zitadel variables get GOOGLE_CLIENT_ID --environment prod
2612
+
2613
+ $ zitadel variables get GOOGLE_CLIENT_ID --environment prod --json
2614
+ ```
2615
+
2616
+ ## `zitadel variables list`
2617
+
2618
+ List the variables entered on an environment or the project.
2619
+
2620
+ ```
2621
+ USAGE
2622
+ $ zitadel variables list [--json] [-c <value>] [-s <value>] [-n]
2623
+ [--dry-run] [--verbose] [--debug] [--telemetry] [-e <value> |
2624
+ --project-level] [--plain]
2625
+
2626
+ FLAGS
2627
+ -c, --cwd=<value> Project directory to operate on.
2628
+ -e, --environment=<value> Environment to address, by name.
2629
+ -n, --non-interactive Disable prompts. Required when scripting or running
2630
+ as an agent.
2631
+ -s, --server=<value> Override the resolved server URL.
2632
+ --debug Debug logging.
2633
+ --dry-run Preview without mutating files or the platform.
2634
+ --plain Tab-separated rows with no header, for piping.
2635
+ Implied when stdout is not a terminal.
2636
+ --project-level Address the project level instead of an
2637
+ environment. Environments do not inherit
2638
+ project-level values.
2639
+ --[no-]telemetry Send anonymous usage analytics. Disable with
2640
+ --no-telemetry.
2641
+ --verbose Verbose logging.
2642
+
2643
+ GLOBAL FLAGS
2644
+ --json Format output as json.
2645
+
2646
+ DESCRIPTION
2647
+ List the variables entered on an environment or the project.
2648
+
2649
+ EXAMPLES
2650
+ $ zitadel variables list --environment prod
2651
+
2652
+ $ zitadel variables list --project-level --json
2653
+ ```
2654
+
2655
+ ## `zitadel variables set NAME`
2656
+
2657
+ Set one variable on an environment or the project.
2658
+
2659
+ ```
2660
+ USAGE
2661
+ $ zitadel variables set NAME [--json] [-c <value>] [-s <value>] [-n]
2662
+ [--dry-run] [--verbose] [--debug] [--telemetry] [-e <value> |
2663
+ --project-level] [--secret] [--as string|number|boolean]
2664
+
2665
+ ARGUMENTS
2666
+ NAME Variable name (letters, digits and underscores).
2667
+
2668
+ FLAGS
2669
+ -c, --cwd=<value> Project directory to operate on.
2670
+ -e, --environment=<value> Environment to address, by name.
2671
+ -n, --non-interactive Disable prompts. Required when scripting or running
2672
+ as an agent.
2673
+ -s, --server=<value> Override the resolved server URL.
2674
+ --as=<option> [default: string] Store the value as this JSON
2675
+ type. A reference to the whole field resolves to
2676
+ that type, so a number stays a number.
2677
+ <options: string|number|boolean>
2678
+ --debug Debug logging.
2679
+ --dry-run Preview without mutating files or the platform.
2680
+ --project-level Address the project level instead of an
2681
+ environment. Environments do not inherit
2682
+ project-level values.
2683
+ --secret Store the value encrypted. It can be replaced later
2684
+ but never read back.
2685
+ --[no-]telemetry Send anonymous usage analytics. Disable with
2686
+ --no-telemetry.
2687
+ --verbose Verbose logging.
2688
+
2689
+ GLOBAL FLAGS
2690
+ --json Format output as json.
2691
+
2692
+ DESCRIPTION
2693
+ Set one variable on an environment or the project.
2694
+
2695
+ EXAMPLES
2696
+ $ zitadel variables set GOOGLE_CLIENT_ID --environment prod
2697
+
2698
+ $ zitadel variables set GOOGLE_CLIENT_SECRET --environment prod --secret < secret.txt
2699
+
2700
+ $ zitadel variables set SESSION_TTL --project-level --as number
681
2701
  ```
682
2702
 
683
2703
  ## `zitadel version`
@@ -695,7 +2715,8 @@ GLOBAL FLAGS
695
2715
  FLAG DESCRIPTIONS
696
2716
  --verbose Show additional information about the CLI.
697
2717
 
698
- Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using.
2718
+ Additionally shows the architecture, node version, operating system, and
2719
+ versions of plugins that the CLI is using.
699
2720
  ```
700
2721
 
701
2722
  _See code: [@oclif/plugin-version](https://github.com/oclif/plugin-version/blob/2.2.46/src/commands/version.ts)_