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

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