@zitadel/cli 1.0.0-alpha.24 → 1.0.0-alpha.25
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 +315 -131
- package/bin/run.js +8 -0
- package/dist/{groups-CMB0fMzE.mjs → groups-CbWm8kCm.mjs} +1 -1
- package/dist/{groups-CMB0fMzE.mjs.map → groups-CbWm8kCm.mjs.map} +1 -1
- package/dist/index.mjs +3001 -804
- package/dist/index.mjs.map +1 -1
- package/dist/lib/oclif/help.mjs +1 -1
- package/dist/lib/oclif/help.mjs.map +1 -1
- package/oclif.manifest.json +497 -3
- package/package.json +14 -10
- package/skills/zitadel-cli/SKILL.md +260 -0
- package/skills/zitadel-cli/references/driving-login-ui.md +72 -0
- package/SKILLS.md +0 -536
package/README.md
CHANGED
|
@@ -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 [`
|
|
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
|
|
@@ -166,6 +166,7 @@ which ships in this package.
|
|
|
166
166
|
* [`zitadel sessions list`](#zitadel-sessions-list)
|
|
167
167
|
* [`zitadel sessions revoke ID`](#zitadel-sessions-revoke-id)
|
|
168
168
|
* [`zitadel setup`](#zitadel-setup)
|
|
169
|
+
* [`zitadel sso enable`](#zitadel-sso-enable)
|
|
169
170
|
* [`zitadel start`](#zitadel-start)
|
|
170
171
|
* [`zitadel status`](#zitadel-status)
|
|
171
172
|
* [`zitadel stop`](#zitadel-stop)
|
|
@@ -194,18 +195,20 @@ Validate and upload repo config to the platform.
|
|
|
194
195
|
```
|
|
195
196
|
USAGE
|
|
196
197
|
$ zitadel apply [--json] [-c <value>] [-s <value>] [-n]
|
|
197
|
-
[--dry-run] [
|
|
198
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry]
|
|
198
199
|
|
|
199
200
|
FLAGS
|
|
200
201
|
-c, --cwd=<value> Project directory to operate on.
|
|
201
202
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
202
203
|
an agent.
|
|
203
204
|
-s, --server=<value> Override the resolved server URL.
|
|
205
|
+
-v, --verbose Verbose logging.
|
|
206
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
207
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
204
208
|
--debug Debug logging.
|
|
205
209
|
--dry-run Preview without mutating files or the platform.
|
|
206
210
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
207
211
|
--no-telemetry.
|
|
208
|
-
--verbose Verbose logging.
|
|
209
212
|
|
|
210
213
|
GLOBAL FLAGS
|
|
211
214
|
--json Format output as json.
|
|
@@ -252,8 +255,7 @@ Take ownership of the login template: scaffold .zitadel/branding/ from a shipped
|
|
|
252
255
|
```
|
|
253
256
|
USAGE
|
|
254
257
|
$ zitadel branding eject [--json] [-c <value>] [-s <value>] [-n]
|
|
255
|
-
[--dry-run] [
|
|
256
|
-
centered|minimal]
|
|
258
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-f] [--design <value>]
|
|
257
259
|
|
|
258
260
|
FLAGS
|
|
259
261
|
-c, --cwd=<value> Project directory to operate on.
|
|
@@ -261,13 +263,15 @@ FLAGS
|
|
|
261
263
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
262
264
|
an agent.
|
|
263
265
|
-s, --server=<value> Override the resolved server URL.
|
|
266
|
+
-v, --verbose Verbose logging.
|
|
267
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
268
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
264
269
|
--debug Debug logging.
|
|
265
|
-
--design=<
|
|
266
|
-
|
|
270
|
+
--design=<value> Design to start from: centered or minimal (default:
|
|
271
|
+
centered).
|
|
267
272
|
--dry-run Preview without mutating files or the platform.
|
|
268
273
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
269
274
|
--no-telemetry.
|
|
270
|
-
--verbose Verbose logging.
|
|
271
275
|
|
|
272
276
|
GLOBAL FLAGS
|
|
273
277
|
--json Format output as json.
|
|
@@ -284,7 +288,7 @@ Get one branding revision by id.
|
|
|
284
288
|
```
|
|
285
289
|
USAGE
|
|
286
290
|
$ zitadel branding get ID [--json] [-c <value>] [-s <value>] [-n]
|
|
287
|
-
[--dry-run] [
|
|
291
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
|
|
288
292
|
|
|
289
293
|
ARGUMENTS
|
|
290
294
|
ID branding revision id
|
|
@@ -294,13 +298,15 @@ FLAGS
|
|
|
294
298
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
295
299
|
an agent.
|
|
296
300
|
-s, --server=<value> Override the resolved server URL.
|
|
301
|
+
-v, --verbose Verbose logging.
|
|
302
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
303
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
297
304
|
--debug Debug logging.
|
|
298
305
|
--dry-run Preview without mutating files or the platform.
|
|
299
306
|
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
300
307
|
the resource's own; `--json` is unaffected.
|
|
301
308
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
302
309
|
--no-telemetry.
|
|
303
|
-
--verbose Verbose logging.
|
|
304
310
|
|
|
305
311
|
GLOBAL FLAGS
|
|
306
312
|
--json Format output as json.
|
|
@@ -321,13 +327,17 @@ List branding.
|
|
|
321
327
|
```
|
|
322
328
|
USAGE
|
|
323
329
|
$ zitadel branding list [--json] [-c <value>] [-s <value>] [-n]
|
|
324
|
-
[--dry-run] [
|
|
330
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
|
|
331
|
+
[--plain]
|
|
325
332
|
|
|
326
333
|
FLAGS
|
|
327
334
|
-c, --cwd=<value> Project directory to operate on.
|
|
328
335
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
329
336
|
an agent.
|
|
330
337
|
-s, --server=<value> Override the resolved server URL.
|
|
338
|
+
-v, --verbose Verbose logging.
|
|
339
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
340
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
331
341
|
--debug Debug logging.
|
|
332
342
|
--dry-run Preview without mutating files or the platform.
|
|
333
343
|
--fields=<value> Columns to show, comma-separated dot-paths (e.g.
|
|
@@ -337,7 +347,6 @@ FLAGS
|
|
|
337
347
|
when stdout is not a terminal.
|
|
338
348
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
339
349
|
--no-telemetry.
|
|
340
|
-
--verbose Verbose logging.
|
|
341
350
|
|
|
342
351
|
GLOBAL FLAGS
|
|
343
352
|
--json Format output as json.
|
|
@@ -356,7 +365,7 @@ Claim this project to make it permanent. Opens a browser to create an account or
|
|
|
356
365
|
```
|
|
357
366
|
USAGE
|
|
358
367
|
$ zitadel claim [--json] [-c <value>] [-s <value>] [-n]
|
|
359
|
-
[--dry-run] [
|
|
368
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--no-open] [--timeout
|
|
360
369
|
<value>]
|
|
361
370
|
|
|
362
371
|
FLAGS
|
|
@@ -364,6 +373,9 @@ FLAGS
|
|
|
364
373
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
365
374
|
an agent.
|
|
366
375
|
-s, --server=<value> Override the resolved server URL.
|
|
376
|
+
-v, --verbose Verbose logging.
|
|
377
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
378
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
367
379
|
--debug Debug logging.
|
|
368
380
|
--dry-run Preview without mutating files or the platform.
|
|
369
381
|
--no-open Print the link instead of opening a browser.
|
|
@@ -371,7 +383,6 @@ FLAGS
|
|
|
371
383
|
--no-telemetry.
|
|
372
384
|
--timeout=<value> Seconds to wait for the browser step. Defaults to the
|
|
373
385
|
link's own expiry (10 minutes).
|
|
374
|
-
--verbose Verbose logging.
|
|
375
386
|
|
|
376
387
|
GLOBAL FLAGS
|
|
377
388
|
--json Format output as json.
|
|
@@ -425,19 +436,21 @@ Open the local console, signed in as the local admin created by `zitadel start`.
|
|
|
425
436
|
```
|
|
426
437
|
USAGE
|
|
427
438
|
$ zitadel console [--json] [-c <value>] [-s <value>] [-n]
|
|
428
|
-
[--dry-run] [
|
|
439
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--no-open]
|
|
429
440
|
|
|
430
441
|
FLAGS
|
|
431
442
|
-c, --cwd=<value> Project directory to operate on.
|
|
432
443
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
433
444
|
an agent.
|
|
434
445
|
-s, --server=<value> Override the resolved server URL.
|
|
446
|
+
-v, --verbose Verbose logging.
|
|
447
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
448
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
435
449
|
--debug Debug logging.
|
|
436
450
|
--dry-run Preview without mutating files or the platform.
|
|
437
451
|
--no-open Print the sign-in link instead of opening a browser.
|
|
438
452
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
439
453
|
--no-telemetry.
|
|
440
|
-
--verbose Verbose logging.
|
|
441
454
|
|
|
442
455
|
GLOBAL FLAGS
|
|
443
456
|
--json Format output as json.
|
|
@@ -446,6 +459,9 @@ DESCRIPTION
|
|
|
446
459
|
Open the local console, signed in as the local admin created by `zitadel
|
|
447
460
|
start`.
|
|
448
461
|
|
|
462
|
+
Run it in the directory `zitadel start` ran in, or one inside it: the local
|
|
463
|
+
admin is read from the nearest `.zitadel/local/` on the way up.
|
|
464
|
+
|
|
449
465
|
EXAMPLES
|
|
450
466
|
$ zitadel console
|
|
451
467
|
|
|
@@ -459,7 +475,7 @@ Verify local runtime and project state.
|
|
|
459
475
|
```
|
|
460
476
|
USAGE
|
|
461
477
|
$ zitadel doctor [--json] [-c <value>] [-s <value>] [-n]
|
|
462
|
-
[--dry-run] [
|
|
478
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--fix] [--image <value>]
|
|
463
479
|
[--port <value>] [--runtime binary|docker]
|
|
464
480
|
|
|
465
481
|
FLAGS
|
|
@@ -467,6 +483,9 @@ FLAGS
|
|
|
467
483
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
468
484
|
an agent.
|
|
469
485
|
-s, --server=<value> Override the resolved server URL.
|
|
486
|
+
-v, --verbose Verbose logging.
|
|
487
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
488
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
470
489
|
--debug Debug logging.
|
|
471
490
|
--dry-run Preview without mutating files or the platform.
|
|
472
491
|
--fix Repair missing files and stale managed wiring.
|
|
@@ -476,7 +495,6 @@ FLAGS
|
|
|
476
495
|
<options: binary|docker>
|
|
477
496
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
478
497
|
--no-telemetry.
|
|
479
|
-
--verbose Verbose logging.
|
|
480
498
|
|
|
481
499
|
GLOBAL FLAGS
|
|
482
500
|
--json Format output as json.
|
|
@@ -492,7 +510,7 @@ Remove managed files and local Zitadel state.
|
|
|
492
510
|
```
|
|
493
511
|
USAGE
|
|
494
512
|
$ zitadel eject [--json] [-c <value>] [-s <value>] [-n]
|
|
495
|
-
[--dry-run] [
|
|
513
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-f]
|
|
496
514
|
|
|
497
515
|
FLAGS
|
|
498
516
|
-c, --cwd=<value> Project directory to operate on.
|
|
@@ -501,11 +519,13 @@ FLAGS
|
|
|
501
519
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
502
520
|
an agent.
|
|
503
521
|
-s, --server=<value> Override the resolved server URL.
|
|
522
|
+
-v, --verbose Verbose logging.
|
|
523
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
524
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
504
525
|
--debug Debug logging.
|
|
505
526
|
--dry-run Preview without mutating files or the platform.
|
|
506
527
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
507
528
|
--no-telemetry.
|
|
508
|
-
--verbose Verbose logging.
|
|
509
529
|
|
|
510
530
|
GLOBAL FLAGS
|
|
511
531
|
--json Format output as json.
|
|
@@ -524,7 +544,7 @@ Get one environment by id.
|
|
|
524
544
|
```
|
|
525
545
|
USAGE
|
|
526
546
|
$ zitadel environments get NAME [--json] [-c <value>] [-s <value>] [-n]
|
|
527
|
-
[--dry-run] [
|
|
547
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
|
|
528
548
|
|
|
529
549
|
ARGUMENTS
|
|
530
550
|
NAME environment name
|
|
@@ -534,13 +554,15 @@ FLAGS
|
|
|
534
554
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
535
555
|
an agent.
|
|
536
556
|
-s, --server=<value> Override the resolved server URL.
|
|
557
|
+
-v, --verbose Verbose logging.
|
|
558
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
559
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
537
560
|
--debug Debug logging.
|
|
538
561
|
--dry-run Preview without mutating files or the platform.
|
|
539
562
|
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
540
563
|
the resource's own; `--json` is unaffected.
|
|
541
564
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
542
565
|
--no-telemetry.
|
|
543
|
-
--verbose Verbose logging.
|
|
544
566
|
|
|
545
567
|
GLOBAL FLAGS
|
|
546
568
|
--json Format output as json.
|
|
@@ -561,7 +583,7 @@ List environments.
|
|
|
561
583
|
```
|
|
562
584
|
USAGE
|
|
563
585
|
$ zitadel environments list [--json] [-c <value>] [-s <value>] [-n]
|
|
564
|
-
[--dry-run] [
|
|
586
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
|
|
565
587
|
--page-token <value>] [--fields <value>] [--plain]
|
|
566
588
|
|
|
567
589
|
FLAGS
|
|
@@ -570,6 +592,9 @@ FLAGS
|
|
|
570
592
|
-n, --non-interactive Disable prompts. Required when scripting or running
|
|
571
593
|
as an agent.
|
|
572
594
|
-s, --server=<value> Override the resolved server URL.
|
|
595
|
+
-v, --verbose Verbose logging.
|
|
596
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
597
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
573
598
|
--debug Debug logging.
|
|
574
599
|
--dry-run Preview without mutating files or the platform.
|
|
575
600
|
--fields=<value> Columns to show, comma-separated dot-paths (e.g.
|
|
@@ -581,7 +606,6 @@ FLAGS
|
|
|
581
606
|
Implied when stdout is not a terminal.
|
|
582
607
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
583
608
|
--no-telemetry.
|
|
584
|
-
--verbose Verbose logging.
|
|
585
609
|
|
|
586
610
|
GLOBAL FLAGS
|
|
587
611
|
--json Format output as json.
|
|
@@ -602,7 +626,7 @@ Get one event by id.
|
|
|
602
626
|
```
|
|
603
627
|
USAGE
|
|
604
628
|
$ zitadel events get ID [--json] [-c <value>] [-s <value>] [-n]
|
|
605
|
-
[--dry-run] [
|
|
629
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
|
|
606
630
|
|
|
607
631
|
ARGUMENTS
|
|
608
632
|
ID event id
|
|
@@ -612,13 +636,15 @@ FLAGS
|
|
|
612
636
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
613
637
|
an agent.
|
|
614
638
|
-s, --server=<value> Override the resolved server URL.
|
|
639
|
+
-v, --verbose Verbose logging.
|
|
640
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
641
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
615
642
|
--debug Debug logging.
|
|
616
643
|
--dry-run Preview without mutating files or the platform.
|
|
617
644
|
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
618
645
|
the resource's own; `--json` is unaffected.
|
|
619
646
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
620
647
|
--no-telemetry.
|
|
621
|
-
--verbose Verbose logging.
|
|
622
648
|
|
|
623
649
|
GLOBAL FLAGS
|
|
624
650
|
--json Format output as json.
|
|
@@ -639,7 +665,7 @@ List events.
|
|
|
639
665
|
```
|
|
640
666
|
USAGE
|
|
641
667
|
$ zitadel events list [--json] [-c <value>] [-s <value>] [-n]
|
|
642
|
-
[--dry-run] [
|
|
668
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
|
|
643
669
|
--page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
|
|
644
670
|
[--sort <value>]
|
|
645
671
|
|
|
@@ -656,6 +682,13 @@ FLAGS
|
|
|
656
682
|
-s, --server=<value>
|
|
657
683
|
Override the resolved server URL.
|
|
658
684
|
|
|
685
|
+
-v, --verbose
|
|
686
|
+
Verbose logging.
|
|
687
|
+
|
|
688
|
+
--[no-]color
|
|
689
|
+
Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are
|
|
690
|
+
honored too.
|
|
691
|
+
|
|
659
692
|
--debug
|
|
660
693
|
Debug logging.
|
|
661
694
|
|
|
@@ -690,9 +723,6 @@ FLAGS
|
|
|
690
723
|
--[no-]telemetry
|
|
691
724
|
Send anonymous usage analytics. Disable with --no-telemetry.
|
|
692
725
|
|
|
693
|
-
--verbose
|
|
694
|
-
Verbose logging.
|
|
695
|
-
|
|
696
726
|
GLOBAL FLAGS
|
|
697
727
|
--json Format output as json.
|
|
698
728
|
|
|
@@ -714,7 +744,7 @@ Get one flow definition by id.
|
|
|
714
744
|
```
|
|
715
745
|
USAGE
|
|
716
746
|
$ zitadel flow-definitions get FLOW [--json] [-c <value>] [-s <value>] [-n]
|
|
717
|
-
[--dry-run] [
|
|
747
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
|
|
718
748
|
|
|
719
749
|
ARGUMENTS
|
|
720
750
|
FLOW flow name (newest revision) or revision id
|
|
@@ -724,13 +754,15 @@ FLAGS
|
|
|
724
754
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
725
755
|
an agent.
|
|
726
756
|
-s, --server=<value> Override the resolved server URL.
|
|
757
|
+
-v, --verbose Verbose logging.
|
|
758
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
759
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
727
760
|
--debug Debug logging.
|
|
728
761
|
--dry-run Preview without mutating files or the platform.
|
|
729
762
|
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
730
763
|
the resource's own; `--json` is unaffected.
|
|
731
764
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
732
765
|
--no-telemetry.
|
|
733
|
-
--verbose Verbose logging.
|
|
734
766
|
|
|
735
767
|
GLOBAL FLAGS
|
|
736
768
|
--json Format output as json.
|
|
@@ -751,7 +783,7 @@ List flow-definitions.
|
|
|
751
783
|
```
|
|
752
784
|
USAGE
|
|
753
785
|
$ zitadel flow-definitions list [--json] [-c <value>] [-s <value>] [-n]
|
|
754
|
-
[--dry-run] [
|
|
786
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
|
|
755
787
|
--page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
|
|
756
788
|
|
|
757
789
|
FLAGS
|
|
@@ -760,6 +792,9 @@ FLAGS
|
|
|
760
792
|
-n, --non-interactive Disable prompts. Required when scripting or running
|
|
761
793
|
as an agent.
|
|
762
794
|
-s, --server=<value> Override the resolved server URL.
|
|
795
|
+
-v, --verbose Verbose logging.
|
|
796
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
797
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
763
798
|
--debug Debug logging.
|
|
764
799
|
--dry-run Preview without mutating files or the platform.
|
|
765
800
|
--fields=<value> Columns to show, comma-separated dot-paths (e.g.
|
|
@@ -774,7 +809,6 @@ FLAGS
|
|
|
774
809
|
Implied when stdout is not a terminal.
|
|
775
810
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
776
811
|
--no-telemetry.
|
|
777
|
-
--verbose Verbose logging.
|
|
778
812
|
|
|
779
813
|
GLOBAL FLAGS
|
|
780
814
|
--json Format output as json.
|
|
@@ -797,7 +831,7 @@ Create a grant.
|
|
|
797
831
|
```
|
|
798
832
|
USAGE
|
|
799
833
|
$ zitadel grants create [--json] [-c <value>] [-s <value>] [-n]
|
|
800
|
-
[--dry-run] [
|
|
834
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--relation
|
|
801
835
|
viewer|editor|admin] [--expires-at <value>] [--data <value> | --file
|
|
802
836
|
<value>]
|
|
803
837
|
|
|
@@ -806,11 +840,13 @@ FLAGS
|
|
|
806
840
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
807
841
|
an agent.
|
|
808
842
|
-s, --server=<value> Override the resolved server URL.
|
|
843
|
+
-v, --verbose Verbose logging.
|
|
844
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
845
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
809
846
|
--debug Debug logging.
|
|
810
847
|
--dry-run Preview without mutating files or the platform.
|
|
811
848
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
812
849
|
--no-telemetry.
|
|
813
|
-
--verbose Verbose logging.
|
|
814
850
|
|
|
815
851
|
RAW BODY FLAGS
|
|
816
852
|
--data=<value> Whole body as a JSON object, instead of the field flags.
|
|
@@ -842,7 +878,7 @@ Delete a grant by id.
|
|
|
842
878
|
```
|
|
843
879
|
USAGE
|
|
844
880
|
$ zitadel grants delete ID [--json] [-c <value>] [-s <value>] [-n]
|
|
845
|
-
[--dry-run] [
|
|
881
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-f]
|
|
846
882
|
|
|
847
883
|
ARGUMENTS
|
|
848
884
|
ID grant id
|
|
@@ -854,11 +890,13 @@ FLAGS
|
|
|
854
890
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
855
891
|
an agent.
|
|
856
892
|
-s, --server=<value> Override the resolved server URL.
|
|
893
|
+
-v, --verbose Verbose logging.
|
|
894
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
895
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
857
896
|
--debug Debug logging.
|
|
858
897
|
--dry-run Preview without mutating files or the platform.
|
|
859
898
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
860
899
|
--no-telemetry.
|
|
861
|
-
--verbose Verbose logging.
|
|
862
900
|
|
|
863
901
|
GLOBAL FLAGS
|
|
864
902
|
--json Format output as json.
|
|
@@ -877,7 +915,7 @@ Get one grant by id.
|
|
|
877
915
|
```
|
|
878
916
|
USAGE
|
|
879
917
|
$ zitadel grants get ID [--json] [-c <value>] [-s <value>] [-n]
|
|
880
|
-
[--dry-run] [
|
|
918
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
|
|
881
919
|
|
|
882
920
|
ARGUMENTS
|
|
883
921
|
ID grant id
|
|
@@ -887,13 +925,15 @@ FLAGS
|
|
|
887
925
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
888
926
|
an agent.
|
|
889
927
|
-s, --server=<value> Override the resolved server URL.
|
|
928
|
+
-v, --verbose Verbose logging.
|
|
929
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
930
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
890
931
|
--debug Debug logging.
|
|
891
932
|
--dry-run Preview without mutating files or the platform.
|
|
892
933
|
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
893
934
|
the resource's own; `--json` is unaffected.
|
|
894
935
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
895
936
|
--no-telemetry.
|
|
896
|
-
--verbose Verbose logging.
|
|
897
937
|
|
|
898
938
|
GLOBAL FLAGS
|
|
899
939
|
--json Format output as json.
|
|
@@ -914,7 +954,7 @@ List grants.
|
|
|
914
954
|
```
|
|
915
955
|
USAGE
|
|
916
956
|
$ zitadel grants list [--json] [-c <value>] [-s <value>] [-n]
|
|
917
|
-
[--dry-run] [
|
|
957
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
|
|
918
958
|
--page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
|
|
919
959
|
[--sort <value>]
|
|
920
960
|
|
|
@@ -931,6 +971,13 @@ FLAGS
|
|
|
931
971
|
-s, --server=<value>
|
|
932
972
|
Override the resolved server URL.
|
|
933
973
|
|
|
974
|
+
-v, --verbose
|
|
975
|
+
Verbose logging.
|
|
976
|
+
|
|
977
|
+
--[no-]color
|
|
978
|
+
Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are
|
|
979
|
+
honored too.
|
|
980
|
+
|
|
934
981
|
--debug
|
|
935
982
|
Debug logging.
|
|
936
983
|
|
|
@@ -969,9 +1016,6 @@ FLAGS
|
|
|
969
1016
|
--[no-]telemetry
|
|
970
1017
|
Send anonymous usage analytics. Disable with --no-telemetry.
|
|
971
1018
|
|
|
972
|
-
--verbose
|
|
973
|
-
Verbose logging.
|
|
974
|
-
|
|
975
1019
|
GLOBAL FLAGS
|
|
976
1020
|
--json Format output as json.
|
|
977
1021
|
|
|
@@ -1013,7 +1057,7 @@ Create an identity provider connection.
|
|
|
1013
1057
|
```
|
|
1014
1058
|
USAGE
|
|
1015
1059
|
$ zitadel idps create [--json] [-c <value>] [-s <value>] [-n]
|
|
1016
|
-
[--dry-run] [
|
|
1060
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--data <value> | --file
|
|
1017
1061
|
<value>]
|
|
1018
1062
|
|
|
1019
1063
|
FLAGS
|
|
@@ -1021,11 +1065,13 @@ FLAGS
|
|
|
1021
1065
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1022
1066
|
an agent.
|
|
1023
1067
|
-s, --server=<value> Override the resolved server URL.
|
|
1068
|
+
-v, --verbose Verbose logging.
|
|
1069
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
1070
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
1024
1071
|
--debug Debug logging.
|
|
1025
1072
|
--dry-run Preview without mutating files or the platform.
|
|
1026
1073
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1027
1074
|
--no-telemetry.
|
|
1028
|
-
--verbose Verbose logging.
|
|
1029
1075
|
|
|
1030
1076
|
RAW BODY FLAGS
|
|
1031
1077
|
--data=<value> Whole body as a JSON object, instead of the field flags.
|
|
@@ -1050,7 +1096,7 @@ Get one identity provider connection by id.
|
|
|
1050
1096
|
```
|
|
1051
1097
|
USAGE
|
|
1052
1098
|
$ zitadel idps get ID [--json] [-c <value>] [-s <value>] [-n]
|
|
1053
|
-
[--dry-run] [
|
|
1099
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
|
|
1054
1100
|
|
|
1055
1101
|
ARGUMENTS
|
|
1056
1102
|
ID identity provider connection id
|
|
@@ -1060,13 +1106,15 @@ FLAGS
|
|
|
1060
1106
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1061
1107
|
an agent.
|
|
1062
1108
|
-s, --server=<value> Override the resolved server URL.
|
|
1109
|
+
-v, --verbose Verbose logging.
|
|
1110
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
1111
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
1063
1112
|
--debug Debug logging.
|
|
1064
1113
|
--dry-run Preview without mutating files or the platform.
|
|
1065
1114
|
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
1066
1115
|
the resource's own; `--json` is unaffected.
|
|
1067
1116
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1068
1117
|
--no-telemetry.
|
|
1069
|
-
--verbose Verbose logging.
|
|
1070
1118
|
|
|
1071
1119
|
GLOBAL FLAGS
|
|
1072
1120
|
--json Format output as json.
|
|
@@ -1087,7 +1135,7 @@ List idps.
|
|
|
1087
1135
|
```
|
|
1088
1136
|
USAGE
|
|
1089
1137
|
$ zitadel idps list [--json] [-c <value>] [-s <value>] [-n]
|
|
1090
|
-
[--dry-run] [
|
|
1138
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
|
|
1091
1139
|
--page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
|
|
1092
1140
|
[--sort <value>]
|
|
1093
1141
|
|
|
@@ -1104,6 +1152,13 @@ FLAGS
|
|
|
1104
1152
|
-s, --server=<value>
|
|
1105
1153
|
Override the resolved server URL.
|
|
1106
1154
|
|
|
1155
|
+
-v, --verbose
|
|
1156
|
+
Verbose logging.
|
|
1157
|
+
|
|
1158
|
+
--[no-]color
|
|
1159
|
+
Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are
|
|
1160
|
+
honored too.
|
|
1161
|
+
|
|
1107
1162
|
--debug
|
|
1108
1163
|
Debug logging.
|
|
1109
1164
|
|
|
@@ -1136,9 +1191,6 @@ FLAGS
|
|
|
1136
1191
|
--[no-]telemetry
|
|
1137
1192
|
Send anonymous usage analytics. Disable with --no-telemetry.
|
|
1138
1193
|
|
|
1139
|
-
--verbose
|
|
1140
|
-
Verbose logging.
|
|
1141
|
-
|
|
1142
1194
|
GLOBAL FLAGS
|
|
1143
1195
|
--json Format output as json.
|
|
1144
1196
|
|
|
@@ -1160,20 +1212,23 @@ Show local Zitadel server logs.
|
|
|
1160
1212
|
```
|
|
1161
1213
|
USAGE
|
|
1162
1214
|
$ zitadel logs [--json] [-c <value>] [-s <value>] [-n]
|
|
1163
|
-
[--dry-run] [
|
|
1215
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--follow] [--tail
|
|
1216
|
+
<value>]
|
|
1164
1217
|
|
|
1165
1218
|
FLAGS
|
|
1166
1219
|
-c, --cwd=<value> Project directory to operate on.
|
|
1167
1220
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1168
1221
|
an agent.
|
|
1169
1222
|
-s, --server=<value> Override the resolved server URL.
|
|
1223
|
+
-v, --verbose Verbose logging.
|
|
1224
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
1225
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
1170
1226
|
--debug Debug logging.
|
|
1171
1227
|
--dry-run Preview without mutating files or the platform.
|
|
1172
1228
|
--follow Follow logs.
|
|
1173
1229
|
--tail=<value> [default: 200] Number of lines to show.
|
|
1174
1230
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1175
1231
|
--no-telemetry.
|
|
1176
|
-
--verbose Verbose logging.
|
|
1177
1232
|
|
|
1178
1233
|
GLOBAL FLAGS
|
|
1179
1234
|
--json Format output as json.
|
|
@@ -1189,18 +1244,20 @@ Validate config without mutation and preview the sync diff.
|
|
|
1189
1244
|
```
|
|
1190
1245
|
USAGE
|
|
1191
1246
|
$ zitadel plan [--json] [-c <value>] [-s <value>] [-n]
|
|
1192
|
-
[--dry-run] [
|
|
1247
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry]
|
|
1193
1248
|
|
|
1194
1249
|
FLAGS
|
|
1195
1250
|
-c, --cwd=<value> Project directory to operate on.
|
|
1196
1251
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1197
1252
|
an agent.
|
|
1198
1253
|
-s, --server=<value> Override the resolved server URL.
|
|
1254
|
+
-v, --verbose Verbose logging.
|
|
1255
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
1256
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
1199
1257
|
--debug Debug logging.
|
|
1200
1258
|
--dry-run Preview without mutating files or the platform.
|
|
1201
1259
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1202
1260
|
--no-telemetry.
|
|
1203
|
-
--verbose Verbose logging.
|
|
1204
1261
|
|
|
1205
1262
|
GLOBAL FLAGS
|
|
1206
1263
|
--json Format output as json.
|
|
@@ -1216,7 +1273,7 @@ Get one project by id.
|
|
|
1216
1273
|
```
|
|
1217
1274
|
USAGE
|
|
1218
1275
|
$ zitadel projects get ID [--json] [-c <value>] [-s <value>] [-n]
|
|
1219
|
-
[--dry-run] [
|
|
1276
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
|
|
1220
1277
|
|
|
1221
1278
|
ARGUMENTS
|
|
1222
1279
|
ID project id
|
|
@@ -1226,13 +1283,15 @@ FLAGS
|
|
|
1226
1283
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1227
1284
|
an agent.
|
|
1228
1285
|
-s, --server=<value> Override the resolved server URL.
|
|
1286
|
+
-v, --verbose Verbose logging.
|
|
1287
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
1288
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
1229
1289
|
--debug Debug logging.
|
|
1230
1290
|
--dry-run Preview without mutating files or the platform.
|
|
1231
1291
|
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
1232
1292
|
the resource's own; `--json` is unaffected.
|
|
1233
1293
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1234
1294
|
--no-telemetry.
|
|
1235
|
-
--verbose Verbose logging.
|
|
1236
1295
|
|
|
1237
1296
|
GLOBAL FLAGS
|
|
1238
1297
|
--json Format output as json.
|
|
@@ -1253,7 +1312,7 @@ List projects.
|
|
|
1253
1312
|
```
|
|
1254
1313
|
USAGE
|
|
1255
1314
|
$ zitadel projects list [--json] [-c <value>] [-s <value>] [-n]
|
|
1256
|
-
[--dry-run] [
|
|
1315
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
|
|
1257
1316
|
--page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
|
|
1258
1317
|
[--sort <value>]
|
|
1259
1318
|
|
|
@@ -1263,6 +1322,9 @@ FLAGS
|
|
|
1263
1322
|
-n, --non-interactive Disable prompts. Required when scripting or running
|
|
1264
1323
|
as an agent.
|
|
1265
1324
|
-s, --server=<value> Override the resolved server URL.
|
|
1325
|
+
-v, --verbose Verbose logging.
|
|
1326
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
1327
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
1266
1328
|
--debug Debug logging.
|
|
1267
1329
|
--dry-run Preview without mutating files or the platform.
|
|
1268
1330
|
--fields=<value> Columns to show, comma-separated dot-paths (e.g.
|
|
@@ -1280,7 +1342,6 @@ FLAGS
|
|
|
1280
1342
|
created_at.
|
|
1281
1343
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1282
1344
|
--no-telemetry.
|
|
1283
|
-
--verbose Verbose logging.
|
|
1284
1345
|
|
|
1285
1346
|
GLOBAL FLAGS
|
|
1286
1347
|
--json Format output as json.
|
|
@@ -1303,8 +1364,8 @@ Update a project by id.
|
|
|
1303
1364
|
```
|
|
1304
1365
|
USAGE
|
|
1305
1366
|
$ zitadel projects update ID [--json] [-c <value>] [-s <value>] [-n]
|
|
1306
|
-
[--dry-run] [
|
|
1307
|
-
<value> | --file <value>]
|
|
1367
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--name <value>]
|
|
1368
|
+
[--password-hash <value>] [--data <value> | --file <value>]
|
|
1308
1369
|
|
|
1309
1370
|
ARGUMENTS
|
|
1310
1371
|
ID project id
|
|
@@ -1314,11 +1375,13 @@ FLAGS
|
|
|
1314
1375
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1315
1376
|
an agent.
|
|
1316
1377
|
-s, --server=<value> Override the resolved server URL.
|
|
1378
|
+
-v, --verbose Verbose logging.
|
|
1379
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
1380
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
1317
1381
|
--debug Debug logging.
|
|
1318
1382
|
--dry-run Preview without mutating files or the platform.
|
|
1319
1383
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1320
1384
|
--no-telemetry.
|
|
1321
|
-
--verbose Verbose logging.
|
|
1322
1385
|
|
|
1323
1386
|
RAW BODY FLAGS
|
|
1324
1387
|
--data=<value> Whole body as a JSON object, instead of the field flags.
|
|
@@ -1328,7 +1391,8 @@ GLOBAL FLAGS
|
|
|
1328
1391
|
--json Format output as json.
|
|
1329
1392
|
|
|
1330
1393
|
OPTIONAL FIELD FLAGS
|
|
1331
|
-
--name=<value>
|
|
1394
|
+
--name=<value> The name of the project.
|
|
1395
|
+
--password-hash=<value> The method this project's passwords are hashed with.
|
|
1332
1396
|
|
|
1333
1397
|
DESCRIPTION
|
|
1334
1398
|
Update a project by id.
|
|
@@ -1346,7 +1410,7 @@ Get one release by id.
|
|
|
1346
1410
|
```
|
|
1347
1411
|
USAGE
|
|
1348
1412
|
$ zitadel releases get ID [--json] [-c <value>] [-s <value>] [-n]
|
|
1349
|
-
[--dry-run] [
|
|
1413
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
|
|
1350
1414
|
|
|
1351
1415
|
ARGUMENTS
|
|
1352
1416
|
ID release id
|
|
@@ -1356,13 +1420,15 @@ FLAGS
|
|
|
1356
1420
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1357
1421
|
an agent.
|
|
1358
1422
|
-s, --server=<value> Override the resolved server URL.
|
|
1423
|
+
-v, --verbose Verbose logging.
|
|
1424
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
1425
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
1359
1426
|
--debug Debug logging.
|
|
1360
1427
|
--dry-run Preview without mutating files or the platform.
|
|
1361
1428
|
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
1362
1429
|
the resource's own; `--json` is unaffected.
|
|
1363
1430
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1364
1431
|
--no-telemetry.
|
|
1365
|
-
--verbose Verbose logging.
|
|
1366
1432
|
|
|
1367
1433
|
GLOBAL FLAGS
|
|
1368
1434
|
--json Format output as json.
|
|
@@ -1383,7 +1449,7 @@ List releases.
|
|
|
1383
1449
|
```
|
|
1384
1450
|
USAGE
|
|
1385
1451
|
$ zitadel releases list [--json] [-c <value>] [-s <value>] [-n]
|
|
1386
|
-
[--dry-run] [
|
|
1452
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
|
|
1387
1453
|
--page-token <value>] [--fields <value>] [--plain]
|
|
1388
1454
|
|
|
1389
1455
|
FLAGS
|
|
@@ -1392,6 +1458,9 @@ FLAGS
|
|
|
1392
1458
|
-n, --non-interactive Disable prompts. Required when scripting or running
|
|
1393
1459
|
as an agent.
|
|
1394
1460
|
-s, --server=<value> Override the resolved server URL.
|
|
1461
|
+
-v, --verbose Verbose logging.
|
|
1462
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
1463
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
1395
1464
|
--debug Debug logging.
|
|
1396
1465
|
--dry-run Preview without mutating files or the platform.
|
|
1397
1466
|
--fields=<value> Columns to show, comma-separated dot-paths (e.g.
|
|
@@ -1403,7 +1472,6 @@ FLAGS
|
|
|
1403
1472
|
Implied when stdout is not a terminal.
|
|
1404
1473
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1405
1474
|
--no-telemetry.
|
|
1406
|
-
--verbose Verbose logging.
|
|
1407
1475
|
|
|
1408
1476
|
GLOBAL FLAGS
|
|
1409
1477
|
--json Format output as json.
|
|
@@ -1424,7 +1492,7 @@ Delete the local Zitadel server runtime and data.
|
|
|
1424
1492
|
```
|
|
1425
1493
|
USAGE
|
|
1426
1494
|
$ zitadel reset [--json] [-c <value>] [-s <value>] [-n]
|
|
1427
|
-
[--dry-run] [
|
|
1495
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-f]
|
|
1428
1496
|
|
|
1429
1497
|
FLAGS
|
|
1430
1498
|
-c, --cwd=<value> Project directory to operate on.
|
|
@@ -1433,11 +1501,13 @@ FLAGS
|
|
|
1433
1501
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1434
1502
|
an agent.
|
|
1435
1503
|
-s, --server=<value> Override the resolved server URL.
|
|
1504
|
+
-v, --verbose Verbose logging.
|
|
1505
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
1506
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
1436
1507
|
--debug Debug logging.
|
|
1437
1508
|
--dry-run Preview without mutating files or the platform.
|
|
1438
1509
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1439
1510
|
--no-telemetry.
|
|
1440
|
-
--verbose Verbose logging.
|
|
1441
1511
|
|
|
1442
1512
|
GLOBAL FLAGS
|
|
1443
1513
|
--json Format output as json.
|
|
@@ -1453,18 +1523,20 @@ List the resources this CLI manages and what can be done to each.
|
|
|
1453
1523
|
```
|
|
1454
1524
|
USAGE
|
|
1455
1525
|
$ zitadel resources [--json] [-c <value>] [-s <value>] [-n]
|
|
1456
|
-
[--dry-run] [
|
|
1526
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry]
|
|
1457
1527
|
|
|
1458
1528
|
FLAGS
|
|
1459
1529
|
-c, --cwd=<value> Project directory to operate on.
|
|
1460
1530
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1461
1531
|
an agent.
|
|
1462
1532
|
-s, --server=<value> Override the resolved server URL.
|
|
1533
|
+
-v, --verbose Verbose logging.
|
|
1534
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
1535
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
1463
1536
|
--debug Debug logging.
|
|
1464
1537
|
--dry-run Preview without mutating files or the platform.
|
|
1465
1538
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1466
1539
|
--no-telemetry.
|
|
1467
|
-
--verbose Verbose logging.
|
|
1468
1540
|
|
|
1469
1541
|
GLOBAL FLAGS
|
|
1470
1542
|
--json Format output as json.
|
|
@@ -1487,7 +1559,7 @@ Get one schema by id.
|
|
|
1487
1559
|
```
|
|
1488
1560
|
USAGE
|
|
1489
1561
|
$ zitadel schemas get SCHEMA [--json] [-c <value>] [-s <value>] [-n]
|
|
1490
|
-
[--dry-run] [
|
|
1562
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
|
|
1491
1563
|
|
|
1492
1564
|
ARGUMENTS
|
|
1493
1565
|
SCHEMA object type (current revision) or revision id
|
|
@@ -1497,13 +1569,15 @@ FLAGS
|
|
|
1497
1569
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1498
1570
|
an agent.
|
|
1499
1571
|
-s, --server=<value> Override the resolved server URL.
|
|
1572
|
+
-v, --verbose Verbose logging.
|
|
1573
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
1574
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
1500
1575
|
--debug Debug logging.
|
|
1501
1576
|
--dry-run Preview without mutating files or the platform.
|
|
1502
1577
|
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
1503
1578
|
the resource's own; `--json` is unaffected.
|
|
1504
1579
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1505
1580
|
--no-telemetry.
|
|
1506
|
-
--verbose Verbose logging.
|
|
1507
1581
|
|
|
1508
1582
|
GLOBAL FLAGS
|
|
1509
1583
|
--json Format output as json.
|
|
@@ -1524,7 +1598,7 @@ List schemas.
|
|
|
1524
1598
|
```
|
|
1525
1599
|
USAGE
|
|
1526
1600
|
$ zitadel schemas list [--json] [-c <value>] [-s <value>] [-n]
|
|
1527
|
-
[--dry-run] [
|
|
1601
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
|
|
1528
1602
|
--page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
|
|
1529
1603
|
|
|
1530
1604
|
FLAGS
|
|
@@ -1533,6 +1607,9 @@ FLAGS
|
|
|
1533
1607
|
-n, --non-interactive Disable prompts. Required when scripting or running
|
|
1534
1608
|
as an agent.
|
|
1535
1609
|
-s, --server=<value> Override the resolved server URL.
|
|
1610
|
+
-v, --verbose Verbose logging.
|
|
1611
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
1612
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
1536
1613
|
--debug Debug logging.
|
|
1537
1614
|
--dry-run Preview without mutating files or the platform.
|
|
1538
1615
|
--fields=<value> Columns to show, comma-separated dot-paths (e.g.
|
|
@@ -1547,7 +1624,6 @@ FLAGS
|
|
|
1547
1624
|
Implied when stdout is not a terminal.
|
|
1548
1625
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1549
1626
|
--no-telemetry.
|
|
1550
|
-
--verbose Verbose logging.
|
|
1551
1627
|
|
|
1552
1628
|
GLOBAL FLAGS
|
|
1553
1629
|
--json Format output as json.
|
|
@@ -1587,7 +1663,7 @@ Get one session by id.
|
|
|
1587
1663
|
```
|
|
1588
1664
|
USAGE
|
|
1589
1665
|
$ zitadel sessions get ID [--json] [-c <value>] [-s <value>] [-n]
|
|
1590
|
-
[--dry-run] [
|
|
1666
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
|
|
1591
1667
|
|
|
1592
1668
|
ARGUMENTS
|
|
1593
1669
|
ID session id
|
|
@@ -1597,13 +1673,15 @@ FLAGS
|
|
|
1597
1673
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1598
1674
|
an agent.
|
|
1599
1675
|
-s, --server=<value> Override the resolved server URL.
|
|
1676
|
+
-v, --verbose Verbose logging.
|
|
1677
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
1678
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
1600
1679
|
--debug Debug logging.
|
|
1601
1680
|
--dry-run Preview without mutating files or the platform.
|
|
1602
1681
|
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
1603
1682
|
the resource's own; `--json` is unaffected.
|
|
1604
1683
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1605
1684
|
--no-telemetry.
|
|
1606
|
-
--verbose Verbose logging.
|
|
1607
1685
|
|
|
1608
1686
|
GLOBAL FLAGS
|
|
1609
1687
|
--json Format output as json.
|
|
@@ -1624,7 +1702,7 @@ List sessions.
|
|
|
1624
1702
|
```
|
|
1625
1703
|
USAGE
|
|
1626
1704
|
$ zitadel sessions list [--json] [-c <value>] [-s <value>] [-n]
|
|
1627
|
-
[--dry-run] [
|
|
1705
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
|
|
1628
1706
|
--page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
|
|
1629
1707
|
[--sort <value>]
|
|
1630
1708
|
|
|
@@ -1641,6 +1719,13 @@ FLAGS
|
|
|
1641
1719
|
-s, --server=<value>
|
|
1642
1720
|
Override the resolved server URL.
|
|
1643
1721
|
|
|
1722
|
+
-v, --verbose
|
|
1723
|
+
Verbose logging.
|
|
1724
|
+
|
|
1725
|
+
--[no-]color
|
|
1726
|
+
Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are
|
|
1727
|
+
honored too.
|
|
1728
|
+
|
|
1644
1729
|
--debug
|
|
1645
1730
|
Debug logging.
|
|
1646
1731
|
|
|
@@ -1677,9 +1762,6 @@ FLAGS
|
|
|
1677
1762
|
--[no-]telemetry
|
|
1678
1763
|
Send anonymous usage analytics. Disable with --no-telemetry.
|
|
1679
1764
|
|
|
1680
|
-
--verbose
|
|
1681
|
-
Verbose logging.
|
|
1682
|
-
|
|
1683
1765
|
GLOBAL FLAGS
|
|
1684
1766
|
--json Format output as json.
|
|
1685
1767
|
|
|
@@ -1701,7 +1783,7 @@ Revoke a session by id.
|
|
|
1701
1783
|
```
|
|
1702
1784
|
USAGE
|
|
1703
1785
|
$ zitadel sessions revoke ID [--json] [-c <value>] [-s <value>] [-n]
|
|
1704
|
-
[--dry-run] [
|
|
1786
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-f]
|
|
1705
1787
|
|
|
1706
1788
|
ARGUMENTS
|
|
1707
1789
|
ID session id
|
|
@@ -1713,11 +1795,13 @@ FLAGS
|
|
|
1713
1795
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1714
1796
|
an agent.
|
|
1715
1797
|
-s, --server=<value> Override the resolved server URL.
|
|
1798
|
+
-v, --verbose Verbose logging.
|
|
1799
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
1800
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
1716
1801
|
--debug Debug logging.
|
|
1717
1802
|
--dry-run Preview without mutating files or the platform.
|
|
1718
1803
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1719
1804
|
--no-telemetry.
|
|
1720
|
-
--verbose Verbose logging.
|
|
1721
1805
|
|
|
1722
1806
|
GLOBAL FLAGS
|
|
1723
1807
|
--json Format output as json.
|
|
@@ -1736,17 +1820,19 @@ Create a Zitadel project and scaffold local auth.
|
|
|
1736
1820
|
```
|
|
1737
1821
|
USAGE
|
|
1738
1822
|
$ zitadel setup [--json] [-c <value>] [-s <value>] [-n]
|
|
1739
|
-
[--dry-run] [
|
|
1823
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-f] [--framework
|
|
1740
1824
|
next|nuxt|react|vue|solid|svelte|qwik|angular] [--renderer react]
|
|
1741
1825
|
[--dev-port <value>] [--skip-install] [--preset
|
|
1742
|
-
password-first|passkey-first] [--use-case minimal|consumer|business]
|
|
1826
|
+
password-first|passkey-first] [--use-case minimal|consumer|business] [--sso
|
|
1827
|
+
google] [--sso-client-id <value>]
|
|
1743
1828
|
|
|
1744
1829
|
FLAGS
|
|
1745
1830
|
-c, --cwd=<value>
|
|
1746
1831
|
Project directory to operate on.
|
|
1747
1832
|
|
|
1748
1833
|
-f, --force
|
|
1749
|
-
Overwrite managed files that already exist
|
|
1834
|
+
Overwrite managed files that already exist, and scaffold into a non-empty
|
|
1835
|
+
directory.
|
|
1750
1836
|
|
|
1751
1837
|
-n, --non-interactive
|
|
1752
1838
|
Disable prompts. Required when scripting or running as an agent.
|
|
@@ -1754,6 +1840,13 @@ FLAGS
|
|
|
1754
1840
|
-s, --server=<value>
|
|
1755
1841
|
Override the resolved server URL.
|
|
1756
1842
|
|
|
1843
|
+
-v, --verbose
|
|
1844
|
+
Verbose logging.
|
|
1845
|
+
|
|
1846
|
+
--[no-]color
|
|
1847
|
+
Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are
|
|
1848
|
+
honored too.
|
|
1849
|
+
|
|
1757
1850
|
--debug
|
|
1758
1851
|
Debug logging.
|
|
1759
1852
|
|
|
@@ -1781,6 +1874,16 @@ FLAGS
|
|
|
1781
1874
|
--skip-install
|
|
1782
1875
|
Do not install dependencies after setup updates package.json.
|
|
1783
1876
|
|
|
1877
|
+
--sso=<option>
|
|
1878
|
+
Social sign-in provider to enable while scaffolding, e.g. google. Skips the
|
|
1879
|
+
wizard's provider question; needs --sso-client-id, and the OAuth application
|
|
1880
|
+
must already be registered with the provider. Pipe the client secret in on
|
|
1881
|
+
stdin; never pass it as a flag.
|
|
1882
|
+
<options: google>
|
|
1883
|
+
|
|
1884
|
+
--sso-client-id=<value>
|
|
1885
|
+
Client id of the OAuth application registered with the --sso provider.
|
|
1886
|
+
|
|
1784
1887
|
--[no-]telemetry
|
|
1785
1888
|
Send anonymous usage analytics. Disable with --no-telemetry.
|
|
1786
1889
|
|
|
@@ -1789,9 +1892,6 @@ FLAGS
|
|
|
1789
1892
|
minimal).
|
|
1790
1893
|
<options: minimal|consumer|business>
|
|
1791
1894
|
|
|
1792
|
-
--verbose
|
|
1793
|
-
Verbose logging.
|
|
1794
|
-
|
|
1795
1895
|
GLOBAL FLAGS
|
|
1796
1896
|
--json Format output as json.
|
|
1797
1897
|
|
|
@@ -1804,6 +1904,49 @@ EXAMPLES
|
|
|
1804
1904
|
$ zitadel setup --framework react --dev-port 3000
|
|
1805
1905
|
```
|
|
1806
1906
|
|
|
1907
|
+
## `zitadel sso enable`
|
|
1908
|
+
|
|
1909
|
+
Enable an identity provider for a user schema.
|
|
1910
|
+
|
|
1911
|
+
```
|
|
1912
|
+
USAGE
|
|
1913
|
+
$ zitadel sso enable [--json] [-c <value>] [-s <value>] [-n]
|
|
1914
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--provider google]
|
|
1915
|
+
[--schema <value>] [--client-id <value>]
|
|
1916
|
+
|
|
1917
|
+
FLAGS
|
|
1918
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1919
|
+
-n, --non-interactive Disable prompts. Required when scripting or running
|
|
1920
|
+
as an agent.
|
|
1921
|
+
-s, --server=<value> Override the resolved server URL.
|
|
1922
|
+
-v, --verbose Verbose logging.
|
|
1923
|
+
--client-id=<value> Client id of the application registered with the
|
|
1924
|
+
provider.
|
|
1925
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
1926
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
1927
|
+
--debug Debug logging.
|
|
1928
|
+
--dry-run Preview without mutating files or the platform.
|
|
1929
|
+
--provider=<option> Identity provider to enable.
|
|
1930
|
+
<options: google>
|
|
1931
|
+
--schema=<value> User schema to change. Required when the Project has
|
|
1932
|
+
more than one.
|
|
1933
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1934
|
+
--no-telemetry.
|
|
1935
|
+
|
|
1936
|
+
GLOBAL FLAGS
|
|
1937
|
+
--json Format output as json.
|
|
1938
|
+
|
|
1939
|
+
DESCRIPTION
|
|
1940
|
+
Enable an identity provider for a user schema.
|
|
1941
|
+
|
|
1942
|
+
EXAMPLES
|
|
1943
|
+
$ zitadel sso enable --provider google
|
|
1944
|
+
|
|
1945
|
+
$ zitadel sso enable --provider google --schema customers
|
|
1946
|
+
|
|
1947
|
+
$ zitadel sso enable --provider google --client-id 1234-abc.apps.googleusercontent.com --non-interactive < secret.txt
|
|
1948
|
+
```
|
|
1949
|
+
|
|
1807
1950
|
## `zitadel start`
|
|
1808
1951
|
|
|
1809
1952
|
Start a local Zitadel server.
|
|
@@ -1811,7 +1954,7 @@ Start a local Zitadel server.
|
|
|
1811
1954
|
```
|
|
1812
1955
|
USAGE
|
|
1813
1956
|
$ zitadel start [--json] [-c <value>] [-s <value>] [-n]
|
|
1814
|
-
[--dry-run] [
|
|
1957
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--image <value>] [--port
|
|
1815
1958
|
<value>] [--runtime binary|docker]
|
|
1816
1959
|
|
|
1817
1960
|
FLAGS
|
|
@@ -1819,6 +1962,9 @@ FLAGS
|
|
|
1819
1962
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1820
1963
|
an agent.
|
|
1821
1964
|
-s, --server=<value> Override the resolved server URL.
|
|
1965
|
+
-v, --verbose Verbose logging.
|
|
1966
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
1967
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
1822
1968
|
--debug Debug logging.
|
|
1823
1969
|
--dry-run Preview without mutating files or the platform.
|
|
1824
1970
|
--image=<value> Container image to run.
|
|
@@ -1827,7 +1973,6 @@ FLAGS
|
|
|
1827
1973
|
<options: binary|docker>
|
|
1828
1974
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1829
1975
|
--no-telemetry.
|
|
1830
|
-
--verbose Verbose logging.
|
|
1831
1976
|
|
|
1832
1977
|
GLOBAL FLAGS
|
|
1833
1978
|
--json Format output as json.
|
|
@@ -1843,18 +1988,20 @@ Summarize the local Zitadel server and project state.
|
|
|
1843
1988
|
```
|
|
1844
1989
|
USAGE
|
|
1845
1990
|
$ zitadel status [--json] [-c <value>] [-s <value>] [-n]
|
|
1846
|
-
[--dry-run] [
|
|
1991
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry]
|
|
1847
1992
|
|
|
1848
1993
|
FLAGS
|
|
1849
1994
|
-c, --cwd=<value> Project directory to operate on.
|
|
1850
1995
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1851
1996
|
an agent.
|
|
1852
1997
|
-s, --server=<value> Override the resolved server URL.
|
|
1998
|
+
-v, --verbose Verbose logging.
|
|
1999
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2000
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
1853
2001
|
--debug Debug logging.
|
|
1854
2002
|
--dry-run Preview without mutating files or the platform.
|
|
1855
2003
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1856
2004
|
--no-telemetry.
|
|
1857
|
-
--verbose Verbose logging.
|
|
1858
2005
|
|
|
1859
2006
|
GLOBAL FLAGS
|
|
1860
2007
|
--json Format output as json.
|
|
@@ -1870,20 +2017,22 @@ Stop the local Zitadel server.
|
|
|
1870
2017
|
```
|
|
1871
2018
|
USAGE
|
|
1872
2019
|
$ zitadel stop [--json] [-c <value>] [-s <value>] [-n]
|
|
1873
|
-
[--dry-run] [
|
|
2020
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--all]
|
|
1874
2021
|
|
|
1875
2022
|
FLAGS
|
|
1876
2023
|
-c, --cwd=<value> Project directory to operate on.
|
|
1877
2024
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1878
2025
|
an agent.
|
|
1879
2026
|
-s, --server=<value> Override the resolved server URL.
|
|
2027
|
+
-v, --verbose Verbose logging.
|
|
1880
2028
|
--all Stop all discovered CLI-managed local Zitadel runtime
|
|
1881
2029
|
processes.
|
|
2030
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2031
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
1882
2032
|
--debug Debug logging.
|
|
1883
2033
|
--dry-run Preview without mutating files or the platform.
|
|
1884
2034
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1885
2035
|
--no-telemetry.
|
|
1886
|
-
--verbose Verbose logging.
|
|
1887
2036
|
|
|
1888
2037
|
GLOBAL FLAGS
|
|
1889
2038
|
--json Format output as json.
|
|
@@ -1899,7 +2048,7 @@ Create a team.
|
|
|
1899
2048
|
```
|
|
1900
2049
|
USAGE
|
|
1901
2050
|
$ zitadel teams create [--json] [-c <value>] [-s <value>] [-n]
|
|
1902
|
-
[--dry-run] [
|
|
2051
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--name <value>] [--data
|
|
1903
2052
|
<value> | --file <value>]
|
|
1904
2053
|
|
|
1905
2054
|
FLAGS
|
|
@@ -1907,11 +2056,13 @@ FLAGS
|
|
|
1907
2056
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1908
2057
|
an agent.
|
|
1909
2058
|
-s, --server=<value> Override the resolved server URL.
|
|
2059
|
+
-v, --verbose Verbose logging.
|
|
2060
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2061
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
1910
2062
|
--debug Debug logging.
|
|
1911
2063
|
--dry-run Preview without mutating files or the platform.
|
|
1912
2064
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1913
2065
|
--no-telemetry.
|
|
1914
|
-
--verbose Verbose logging.
|
|
1915
2066
|
|
|
1916
2067
|
RAW BODY FLAGS
|
|
1917
2068
|
--data=<value> Whole body as a JSON object, instead of the field flags.
|
|
@@ -1941,7 +2092,7 @@ Deactivate a team by id.
|
|
|
1941
2092
|
```
|
|
1942
2093
|
USAGE
|
|
1943
2094
|
$ zitadel teams deactivate ID [--json] [-c <value>] [-s <value>] [-n]
|
|
1944
|
-
[--dry-run] [
|
|
2095
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-f]
|
|
1945
2096
|
|
|
1946
2097
|
ARGUMENTS
|
|
1947
2098
|
ID team id
|
|
@@ -1953,11 +2104,13 @@ FLAGS
|
|
|
1953
2104
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1954
2105
|
an agent.
|
|
1955
2106
|
-s, --server=<value> Override the resolved server URL.
|
|
2107
|
+
-v, --verbose Verbose logging.
|
|
2108
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2109
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
1956
2110
|
--debug Debug logging.
|
|
1957
2111
|
--dry-run Preview without mutating files or the platform.
|
|
1958
2112
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1959
2113
|
--no-telemetry.
|
|
1960
|
-
--verbose Verbose logging.
|
|
1961
2114
|
|
|
1962
2115
|
GLOBAL FLAGS
|
|
1963
2116
|
--json Format output as json.
|
|
@@ -1976,7 +2129,7 @@ Get one team by id.
|
|
|
1976
2129
|
```
|
|
1977
2130
|
USAGE
|
|
1978
2131
|
$ zitadel teams get ID [--json] [-c <value>] [-s <value>] [-n]
|
|
1979
|
-
[--dry-run] [
|
|
2132
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
|
|
1980
2133
|
|
|
1981
2134
|
ARGUMENTS
|
|
1982
2135
|
ID team id
|
|
@@ -1986,13 +2139,15 @@ FLAGS
|
|
|
1986
2139
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1987
2140
|
an agent.
|
|
1988
2141
|
-s, --server=<value> Override the resolved server URL.
|
|
2142
|
+
-v, --verbose Verbose logging.
|
|
2143
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2144
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
1989
2145
|
--debug Debug logging.
|
|
1990
2146
|
--dry-run Preview without mutating files or the platform.
|
|
1991
2147
|
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
1992
2148
|
the resource's own; `--json` is unaffected.
|
|
1993
2149
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1994
2150
|
--no-telemetry.
|
|
1995
|
-
--verbose Verbose logging.
|
|
1996
2151
|
|
|
1997
2152
|
GLOBAL FLAGS
|
|
1998
2153
|
--json Format output as json.
|
|
@@ -2013,7 +2168,7 @@ List teams.
|
|
|
2013
2168
|
```
|
|
2014
2169
|
USAGE
|
|
2015
2170
|
$ zitadel teams list [--json] [-c <value>] [-s <value>] [-n]
|
|
2016
|
-
[--dry-run] [
|
|
2171
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
|
|
2017
2172
|
--page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
|
|
2018
2173
|
[--sort <value>]
|
|
2019
2174
|
|
|
@@ -2030,6 +2185,13 @@ FLAGS
|
|
|
2030
2185
|
-s, --server=<value>
|
|
2031
2186
|
Override the resolved server URL.
|
|
2032
2187
|
|
|
2188
|
+
-v, --verbose
|
|
2189
|
+
Verbose logging.
|
|
2190
|
+
|
|
2191
|
+
--[no-]color
|
|
2192
|
+
Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are
|
|
2193
|
+
honored too.
|
|
2194
|
+
|
|
2033
2195
|
--debug
|
|
2034
2196
|
Debug logging.
|
|
2035
2197
|
|
|
@@ -2064,9 +2226,6 @@ FLAGS
|
|
|
2064
2226
|
--[no-]telemetry
|
|
2065
2227
|
Send anonymous usage analytics. Disable with --no-telemetry.
|
|
2066
2228
|
|
|
2067
|
-
--verbose
|
|
2068
|
-
Verbose logging.
|
|
2069
|
-
|
|
2070
2229
|
GLOBAL FLAGS
|
|
2071
2230
|
--json Format output as json.
|
|
2072
2231
|
|
|
@@ -2088,7 +2247,7 @@ Update a team by id.
|
|
|
2088
2247
|
```
|
|
2089
2248
|
USAGE
|
|
2090
2249
|
$ zitadel teams update ID [--json] [-c <value>] [-s <value>] [-n]
|
|
2091
|
-
[--dry-run] [
|
|
2250
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--name <value>] [--data
|
|
2092
2251
|
<value> | --file <value>]
|
|
2093
2252
|
|
|
2094
2253
|
ARGUMENTS
|
|
@@ -2099,11 +2258,13 @@ FLAGS
|
|
|
2099
2258
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2100
2259
|
an agent.
|
|
2101
2260
|
-s, --server=<value> Override the resolved server URL.
|
|
2261
|
+
-v, --verbose Verbose logging.
|
|
2262
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2263
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
2102
2264
|
--debug Debug logging.
|
|
2103
2265
|
--dry-run Preview without mutating files or the platform.
|
|
2104
2266
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2105
2267
|
--no-telemetry.
|
|
2106
|
-
--verbose Verbose logging.
|
|
2107
2268
|
|
|
2108
2269
|
RAW BODY FLAGS
|
|
2109
2270
|
--data=<value> Whole body as a JSON object, instead of the field flags.
|
|
@@ -2131,7 +2292,7 @@ Remove managed files and local Zitadel state.
|
|
|
2131
2292
|
```
|
|
2132
2293
|
USAGE
|
|
2133
2294
|
$ zitadel uninstall [--json] [-c <value>] [-s <value>] [-n]
|
|
2134
|
-
[--dry-run] [
|
|
2295
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-f]
|
|
2135
2296
|
|
|
2136
2297
|
FLAGS
|
|
2137
2298
|
-c, --cwd=<value> Project directory to operate on.
|
|
@@ -2140,11 +2301,13 @@ FLAGS
|
|
|
2140
2301
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2141
2302
|
an agent.
|
|
2142
2303
|
-s, --server=<value> Override the resolved server URL.
|
|
2304
|
+
-v, --verbose Verbose logging.
|
|
2305
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2306
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
2143
2307
|
--debug Debug logging.
|
|
2144
2308
|
--dry-run Preview without mutating files or the platform.
|
|
2145
2309
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2146
2310
|
--no-telemetry.
|
|
2147
|
-
--verbose Verbose logging.
|
|
2148
2311
|
|
|
2149
2312
|
GLOBAL FLAGS
|
|
2150
2313
|
--json Format output as json.
|
|
@@ -2163,7 +2326,7 @@ Create an user.
|
|
|
2163
2326
|
```
|
|
2164
2327
|
USAGE
|
|
2165
2328
|
$ zitadel users create [--json] [-c <value>] [-s <value>] [-n]
|
|
2166
|
-
[--dry-run] [
|
|
2329
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--schema <value>]
|
|
2167
2330
|
[--attributes <value>...] [--data <value> | --file <value>]
|
|
2168
2331
|
|
|
2169
2332
|
FLAGS
|
|
@@ -2171,11 +2334,13 @@ FLAGS
|
|
|
2171
2334
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2172
2335
|
an agent.
|
|
2173
2336
|
-s, --server=<value> Override the resolved server URL.
|
|
2337
|
+
-v, --verbose Verbose logging.
|
|
2338
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2339
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
2174
2340
|
--debug Debug logging.
|
|
2175
2341
|
--dry-run Preview without mutating files or the platform.
|
|
2176
2342
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2177
2343
|
--no-telemetry.
|
|
2178
|
-
--verbose Verbose logging.
|
|
2179
2344
|
|
|
2180
2345
|
REQUIRED FIELD FLAGS
|
|
2181
2346
|
--attributes=<value>... (required) Repeatable attributes entry: key=value for
|
|
@@ -2209,7 +2374,7 @@ Delete an user by id.
|
|
|
2209
2374
|
```
|
|
2210
2375
|
USAGE
|
|
2211
2376
|
$ zitadel users delete ID [--json] [-c <value>] [-s <value>] [-n]
|
|
2212
|
-
[--dry-run] [
|
|
2377
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-f]
|
|
2213
2378
|
|
|
2214
2379
|
ARGUMENTS
|
|
2215
2380
|
ID user id
|
|
@@ -2221,11 +2386,13 @@ FLAGS
|
|
|
2221
2386
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2222
2387
|
an agent.
|
|
2223
2388
|
-s, --server=<value> Override the resolved server URL.
|
|
2389
|
+
-v, --verbose Verbose logging.
|
|
2390
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2391
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
2224
2392
|
--debug Debug logging.
|
|
2225
2393
|
--dry-run Preview without mutating files or the platform.
|
|
2226
2394
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2227
2395
|
--no-telemetry.
|
|
2228
|
-
--verbose Verbose logging.
|
|
2229
2396
|
|
|
2230
2397
|
GLOBAL FLAGS
|
|
2231
2398
|
--json Format output as json.
|
|
@@ -2244,7 +2411,7 @@ Get one user by id.
|
|
|
2244
2411
|
```
|
|
2245
2412
|
USAGE
|
|
2246
2413
|
$ zitadel users get ID [--json] [-c <value>] [-s <value>] [-n]
|
|
2247
|
-
[--dry-run] [
|
|
2414
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
|
|
2248
2415
|
|
|
2249
2416
|
ARGUMENTS
|
|
2250
2417
|
ID user id
|
|
@@ -2254,13 +2421,15 @@ FLAGS
|
|
|
2254
2421
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2255
2422
|
an agent.
|
|
2256
2423
|
-s, --server=<value> Override the resolved server URL.
|
|
2424
|
+
-v, --verbose Verbose logging.
|
|
2425
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2426
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
2257
2427
|
--debug Debug logging.
|
|
2258
2428
|
--dry-run Preview without mutating files or the platform.
|
|
2259
2429
|
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
2260
2430
|
the resource's own; `--json` is unaffected.
|
|
2261
2431
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2262
2432
|
--no-telemetry.
|
|
2263
|
-
--verbose Verbose logging.
|
|
2264
2433
|
|
|
2265
2434
|
GLOBAL FLAGS
|
|
2266
2435
|
--json Format output as json.
|
|
@@ -2281,7 +2450,7 @@ List users.
|
|
|
2281
2450
|
```
|
|
2282
2451
|
USAGE
|
|
2283
2452
|
$ zitadel users list [--json] [-c <value>] [-s <value>] [-n]
|
|
2284
|
-
[--dry-run] [
|
|
2453
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
|
|
2285
2454
|
--page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
|
|
2286
2455
|
[--sort <value>]
|
|
2287
2456
|
|
|
@@ -2298,6 +2467,13 @@ FLAGS
|
|
|
2298
2467
|
-s, --server=<value>
|
|
2299
2468
|
Override the resolved server URL.
|
|
2300
2469
|
|
|
2470
|
+
-v, --verbose
|
|
2471
|
+
Verbose logging.
|
|
2472
|
+
|
|
2473
|
+
--[no-]color
|
|
2474
|
+
Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are
|
|
2475
|
+
honored too.
|
|
2476
|
+
|
|
2301
2477
|
--debug
|
|
2302
2478
|
Debug logging.
|
|
2303
2479
|
|
|
@@ -2338,9 +2514,6 @@ FLAGS
|
|
|
2338
2514
|
--[no-]telemetry
|
|
2339
2515
|
Send anonymous usage analytics. Disable with --no-telemetry.
|
|
2340
2516
|
|
|
2341
|
-
--verbose
|
|
2342
|
-
Verbose logging.
|
|
2343
|
-
|
|
2344
2517
|
GLOBAL FLAGS
|
|
2345
2518
|
--json Format output as json.
|
|
2346
2519
|
|
|
@@ -2362,7 +2535,7 @@ Update an user by id.
|
|
|
2362
2535
|
```
|
|
2363
2536
|
USAGE
|
|
2364
2537
|
$ zitadel users update ID [--json] [-c <value>] [-s <value>] [-n]
|
|
2365
|
-
[--dry-run] [
|
|
2538
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--schema <value>]
|
|
2366
2539
|
[--attributes <value>...] [--data <value> | --file <value>]
|
|
2367
2540
|
|
|
2368
2541
|
ARGUMENTS
|
|
@@ -2373,11 +2546,13 @@ FLAGS
|
|
|
2373
2546
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2374
2547
|
an agent.
|
|
2375
2548
|
-s, --server=<value> Override the resolved server URL.
|
|
2549
|
+
-v, --verbose Verbose logging.
|
|
2550
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2551
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
2376
2552
|
--debug Debug logging.
|
|
2377
2553
|
--dry-run Preview without mutating files or the platform.
|
|
2378
2554
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2379
2555
|
--no-telemetry.
|
|
2380
|
-
--verbose Verbose logging.
|
|
2381
2556
|
|
|
2382
2557
|
OPTIONAL FIELD FLAGS
|
|
2383
2558
|
--attributes=<value>... Repeatable attributes entry: key=value for a string,
|
|
@@ -2407,7 +2582,7 @@ Delete one variable from the project.
|
|
|
2407
2582
|
```
|
|
2408
2583
|
USAGE
|
|
2409
2584
|
$ zitadel variables delete NAME [--json] [-c <value>] [-s <value>] [-n]
|
|
2410
|
-
[--dry-run] [
|
|
2585
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--project-level] [-f]
|
|
2411
2586
|
|
|
2412
2587
|
ARGUMENTS
|
|
2413
2588
|
NAME Variable name to delete.
|
|
@@ -2419,13 +2594,15 @@ FLAGS
|
|
|
2419
2594
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2420
2595
|
an agent.
|
|
2421
2596
|
-s, --server=<value> Override the resolved server URL.
|
|
2597
|
+
-v, --verbose Verbose logging.
|
|
2598
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2599
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
2422
2600
|
--debug Debug logging.
|
|
2423
2601
|
--dry-run Preview without mutating files or the platform.
|
|
2424
2602
|
--project-level Address the project level. Required: it is the only
|
|
2425
2603
|
owner the CLI can address today.
|
|
2426
2604
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2427
2605
|
--no-telemetry.
|
|
2428
|
-
--verbose Verbose logging.
|
|
2429
2606
|
|
|
2430
2607
|
GLOBAL FLAGS
|
|
2431
2608
|
--json Format output as json.
|
|
@@ -2446,7 +2623,7 @@ Get one variable from the project.
|
|
|
2446
2623
|
```
|
|
2447
2624
|
USAGE
|
|
2448
2625
|
$ zitadel variables get NAME [--json] [-c <value>] [-s <value>] [-n]
|
|
2449
|
-
[--dry-run] [
|
|
2626
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--project-level]
|
|
2450
2627
|
|
|
2451
2628
|
ARGUMENTS
|
|
2452
2629
|
NAME Variable name to read.
|
|
@@ -2456,13 +2633,15 @@ FLAGS
|
|
|
2456
2633
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2457
2634
|
an agent.
|
|
2458
2635
|
-s, --server=<value> Override the resolved server URL.
|
|
2636
|
+
-v, --verbose Verbose logging.
|
|
2637
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2638
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
2459
2639
|
--debug Debug logging.
|
|
2460
2640
|
--dry-run Preview without mutating files or the platform.
|
|
2461
2641
|
--project-level Address the project level. Required: it is the only
|
|
2462
2642
|
owner the CLI can address today.
|
|
2463
2643
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2464
2644
|
--no-telemetry.
|
|
2465
|
-
--verbose Verbose logging.
|
|
2466
2645
|
|
|
2467
2646
|
GLOBAL FLAGS
|
|
2468
2647
|
--json Format output as json.
|
|
@@ -2483,13 +2662,17 @@ List the variables entered on the project.
|
|
|
2483
2662
|
```
|
|
2484
2663
|
USAGE
|
|
2485
2664
|
$ zitadel variables list [--json] [-c <value>] [-s <value>] [-n]
|
|
2486
|
-
[--dry-run] [
|
|
2665
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--project-level]
|
|
2666
|
+
[--plain]
|
|
2487
2667
|
|
|
2488
2668
|
FLAGS
|
|
2489
2669
|
-c, --cwd=<value> Project directory to operate on.
|
|
2490
2670
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2491
2671
|
an agent.
|
|
2492
2672
|
-s, --server=<value> Override the resolved server URL.
|
|
2673
|
+
-v, --verbose Verbose logging.
|
|
2674
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2675
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
2493
2676
|
--debug Debug logging.
|
|
2494
2677
|
--dry-run Preview without mutating files or the platform.
|
|
2495
2678
|
--plain Tab-separated rows with no header, for piping. Implied
|
|
@@ -2498,7 +2681,6 @@ FLAGS
|
|
|
2498
2681
|
owner the CLI can address today.
|
|
2499
2682
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2500
2683
|
--no-telemetry.
|
|
2501
|
-
--verbose Verbose logging.
|
|
2502
2684
|
|
|
2503
2685
|
GLOBAL FLAGS
|
|
2504
2686
|
--json Format output as json.
|
|
@@ -2519,8 +2701,8 @@ Set one variable on the project.
|
|
|
2519
2701
|
```
|
|
2520
2702
|
USAGE
|
|
2521
2703
|
$ zitadel variables set NAME [--json] [-c <value>] [-s <value>] [-n]
|
|
2522
|
-
[--dry-run] [
|
|
2523
|
-
[--as string|number|boolean]
|
|
2704
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--project-level]
|
|
2705
|
+
[--secret] [--as string|number|boolean]
|
|
2524
2706
|
|
|
2525
2707
|
ARGUMENTS
|
|
2526
2708
|
NAME Variable name (letters, digits and underscores).
|
|
@@ -2530,10 +2712,13 @@ FLAGS
|
|
|
2530
2712
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2531
2713
|
an agent.
|
|
2532
2714
|
-s, --server=<value> Override the resolved server URL.
|
|
2715
|
+
-v, --verbose Verbose logging.
|
|
2533
2716
|
--as=<option> [default: string] Store the value as this JSON type. A
|
|
2534
2717
|
reference to the whole field resolves to that type, so
|
|
2535
2718
|
a number stays a number.
|
|
2536
2719
|
<options: string|number|boolean>
|
|
2720
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2721
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
2537
2722
|
--debug Debug logging.
|
|
2538
2723
|
--dry-run Preview without mutating files or the platform.
|
|
2539
2724
|
--project-level Address the project level. Required: it is the only
|
|
@@ -2542,7 +2727,6 @@ FLAGS
|
|
|
2542
2727
|
never read back.
|
|
2543
2728
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2544
2729
|
--no-telemetry.
|
|
2545
|
-
--verbose Verbose logging.
|
|
2546
2730
|
|
|
2547
2731
|
GLOBAL FLAGS
|
|
2548
2732
|
--json Format output as json.
|