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

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.
package/README.md CHANGED
@@ -1,15 +1,15 @@
1
1
  # @zitadel/cli
2
2
 
3
- Scaffolds Zitadel auth (login, register, profile, middleware/proxy) into a Next.js, Nuxt, React, Vue, Angular, Solid, Svelte, or Qwik app.
3
+ Scaffolds Zitadel auth (login, register, profile, middleware/proxy) into a Next.js, Nuxt, SvelteKit, SolidStart, Qwik Router, TanStack Start, React, Vue, Angular, Solid, Svelte, or Qwik app.
4
4
 
5
5
  ```sh
6
6
  npx @zitadel/cli@alpha start
7
7
  npx @zitadel/cli@alpha setup --server local
8
8
  ```
9
9
 
10
- During the public alpha, bare `npx @zitadel/cli` resolves to the same tested
11
- alpha CLI. Use `@alpha` or an exact `0.1.0-alpha.N` selector in bug reports and
12
- automation when reproducibility matters.
10
+ Always pass `@alpha`: bare `npx @zitadel/cli` resolves npm's `latest` tag, which
11
+ still points at an early `0.0.0` build. Use an exact `1.0.0-alpha.N` selector in
12
+ bug reports and automation when reproducibility matters.
13
13
 
14
14
  > **Beta.** This is the **next-generation Zitadel**, a ground-up rewrite of the platform. It is distinct from the established Zitadel at [github.com/zitadel/zitadel](https://github.com/zitadel/zitadel). APIs and CLI flags will change.
15
15
 
@@ -69,9 +69,9 @@ For a reproducible tester report, use the exact alpha train from the GitHub
69
69
  Release:
70
70
 
71
71
  ```sh
72
- npx @zitadel/cli@0.1.0-alpha.N doctor
73
- npx @zitadel/cli@0.1.0-alpha.N start
74
- npx @zitadel/cli@0.1.0-alpha.N setup --server local
72
+ npx @zitadel/cli@1.0.0-alpha.N doctor
73
+ npx @zitadel/cli@1.0.0-alpha.N start
74
+ npx @zitadel/cli@1.0.0-alpha.N setup --server local
75
75
  ```
76
76
 
77
77
  The default project flow supports password registration/login, passkey
@@ -117,7 +117,7 @@ and agent UIs may display stderr package-manager progress together with stdout.
117
117
  - `zitadel start|stop|logs|reset`: manage the local runtime
118
118
 
119
119
  The full agent-facing contract (JSON envelope, posture rules, claim flow,
120
- doctor repair) is [`SKILLS.md`](https://github.com/zitadel/nextgen/blob/main/apps/cli/SKILLS.md),
120
+ doctor repair) is [`SKILL.md`](https://github.com/zitadel/nextgen/blob/main/apps/cli/skills/zitadel-cli/SKILL.md),
121
121
  which ships in this package.
122
122
 
123
123
  ## Reference
@@ -127,6 +127,12 @@ which ships in this package.
127
127
 
128
128
  <!-- commands -->
129
129
  * [`zitadel apply`](#zitadel-apply)
130
+ * [`zitadel auth-method passkey disable`](#zitadel-auth-method-passkey-disable)
131
+ * [`zitadel auth-method passkey enable`](#zitadel-auth-method-passkey-enable)
132
+ * [`zitadel auth-method password disable`](#zitadel-auth-method-password-disable)
133
+ * [`zitadel auth-method password enable`](#zitadel-auth-method-password-enable)
134
+ * [`zitadel auth-method sso disable`](#zitadel-auth-method-sso-disable)
135
+ * [`zitadel auth-method sso enable`](#zitadel-auth-method-sso-enable)
130
136
  * [`zitadel autocomplete [SHELL]`](#zitadel-autocomplete-shell)
131
137
  * [`zitadel branding eject`](#zitadel-branding-eject)
132
138
  * [`zitadel branding get ID`](#zitadel-branding-get-id)
@@ -136,8 +142,6 @@ which ships in this package.
136
142
  * [`zitadel console`](#zitadel-console)
137
143
  * [`zitadel doctor`](#zitadel-doctor)
138
144
  * [`zitadel eject`](#zitadel-eject)
139
- * [`zitadel environments get NAME`](#zitadel-environments-get-name)
140
- * [`zitadel environments list`](#zitadel-environments-list)
141
145
  * [`zitadel events get ID`](#zitadel-events-get-id)
142
146
  * [`zitadel events list`](#zitadel-events-list)
143
147
  * [`zitadel flow-definitions get FLOW`](#zitadel-flow-definitions-get-flow)
@@ -194,18 +198,20 @@ Validate and upload repo config to the platform.
194
198
  ```
195
199
  USAGE
196
200
  $ zitadel apply [--json] [-c <value>] [-s <value>] [-n]
197
- [--dry-run] [--verbose] [--debug] [--telemetry]
201
+ [--dry-run] [-v] [--debug] [--color] [--telemetry]
198
202
 
199
203
  FLAGS
200
204
  -c, --cwd=<value> Project directory to operate on.
201
205
  -n, --non-interactive Disable prompts. Required when scripting or running as
202
206
  an agent.
203
207
  -s, --server=<value> Override the resolved server URL.
208
+ -v, --verbose Verbose logging.
209
+ --[no-]color Colorize human output. Disable with --no-color;
210
+ NO_COLOR and FORCE_COLOR are honored too.
204
211
  --debug Debug logging.
205
212
  --dry-run Preview without mutating files or the platform.
206
213
  --[no-]telemetry Send anonymous usage analytics. Disable with
207
214
  --no-telemetry.
208
- --verbose Verbose logging.
209
215
 
210
216
  GLOBAL FLAGS
211
217
  --json Format output as json.
@@ -214,6 +220,252 @@ DESCRIPTION
214
220
  Validate and upload repo config to the platform.
215
221
  ```
216
222
 
223
+ ## `zitadel auth-method passkey disable`
224
+
225
+ Disable passkey sign-in for a user schema.
226
+
227
+ ```
228
+ USAGE
229
+ $ zitadel auth-method passkey disable [--json] [-c <value>] [-s <value>] [-n]
230
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--schema <value>] [-f]
231
+
232
+ FLAGS
233
+ -c, --cwd=<value> Project directory to operate on.
234
+ -f, --force Disable the schema's last way to sign in. Its users can
235
+ then only be managed through the API.
236
+ -n, --non-interactive Disable prompts. Required when scripting or running as
237
+ an agent.
238
+ -s, --server=<value> Override the resolved server URL.
239
+ -v, --verbose Verbose logging.
240
+ --[no-]color Colorize human output. Disable with --no-color;
241
+ NO_COLOR and FORCE_COLOR are honored too.
242
+ --debug Debug logging.
243
+ --dry-run Preview without mutating files or the platform.
244
+ --schema=<value> User schema to change. Required when the Project has
245
+ more than one.
246
+ --[no-]telemetry Send anonymous usage analytics. Disable with
247
+ --no-telemetry.
248
+
249
+ GLOBAL FLAGS
250
+ --json Format output as json.
251
+
252
+ DESCRIPTION
253
+ Disable passkey sign-in for a user schema.
254
+
255
+ EXAMPLES
256
+ $ zitadel auth-method passkey disable
257
+
258
+ $ zitadel auth-method passkey disable --schema customers
259
+ ```
260
+
261
+ ## `zitadel auth-method passkey enable`
262
+
263
+ Enable passkey sign-in for a user schema.
264
+
265
+ ```
266
+ USAGE
267
+ $ zitadel auth-method passkey enable [--json] [-c <value>] [-s <value>] [-n]
268
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--schema <value>]
269
+
270
+ FLAGS
271
+ -c, --cwd=<value> Project directory to operate on.
272
+ -n, --non-interactive Disable prompts. Required when scripting or running as
273
+ an agent.
274
+ -s, --server=<value> Override the resolved server URL.
275
+ -v, --verbose Verbose logging.
276
+ --[no-]color Colorize human output. Disable with --no-color;
277
+ NO_COLOR and FORCE_COLOR are honored too.
278
+ --debug Debug logging.
279
+ --dry-run Preview without mutating files or the platform.
280
+ --schema=<value> User schema to change. Required when the Project has
281
+ more than one.
282
+ --[no-]telemetry Send anonymous usage analytics. Disable with
283
+ --no-telemetry.
284
+
285
+ GLOBAL FLAGS
286
+ --json Format output as json.
287
+
288
+ DESCRIPTION
289
+ Enable passkey sign-in for a user schema.
290
+
291
+ EXAMPLES
292
+ $ zitadel auth-method passkey enable
293
+
294
+ $ zitadel auth-method passkey enable --schema customers
295
+ ```
296
+
297
+ ## `zitadel auth-method password disable`
298
+
299
+ Disable password sign-in for a user schema.
300
+
301
+ ```
302
+ USAGE
303
+ $ zitadel auth-method password disable [--json] [-c <value>] [-s <value>] [-n]
304
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--schema <value>] [-f]
305
+
306
+ FLAGS
307
+ -c, --cwd=<value> Project directory to operate on.
308
+ -f, --force Disable the schema's last way to sign in. Its users can
309
+ then only be managed through the API.
310
+ -n, --non-interactive Disable prompts. Required when scripting or running as
311
+ an agent.
312
+ -s, --server=<value> Override the resolved server URL.
313
+ -v, --verbose Verbose logging.
314
+ --[no-]color Colorize human output. Disable with --no-color;
315
+ NO_COLOR and FORCE_COLOR are honored too.
316
+ --debug Debug logging.
317
+ --dry-run Preview without mutating files or the platform.
318
+ --schema=<value> User schema to change. Required when the Project has
319
+ more than one.
320
+ --[no-]telemetry Send anonymous usage analytics. Disable with
321
+ --no-telemetry.
322
+
323
+ GLOBAL FLAGS
324
+ --json Format output as json.
325
+
326
+ DESCRIPTION
327
+ Disable password sign-in for a user schema.
328
+
329
+ EXAMPLES
330
+ $ zitadel auth-method password disable
331
+
332
+ $ zitadel auth-method password disable --schema customers
333
+ ```
334
+
335
+ ## `zitadel auth-method password enable`
336
+
337
+ Enable password sign-in for a user schema.
338
+
339
+ ```
340
+ USAGE
341
+ $ zitadel auth-method password enable [--json] [-c <value>] [-s <value>] [-n]
342
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--schema <value>]
343
+
344
+ FLAGS
345
+ -c, --cwd=<value> Project directory to operate on.
346
+ -n, --non-interactive Disable prompts. Required when scripting or running as
347
+ an agent.
348
+ -s, --server=<value> Override the resolved server URL.
349
+ -v, --verbose Verbose logging.
350
+ --[no-]color Colorize human output. Disable with --no-color;
351
+ NO_COLOR and FORCE_COLOR are honored too.
352
+ --debug Debug logging.
353
+ --dry-run Preview without mutating files or the platform.
354
+ --schema=<value> User schema to change. Required when the Project has
355
+ more than one.
356
+ --[no-]telemetry Send anonymous usage analytics. Disable with
357
+ --no-telemetry.
358
+
359
+ GLOBAL FLAGS
360
+ --json Format output as json.
361
+
362
+ DESCRIPTION
363
+ Enable password sign-in for a user schema.
364
+
365
+ EXAMPLES
366
+ $ zitadel auth-method password enable
367
+
368
+ $ zitadel auth-method password enable --schema customers
369
+ ```
370
+
371
+ ## `zitadel auth-method sso disable`
372
+
373
+ Remove an identity provider from a user schema.
374
+
375
+ ```
376
+ USAGE
377
+ $ zitadel auth-method sso disable [--json] [-c <value>] [-s <value>] [-n]
378
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--schema <value>]
379
+ [--provider <value>] [-f]
380
+
381
+ FLAGS
382
+ -c, --cwd=<value> Project directory to operate on.
383
+ -f, --force Disable the schema's last way to sign in. Its users
384
+ can then only be managed through the API.
385
+ -n, --non-interactive Disable prompts. Required when scripting or running as
386
+ an agent.
387
+ -s, --server=<value> Override the resolved server URL.
388
+ -v, --verbose Verbose logging.
389
+ --[no-]color Colorize human output. Disable with --no-color;
390
+ NO_COLOR and FORCE_COLOR are honored too.
391
+ --debug Debug logging.
392
+ --dry-run Preview without mutating files or the platform.
393
+ --provider=<value> Identity provider to remove.
394
+ --schema=<value> User schema to change. Required when the Project has
395
+ more than one.
396
+ --[no-]telemetry Send anonymous usage analytics. Disable with
397
+ --no-telemetry.
398
+
399
+ GLOBAL FLAGS
400
+ --json Format output as json.
401
+
402
+ DESCRIPTION
403
+ Remove an identity provider from a user schema.
404
+
405
+ EXAMPLES
406
+ $ zitadel auth-method sso disable --provider google
407
+
408
+ $ zitadel auth-method sso disable --provider google --schema customers
409
+ ```
410
+
411
+ ## `zitadel auth-method sso enable`
412
+
413
+ Add an identity provider to a user schema.
414
+
415
+ ```
416
+ USAGE
417
+ $ zitadel auth-method sso enable [--json] [-c <value>] [-s <value>] [-n]
418
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--schema <value>]
419
+ [--provider google|custom] [--slug <value>] [--display-name <value>]
420
+ [--issuer <value>] [--scopes <value>] [--client-id <value>]
421
+
422
+ FLAGS
423
+ -c, --cwd=<value> Project directory to operate on.
424
+ -n, --non-interactive Disable prompts. Required when scripting or
425
+ running as an agent.
426
+ -s, --server=<value> Override the resolved server URL.
427
+ -v, --verbose Verbose logging.
428
+ --client-id=<value> Client id of the application registered with the
429
+ provider.
430
+ --[no-]color Colorize human output. Disable with --no-color;
431
+ NO_COLOR and FORCE_COLOR are honored too.
432
+ --debug Debug logging.
433
+ --display-name=<value> Name shown on the custom connection's sign-in
434
+ button.
435
+ --dry-run Preview without mutating files or the platform.
436
+ --issuer=<value> Issuer URL of the custom provider. Its endpoints
437
+ are found by OIDC discovery.
438
+ --provider=<option> Identity provider to enable, or "custom" for any
439
+ other OpenID Connect provider.
440
+ <options: google|custom>
441
+ --schema=<value> User schema to change. Required when the Project
442
+ has more than one.
443
+ --scopes=<value> Scopes the custom connection requests, separated
444
+ by spaces or commas. Must include openid. Default:
445
+ openid profile email.
446
+ --slug=<value> Name of the custom connection. Schemas and flows
447
+ refer to it by this.
448
+ --[no-]telemetry Send anonymous usage analytics. Disable with
449
+ --no-telemetry.
450
+
451
+ GLOBAL FLAGS
452
+ --json Format output as json.
453
+
454
+ DESCRIPTION
455
+ Add an identity provider to a user schema.
456
+
457
+ EXAMPLES
458
+ $ zitadel auth-method sso enable --provider google
459
+
460
+ $ zitadel auth-method sso enable --provider google --schema customers
461
+
462
+ $ zitadel auth-method sso enable --provider google --client-id 1234-abc.apps.googleusercontent.com --non-interactive < secret.txt
463
+
464
+ $ zitadel auth-method sso enable --provider custom --slug acme-sso --display-name 'Acme SSO' --issuer https://sso.acme.example
465
+
466
+ $ zitadel auth-method sso enable --provider custom --slug acme-sso --display-name 'Acme SSO' --issuer https://sso.acme.example --scopes 'openid profile email groups' --client-id abc123 --non-interactive < secret.txt
467
+ ```
468
+
217
469
  ## `zitadel autocomplete [SHELL]`
218
470
 
219
471
  Display autocomplete installation instructions.
@@ -252,8 +504,7 @@ Take ownership of the login template: scaffold .zitadel/branding/ from a shipped
252
504
  ```
253
505
  USAGE
254
506
  $ zitadel branding eject [--json] [-c <value>] [-s <value>] [-n]
255
- [--dry-run] [--verbose] [--debug] [--telemetry] [-f] [--design
256
- centered|minimal]
507
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-f] [--design <value>]
257
508
 
258
509
  FLAGS
259
510
  -c, --cwd=<value> Project directory to operate on.
@@ -261,13 +512,15 @@ FLAGS
261
512
  -n, --non-interactive Disable prompts. Required when scripting or running as
262
513
  an agent.
263
514
  -s, --server=<value> Override the resolved server URL.
515
+ -v, --verbose Verbose logging.
516
+ --[no-]color Colorize human output. Disable with --no-color;
517
+ NO_COLOR and FORCE_COLOR are honored too.
264
518
  --debug Debug logging.
265
- --design=<option> Design to start from (default: centered).
266
- <options: centered|minimal>
519
+ --design=<value> Design to start from: centered or minimal (default:
520
+ centered).
267
521
  --dry-run Preview without mutating files or the platform.
268
522
  --[no-]telemetry Send anonymous usage analytics. Disable with
269
523
  --no-telemetry.
270
- --verbose Verbose logging.
271
524
 
272
525
  GLOBAL FLAGS
273
526
  --json Format output as json.
@@ -284,7 +537,7 @@ Get one branding revision by id.
284
537
  ```
285
538
  USAGE
286
539
  $ zitadel branding get ID [--json] [-c <value>] [-s <value>] [-n]
287
- [--dry-run] [--verbose] [--debug] [--telemetry] [--fields <value>]
540
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
288
541
 
289
542
  ARGUMENTS
290
543
  ID branding revision id
@@ -294,13 +547,15 @@ FLAGS
294
547
  -n, --non-interactive Disable prompts. Required when scripting or running as
295
548
  an agent.
296
549
  -s, --server=<value> Override the resolved server URL.
550
+ -v, --verbose Verbose logging.
551
+ --[no-]color Colorize human output. Disable with --no-color;
552
+ NO_COLOR and FORCE_COLOR are honored too.
297
553
  --debug Debug logging.
298
554
  --dry-run Preview without mutating files or the platform.
299
555
  --fields=<value> Fields to show, comma-separated dot-paths. Defaults to
300
556
  the resource's own; `--json` is unaffected.
301
557
  --[no-]telemetry Send anonymous usage analytics. Disable with
302
558
  --no-telemetry.
303
- --verbose Verbose logging.
304
559
 
305
560
  GLOBAL FLAGS
306
561
  --json Format output as json.
@@ -321,13 +576,17 @@ List branding.
321
576
  ```
322
577
  USAGE
323
578
  $ zitadel branding list [--json] [-c <value>] [-s <value>] [-n]
324
- [--dry-run] [--verbose] [--debug] [--telemetry] [--fields <value>] [--plain]
579
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
580
+ [--plain]
325
581
 
326
582
  FLAGS
327
583
  -c, --cwd=<value> Project directory to operate on.
328
584
  -n, --non-interactive Disable prompts. Required when scripting or running as
329
585
  an agent.
330
586
  -s, --server=<value> Override the resolved server URL.
587
+ -v, --verbose Verbose logging.
588
+ --[no-]color Colorize human output. Disable with --no-color;
589
+ NO_COLOR and FORCE_COLOR are honored too.
331
590
  --debug Debug logging.
332
591
  --dry-run Preview without mutating files or the platform.
333
592
  --fields=<value> Columns to show, comma-separated dot-paths (e.g.
@@ -337,7 +596,6 @@ FLAGS
337
596
  when stdout is not a terminal.
338
597
  --[no-]telemetry Send anonymous usage analytics. Disable with
339
598
  --no-telemetry.
340
- --verbose Verbose logging.
341
599
 
342
600
  GLOBAL FLAGS
343
601
  --json Format output as json.
@@ -356,7 +614,7 @@ Claim this project to make it permanent. Opens a browser to create an account or
356
614
  ```
357
615
  USAGE
358
616
  $ zitadel claim [--json] [-c <value>] [-s <value>] [-n]
359
- [--dry-run] [--verbose] [--debug] [--telemetry] [--no-open] [--timeout
617
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--no-open] [--timeout
360
618
  <value>]
361
619
 
362
620
  FLAGS
@@ -364,6 +622,9 @@ FLAGS
364
622
  -n, --non-interactive Disable prompts. Required when scripting or running as
365
623
  an agent.
366
624
  -s, --server=<value> Override the resolved server URL.
625
+ -v, --verbose Verbose logging.
626
+ --[no-]color Colorize human output. Disable with --no-color;
627
+ NO_COLOR and FORCE_COLOR are honored too.
367
628
  --debug Debug logging.
368
629
  --dry-run Preview without mutating files or the platform.
369
630
  --no-open Print the link instead of opening a browser.
@@ -371,7 +632,6 @@ FLAGS
371
632
  --no-telemetry.
372
633
  --timeout=<value> Seconds to wait for the browser step. Defaults to the
373
634
  link's own expiry (10 minutes).
374
- --verbose Verbose logging.
375
635
 
376
636
  GLOBAL FLAGS
377
637
  --json Format output as json.
@@ -425,19 +685,21 @@ Open the local console, signed in as the local admin created by `zitadel start`.
425
685
  ```
426
686
  USAGE
427
687
  $ zitadel console [--json] [-c <value>] [-s <value>] [-n]
428
- [--dry-run] [--verbose] [--debug] [--telemetry] [--no-open]
688
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--no-open]
429
689
 
430
690
  FLAGS
431
691
  -c, --cwd=<value> Project directory to operate on.
432
692
  -n, --non-interactive Disable prompts. Required when scripting or running as
433
693
  an agent.
434
694
  -s, --server=<value> Override the resolved server URL.
695
+ -v, --verbose Verbose logging.
696
+ --[no-]color Colorize human output. Disable with --no-color;
697
+ NO_COLOR and FORCE_COLOR are honored too.
435
698
  --debug Debug logging.
436
699
  --dry-run Preview without mutating files or the platform.
437
700
  --no-open Print the sign-in link instead of opening a browser.
438
701
  --[no-]telemetry Send anonymous usage analytics. Disable with
439
702
  --no-telemetry.
440
- --verbose Verbose logging.
441
703
 
442
704
  GLOBAL FLAGS
443
705
  --json Format output as json.
@@ -446,6 +708,9 @@ DESCRIPTION
446
708
  Open the local console, signed in as the local admin created by `zitadel
447
709
  start`.
448
710
 
711
+ Run it in the directory `zitadel start` ran in, or one inside it: the local
712
+ admin is read from the nearest `.zitadel/local/` on the way up.
713
+
449
714
  EXAMPLES
450
715
  $ zitadel console
451
716
 
@@ -459,7 +724,7 @@ Verify local runtime and project state.
459
724
  ```
460
725
  USAGE
461
726
  $ zitadel doctor [--json] [-c <value>] [-s <value>] [-n]
462
- [--dry-run] [--verbose] [--debug] [--telemetry] [--fix] [--image <value>]
727
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--fix] [--image <value>]
463
728
  [--port <value>] [--runtime binary|docker]
464
729
 
465
730
  FLAGS
@@ -467,16 +732,19 @@ FLAGS
467
732
  -n, --non-interactive Disable prompts. Required when scripting or running as
468
733
  an agent.
469
734
  -s, --server=<value> Override the resolved server URL.
735
+ -v, --verbose Verbose logging.
736
+ --[no-]color Colorize human output. Disable with --no-color;
737
+ NO_COLOR and FORCE_COLOR are honored too.
470
738
  --debug Debug logging.
471
739
  --dry-run Preview without mutating files or the platform.
472
740
  --fix Repair missing files and stale managed wiring.
473
741
  --image=<value> Container image to check.
474
- --port=<value> [default: 8080] Local HTTP port.
742
+ --port=<value> Local HTTP port to check. Defaults to the port this
743
+ directory's server uses.
475
744
  --runtime=<option> Local runtime backend.
476
745
  <options: binary|docker>
477
746
  --[no-]telemetry Send anonymous usage analytics. Disable with
478
747
  --no-telemetry.
479
- --verbose Verbose logging.
480
748
 
481
749
  GLOBAL FLAGS
482
750
  --json Format output as json.
@@ -492,7 +760,7 @@ Remove managed files and local Zitadel state.
492
760
  ```
493
761
  USAGE
494
762
  $ zitadel eject [--json] [-c <value>] [-s <value>] [-n]
495
- [--dry-run] [--verbose] [--debug] [--telemetry] [-f]
763
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-f]
496
764
 
497
765
  FLAGS
498
766
  -c, --cwd=<value> Project directory to operate on.
@@ -501,11 +769,13 @@ FLAGS
501
769
  -n, --non-interactive Disable prompts. Required when scripting or running as
502
770
  an agent.
503
771
  -s, --server=<value> Override the resolved server URL.
772
+ -v, --verbose Verbose logging.
773
+ --[no-]color Colorize human output. Disable with --no-color;
774
+ NO_COLOR and FORCE_COLOR are honored too.
504
775
  --debug Debug logging.
505
776
  --dry-run Preview without mutating files or the platform.
506
777
  --[no-]telemetry Send anonymous usage analytics. Disable with
507
778
  --no-telemetry.
508
- --verbose Verbose logging.
509
779
 
510
780
  GLOBAL FLAGS
511
781
  --json Format output as json.
@@ -517,84 +787,6 @@ ALIASES
517
787
  $ zitadel uninstall
518
788
  ```
519
789
 
520
- ## `zitadel environments get NAME`
521
-
522
- Get one environment by id.
523
-
524
- ```
525
- USAGE
526
- $ zitadel environments get NAME [--json] [-c <value>] [-s <value>] [-n]
527
- [--dry-run] [--verbose] [--debug] [--telemetry] [--fields <value>]
528
-
529
- ARGUMENTS
530
- NAME environment name
531
-
532
- FLAGS
533
- -c, --cwd=<value> Project directory to operate on.
534
- -n, --non-interactive Disable prompts. Required when scripting or running as
535
- an agent.
536
- -s, --server=<value> Override the resolved server URL.
537
- --debug Debug logging.
538
- --dry-run Preview without mutating files or the platform.
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.
543
- --verbose Verbose logging.
544
-
545
- GLOBAL FLAGS
546
- --json Format output as json.
547
-
548
- DESCRIPTION
549
- Get one environment by id.
550
-
551
- EXAMPLES
552
- $ zitadel environments get <id>
553
-
554
- $ zitadel environments get <id> --json
555
- ```
556
-
557
- ## `zitadel environments list`
558
-
559
- List environments.
560
-
561
- ```
562
- USAGE
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]
566
-
567
- FLAGS
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.
585
-
586
- GLOBAL FLAGS
587
- --json Format output as json.
588
-
589
- DESCRIPTION
590
- List environments.
591
-
592
- EXAMPLES
593
- $ zitadel environments list --json
594
-
595
- $ zitadel environments list --all --json
596
- ```
597
-
598
790
  ## `zitadel events get ID`
599
791
 
600
792
  Get one event by id.
@@ -602,7 +794,7 @@ Get one event by id.
602
794
  ```
603
795
  USAGE
604
796
  $ zitadel events get ID [--json] [-c <value>] [-s <value>] [-n]
605
- [--dry-run] [--verbose] [--debug] [--telemetry] [--fields <value>]
797
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
606
798
 
607
799
  ARGUMENTS
608
800
  ID event id
@@ -612,13 +804,15 @@ FLAGS
612
804
  -n, --non-interactive Disable prompts. Required when scripting or running as
613
805
  an agent.
614
806
  -s, --server=<value> Override the resolved server URL.
807
+ -v, --verbose Verbose logging.
808
+ --[no-]color Colorize human output. Disable with --no-color;
809
+ NO_COLOR and FORCE_COLOR are honored too.
615
810
  --debug Debug logging.
616
811
  --dry-run Preview without mutating files or the platform.
617
812
  --fields=<value> Fields to show, comma-separated dot-paths. Defaults to
618
813
  the resource's own; `--json` is unaffected.
619
814
  --[no-]telemetry Send anonymous usage analytics. Disable with
620
815
  --no-telemetry.
621
- --verbose Verbose logging.
622
816
 
623
817
  GLOBAL FLAGS
624
818
  --json Format output as json.
@@ -639,7 +833,7 @@ List events.
639
833
  ```
640
834
  USAGE
641
835
  $ zitadel events list [--json] [-c <value>] [-s <value>] [-n]
642
- [--dry-run] [--verbose] [--debug] [--telemetry] [--limit <value>] [-a |
836
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
643
837
  --page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
644
838
  [--sort <value>]
645
839
 
@@ -656,6 +850,13 @@ FLAGS
656
850
  -s, --server=<value>
657
851
  Override the resolved server URL.
658
852
 
853
+ -v, --verbose
854
+ Verbose logging.
855
+
856
+ --[no-]color
857
+ Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are
858
+ honored too.
859
+
659
860
  --debug
660
861
  Debug logging.
661
862
 
@@ -690,9 +891,6 @@ FLAGS
690
891
  --[no-]telemetry
691
892
  Send anonymous usage analytics. Disable with --no-telemetry.
692
893
 
693
- --verbose
694
- Verbose logging.
695
-
696
894
  GLOBAL FLAGS
697
895
  --json Format output as json.
698
896
 
@@ -714,7 +912,7 @@ Get one flow definition by id.
714
912
  ```
715
913
  USAGE
716
914
  $ zitadel flow-definitions get FLOW [--json] [-c <value>] [-s <value>] [-n]
717
- [--dry-run] [--verbose] [--debug] [--telemetry] [--fields <value>]
915
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
718
916
 
719
917
  ARGUMENTS
720
918
  FLOW flow name (newest revision) or revision id
@@ -724,13 +922,15 @@ FLAGS
724
922
  -n, --non-interactive Disable prompts. Required when scripting or running as
725
923
  an agent.
726
924
  -s, --server=<value> Override the resolved server URL.
925
+ -v, --verbose Verbose logging.
926
+ --[no-]color Colorize human output. Disable with --no-color;
927
+ NO_COLOR and FORCE_COLOR are honored too.
727
928
  --debug Debug logging.
728
929
  --dry-run Preview without mutating files or the platform.
729
930
  --fields=<value> Fields to show, comma-separated dot-paths. Defaults to
730
931
  the resource's own; `--json` is unaffected.
731
932
  --[no-]telemetry Send anonymous usage analytics. Disable with
732
933
  --no-telemetry.
733
- --verbose Verbose logging.
734
934
 
735
935
  GLOBAL FLAGS
736
936
  --json Format output as json.
@@ -751,7 +951,7 @@ List flow-definitions.
751
951
  ```
752
952
  USAGE
753
953
  $ zitadel flow-definitions list [--json] [-c <value>] [-s <value>] [-n]
754
- [--dry-run] [--verbose] [--debug] [--telemetry] [--limit <value>] [-a |
954
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
755
955
  --page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
756
956
 
757
957
  FLAGS
@@ -760,6 +960,9 @@ FLAGS
760
960
  -n, --non-interactive Disable prompts. Required when scripting or running
761
961
  as an agent.
762
962
  -s, --server=<value> Override the resolved server URL.
963
+ -v, --verbose Verbose logging.
964
+ --[no-]color Colorize human output. Disable with --no-color;
965
+ NO_COLOR and FORCE_COLOR are honored too.
763
966
  --debug Debug logging.
764
967
  --dry-run Preview without mutating files or the platform.
765
968
  --fields=<value> Columns to show, comma-separated dot-paths (e.g.
@@ -774,7 +977,6 @@ FLAGS
774
977
  Implied when stdout is not a terminal.
775
978
  --[no-]telemetry Send anonymous usage analytics. Disable with
776
979
  --no-telemetry.
777
- --verbose Verbose logging.
778
980
 
779
981
  GLOBAL FLAGS
780
982
  --json Format output as json.
@@ -797,24 +999,33 @@ Create a grant.
797
999
  ```
798
1000
  USAGE
799
1001
  $ 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>]
1002
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--relation
1003
+ viewer|editor|admin] [--expires-at <value>] [--user-user-id <value>]
1004
+ [--user-identifier <value>] [--team-team-id <value>] [--team-name <value>]
1005
+ [--data <value> | --file <value>] [--set <value>...]
803
1006
 
804
1007
  FLAGS
805
1008
  -c, --cwd=<value> Project directory to operate on.
806
1009
  -n, --non-interactive Disable prompts. Required when scripting or running as
807
1010
  an agent.
808
1011
  -s, --server=<value> Override the resolved server URL.
1012
+ -v, --verbose Verbose logging.
1013
+ --[no-]color Colorize human output. Disable with --no-color;
1014
+ NO_COLOR and FORCE_COLOR are honored too.
809
1015
  --debug Debug logging.
810
1016
  --dry-run Preview without mutating files or the platform.
811
1017
  --[no-]telemetry Send anonymous usage analytics. Disable with
812
1018
  --no-telemetry.
813
- --verbose Verbose logging.
814
1019
 
815
1020
  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.
1021
+ --data=<value> Whole body as a JSON object. Field flags and --set apply
1022
+ over it.
1023
+ --file=<value> Read the body from a JSON file; `-` reads stdin. Field flags
1024
+ and --set apply over it.
1025
+ --set=<value>... Set one field by its dot path: path=value, or path:=json for
1026
+ JSON. Repeatable; applied after the field flags, in order. A
1027
+ key that contains a dot is set through its parent: --set
1028
+ 'parent:={"a.b":"x"}'.
818
1029
 
819
1030
  OPTIONAL FIELD FLAGS
820
1031
  --expires-at=<value> Optional expiry.
@@ -826,10 +1037,22 @@ REQUIRED FIELD FLAGS
826
1037
  --relation=<option> (required) Catalog relation on `object_type` `project`.
827
1038
  <options: viewer|editor|admin>
828
1039
 
1040
+ TEAM FIELD FLAGS
1041
+ --team-name=<value> Team name, unique per project case-insensitively.
1042
+ --team-team-id=<value>
1043
+
1044
+ USER FIELD FLAGS
1045
+ --user-identifier=<value> The user schema's designated identifier
1046
+ (`x-identifier`), looked up in the platform
1047
+ project.
1048
+ --user-user-id=<value>
1049
+
829
1050
  DESCRIPTION
830
1051
  Create a grant.
831
1052
 
832
1053
  EXAMPLES
1054
+ $ zitadel grants create --relation viewer --user-identifier alice@acme.com --json
1055
+
833
1056
  $ zitadel grants create --data '{...}' --json
834
1057
 
835
1058
  $ zitadel grants create --file ./grant.json
@@ -842,7 +1065,7 @@ Delete a grant by id.
842
1065
  ```
843
1066
  USAGE
844
1067
  $ zitadel grants delete ID [--json] [-c <value>] [-s <value>] [-n]
845
- [--dry-run] [--verbose] [--debug] [--telemetry] [-f]
1068
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-f]
846
1069
 
847
1070
  ARGUMENTS
848
1071
  ID grant id
@@ -854,11 +1077,13 @@ FLAGS
854
1077
  -n, --non-interactive Disable prompts. Required when scripting or running as
855
1078
  an agent.
856
1079
  -s, --server=<value> Override the resolved server URL.
1080
+ -v, --verbose Verbose logging.
1081
+ --[no-]color Colorize human output. Disable with --no-color;
1082
+ NO_COLOR and FORCE_COLOR are honored too.
857
1083
  --debug Debug logging.
858
1084
  --dry-run Preview without mutating files or the platform.
859
1085
  --[no-]telemetry Send anonymous usage analytics. Disable with
860
1086
  --no-telemetry.
861
- --verbose Verbose logging.
862
1087
 
863
1088
  GLOBAL FLAGS
864
1089
  --json Format output as json.
@@ -877,7 +1102,7 @@ Get one grant by id.
877
1102
  ```
878
1103
  USAGE
879
1104
  $ zitadel grants get ID [--json] [-c <value>] [-s <value>] [-n]
880
- [--dry-run] [--verbose] [--debug] [--telemetry] [--fields <value>]
1105
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
881
1106
 
882
1107
  ARGUMENTS
883
1108
  ID grant id
@@ -887,13 +1112,15 @@ FLAGS
887
1112
  -n, --non-interactive Disable prompts. Required when scripting or running as
888
1113
  an agent.
889
1114
  -s, --server=<value> Override the resolved server URL.
1115
+ -v, --verbose Verbose logging.
1116
+ --[no-]color Colorize human output. Disable with --no-color;
1117
+ NO_COLOR and FORCE_COLOR are honored too.
890
1118
  --debug Debug logging.
891
1119
  --dry-run Preview without mutating files or the platform.
892
1120
  --fields=<value> Fields to show, comma-separated dot-paths. Defaults to
893
1121
  the resource's own; `--json` is unaffected.
894
1122
  --[no-]telemetry Send anonymous usage analytics. Disable with
895
1123
  --no-telemetry.
896
- --verbose Verbose logging.
897
1124
 
898
1125
  GLOBAL FLAGS
899
1126
  --json Format output as json.
@@ -914,7 +1141,7 @@ List grants.
914
1141
  ```
915
1142
  USAGE
916
1143
  $ zitadel grants list [--json] [-c <value>] [-s <value>] [-n]
917
- [--dry-run] [--verbose] [--debug] [--telemetry] [--limit <value>] [-a |
1144
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
918
1145
  --page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
919
1146
  [--sort <value>]
920
1147
 
@@ -931,6 +1158,13 @@ FLAGS
931
1158
  -s, --server=<value>
932
1159
  Override the resolved server URL.
933
1160
 
1161
+ -v, --verbose
1162
+ Verbose logging.
1163
+
1164
+ --[no-]color
1165
+ Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are
1166
+ honored too.
1167
+
934
1168
  --debug
935
1169
  Debug logging.
936
1170
 
@@ -969,9 +1203,6 @@ FLAGS
969
1203
  --[no-]telemetry
970
1204
  Send anonymous usage analytics. Disable with --no-telemetry.
971
1205
 
972
- --verbose
973
- Verbose logging.
974
-
975
1206
  GLOBAL FLAGS
976
1207
  --json Format output as json.
977
1208
 
@@ -1013,34 +1244,122 @@ Create an identity provider connection.
1013
1244
  ```
1014
1245
  USAGE
1015
1246
  $ zitadel idps create [--json] [-c <value>] [-s <value>] [-n]
1016
- [--dry-run] [--verbose] [--debug] [--telemetry] [--data <value> | --file
1017
- <value>]
1247
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--slug <value>]
1248
+ [--protocol oidc] [--template <value>] [--display-name <value>]
1249
+ [--subject-claim <value>] [--claim-mapping <value>...] [--verified-claims
1250
+ <value>...] [--provisioning-creation disabled|auto] [--oidc-issuer <value>]
1251
+ [--oidc-jwks-uri <value>] [--oidc-id-token-mapping]
1252
+ [--oidc-authorization-endpoint <value>] [--oidc-token-endpoint <value>]
1253
+ [--oidc-userinfo-endpoint <value>] [--oidc-client-id <value>]
1254
+ [--oidc-client-secret <value>] [--oidc-token-endpoint-auth-method
1255
+ client_secret_basic|client_secret_post] [--oidc-scopes <value>...]
1256
+ [--oidc-pkce-enabled] [--oidc-static-authorize-parameters <value>...]
1257
+ [--data <value> | --file <value>] [--set <value>...]
1018
1258
 
1019
1259
  FLAGS
1020
1260
  -c, --cwd=<value> Project directory to operate on.
1021
1261
  -n, --non-interactive Disable prompts. Required when scripting or running as
1022
1262
  an agent.
1023
1263
  -s, --server=<value> Override the resolved server URL.
1264
+ -v, --verbose Verbose logging.
1265
+ --[no-]color Colorize human output. Disable with --no-color;
1266
+ NO_COLOR and FORCE_COLOR are honored too.
1024
1267
  --debug Debug logging.
1025
1268
  --dry-run Preview without mutating files or the platform.
1026
1269
  --[no-]telemetry Send anonymous usage analytics. Disable with
1027
1270
  --no-telemetry.
1028
- --verbose Verbose logging.
1271
+
1272
+ OPTIONAL FIELD FLAGS
1273
+ --claim-mapping=<value>... Repeatable claim_mapping entry: key=value for a
1274
+ string, key:=value for JSON. Maps user-schema
1275
+ property names (keys) to provider claim names
1276
+ (values).
1277
+ --subject-claim=<value> Claim carrying the provider's stable subject
1278
+ identifier.
1279
+ --template=<value> Template hint for rendering the provider (logo,
1280
+ colors).
1281
+ --verified-claims=<value>... Repeatable verified_claims entry: key=value for
1282
+ a string, key:=value for JSON. Maps a verifiable
1283
+ user-schema property to its verification source:
1284
+ a claim name (read the claim) or the…
1029
1285
 
1030
1286
  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.
1287
+ --data=<value> Whole body as a JSON object. Field flags and --set apply
1288
+ over it.
1289
+ --file=<value> Read the body from a JSON file; `-` reads stdin. Field flags
1290
+ and --set apply over it.
1291
+ --set=<value>... Set one field by its dot path: path=value, or path:=json for
1292
+ JSON. Repeatable; applied after the field flags, in order. A
1293
+ key that contains a dot is set through its parent: --set
1294
+ 'parent:={"a.b":"x"}'.
1295
+
1296
+ REQUIRED FIELD FLAGS
1297
+ --display-name=<value> (required) Shown to the user on the sign-in button.
1298
+ --protocol=<option> (required) The protocol used by the identity provider.
1299
+ <options: oidc>
1300
+ --slug=<value> (required) Stable identifier, referenced by user
1301
+ schemas (x-auth-methods.sso.providers) and flow steps
1302
+ (sso_providers).
1033
1303
 
1034
1304
  GLOBAL FLAGS
1035
1305
  --json Format output as json.
1036
1306
 
1307
+ OIDC FIELD FLAGS
1308
+ --oidc-authorization-endpoint=<value>
1309
+ For a provider that exposes no .well-known document.
1310
+
1311
+ --oidc-client-id=<value>
1312
+ (required with oidc.*) Either a literal in case the same client is used in
1313
+ all environments, or a `${{ NAME }}` reference to a…
1314
+
1315
+ --oidc-client-secret=<value>
1316
+ (required with oidc.*) A reference to the variable holding the client
1317
+ secret, never the secret itself.
1318
+
1319
+ --[no-]oidc-id-token-mapping
1320
+ Read user claims from the id_token instead of the userinfo endpoint, for
1321
+ providers that populate only the…
1322
+
1323
+ --oidc-issuer=<value>
1324
+ (required with oidc.*) Discovery base.
1325
+
1326
+ --oidc-jwks-uri=<value>
1327
+ JWKS endpoint, for a provider that exposes no .well-known document.
1328
+
1329
+ --[no-]oidc-pkce-enabled
1330
+ Send PKCE (code_challenge/code_verifier).
1331
+
1332
+ --oidc-scopes=<value>...
1333
+ Repeatable, one value each. Must contain `openid` - without it the provider
1334
+ returns no id_token and the connection is not OIDC.
1335
+
1336
+ --oidc-static-authorize-parameters=<value>...
1337
+ Repeatable oidc.static_authorize_parameters entry: key=value for a string,
1338
+ key:=value for JSON. Extra provider-specific authorize parameters (for
1339
+ example `prompt`).
1340
+
1341
+ --oidc-token-endpoint=<value>
1342
+ For a provider that exposes no .well-known document.
1343
+
1344
+ --oidc-token-endpoint-auth-method=<option>
1345
+ How the client authenticates at the token endpoint.
1346
+ <options: client_secret_basic|client_secret_post>
1347
+
1348
+ --oidc-userinfo-endpoint=<value>
1349
+ For a provider that exposes no .well-known document.
1350
+
1351
+ PROVISIONING FIELD FLAGS
1352
+ --provisioning-creation=<option> <options: disabled|auto>
1353
+
1037
1354
  DESCRIPTION
1038
1355
  Create an identity provider connection.
1039
1356
 
1040
1357
  EXAMPLES
1358
+ $ zitadel idps create --slug acme-sso --protocol oidc --display-name 'Acme SSO' --oidc-issuer https://sso.acme.example --oidc-client-id <client_id> --oidc-client-secret '${{ ACME_SSO_CLIENT_SECRET }}' --oidc-scopes openid --oidc-scopes profile --oidc-scopes email --json
1359
+
1041
1360
  $ zitadel idps create --data '{...}' --json
1042
1361
 
1043
- $ zitadel idps create --file ./identity provider connection.json
1362
+ $ zitadel idps create --file ./identity-provider-connection.json
1044
1363
  ```
1045
1364
 
1046
1365
  ## `zitadel idps get ID`
@@ -1050,7 +1369,7 @@ Get one identity provider connection by id.
1050
1369
  ```
1051
1370
  USAGE
1052
1371
  $ zitadel idps get ID [--json] [-c <value>] [-s <value>] [-n]
1053
- [--dry-run] [--verbose] [--debug] [--telemetry] [--fields <value>]
1372
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
1054
1373
 
1055
1374
  ARGUMENTS
1056
1375
  ID identity provider connection id
@@ -1060,13 +1379,15 @@ FLAGS
1060
1379
  -n, --non-interactive Disable prompts. Required when scripting or running as
1061
1380
  an agent.
1062
1381
  -s, --server=<value> Override the resolved server URL.
1382
+ -v, --verbose Verbose logging.
1383
+ --[no-]color Colorize human output. Disable with --no-color;
1384
+ NO_COLOR and FORCE_COLOR are honored too.
1063
1385
  --debug Debug logging.
1064
1386
  --dry-run Preview without mutating files or the platform.
1065
1387
  --fields=<value> Fields to show, comma-separated dot-paths. Defaults to
1066
1388
  the resource's own; `--json` is unaffected.
1067
1389
  --[no-]telemetry Send anonymous usage analytics. Disable with
1068
1390
  --no-telemetry.
1069
- --verbose Verbose logging.
1070
1391
 
1071
1392
  GLOBAL FLAGS
1072
1393
  --json Format output as json.
@@ -1087,7 +1408,7 @@ List idps.
1087
1408
  ```
1088
1409
  USAGE
1089
1410
  $ zitadel idps list [--json] [-c <value>] [-s <value>] [-n]
1090
- [--dry-run] [--verbose] [--debug] [--telemetry] [--limit <value>] [-a |
1411
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
1091
1412
  --page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
1092
1413
  [--sort <value>]
1093
1414
 
@@ -1104,6 +1425,13 @@ FLAGS
1104
1425
  -s, --server=<value>
1105
1426
  Override the resolved server URL.
1106
1427
 
1428
+ -v, --verbose
1429
+ Verbose logging.
1430
+
1431
+ --[no-]color
1432
+ Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are
1433
+ honored too.
1434
+
1107
1435
  --debug
1108
1436
  Debug logging.
1109
1437
 
@@ -1136,9 +1464,6 @@ FLAGS
1136
1464
  --[no-]telemetry
1137
1465
  Send anonymous usage analytics. Disable with --no-telemetry.
1138
1466
 
1139
- --verbose
1140
- Verbose logging.
1141
-
1142
1467
  GLOBAL FLAGS
1143
1468
  --json Format output as json.
1144
1469
 
@@ -1160,20 +1485,23 @@ Show local Zitadel server logs.
1160
1485
  ```
1161
1486
  USAGE
1162
1487
  $ zitadel logs [--json] [-c <value>] [-s <value>] [-n]
1163
- [--dry-run] [--verbose] [--debug] [--telemetry] [--follow] [--tail <value>]
1488
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--follow] [--tail
1489
+ <value>]
1164
1490
 
1165
1491
  FLAGS
1166
1492
  -c, --cwd=<value> Project directory to operate on.
1167
1493
  -n, --non-interactive Disable prompts. Required when scripting or running as
1168
1494
  an agent.
1169
1495
  -s, --server=<value> Override the resolved server URL.
1496
+ -v, --verbose Verbose logging.
1497
+ --[no-]color Colorize human output. Disable with --no-color;
1498
+ NO_COLOR and FORCE_COLOR are honored too.
1170
1499
  --debug Debug logging.
1171
1500
  --dry-run Preview without mutating files or the platform.
1172
1501
  --follow Follow logs.
1173
1502
  --tail=<value> [default: 200] Number of lines to show.
1174
1503
  --[no-]telemetry Send anonymous usage analytics. Disable with
1175
1504
  --no-telemetry.
1176
- --verbose Verbose logging.
1177
1505
 
1178
1506
  GLOBAL FLAGS
1179
1507
  --json Format output as json.
@@ -1189,18 +1517,20 @@ Validate config without mutation and preview the sync diff.
1189
1517
  ```
1190
1518
  USAGE
1191
1519
  $ zitadel plan [--json] [-c <value>] [-s <value>] [-n]
1192
- [--dry-run] [--verbose] [--debug] [--telemetry]
1520
+ [--dry-run] [-v] [--debug] [--color] [--telemetry]
1193
1521
 
1194
1522
  FLAGS
1195
1523
  -c, --cwd=<value> Project directory to operate on.
1196
1524
  -n, --non-interactive Disable prompts. Required when scripting or running as
1197
1525
  an agent.
1198
1526
  -s, --server=<value> Override the resolved server URL.
1527
+ -v, --verbose Verbose logging.
1528
+ --[no-]color Colorize human output. Disable with --no-color;
1529
+ NO_COLOR and FORCE_COLOR are honored too.
1199
1530
  --debug Debug logging.
1200
1531
  --dry-run Preview without mutating files or the platform.
1201
1532
  --[no-]telemetry Send anonymous usage analytics. Disable with
1202
1533
  --no-telemetry.
1203
- --verbose Verbose logging.
1204
1534
 
1205
1535
  GLOBAL FLAGS
1206
1536
  --json Format output as json.
@@ -1216,7 +1546,7 @@ Get one project by id.
1216
1546
  ```
1217
1547
  USAGE
1218
1548
  $ zitadel projects get ID [--json] [-c <value>] [-s <value>] [-n]
1219
- [--dry-run] [--verbose] [--debug] [--telemetry] [--fields <value>]
1549
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
1220
1550
 
1221
1551
  ARGUMENTS
1222
1552
  ID project id
@@ -1226,13 +1556,15 @@ FLAGS
1226
1556
  -n, --non-interactive Disable prompts. Required when scripting or running as
1227
1557
  an agent.
1228
1558
  -s, --server=<value> Override the resolved server URL.
1559
+ -v, --verbose Verbose logging.
1560
+ --[no-]color Colorize human output. Disable with --no-color;
1561
+ NO_COLOR and FORCE_COLOR are honored too.
1229
1562
  --debug Debug logging.
1230
1563
  --dry-run Preview without mutating files or the platform.
1231
1564
  --fields=<value> Fields to show, comma-separated dot-paths. Defaults to
1232
1565
  the resource's own; `--json` is unaffected.
1233
1566
  --[no-]telemetry Send anonymous usage analytics. Disable with
1234
1567
  --no-telemetry.
1235
- --verbose Verbose logging.
1236
1568
 
1237
1569
  GLOBAL FLAGS
1238
1570
  --json Format output as json.
@@ -1253,7 +1585,7 @@ List projects.
1253
1585
  ```
1254
1586
  USAGE
1255
1587
  $ zitadel projects list [--json] [-c <value>] [-s <value>] [-n]
1256
- [--dry-run] [--verbose] [--debug] [--telemetry] [--limit <value>] [-a |
1588
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
1257
1589
  --page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
1258
1590
  [--sort <value>]
1259
1591
 
@@ -1263,6 +1595,9 @@ FLAGS
1263
1595
  -n, --non-interactive Disable prompts. Required when scripting or running
1264
1596
  as an agent.
1265
1597
  -s, --server=<value> Override the resolved server URL.
1598
+ -v, --verbose Verbose logging.
1599
+ --[no-]color Colorize human output. Disable with --no-color;
1600
+ NO_COLOR and FORCE_COLOR are honored too.
1266
1601
  --debug Debug logging.
1267
1602
  --dry-run Preview without mutating files or the platform.
1268
1603
  --fields=<value> Columns to show, comma-separated dot-paths (e.g.
@@ -1280,7 +1615,6 @@ FLAGS
1280
1615
  created_at.
1281
1616
  --[no-]telemetry Send anonymous usage analytics. Disable with
1282
1617
  --no-telemetry.
1283
- --verbose Verbose logging.
1284
1618
 
1285
1619
  GLOBAL FLAGS
1286
1620
  --json Format output as json.
@@ -1303,8 +1637,13 @@ Update a project by id.
1303
1637
  ```
1304
1638
  USAGE
1305
1639
  $ zitadel projects update ID [--json] [-c <value>] [-s <value>] [-n]
1306
- [--dry-run] [--verbose] [--debug] [--telemetry] [--name <value>] [--data
1307
- <value> | --file <value>]
1640
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--name <value>]
1641
+ [--password-hash-algorithm argon2i|argon2id|bcrypt|scrypt|pbkdf2|sha2]
1642
+ [--password-hash-params-time <value>] [--password-hash-params-memory
1643
+ <value>] [--password-hash-params-threads <value>]
1644
+ [--password-hash-params-cost <value>] [--password-hash-params-rounds
1645
+ <value>] [--password-hash-params-hash sha1|sha224|sha256|sha384|sha512]
1646
+ [--data <value> | --file <value>] [--set <value>...]
1308
1647
 
1309
1648
  ARGUMENTS
1310
1649
  ID project id
@@ -1314,15 +1653,23 @@ FLAGS
1314
1653
  -n, --non-interactive Disable prompts. Required when scripting or running as
1315
1654
  an agent.
1316
1655
  -s, --server=<value> Override the resolved server URL.
1656
+ -v, --verbose Verbose logging.
1657
+ --[no-]color Colorize human output. Disable with --no-color;
1658
+ NO_COLOR and FORCE_COLOR are honored too.
1317
1659
  --debug Debug logging.
1318
1660
  --dry-run Preview without mutating files or the platform.
1319
1661
  --[no-]telemetry Send anonymous usage analytics. Disable with
1320
1662
  --no-telemetry.
1321
- --verbose Verbose logging.
1322
1663
 
1323
1664
  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.
1665
+ --data=<value> Whole body as a JSON object. Field flags and --set apply
1666
+ over it.
1667
+ --file=<value> Read the body from a JSON file; `-` reads stdin. Field flags
1668
+ and --set apply over it.
1669
+ --set=<value>... Set one field by its dot path: path=value, or path:=json for
1670
+ JSON. Repeatable; applied after the field flags, in order. A
1671
+ key that contains a dot is set through its parent: --set
1672
+ 'parent:={"a.b":"x"}'.
1326
1673
 
1327
1674
  GLOBAL FLAGS
1328
1675
  --json Format output as json.
@@ -1330,6 +1677,21 @@ GLOBAL FLAGS
1330
1677
  OPTIONAL FIELD FLAGS
1331
1678
  --name=<value> The name of the project.
1332
1679
 
1680
+ PASSWORD HASH FIELD FLAGS
1681
+ --password-hash-algorithm=<option> (required with password_hash.*) The
1682
+ hashing algorithm.
1683
+ <options: argon2i|argon2id|bcrypt|scry
1684
+ pt|pbkdf2|sha2>
1685
+ --password-hash-params-cost=<value> bcrypt cost, or scrypt's log2 of the
1686
+ CPU/memory cost.
1687
+ --password-hash-params-hash=<option> The underlying hash.
1688
+ <options:
1689
+ sha1|sha224|sha256|sha384|sha512>
1690
+ --password-hash-params-memory=<value> argon2 memory in KiB.
1691
+ --password-hash-params-rounds=<value> pbkdf2 or sha2 iteration count.
1692
+ --password-hash-params-threads=<value> argon2 lanes.
1693
+ --password-hash-params-time=<value> argon2 passes over memory.
1694
+
1333
1695
  DESCRIPTION
1334
1696
  Update a project by id.
1335
1697
 
@@ -1346,7 +1708,7 @@ Get one release by id.
1346
1708
  ```
1347
1709
  USAGE
1348
1710
  $ zitadel releases get ID [--json] [-c <value>] [-s <value>] [-n]
1349
- [--dry-run] [--verbose] [--debug] [--telemetry] [--fields <value>]
1711
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
1350
1712
 
1351
1713
  ARGUMENTS
1352
1714
  ID release id
@@ -1356,13 +1718,15 @@ FLAGS
1356
1718
  -n, --non-interactive Disable prompts. Required when scripting or running as
1357
1719
  an agent.
1358
1720
  -s, --server=<value> Override the resolved server URL.
1721
+ -v, --verbose Verbose logging.
1722
+ --[no-]color Colorize human output. Disable with --no-color;
1723
+ NO_COLOR and FORCE_COLOR are honored too.
1359
1724
  --debug Debug logging.
1360
1725
  --dry-run Preview without mutating files or the platform.
1361
1726
  --fields=<value> Fields to show, comma-separated dot-paths. Defaults to
1362
1727
  the resource's own; `--json` is unaffected.
1363
1728
  --[no-]telemetry Send anonymous usage analytics. Disable with
1364
1729
  --no-telemetry.
1365
- --verbose Verbose logging.
1366
1730
 
1367
1731
  GLOBAL FLAGS
1368
1732
  --json Format output as json.
@@ -1383,7 +1747,7 @@ List releases.
1383
1747
  ```
1384
1748
  USAGE
1385
1749
  $ zitadel releases list [--json] [-c <value>] [-s <value>] [-n]
1386
- [--dry-run] [--verbose] [--debug] [--telemetry] [--limit <value>] [-a |
1750
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
1387
1751
  --page-token <value>] [--fields <value>] [--plain]
1388
1752
 
1389
1753
  FLAGS
@@ -1392,6 +1756,9 @@ FLAGS
1392
1756
  -n, --non-interactive Disable prompts. Required when scripting or running
1393
1757
  as an agent.
1394
1758
  -s, --server=<value> Override the resolved server URL.
1759
+ -v, --verbose Verbose logging.
1760
+ --[no-]color Colorize human output. Disable with --no-color;
1761
+ NO_COLOR and FORCE_COLOR are honored too.
1395
1762
  --debug Debug logging.
1396
1763
  --dry-run Preview without mutating files or the platform.
1397
1764
  --fields=<value> Columns to show, comma-separated dot-paths (e.g.
@@ -1403,7 +1770,6 @@ FLAGS
1403
1770
  Implied when stdout is not a terminal.
1404
1771
  --[no-]telemetry Send anonymous usage analytics. Disable with
1405
1772
  --no-telemetry.
1406
- --verbose Verbose logging.
1407
1773
 
1408
1774
  GLOBAL FLAGS
1409
1775
  --json Format output as json.
@@ -1424,7 +1790,7 @@ Delete the local Zitadel server runtime and data.
1424
1790
  ```
1425
1791
  USAGE
1426
1792
  $ zitadel reset [--json] [-c <value>] [-s <value>] [-n]
1427
- [--dry-run] [--verbose] [--debug] [--telemetry] [-f]
1793
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-f]
1428
1794
 
1429
1795
  FLAGS
1430
1796
  -c, --cwd=<value> Project directory to operate on.
@@ -1433,11 +1799,13 @@ FLAGS
1433
1799
  -n, --non-interactive Disable prompts. Required when scripting or running as
1434
1800
  an agent.
1435
1801
  -s, --server=<value> Override the resolved server URL.
1802
+ -v, --verbose Verbose logging.
1803
+ --[no-]color Colorize human output. Disable with --no-color;
1804
+ NO_COLOR and FORCE_COLOR are honored too.
1436
1805
  --debug Debug logging.
1437
1806
  --dry-run Preview without mutating files or the platform.
1438
1807
  --[no-]telemetry Send anonymous usage analytics. Disable with
1439
1808
  --no-telemetry.
1440
- --verbose Verbose logging.
1441
1809
 
1442
1810
  GLOBAL FLAGS
1443
1811
  --json Format output as json.
@@ -1453,18 +1821,20 @@ List the resources this CLI manages and what can be done to each.
1453
1821
  ```
1454
1822
  USAGE
1455
1823
  $ zitadel resources [--json] [-c <value>] [-s <value>] [-n]
1456
- [--dry-run] [--verbose] [--debug] [--telemetry]
1824
+ [--dry-run] [-v] [--debug] [--color] [--telemetry]
1457
1825
 
1458
1826
  FLAGS
1459
1827
  -c, --cwd=<value> Project directory to operate on.
1460
1828
  -n, --non-interactive Disable prompts. Required when scripting or running as
1461
1829
  an agent.
1462
1830
  -s, --server=<value> Override the resolved server URL.
1831
+ -v, --verbose Verbose logging.
1832
+ --[no-]color Colorize human output. Disable with --no-color;
1833
+ NO_COLOR and FORCE_COLOR are honored too.
1463
1834
  --debug Debug logging.
1464
1835
  --dry-run Preview without mutating files or the platform.
1465
1836
  --[no-]telemetry Send anonymous usage analytics. Disable with
1466
1837
  --no-telemetry.
1467
- --verbose Verbose logging.
1468
1838
 
1469
1839
  GLOBAL FLAGS
1470
1840
  --json Format output as json.
@@ -1487,7 +1857,7 @@ Get one schema by id.
1487
1857
  ```
1488
1858
  USAGE
1489
1859
  $ zitadel schemas get SCHEMA [--json] [-c <value>] [-s <value>] [-n]
1490
- [--dry-run] [--verbose] [--debug] [--telemetry] [--fields <value>]
1860
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
1491
1861
 
1492
1862
  ARGUMENTS
1493
1863
  SCHEMA object type (current revision) or revision id
@@ -1497,13 +1867,15 @@ FLAGS
1497
1867
  -n, --non-interactive Disable prompts. Required when scripting or running as
1498
1868
  an agent.
1499
1869
  -s, --server=<value> Override the resolved server URL.
1870
+ -v, --verbose Verbose logging.
1871
+ --[no-]color Colorize human output. Disable with --no-color;
1872
+ NO_COLOR and FORCE_COLOR are honored too.
1500
1873
  --debug Debug logging.
1501
1874
  --dry-run Preview without mutating files or the platform.
1502
1875
  --fields=<value> Fields to show, comma-separated dot-paths. Defaults to
1503
1876
  the resource's own; `--json` is unaffected.
1504
1877
  --[no-]telemetry Send anonymous usage analytics. Disable with
1505
1878
  --no-telemetry.
1506
- --verbose Verbose logging.
1507
1879
 
1508
1880
  GLOBAL FLAGS
1509
1881
  --json Format output as json.
@@ -1524,7 +1896,7 @@ List schemas.
1524
1896
  ```
1525
1897
  USAGE
1526
1898
  $ zitadel schemas list [--json] [-c <value>] [-s <value>] [-n]
1527
- [--dry-run] [--verbose] [--debug] [--telemetry] [--limit <value>] [-a |
1899
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
1528
1900
  --page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
1529
1901
 
1530
1902
  FLAGS
@@ -1533,6 +1905,9 @@ FLAGS
1533
1905
  -n, --non-interactive Disable prompts. Required when scripting or running
1534
1906
  as an agent.
1535
1907
  -s, --server=<value> Override the resolved server URL.
1908
+ -v, --verbose Verbose logging.
1909
+ --[no-]color Colorize human output. Disable with --no-color;
1910
+ NO_COLOR and FORCE_COLOR are honored too.
1536
1911
  --debug Debug logging.
1537
1912
  --dry-run Preview without mutating files or the platform.
1538
1913
  --fields=<value> Columns to show, comma-separated dot-paths (e.g.
@@ -1547,7 +1922,6 @@ FLAGS
1547
1922
  Implied when stdout is not a terminal.
1548
1923
  --[no-]telemetry Send anonymous usage analytics. Disable with
1549
1924
  --no-telemetry.
1550
- --verbose Verbose logging.
1551
1925
 
1552
1926
  GLOBAL FLAGS
1553
1927
  --json Format output as json.
@@ -1587,7 +1961,7 @@ Get one session by id.
1587
1961
  ```
1588
1962
  USAGE
1589
1963
  $ zitadel sessions get ID [--json] [-c <value>] [-s <value>] [-n]
1590
- [--dry-run] [--verbose] [--debug] [--telemetry] [--fields <value>]
1964
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
1591
1965
 
1592
1966
  ARGUMENTS
1593
1967
  ID session id
@@ -1597,13 +1971,15 @@ FLAGS
1597
1971
  -n, --non-interactive Disable prompts. Required when scripting or running as
1598
1972
  an agent.
1599
1973
  -s, --server=<value> Override the resolved server URL.
1974
+ -v, --verbose Verbose logging.
1975
+ --[no-]color Colorize human output. Disable with --no-color;
1976
+ NO_COLOR and FORCE_COLOR are honored too.
1600
1977
  --debug Debug logging.
1601
1978
  --dry-run Preview without mutating files or the platform.
1602
1979
  --fields=<value> Fields to show, comma-separated dot-paths. Defaults to
1603
1980
  the resource's own; `--json` is unaffected.
1604
1981
  --[no-]telemetry Send anonymous usage analytics. Disable with
1605
1982
  --no-telemetry.
1606
- --verbose Verbose logging.
1607
1983
 
1608
1984
  GLOBAL FLAGS
1609
1985
  --json Format output as json.
@@ -1624,7 +2000,7 @@ List sessions.
1624
2000
  ```
1625
2001
  USAGE
1626
2002
  $ zitadel sessions list [--json] [-c <value>] [-s <value>] [-n]
1627
- [--dry-run] [--verbose] [--debug] [--telemetry] [--limit <value>] [-a |
2003
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
1628
2004
  --page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
1629
2005
  [--sort <value>]
1630
2006
 
@@ -1641,6 +2017,13 @@ FLAGS
1641
2017
  -s, --server=<value>
1642
2018
  Override the resolved server URL.
1643
2019
 
2020
+ -v, --verbose
2021
+ Verbose logging.
2022
+
2023
+ --[no-]color
2024
+ Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are
2025
+ honored too.
2026
+
1644
2027
  --debug
1645
2028
  Debug logging.
1646
2029
 
@@ -1677,9 +2060,6 @@ FLAGS
1677
2060
  --[no-]telemetry
1678
2061
  Send anonymous usage analytics. Disable with --no-telemetry.
1679
2062
 
1680
- --verbose
1681
- Verbose logging.
1682
-
1683
2063
  GLOBAL FLAGS
1684
2064
  --json Format output as json.
1685
2065
 
@@ -1701,7 +2081,7 @@ Revoke a session by id.
1701
2081
  ```
1702
2082
  USAGE
1703
2083
  $ zitadel sessions revoke ID [--json] [-c <value>] [-s <value>] [-n]
1704
- [--dry-run] [--verbose] [--debug] [--telemetry] [-f]
2084
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-f]
1705
2085
 
1706
2086
  ARGUMENTS
1707
2087
  ID session id
@@ -1713,11 +2093,13 @@ FLAGS
1713
2093
  -n, --non-interactive Disable prompts. Required when scripting or running as
1714
2094
  an agent.
1715
2095
  -s, --server=<value> Override the resolved server URL.
2096
+ -v, --verbose Verbose logging.
2097
+ --[no-]color Colorize human output. Disable with --no-color;
2098
+ NO_COLOR and FORCE_COLOR are honored too.
1716
2099
  --debug Debug logging.
1717
2100
  --dry-run Preview without mutating files or the platform.
1718
2101
  --[no-]telemetry Send anonymous usage analytics. Disable with
1719
2102
  --no-telemetry.
1720
- --verbose Verbose logging.
1721
2103
 
1722
2104
  GLOBAL FLAGS
1723
2105
  --json Format output as json.
@@ -1736,17 +2118,21 @@ Create a Zitadel project and scaffold local auth.
1736
2118
  ```
1737
2119
  USAGE
1738
2120
  $ 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]
2121
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-f] [--framework
2122
+ next|nuxt|tanstack-start|react|vue|solid-start|solid|sveltekit|svelte|qwik-r
2123
+ outer|qwik|angular] [--renderer react] [--dev-port <value>] [--skip-install]
2124
+ [--preset password-first|passkey-first] [--use-case
2125
+ minimal|consumer|business] [--sso google|custom] [--sso-client-id <value>]
2126
+ [--sso-slug <value>] [--sso-display-name <value>] [--sso-issuer <value>]
2127
+ [--sso-scopes <value>]
1743
2128
 
1744
2129
  FLAGS
1745
2130
  -c, --cwd=<value>
1746
2131
  Project directory to operate on.
1747
2132
 
1748
2133
  -f, --force
1749
- Overwrite managed files that already exist.
2134
+ Overwrite managed files that already exist, and scaffold into a non-empty
2135
+ directory.
1750
2136
 
1751
2137
  -n, --non-interactive
1752
2138
  Disable prompts. Required when scripting or running as an agent.
@@ -1754,6 +2140,13 @@ FLAGS
1754
2140
  -s, --server=<value>
1755
2141
  Override the resolved server URL.
1756
2142
 
2143
+ -v, --verbose
2144
+ Verbose logging.
2145
+
2146
+ --[no-]color
2147
+ Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are
2148
+ honored too.
2149
+
1757
2150
  --debug
1758
2151
  Debug logging.
1759
2152
 
@@ -1767,7 +2160,8 @@ FLAGS
1767
2160
 
1768
2161
  --framework=<option>
1769
2162
  Framework to target.
1770
- <options: next|nuxt|react|vue|solid|svelte|qwik|angular>
2163
+ <options: next|nuxt|tanstack-start|react|vue|solid-start|solid|sveltekit|sve
2164
+ lte|qwik-router|qwik|angular>
1771
2165
 
1772
2166
  --preset=<option>
1773
2167
  Sign-in preset for the scaffolded schema and login flow (default:
@@ -1781,6 +2175,31 @@ FLAGS
1781
2175
  --skip-install
1782
2176
  Do not install dependencies after setup updates package.json.
1783
2177
 
2178
+ --sso=<option>
2179
+ Social sign-in provider to enable while scaffolding, e.g. google. Skips the
2180
+ wizard's provider question; needs --sso-client-id, and the OAuth application
2181
+ must already be registered with the provider. Pipe the client secret in on
2182
+ stdin; never pass it as a flag.
2183
+ <options: google|custom>
2184
+
2185
+ --sso-client-id=<value>
2186
+ Client id of the OAuth application registered with the --sso provider.
2187
+
2188
+ --sso-display-name=<value>
2189
+ With --sso custom: the name shown on the sign-in button.
2190
+
2191
+ --sso-issuer=<value>
2192
+ With --sso custom: the provider's issuer URL. Its endpoints come from OIDC
2193
+ discovery.
2194
+
2195
+ --sso-scopes=<value>
2196
+ With --sso custom: the scopes to request, separated by spaces or commas.
2197
+ Must include openid. Default: openid profile email.
2198
+
2199
+ --sso-slug=<value>
2200
+ With --sso custom: the name of the connection. Schemas and flows refer to
2201
+ it.
2202
+
1784
2203
  --[no-]telemetry
1785
2204
  Send anonymous usage analytics. Disable with --no-telemetry.
1786
2205
 
@@ -1789,9 +2208,6 @@ FLAGS
1789
2208
  minimal).
1790
2209
  <options: minimal|consumer|business>
1791
2210
 
1792
- --verbose
1793
- Verbose logging.
1794
-
1795
2211
  GLOBAL FLAGS
1796
2212
  --json Format output as json.
1797
2213
 
@@ -1811,7 +2227,7 @@ Start a local Zitadel server.
1811
2227
  ```
1812
2228
  USAGE
1813
2229
  $ zitadel start [--json] [-c <value>] [-s <value>] [-n]
1814
- [--dry-run] [--verbose] [--debug] [--telemetry] [--image <value>] [--port
2230
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--image <value>] [--port
1815
2231
  <value>] [--runtime binary|docker]
1816
2232
 
1817
2233
  FLAGS
@@ -1819,15 +2235,18 @@ FLAGS
1819
2235
  -n, --non-interactive Disable prompts. Required when scripting or running as
1820
2236
  an agent.
1821
2237
  -s, --server=<value> Override the resolved server URL.
2238
+ -v, --verbose Verbose logging.
2239
+ --[no-]color Colorize human output. Disable with --no-color;
2240
+ NO_COLOR and FORCE_COLOR are honored too.
1822
2241
  --debug Debug logging.
1823
2242
  --dry-run Preview without mutating files or the platform.
1824
2243
  --image=<value> Container image to run.
1825
- --port=<value> [default: 8080] Local HTTP port.
2244
+ --port=<value> Local HTTP port. By default this directory keeps the
2245
+ port it had, or takes the first free one from 8080.
1826
2246
  --runtime=<option> Local runtime backend.
1827
2247
  <options: binary|docker>
1828
2248
  --[no-]telemetry Send anonymous usage analytics. Disable with
1829
2249
  --no-telemetry.
1830
- --verbose Verbose logging.
1831
2250
 
1832
2251
  GLOBAL FLAGS
1833
2252
  --json Format output as json.
@@ -1843,18 +2262,20 @@ Summarize the local Zitadel server and project state.
1843
2262
  ```
1844
2263
  USAGE
1845
2264
  $ zitadel status [--json] [-c <value>] [-s <value>] [-n]
1846
- [--dry-run] [--verbose] [--debug] [--telemetry]
2265
+ [--dry-run] [-v] [--debug] [--color] [--telemetry]
1847
2266
 
1848
2267
  FLAGS
1849
2268
  -c, --cwd=<value> Project directory to operate on.
1850
2269
  -n, --non-interactive Disable prompts. Required when scripting or running as
1851
2270
  an agent.
1852
2271
  -s, --server=<value> Override the resolved server URL.
2272
+ -v, --verbose Verbose logging.
2273
+ --[no-]color Colorize human output. Disable with --no-color;
2274
+ NO_COLOR and FORCE_COLOR are honored too.
1853
2275
  --debug Debug logging.
1854
2276
  --dry-run Preview without mutating files or the platform.
1855
2277
  --[no-]telemetry Send anonymous usage analytics. Disable with
1856
2278
  --no-telemetry.
1857
- --verbose Verbose logging.
1858
2279
 
1859
2280
  GLOBAL FLAGS
1860
2281
  --json Format output as json.
@@ -1870,20 +2291,22 @@ Stop the local Zitadel server.
1870
2291
  ```
1871
2292
  USAGE
1872
2293
  $ zitadel stop [--json] [-c <value>] [-s <value>] [-n]
1873
- [--dry-run] [--verbose] [--debug] [--telemetry] [--all]
2294
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--all]
1874
2295
 
1875
2296
  FLAGS
1876
2297
  -c, --cwd=<value> Project directory to operate on.
1877
2298
  -n, --non-interactive Disable prompts. Required when scripting or running as
1878
2299
  an agent.
1879
2300
  -s, --server=<value> Override the resolved server URL.
2301
+ -v, --verbose Verbose logging.
1880
2302
  --all Stop all discovered CLI-managed local Zitadel runtime
1881
2303
  processes.
2304
+ --[no-]color Colorize human output. Disable with --no-color;
2305
+ NO_COLOR and FORCE_COLOR are honored too.
1882
2306
  --debug Debug logging.
1883
2307
  --dry-run Preview without mutating files or the platform.
1884
2308
  --[no-]telemetry Send anonymous usage analytics. Disable with
1885
2309
  --no-telemetry.
1886
- --verbose Verbose logging.
1887
2310
 
1888
2311
  GLOBAL FLAGS
1889
2312
  --json Format output as json.
@@ -1899,23 +2322,31 @@ Create a team.
1899
2322
  ```
1900
2323
  USAGE
1901
2324
  $ zitadel teams create [--json] [-c <value>] [-s <value>] [-n]
1902
- [--dry-run] [--verbose] [--debug] [--telemetry] [--name <value>] [--data
1903
- <value> | --file <value>]
2325
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--name <value>] [--data
2326
+ <value> | --file <value>] [--set <value>...]
1904
2327
 
1905
2328
  FLAGS
1906
2329
  -c, --cwd=<value> Project directory to operate on.
1907
2330
  -n, --non-interactive Disable prompts. Required when scripting or running as
1908
2331
  an agent.
1909
2332
  -s, --server=<value> Override the resolved server URL.
2333
+ -v, --verbose Verbose logging.
2334
+ --[no-]color Colorize human output. Disable with --no-color;
2335
+ NO_COLOR and FORCE_COLOR are honored too.
1910
2336
  --debug Debug logging.
1911
2337
  --dry-run Preview without mutating files or the platform.
1912
2338
  --[no-]telemetry Send anonymous usage analytics. Disable with
1913
2339
  --no-telemetry.
1914
- --verbose Verbose logging.
1915
2340
 
1916
2341
  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.
2342
+ --data=<value> Whole body as a JSON object. Field flags and --set apply
2343
+ over it.
2344
+ --file=<value> Read the body from a JSON file; `-` reads stdin. Field flags
2345
+ and --set apply over it.
2346
+ --set=<value>... Set one field by its dot path: path=value, or path:=json for
2347
+ JSON. Repeatable; applied after the field flags, in order. A
2348
+ key that contains a dot is set through its parent: --set
2349
+ 'parent:={"a.b":"x"}'.
1919
2350
 
1920
2351
  GLOBAL FLAGS
1921
2352
  --json Format output as json.
@@ -1941,7 +2372,7 @@ Deactivate a team by id.
1941
2372
  ```
1942
2373
  USAGE
1943
2374
  $ zitadel teams deactivate ID [--json] [-c <value>] [-s <value>] [-n]
1944
- [--dry-run] [--verbose] [--debug] [--telemetry] [-f]
2375
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-f]
1945
2376
 
1946
2377
  ARGUMENTS
1947
2378
  ID team id
@@ -1953,11 +2384,13 @@ FLAGS
1953
2384
  -n, --non-interactive Disable prompts. Required when scripting or running as
1954
2385
  an agent.
1955
2386
  -s, --server=<value> Override the resolved server URL.
2387
+ -v, --verbose Verbose logging.
2388
+ --[no-]color Colorize human output. Disable with --no-color;
2389
+ NO_COLOR and FORCE_COLOR are honored too.
1956
2390
  --debug Debug logging.
1957
2391
  --dry-run Preview without mutating files or the platform.
1958
2392
  --[no-]telemetry Send anonymous usage analytics. Disable with
1959
2393
  --no-telemetry.
1960
- --verbose Verbose logging.
1961
2394
 
1962
2395
  GLOBAL FLAGS
1963
2396
  --json Format output as json.
@@ -1976,7 +2409,7 @@ Get one team by id.
1976
2409
  ```
1977
2410
  USAGE
1978
2411
  $ zitadel teams get ID [--json] [-c <value>] [-s <value>] [-n]
1979
- [--dry-run] [--verbose] [--debug] [--telemetry] [--fields <value>]
2412
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
1980
2413
 
1981
2414
  ARGUMENTS
1982
2415
  ID team id
@@ -1986,13 +2419,15 @@ FLAGS
1986
2419
  -n, --non-interactive Disable prompts. Required when scripting or running as
1987
2420
  an agent.
1988
2421
  -s, --server=<value> Override the resolved server URL.
2422
+ -v, --verbose Verbose logging.
2423
+ --[no-]color Colorize human output. Disable with --no-color;
2424
+ NO_COLOR and FORCE_COLOR are honored too.
1989
2425
  --debug Debug logging.
1990
2426
  --dry-run Preview without mutating files or the platform.
1991
2427
  --fields=<value> Fields to show, comma-separated dot-paths. Defaults to
1992
2428
  the resource's own; `--json` is unaffected.
1993
2429
  --[no-]telemetry Send anonymous usage analytics. Disable with
1994
2430
  --no-telemetry.
1995
- --verbose Verbose logging.
1996
2431
 
1997
2432
  GLOBAL FLAGS
1998
2433
  --json Format output as json.
@@ -2013,7 +2448,7 @@ List teams.
2013
2448
  ```
2014
2449
  USAGE
2015
2450
  $ zitadel teams list [--json] [-c <value>] [-s <value>] [-n]
2016
- [--dry-run] [--verbose] [--debug] [--telemetry] [--limit <value>] [-a |
2451
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
2017
2452
  --page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
2018
2453
  [--sort <value>]
2019
2454
 
@@ -2030,6 +2465,13 @@ FLAGS
2030
2465
  -s, --server=<value>
2031
2466
  Override the resolved server URL.
2032
2467
 
2468
+ -v, --verbose
2469
+ Verbose logging.
2470
+
2471
+ --[no-]color
2472
+ Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are
2473
+ honored too.
2474
+
2033
2475
  --debug
2034
2476
  Debug logging.
2035
2477
 
@@ -2064,9 +2506,6 @@ FLAGS
2064
2506
  --[no-]telemetry
2065
2507
  Send anonymous usage analytics. Disable with --no-telemetry.
2066
2508
 
2067
- --verbose
2068
- Verbose logging.
2069
-
2070
2509
  GLOBAL FLAGS
2071
2510
  --json Format output as json.
2072
2511
 
@@ -2088,8 +2527,8 @@ Update a team by id.
2088
2527
  ```
2089
2528
  USAGE
2090
2529
  $ zitadel teams update ID [--json] [-c <value>] [-s <value>] [-n]
2091
- [--dry-run] [--verbose] [--debug] [--telemetry] [--name <value>] [--data
2092
- <value> | --file <value>]
2530
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--name <value>] [--data
2531
+ <value> | --file <value>] [--set <value>...]
2093
2532
 
2094
2533
  ARGUMENTS
2095
2534
  ID team id
@@ -2099,15 +2538,23 @@ FLAGS
2099
2538
  -n, --non-interactive Disable prompts. Required when scripting or running as
2100
2539
  an agent.
2101
2540
  -s, --server=<value> Override the resolved server URL.
2541
+ -v, --verbose Verbose logging.
2542
+ --[no-]color Colorize human output. Disable with --no-color;
2543
+ NO_COLOR and FORCE_COLOR are honored too.
2102
2544
  --debug Debug logging.
2103
2545
  --dry-run Preview without mutating files or the platform.
2104
2546
  --[no-]telemetry Send anonymous usage analytics. Disable with
2105
2547
  --no-telemetry.
2106
- --verbose Verbose logging.
2107
2548
 
2108
2549
  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.
2550
+ --data=<value> Whole body as a JSON object. Field flags and --set apply
2551
+ over it.
2552
+ --file=<value> Read the body from a JSON file; `-` reads stdin. Field flags
2553
+ and --set apply over it.
2554
+ --set=<value>... Set one field by its dot path: path=value, or path:=json for
2555
+ JSON. Repeatable; applied after the field flags, in order. A
2556
+ key that contains a dot is set through its parent: --set
2557
+ 'parent:={"a.b":"x"}'.
2111
2558
 
2112
2559
  GLOBAL FLAGS
2113
2560
  --json Format output as json.
@@ -2131,7 +2578,7 @@ Remove managed files and local Zitadel state.
2131
2578
  ```
2132
2579
  USAGE
2133
2580
  $ zitadel uninstall [--json] [-c <value>] [-s <value>] [-n]
2134
- [--dry-run] [--verbose] [--debug] [--telemetry] [-f]
2581
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-f]
2135
2582
 
2136
2583
  FLAGS
2137
2584
  -c, --cwd=<value> Project directory to operate on.
@@ -2140,11 +2587,13 @@ FLAGS
2140
2587
  -n, --non-interactive Disable prompts. Required when scripting or running as
2141
2588
  an agent.
2142
2589
  -s, --server=<value> Override the resolved server URL.
2590
+ -v, --verbose Verbose logging.
2591
+ --[no-]color Colorize human output. Disable with --no-color;
2592
+ NO_COLOR and FORCE_COLOR are honored too.
2143
2593
  --debug Debug logging.
2144
2594
  --dry-run Preview without mutating files or the platform.
2145
2595
  --[no-]telemetry Send anonymous usage analytics. Disable with
2146
2596
  --no-telemetry.
2147
- --verbose Verbose logging.
2148
2597
 
2149
2598
  GLOBAL FLAGS
2150
2599
  --json Format output as json.
@@ -2158,24 +2607,27 @@ ALIASES
2158
2607
 
2159
2608
  ## `zitadel users create`
2160
2609
 
2161
- Create an user.
2610
+ Create a user.
2162
2611
 
2163
2612
  ```
2164
2613
  USAGE
2165
2614
  $ zitadel users create [--json] [-c <value>] [-s <value>] [-n]
2166
- [--dry-run] [--verbose] [--debug] [--telemetry] [--schema <value>]
2167
- [--attributes <value>...] [--data <value> | --file <value>]
2615
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--schema <value>]
2616
+ [--attributes <value>...] [--data <value> | --file <value>] [--set
2617
+ <value>...]
2168
2618
 
2169
2619
  FLAGS
2170
2620
  -c, --cwd=<value> Project directory to operate on.
2171
2621
  -n, --non-interactive Disable prompts. Required when scripting or running as
2172
2622
  an agent.
2173
2623
  -s, --server=<value> Override the resolved server URL.
2624
+ -v, --verbose Verbose logging.
2625
+ --[no-]color Colorize human output. Disable with --no-color;
2626
+ NO_COLOR and FORCE_COLOR are honored too.
2174
2627
  --debug Debug logging.
2175
2628
  --dry-run Preview without mutating files or the platform.
2176
2629
  --[no-]telemetry Send anonymous usage analytics. Disable with
2177
2630
  --no-telemetry.
2178
- --verbose Verbose logging.
2179
2631
 
2180
2632
  REQUIRED FIELD FLAGS
2181
2633
  --attributes=<value>... (required) Repeatable attributes entry: key=value for
@@ -2185,14 +2637,20 @@ REQUIRED FIELD FLAGS
2185
2637
  `attributes`.
2186
2638
 
2187
2639
  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.
2640
+ --data=<value> Whole body as a JSON object. Field flags and --set apply
2641
+ over it.
2642
+ --file=<value> Read the body from a JSON file; `-` reads stdin. Field flags
2643
+ and --set apply over it.
2644
+ --set=<value>... Set one field by its dot path: path=value, or path:=json for
2645
+ JSON. Repeatable; applied after the field flags, in order. A
2646
+ key that contains a dot is set through its parent: --set
2647
+ 'parent:={"a.b":"x"}'.
2190
2648
 
2191
2649
  GLOBAL FLAGS
2192
2650
  --json Format output as json.
2193
2651
 
2194
2652
  DESCRIPTION
2195
- Create an user.
2653
+ Create a user.
2196
2654
 
2197
2655
  EXAMPLES
2198
2656
  $ zitadel users create --schema <schema> --attributes <key>=<value> --json
@@ -2204,12 +2662,12 @@ EXAMPLES
2204
2662
 
2205
2663
  ## `zitadel users delete ID`
2206
2664
 
2207
- Delete an user by id.
2665
+ Delete a user by id.
2208
2666
 
2209
2667
  ```
2210
2668
  USAGE
2211
2669
  $ zitadel users delete ID [--json] [-c <value>] [-s <value>] [-n]
2212
- [--dry-run] [--verbose] [--debug] [--telemetry] [-f]
2670
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-f]
2213
2671
 
2214
2672
  ARGUMENTS
2215
2673
  ID user id
@@ -2221,17 +2679,19 @@ FLAGS
2221
2679
  -n, --non-interactive Disable prompts. Required when scripting or running as
2222
2680
  an agent.
2223
2681
  -s, --server=<value> Override the resolved server URL.
2682
+ -v, --verbose Verbose logging.
2683
+ --[no-]color Colorize human output. Disable with --no-color;
2684
+ NO_COLOR and FORCE_COLOR are honored too.
2224
2685
  --debug Debug logging.
2225
2686
  --dry-run Preview without mutating files or the platform.
2226
2687
  --[no-]telemetry Send anonymous usage analytics. Disable with
2227
2688
  --no-telemetry.
2228
- --verbose Verbose logging.
2229
2689
 
2230
2690
  GLOBAL FLAGS
2231
2691
  --json Format output as json.
2232
2692
 
2233
2693
  DESCRIPTION
2234
- Delete an user by id.
2694
+ Delete a user by id.
2235
2695
 
2236
2696
  EXAMPLES
2237
2697
  $ zitadel users delete <id> --force --json
@@ -2244,7 +2704,7 @@ Get one user by id.
2244
2704
  ```
2245
2705
  USAGE
2246
2706
  $ zitadel users get ID [--json] [-c <value>] [-s <value>] [-n]
2247
- [--dry-run] [--verbose] [--debug] [--telemetry] [--fields <value>]
2707
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
2248
2708
 
2249
2709
  ARGUMENTS
2250
2710
  ID user id
@@ -2254,13 +2714,15 @@ FLAGS
2254
2714
  -n, --non-interactive Disable prompts. Required when scripting or running as
2255
2715
  an agent.
2256
2716
  -s, --server=<value> Override the resolved server URL.
2717
+ -v, --verbose Verbose logging.
2718
+ --[no-]color Colorize human output. Disable with --no-color;
2719
+ NO_COLOR and FORCE_COLOR are honored too.
2257
2720
  --debug Debug logging.
2258
2721
  --dry-run Preview without mutating files or the platform.
2259
2722
  --fields=<value> Fields to show, comma-separated dot-paths. Defaults to
2260
2723
  the resource's own; `--json` is unaffected.
2261
2724
  --[no-]telemetry Send anonymous usage analytics. Disable with
2262
2725
  --no-telemetry.
2263
- --verbose Verbose logging.
2264
2726
 
2265
2727
  GLOBAL FLAGS
2266
2728
  --json Format output as json.
@@ -2281,7 +2743,7 @@ List users.
2281
2743
  ```
2282
2744
  USAGE
2283
2745
  $ zitadel users list [--json] [-c <value>] [-s <value>] [-n]
2284
- [--dry-run] [--verbose] [--debug] [--telemetry] [--limit <value>] [-a |
2746
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
2285
2747
  --page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
2286
2748
  [--sort <value>]
2287
2749
 
@@ -2298,6 +2760,13 @@ FLAGS
2298
2760
  -s, --server=<value>
2299
2761
  Override the resolved server URL.
2300
2762
 
2763
+ -v, --verbose
2764
+ Verbose logging.
2765
+
2766
+ --[no-]color
2767
+ Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are
2768
+ honored too.
2769
+
2301
2770
  --debug
2302
2771
  Debug logging.
2303
2772
 
@@ -2338,9 +2807,6 @@ FLAGS
2338
2807
  --[no-]telemetry
2339
2808
  Send anonymous usage analytics. Disable with --no-telemetry.
2340
2809
 
2341
- --verbose
2342
- Verbose logging.
2343
-
2344
2810
  GLOBAL FLAGS
2345
2811
  --json Format output as json.
2346
2812
 
@@ -2357,13 +2823,14 @@ EXAMPLES
2357
2823
 
2358
2824
  ## `zitadel users update ID`
2359
2825
 
2360
- Update an user by id.
2826
+ Update a user by id.
2361
2827
 
2362
2828
  ```
2363
2829
  USAGE
2364
2830
  $ 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>]
2831
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--schema <value>]
2832
+ [--attributes <value>...] [--data <value> | --file <value>] [--set
2833
+ <value>...]
2367
2834
 
2368
2835
  ARGUMENTS
2369
2836
  ID user id
@@ -2373,11 +2840,13 @@ FLAGS
2373
2840
  -n, --non-interactive Disable prompts. Required when scripting or running as
2374
2841
  an agent.
2375
2842
  -s, --server=<value> Override the resolved server URL.
2843
+ -v, --verbose Verbose logging.
2844
+ --[no-]color Colorize human output. Disable with --no-color;
2845
+ NO_COLOR and FORCE_COLOR are honored too.
2376
2846
  --debug Debug logging.
2377
2847
  --dry-run Preview without mutating files or the platform.
2378
2848
  --[no-]telemetry Send anonymous usage analytics. Disable with
2379
2849
  --no-telemetry.
2380
- --verbose Verbose logging.
2381
2850
 
2382
2851
  OPTIONAL FIELD FLAGS
2383
2852
  --attributes=<value>... Repeatable attributes entry: key=value for a string,
@@ -2385,14 +2854,20 @@ OPTIONAL FIELD FLAGS
2385
2854
  --schema=<value> The schema the user follows after this patch.
2386
2855
 
2387
2856
  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.
2857
+ --data=<value> Whole body as a JSON object. Field flags and --set apply
2858
+ over it.
2859
+ --file=<value> Read the body from a JSON file; `-` reads stdin. Field flags
2860
+ and --set apply over it.
2861
+ --set=<value>... Set one field by its dot path: path=value, or path:=json for
2862
+ JSON. Repeatable; applied after the field flags, in order. A
2863
+ key that contains a dot is set through its parent: --set
2864
+ 'parent:={"a.b":"x"}'.
2390
2865
 
2391
2866
  GLOBAL FLAGS
2392
2867
  --json Format output as json.
2393
2868
 
2394
2869
  DESCRIPTION
2395
- Update an user by id.
2870
+ Update a user by id.
2396
2871
 
2397
2872
  EXAMPLES
2398
2873
  $ zitadel users update <id> --data '{...}' --json
@@ -2407,7 +2882,7 @@ Delete one variable from the project.
2407
2882
  ```
2408
2883
  USAGE
2409
2884
  $ zitadel variables delete NAME [--json] [-c <value>] [-s <value>] [-n]
2410
- [--dry-run] [--verbose] [--debug] [--telemetry] [--project-level] [-f]
2885
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--project-level] [-f]
2411
2886
 
2412
2887
  ARGUMENTS
2413
2888
  NAME Variable name to delete.
@@ -2419,13 +2894,15 @@ FLAGS
2419
2894
  -n, --non-interactive Disable prompts. Required when scripting or running as
2420
2895
  an agent.
2421
2896
  -s, --server=<value> Override the resolved server URL.
2897
+ -v, --verbose Verbose logging.
2898
+ --[no-]color Colorize human output. Disable with --no-color;
2899
+ NO_COLOR and FORCE_COLOR are honored too.
2422
2900
  --debug Debug logging.
2423
2901
  --dry-run Preview without mutating files or the platform.
2424
2902
  --project-level Address the project level. Required: it is the only
2425
2903
  owner the CLI can address today.
2426
2904
  --[no-]telemetry Send anonymous usage analytics. Disable with
2427
2905
  --no-telemetry.
2428
- --verbose Verbose logging.
2429
2906
 
2430
2907
  GLOBAL FLAGS
2431
2908
  --json Format output as json.
@@ -2446,7 +2923,7 @@ Get one variable from the project.
2446
2923
  ```
2447
2924
  USAGE
2448
2925
  $ zitadel variables get NAME [--json] [-c <value>] [-s <value>] [-n]
2449
- [--dry-run] [--verbose] [--debug] [--telemetry] [--project-level]
2926
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--project-level]
2450
2927
 
2451
2928
  ARGUMENTS
2452
2929
  NAME Variable name to read.
@@ -2456,13 +2933,15 @@ FLAGS
2456
2933
  -n, --non-interactive Disable prompts. Required when scripting or running as
2457
2934
  an agent.
2458
2935
  -s, --server=<value> Override the resolved server URL.
2936
+ -v, --verbose Verbose logging.
2937
+ --[no-]color Colorize human output. Disable with --no-color;
2938
+ NO_COLOR and FORCE_COLOR are honored too.
2459
2939
  --debug Debug logging.
2460
2940
  --dry-run Preview without mutating files or the platform.
2461
2941
  --project-level Address the project level. Required: it is the only
2462
2942
  owner the CLI can address today.
2463
2943
  --[no-]telemetry Send anonymous usage analytics. Disable with
2464
2944
  --no-telemetry.
2465
- --verbose Verbose logging.
2466
2945
 
2467
2946
  GLOBAL FLAGS
2468
2947
  --json Format output as json.
@@ -2483,13 +2962,17 @@ List the variables entered on the project.
2483
2962
  ```
2484
2963
  USAGE
2485
2964
  $ zitadel variables list [--json] [-c <value>] [-s <value>] [-n]
2486
- [--dry-run] [--verbose] [--debug] [--telemetry] [--project-level] [--plain]
2965
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--project-level]
2966
+ [--plain]
2487
2967
 
2488
2968
  FLAGS
2489
2969
  -c, --cwd=<value> Project directory to operate on.
2490
2970
  -n, --non-interactive Disable prompts. Required when scripting or running as
2491
2971
  an agent.
2492
2972
  -s, --server=<value> Override the resolved server URL.
2973
+ -v, --verbose Verbose logging.
2974
+ --[no-]color Colorize human output. Disable with --no-color;
2975
+ NO_COLOR and FORCE_COLOR are honored too.
2493
2976
  --debug Debug logging.
2494
2977
  --dry-run Preview without mutating files or the platform.
2495
2978
  --plain Tab-separated rows with no header, for piping. Implied
@@ -2498,7 +2981,6 @@ FLAGS
2498
2981
  owner the CLI can address today.
2499
2982
  --[no-]telemetry Send anonymous usage analytics. Disable with
2500
2983
  --no-telemetry.
2501
- --verbose Verbose logging.
2502
2984
 
2503
2985
  GLOBAL FLAGS
2504
2986
  --json Format output as json.
@@ -2519,8 +3001,8 @@ Set one variable on the project.
2519
3001
  ```
2520
3002
  USAGE
2521
3003
  $ zitadel variables set NAME [--json] [-c <value>] [-s <value>] [-n]
2522
- [--dry-run] [--verbose] [--debug] [--telemetry] [--project-level] [--secret]
2523
- [--as string|number|boolean]
3004
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--project-level]
3005
+ [--secret] [--as string|number|boolean]
2524
3006
 
2525
3007
  ARGUMENTS
2526
3008
  NAME Variable name (letters, digits and underscores).
@@ -2530,10 +3012,11 @@ FLAGS
2530
3012
  -n, --non-interactive Disable prompts. Required when scripting or running as
2531
3013
  an agent.
2532
3014
  -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.
3015
+ -v, --verbose Verbose logging.
3016
+ --as=<option> [default: string] Store the value as this JSON type.
2536
3017
  <options: string|number|boolean>
3018
+ --[no-]color Colorize human output. Disable with --no-color;
3019
+ NO_COLOR and FORCE_COLOR are honored too.
2537
3020
  --debug Debug logging.
2538
3021
  --dry-run Preview without mutating files or the platform.
2539
3022
  --project-level Address the project level. Required: it is the only
@@ -2542,7 +3025,6 @@ FLAGS
2542
3025
  never read back.
2543
3026
  --[no-]telemetry Send anonymous usage analytics. Disable with
2544
3027
  --no-telemetry.
2545
- --verbose Verbose logging.
2546
3028
 
2547
3029
  GLOBAL FLAGS
2548
3030
  --json Format output as json.