@zitadel/cli 1.0.0-alpha.23 → 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 +766 -724
- 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 +3185 -1270
- 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 +516 -578
- package/package.json +16 -9
- package/skills/zitadel-cli/SKILL.md +260 -0
- package/skills/zitadel-cli/references/driving-login-ui.md +72 -0
- package/SKILLS.md +0 -529
package/README.md
CHANGED
|
@@ -35,9 +35,11 @@ npm run dev
|
|
|
35
35
|
under `.zitadel/local/` (SQLite by default). Remote-server setup can use
|
|
36
36
|
`--server <url>` without starting a local runtime. Use `--runtime docker`,
|
|
37
37
|
`--image`, or `ZITADEL_LOCAL_IMAGE` for advanced Docker backend debugging.
|
|
38
|
+
`start` also creates a local admin, `admin@zitadel.localhost`, and ends by
|
|
39
|
+
printing a one-time sign-in link for the management console.
|
|
38
40
|
`setup --server local` creates a project on that local server, asks which
|
|
39
|
-
framework to scaffold when the directory is fresh
|
|
40
|
-
|
|
41
|
+
framework to scaffold when the directory is fresh, writes the app into the
|
|
42
|
+
current directory, and scaffolds the framework's
|
|
41
43
|
idiomatic auth routes plus the proxy layer — for Next.js that means
|
|
42
44
|
`app/login`, `app/register`, `app/profile`, and `proxy.ts` for Next 16+ or
|
|
43
45
|
`middleware.ts` for older versions; other frameworks get their equivalents
|
|
@@ -46,6 +48,11 @@ embedding posture from the app instead of assuming a fresh skeleton: the
|
|
|
46
48
|
scaffolded pages take the `variant="widget"` posture inside your app's own
|
|
47
49
|
shell, recorded in the scaffold manifest and verified by `doctor`. Fresh
|
|
48
50
|
scaffolds also replace the starter home page with a redirect to `/login`.
|
|
51
|
+
Against a local server started with the default platform bootstrap, setup also
|
|
52
|
+
attaches the new project to the local admin's team, so the project is owned
|
|
53
|
+
from the start and `zitadel claim` reports it as already owned. If you opted
|
|
54
|
+
out with `NEXTGEN_PLATFORM_BOOTSTRAP_PROJECT=false`, there is no local admin
|
|
55
|
+
and the project has no owning team; that server cannot claim projects.
|
|
49
56
|
Setup writes `.env.local` and `.zitadel/`, and installs
|
|
50
57
|
dependencies with the detected package manager. Pass `--skip-install` to install
|
|
51
58
|
them yourself. The project's default user schema and login flow are provisioned
|
|
@@ -54,7 +61,9 @@ from versioned local defaults; setup writes editable copies into
|
|
|
54
61
|
`.zitadel/flows/default-login.json`, uploads them through the schema and flow
|
|
55
62
|
APIs, then seeds `.zitadel/state.json` so `zitadel plan` is immediately empty.
|
|
56
63
|
Open the dev server URL printed by your framework, register a user, log out,
|
|
57
|
-
log back in, and end on the signed-in profile page.
|
|
64
|
+
log back in, and end on the signed-in profile page. That user is an end user
|
|
65
|
+
of your app. The management console is a separate sign-in: run
|
|
66
|
+
`zitadel console` for a fresh one-time link as the local admin.
|
|
58
67
|
|
|
59
68
|
For a reproducible tester report, use the exact alpha train from the GitHub
|
|
60
69
|
Release:
|
|
@@ -76,7 +85,7 @@ plus a `login.liquid` LiquidJS template), then re-run `zitadel plan` and
|
|
|
76
85
|
`zitadel apply`. Server-provisioned defaults remain a fallback for non-CLI
|
|
77
86
|
project creation, but CLI-created projects are authored from local files first.
|
|
78
87
|
Login templates are supported: scaffold them with the `branding eject` command
|
|
79
|
-
(`--design centered|
|
|
88
|
+
(`--design centered|minimal`); setup never does;
|
|
80
89
|
every edit publishes a new immutable branding revision and the login serves
|
|
81
90
|
the newest one. Flows work the same way: every edit publishes a new immutable
|
|
82
91
|
flow revision. A page that pins `flow-name` gets that flow's newest revision. A
|
|
@@ -89,21 +98,26 @@ and agent UIs may display stderr package-manager progress together with stdout.
|
|
|
89
98
|
|
|
90
99
|
## Other commands
|
|
91
100
|
|
|
92
|
-
- `zitadel claim
|
|
101
|
+
- `zitadel claim`: claim the project to make it permanent (opens the claim
|
|
93
102
|
page, polls for completion; the claim then shows in `setup`, `status`, and
|
|
94
103
|
`doctor`)
|
|
95
|
-
- `zitadel
|
|
104
|
+
- `zitadel console`: print a fresh one-time sign-in link for the local
|
|
105
|
+
console as `admin@zitadel.localhost` and open it in a browser
|
|
106
|
+
(`--no-open` prints the link only)
|
|
107
|
+
- `zitadel doctor`: verify the local runtime and generated project files
|
|
96
108
|
(including scaffold drift and dependency-version alignment)
|
|
97
|
-
- `zitadel status
|
|
98
|
-
- `zitadel plan
|
|
99
|
-
- `zitadel apply
|
|
100
|
-
- `zitadel branding eject
|
|
101
|
-
- `zitadel schemas list
|
|
102
|
-
- `zitadel
|
|
103
|
-
-
|
|
109
|
+
- `zitadel status`: summarise the local runtime and project
|
|
110
|
+
- `zitadel plan`: validate config and preview sync changes without mutation
|
|
111
|
+
- `zitadel apply`: validate and upload repo config to Zitadel
|
|
112
|
+
- `zitadel branding eject`: scaffold an editable login template from a design
|
|
113
|
+
- `zitadel schemas list`: list the project's user schemas
|
|
114
|
+
- `zitadel variables list|get|set|delete`: manage the project's variables and
|
|
115
|
+
secrets (`--project-level`)
|
|
116
|
+
- `zitadel eject`: remove what setup wrote (alias: `zitadel uninstall`)
|
|
117
|
+
- `zitadel start|stop|logs|reset`: manage the local runtime
|
|
104
118
|
|
|
105
119
|
The full agent-facing contract (JSON envelope, posture rules, claim flow,
|
|
106
|
-
doctor repair) is [`
|
|
120
|
+
doctor repair) is [`SKILL.md`](https://github.com/zitadel/nextgen/blob/main/apps/cli/skills/zitadel-cli/SKILL.md),
|
|
107
121
|
which ships in this package.
|
|
108
122
|
|
|
109
123
|
## Reference
|
|
@@ -152,6 +166,7 @@ which ships in this package.
|
|
|
152
166
|
* [`zitadel sessions list`](#zitadel-sessions-list)
|
|
153
167
|
* [`zitadel sessions revoke ID`](#zitadel-sessions-revoke-id)
|
|
154
168
|
* [`zitadel setup`](#zitadel-setup)
|
|
169
|
+
* [`zitadel sso enable`](#zitadel-sso-enable)
|
|
155
170
|
* [`zitadel start`](#zitadel-start)
|
|
156
171
|
* [`zitadel status`](#zitadel-status)
|
|
157
172
|
* [`zitadel stop`](#zitadel-stop)
|
|
@@ -180,21 +195,20 @@ Validate and upload repo config to the platform.
|
|
|
180
195
|
```
|
|
181
196
|
USAGE
|
|
182
197
|
$ zitadel apply [--json] [-c <value>] [-s <value>] [-n]
|
|
183
|
-
[--dry-run] [
|
|
184
|
-
development|preview|production]
|
|
198
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry]
|
|
185
199
|
|
|
186
200
|
FLAGS
|
|
187
|
-
-c, --cwd=<value>
|
|
188
|
-
-
|
|
189
|
-
|
|
190
|
-
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
--
|
|
195
|
-
--
|
|
196
|
-
|
|
197
|
-
|
|
201
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
202
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
203
|
+
an agent.
|
|
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.
|
|
208
|
+
--debug Debug logging.
|
|
209
|
+
--dry-run Preview without mutating files or the platform.
|
|
210
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
211
|
+
--no-telemetry.
|
|
198
212
|
|
|
199
213
|
GLOBAL FLAGS
|
|
200
214
|
--json Format output as json.
|
|
@@ -241,8 +255,7 @@ Take ownership of the login template: scaffold .zitadel/branding/ from a shipped
|
|
|
241
255
|
```
|
|
242
256
|
USAGE
|
|
243
257
|
$ zitadel branding eject [--json] [-c <value>] [-s <value>] [-n]
|
|
244
|
-
[--dry-run] [
|
|
245
|
-
centered|split|split-right|hero|minimal]
|
|
258
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-f] [--design <value>]
|
|
246
259
|
|
|
247
260
|
FLAGS
|
|
248
261
|
-c, --cwd=<value> Project directory to operate on.
|
|
@@ -250,13 +263,15 @@ FLAGS
|
|
|
250
263
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
251
264
|
an agent.
|
|
252
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.
|
|
253
269
|
--debug Debug logging.
|
|
254
|
-
--design=<
|
|
255
|
-
|
|
270
|
+
--design=<value> Design to start from: centered or minimal (default:
|
|
271
|
+
centered).
|
|
256
272
|
--dry-run Preview without mutating files or the platform.
|
|
257
273
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
258
274
|
--no-telemetry.
|
|
259
|
-
--verbose Verbose logging.
|
|
260
275
|
|
|
261
276
|
GLOBAL FLAGS
|
|
262
277
|
--json Format output as json.
|
|
@@ -273,27 +288,25 @@ Get one branding revision by id.
|
|
|
273
288
|
```
|
|
274
289
|
USAGE
|
|
275
290
|
$ zitadel branding get ID [--json] [-c <value>] [-s <value>] [-n]
|
|
276
|
-
[--dry-run] [
|
|
277
|
-
development|preview|production]
|
|
291
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
|
|
278
292
|
|
|
279
293
|
ARGUMENTS
|
|
280
294
|
ID branding revision id
|
|
281
295
|
|
|
282
296
|
FLAGS
|
|
283
|
-
-c, --cwd=<value>
|
|
284
|
-
-
|
|
285
|
-
|
|
286
|
-
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
--
|
|
291
|
-
--
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
--[no-]telemetry
|
|
295
|
-
|
|
296
|
-
--verbose Verbose logging.
|
|
297
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
298
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
299
|
+
an agent.
|
|
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.
|
|
304
|
+
--debug Debug logging.
|
|
305
|
+
--dry-run Preview without mutating files or the platform.
|
|
306
|
+
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
307
|
+
the resource's own; `--json` is unaffected.
|
|
308
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
309
|
+
--no-telemetry.
|
|
297
310
|
|
|
298
311
|
GLOBAL FLAGS
|
|
299
312
|
--json Format output as json.
|
|
@@ -314,26 +327,26 @@ List branding.
|
|
|
314
327
|
```
|
|
315
328
|
USAGE
|
|
316
329
|
$ zitadel branding list [--json] [-c <value>] [-s <value>] [-n]
|
|
317
|
-
[--dry-run] [
|
|
318
|
-
[
|
|
330
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
|
|
331
|
+
[--plain]
|
|
319
332
|
|
|
320
333
|
FLAGS
|
|
321
|
-
-c, --cwd=<value>
|
|
322
|
-
-
|
|
323
|
-
|
|
324
|
-
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
--
|
|
329
|
-
--
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
334
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
335
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
336
|
+
an agent.
|
|
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.
|
|
341
|
+
--debug Debug logging.
|
|
342
|
+
--dry-run Preview without mutating files or the platform.
|
|
343
|
+
--fields=<value> Columns to show, comma-separated dot-paths (e.g.
|
|
344
|
+
id,attributes.email). Defaults to the resource's own
|
|
345
|
+
columns; `--json` is unaffected.
|
|
346
|
+
--plain Tab-separated rows with no header, for piping. Implied
|
|
347
|
+
when stdout is not a terminal.
|
|
348
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
349
|
+
--no-telemetry.
|
|
337
350
|
|
|
338
351
|
GLOBAL FLAGS
|
|
339
352
|
--json Format output as json.
|
|
@@ -352,7 +365,7 @@ Claim this project to make it permanent. Opens a browser to create an account or
|
|
|
352
365
|
```
|
|
353
366
|
USAGE
|
|
354
367
|
$ zitadel claim [--json] [-c <value>] [-s <value>] [-n]
|
|
355
|
-
[--dry-run] [
|
|
368
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--no-open] [--timeout
|
|
356
369
|
<value>]
|
|
357
370
|
|
|
358
371
|
FLAGS
|
|
@@ -360,6 +373,9 @@ FLAGS
|
|
|
360
373
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
361
374
|
an agent.
|
|
362
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.
|
|
363
379
|
--debug Debug logging.
|
|
364
380
|
--dry-run Preview without mutating files or the platform.
|
|
365
381
|
--no-open Print the link instead of opening a browser.
|
|
@@ -367,7 +383,6 @@ FLAGS
|
|
|
367
383
|
--no-telemetry.
|
|
368
384
|
--timeout=<value> Seconds to wait for the browser step. Defaults to the
|
|
369
385
|
link's own expiry (10 minutes).
|
|
370
|
-
--verbose Verbose logging.
|
|
371
386
|
|
|
372
387
|
GLOBAL FLAGS
|
|
373
388
|
--json Format output as json.
|
|
@@ -421,19 +436,21 @@ Open the local console, signed in as the local admin created by `zitadel start`.
|
|
|
421
436
|
```
|
|
422
437
|
USAGE
|
|
423
438
|
$ zitadel console [--json] [-c <value>] [-s <value>] [-n]
|
|
424
|
-
[--dry-run] [
|
|
439
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--no-open]
|
|
425
440
|
|
|
426
441
|
FLAGS
|
|
427
442
|
-c, --cwd=<value> Project directory to operate on.
|
|
428
443
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
429
444
|
an agent.
|
|
430
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.
|
|
431
449
|
--debug Debug logging.
|
|
432
450
|
--dry-run Preview without mutating files or the platform.
|
|
433
451
|
--no-open Print the sign-in link instead of opening a browser.
|
|
434
452
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
435
453
|
--no-telemetry.
|
|
436
|
-
--verbose Verbose logging.
|
|
437
454
|
|
|
438
455
|
GLOBAL FLAGS
|
|
439
456
|
--json Format output as json.
|
|
@@ -442,6 +459,9 @@ DESCRIPTION
|
|
|
442
459
|
Open the local console, signed in as the local admin created by `zitadel
|
|
443
460
|
start`.
|
|
444
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
|
+
|
|
445
465
|
EXAMPLES
|
|
446
466
|
$ zitadel console
|
|
447
467
|
|
|
@@ -455,7 +475,7 @@ Verify local runtime and project state.
|
|
|
455
475
|
```
|
|
456
476
|
USAGE
|
|
457
477
|
$ zitadel doctor [--json] [-c <value>] [-s <value>] [-n]
|
|
458
|
-
[--dry-run] [
|
|
478
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--fix] [--image <value>]
|
|
459
479
|
[--port <value>] [--runtime binary|docker]
|
|
460
480
|
|
|
461
481
|
FLAGS
|
|
@@ -463,6 +483,9 @@ FLAGS
|
|
|
463
483
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
464
484
|
an agent.
|
|
465
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.
|
|
466
489
|
--debug Debug logging.
|
|
467
490
|
--dry-run Preview without mutating files or the platform.
|
|
468
491
|
--fix Repair missing files and stale managed wiring.
|
|
@@ -472,7 +495,6 @@ FLAGS
|
|
|
472
495
|
<options: binary|docker>
|
|
473
496
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
474
497
|
--no-telemetry.
|
|
475
|
-
--verbose Verbose logging.
|
|
476
498
|
|
|
477
499
|
GLOBAL FLAGS
|
|
478
500
|
--json Format output as json.
|
|
@@ -488,7 +510,7 @@ Remove managed files and local Zitadel state.
|
|
|
488
510
|
```
|
|
489
511
|
USAGE
|
|
490
512
|
$ zitadel eject [--json] [-c <value>] [-s <value>] [-n]
|
|
491
|
-
[--dry-run] [
|
|
513
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-f]
|
|
492
514
|
|
|
493
515
|
FLAGS
|
|
494
516
|
-c, --cwd=<value> Project directory to operate on.
|
|
@@ -497,11 +519,13 @@ FLAGS
|
|
|
497
519
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
498
520
|
an agent.
|
|
499
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.
|
|
500
525
|
--debug Debug logging.
|
|
501
526
|
--dry-run Preview without mutating files or the platform.
|
|
502
527
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
503
528
|
--no-telemetry.
|
|
504
|
-
--verbose Verbose logging.
|
|
505
529
|
|
|
506
530
|
GLOBAL FLAGS
|
|
507
531
|
--json Format output as json.
|
|
@@ -520,27 +544,25 @@ Get one environment by id.
|
|
|
520
544
|
```
|
|
521
545
|
USAGE
|
|
522
546
|
$ zitadel environments get NAME [--json] [-c <value>] [-s <value>] [-n]
|
|
523
|
-
[--dry-run] [
|
|
524
|
-
development|preview|production]
|
|
547
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
|
|
525
548
|
|
|
526
549
|
ARGUMENTS
|
|
527
550
|
NAME environment name
|
|
528
551
|
|
|
529
552
|
FLAGS
|
|
530
|
-
-c, --cwd=<value>
|
|
531
|
-
-
|
|
532
|
-
|
|
533
|
-
-
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
--
|
|
538
|
-
--
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
--[no-]telemetry
|
|
542
|
-
|
|
543
|
-
--verbose Verbose logging.
|
|
553
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
554
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
555
|
+
an agent.
|
|
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.
|
|
560
|
+
--debug Debug logging.
|
|
561
|
+
--dry-run Preview without mutating files or the platform.
|
|
562
|
+
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
563
|
+
the resource's own; `--json` is unaffected.
|
|
564
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
565
|
+
--no-telemetry.
|
|
544
566
|
|
|
545
567
|
GLOBAL FLAGS
|
|
546
568
|
--json Format output as json.
|
|
@@ -561,30 +583,29 @@ List environments.
|
|
|
561
583
|
```
|
|
562
584
|
USAGE
|
|
563
585
|
$ zitadel environments list [--json] [-c <value>] [-s <value>] [-n]
|
|
564
|
-
[--dry-run] [
|
|
565
|
-
--page-token <value>] [--fields <value>] [--plain]
|
|
566
|
-
development|preview|production]
|
|
586
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
|
|
587
|
+
--page-token <value>] [--fields <value>] [--plain]
|
|
567
588
|
|
|
568
589
|
FLAGS
|
|
569
|
-
-a, --all
|
|
570
|
-
-c, --cwd=<value>
|
|
571
|
-
-
|
|
572
|
-
|
|
573
|
-
-
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
--
|
|
578
|
-
--
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
--
|
|
583
|
-
--
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
|
|
587
|
-
|
|
590
|
+
-a, --all Fetch every page instead of one.
|
|
591
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
592
|
+
-n, --non-interactive Disable prompts. Required when scripting or running
|
|
593
|
+
as an agent.
|
|
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.
|
|
598
|
+
--debug Debug logging.
|
|
599
|
+
--dry-run Preview without mutating files or the platform.
|
|
600
|
+
--fields=<value> Columns to show, comma-separated dot-paths (e.g.
|
|
601
|
+
id,attributes.email). Defaults to the resource's own
|
|
602
|
+
columns; `--json` is unaffected.
|
|
603
|
+
--limit=<value> Page size (server default 20, max 100).
|
|
604
|
+
--page-token=<value> Continue from a previous page's next_page_token.
|
|
605
|
+
--plain Tab-separated rows with no header, for piping.
|
|
606
|
+
Implied when stdout is not a terminal.
|
|
607
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
608
|
+
--no-telemetry.
|
|
588
609
|
|
|
589
610
|
GLOBAL FLAGS
|
|
590
611
|
--json Format output as json.
|
|
@@ -605,27 +626,25 @@ Get one event by id.
|
|
|
605
626
|
```
|
|
606
627
|
USAGE
|
|
607
628
|
$ zitadel events get ID [--json] [-c <value>] [-s <value>] [-n]
|
|
608
|
-
[--dry-run] [
|
|
609
|
-
development|preview|production]
|
|
629
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
|
|
610
630
|
|
|
611
631
|
ARGUMENTS
|
|
612
632
|
ID event id
|
|
613
633
|
|
|
614
634
|
FLAGS
|
|
615
|
-
-c, --cwd=<value>
|
|
616
|
-
-
|
|
617
|
-
|
|
618
|
-
-
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
--
|
|
623
|
-
--
|
|
624
|
-
|
|
625
|
-
|
|
626
|
-
--[no-]telemetry
|
|
627
|
-
|
|
628
|
-
--verbose Verbose logging.
|
|
635
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
636
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
637
|
+
an agent.
|
|
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.
|
|
642
|
+
--debug Debug logging.
|
|
643
|
+
--dry-run Preview without mutating files or the platform.
|
|
644
|
+
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
645
|
+
the resource's own; `--json` is unaffected.
|
|
646
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
647
|
+
--no-telemetry.
|
|
629
648
|
|
|
630
649
|
GLOBAL FLAGS
|
|
631
650
|
--json Format output as json.
|
|
@@ -646,9 +665,9 @@ List events.
|
|
|
646
665
|
```
|
|
647
666
|
USAGE
|
|
648
667
|
$ zitadel events list [--json] [-c <value>] [-s <value>] [-n]
|
|
649
|
-
[--dry-run] [
|
|
668
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
|
|
650
669
|
--page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
|
|
651
|
-
[--sort <value>]
|
|
670
|
+
[--sort <value>]
|
|
652
671
|
|
|
653
672
|
FLAGS
|
|
654
673
|
-a, --all
|
|
@@ -657,16 +676,19 @@ FLAGS
|
|
|
657
676
|
-c, --cwd=<value>
|
|
658
677
|
Project directory to operate on.
|
|
659
678
|
|
|
660
|
-
-e, --environment=<option>
|
|
661
|
-
Target environment (default: development).
|
|
662
|
-
<options: development|preview|production>
|
|
663
|
-
|
|
664
679
|
-n, --non-interactive
|
|
665
680
|
Disable prompts. Required when scripting or running as an agent.
|
|
666
681
|
|
|
667
682
|
-s, --server=<value>
|
|
668
683
|
Override the resolved server URL.
|
|
669
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
|
+
|
|
670
692
|
--debug
|
|
671
693
|
Debug logging.
|
|
672
694
|
|
|
@@ -701,9 +723,6 @@ FLAGS
|
|
|
701
723
|
--[no-]telemetry
|
|
702
724
|
Send anonymous usage analytics. Disable with --no-telemetry.
|
|
703
725
|
|
|
704
|
-
--verbose
|
|
705
|
-
Verbose logging.
|
|
706
|
-
|
|
707
726
|
GLOBAL FLAGS
|
|
708
727
|
--json Format output as json.
|
|
709
728
|
|
|
@@ -725,27 +744,25 @@ Get one flow definition by id.
|
|
|
725
744
|
```
|
|
726
745
|
USAGE
|
|
727
746
|
$ zitadel flow-definitions get FLOW [--json] [-c <value>] [-s <value>] [-n]
|
|
728
|
-
[--dry-run] [
|
|
729
|
-
development|preview|production]
|
|
747
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
|
|
730
748
|
|
|
731
749
|
ARGUMENTS
|
|
732
750
|
FLOW flow name (newest revision) or revision id
|
|
733
751
|
|
|
734
752
|
FLAGS
|
|
735
|
-
-c, --cwd=<value>
|
|
736
|
-
-
|
|
737
|
-
|
|
738
|
-
-
|
|
739
|
-
|
|
740
|
-
|
|
741
|
-
|
|
742
|
-
--
|
|
743
|
-
--
|
|
744
|
-
|
|
745
|
-
|
|
746
|
-
--[no-]telemetry
|
|
747
|
-
|
|
748
|
-
--verbose Verbose logging.
|
|
753
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
754
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
755
|
+
an agent.
|
|
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.
|
|
760
|
+
--debug Debug logging.
|
|
761
|
+
--dry-run Preview without mutating files or the platform.
|
|
762
|
+
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
763
|
+
the resource's own; `--json` is unaffected.
|
|
764
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
765
|
+
--no-telemetry.
|
|
749
766
|
|
|
750
767
|
GLOBAL FLAGS
|
|
751
768
|
--json Format output as json.
|
|
@@ -766,34 +783,32 @@ List flow-definitions.
|
|
|
766
783
|
```
|
|
767
784
|
USAGE
|
|
768
785
|
$ zitadel flow-definitions list [--json] [-c <value>] [-s <value>] [-n]
|
|
769
|
-
[--dry-run] [
|
|
770
|
-
--page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
|
|
771
|
-
development|preview|production]
|
|
786
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
|
|
787
|
+
--page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
|
|
772
788
|
|
|
773
789
|
FLAGS
|
|
774
|
-
-a, --all
|
|
775
|
-
-c, --cwd=<value>
|
|
776
|
-
-
|
|
777
|
-
|
|
778
|
-
-
|
|
779
|
-
|
|
780
|
-
|
|
781
|
-
|
|
782
|
-
--
|
|
783
|
-
--
|
|
784
|
-
|
|
785
|
-
|
|
786
|
-
|
|
787
|
-
|
|
788
|
-
|
|
789
|
-
|
|
790
|
-
--limit=<value>
|
|
791
|
-
--page-token=<value>
|
|
792
|
-
--plain
|
|
793
|
-
|
|
794
|
-
--[no-]telemetry
|
|
795
|
-
|
|
796
|
-
--verbose Verbose logging.
|
|
790
|
+
-a, --all Fetch every page instead of one.
|
|
791
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
792
|
+
-n, --non-interactive Disable prompts. Required when scripting or running
|
|
793
|
+
as an agent.
|
|
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.
|
|
798
|
+
--debug Debug logging.
|
|
799
|
+
--dry-run Preview without mutating files or the platform.
|
|
800
|
+
--fields=<value> Columns to show, comma-separated dot-paths (e.g.
|
|
801
|
+
id,attributes.email). Defaults to the resource's own
|
|
802
|
+
columns; `--json` is unaffected.
|
|
803
|
+
--filter=<value>... Filter as field=operation:value (operation defaults
|
|
804
|
+
to equals). Fields: name (equals), purpose (equals),
|
|
805
|
+
revisions (equals; values all|latest).
|
|
806
|
+
--limit=<value> Page size (server default 20, max 100).
|
|
807
|
+
--page-token=<value> Continue from a previous page's next_page_token.
|
|
808
|
+
--plain Tab-separated rows with no header, for piping.
|
|
809
|
+
Implied when stdout is not a terminal.
|
|
810
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
811
|
+
--no-telemetry.
|
|
797
812
|
|
|
798
813
|
GLOBAL FLAGS
|
|
799
814
|
--json Format output as json.
|
|
@@ -816,23 +831,22 @@ Create a grant.
|
|
|
816
831
|
```
|
|
817
832
|
USAGE
|
|
818
833
|
$ zitadel grants create [--json] [-c <value>] [-s <value>] [-n]
|
|
819
|
-
[--dry-run] [
|
|
820
|
-
[--
|
|
821
|
-
<value>]
|
|
822
|
-
development|preview|production]
|
|
834
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--relation
|
|
835
|
+
viewer|editor|admin] [--expires-at <value>] [--data <value> | --file
|
|
836
|
+
<value>]
|
|
823
837
|
|
|
824
838
|
FLAGS
|
|
825
|
-
-c, --cwd=<value>
|
|
826
|
-
-
|
|
827
|
-
|
|
828
|
-
-
|
|
829
|
-
|
|
830
|
-
|
|
831
|
-
|
|
832
|
-
--
|
|
833
|
-
--
|
|
834
|
-
|
|
835
|
-
|
|
839
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
840
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
841
|
+
an agent.
|
|
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.
|
|
846
|
+
--debug Debug logging.
|
|
847
|
+
--dry-run Preview without mutating files or the platform.
|
|
848
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
849
|
+
--no-telemetry.
|
|
836
850
|
|
|
837
851
|
RAW BODY FLAGS
|
|
838
852
|
--data=<value> Whole body as a JSON object, instead of the field flags.
|
|
@@ -845,20 +859,13 @@ GLOBAL FLAGS
|
|
|
845
859
|
--json Format output as json.
|
|
846
860
|
|
|
847
861
|
REQUIRED FIELD FLAGS
|
|
848
|
-
--
|
|
849
|
-
|
|
850
|
-
--principal-type=<option> (required) Kind of principal to bind.
|
|
851
|
-
<options: user|team>
|
|
852
|
-
--relation=<option> (required) Catalog relation on `object_type`
|
|
853
|
-
`project`.
|
|
854
|
-
<options: viewer|editor|admin>
|
|
862
|
+
--relation=<option> (required) Catalog relation on `object_type` `project`.
|
|
863
|
+
<options: viewer|editor|admin>
|
|
855
864
|
|
|
856
865
|
DESCRIPTION
|
|
857
866
|
Create a grant.
|
|
858
867
|
|
|
859
868
|
EXAMPLES
|
|
860
|
-
$ zitadel grants create --principal-type user --principal-id <principal_id> --relation viewer --json
|
|
861
|
-
|
|
862
869
|
$ zitadel grants create --data '{...}' --json
|
|
863
870
|
|
|
864
871
|
$ zitadel grants create --file ./grant.json
|
|
@@ -871,26 +878,25 @@ Delete a grant by id.
|
|
|
871
878
|
```
|
|
872
879
|
USAGE
|
|
873
880
|
$ zitadel grants delete ID [--json] [-c <value>] [-s <value>] [-n]
|
|
874
|
-
[--dry-run] [
|
|
875
|
-
development|preview|production]
|
|
881
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-f]
|
|
876
882
|
|
|
877
883
|
ARGUMENTS
|
|
878
884
|
ID grant id
|
|
879
885
|
|
|
880
886
|
FLAGS
|
|
881
|
-
-c, --cwd=<value>
|
|
882
|
-
-
|
|
883
|
-
|
|
884
|
-
-
|
|
885
|
-
|
|
886
|
-
-
|
|
887
|
-
|
|
888
|
-
|
|
889
|
-
|
|
890
|
-
--
|
|
891
|
-
--
|
|
892
|
-
|
|
893
|
-
|
|
887
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
888
|
+
-f, --force Delete the grant without the confirmation prompt.
|
|
889
|
+
Required when non-interactive.
|
|
890
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
891
|
+
an agent.
|
|
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.
|
|
896
|
+
--debug Debug logging.
|
|
897
|
+
--dry-run Preview without mutating files or the platform.
|
|
898
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
899
|
+
--no-telemetry.
|
|
894
900
|
|
|
895
901
|
GLOBAL FLAGS
|
|
896
902
|
--json Format output as json.
|
|
@@ -909,27 +915,25 @@ Get one grant by id.
|
|
|
909
915
|
```
|
|
910
916
|
USAGE
|
|
911
917
|
$ zitadel grants get ID [--json] [-c <value>] [-s <value>] [-n]
|
|
912
|
-
[--dry-run] [
|
|
913
|
-
development|preview|production]
|
|
918
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
|
|
914
919
|
|
|
915
920
|
ARGUMENTS
|
|
916
921
|
ID grant id
|
|
917
922
|
|
|
918
923
|
FLAGS
|
|
919
|
-
-c, --cwd=<value>
|
|
920
|
-
-
|
|
921
|
-
|
|
922
|
-
-
|
|
923
|
-
|
|
924
|
-
|
|
925
|
-
|
|
926
|
-
--
|
|
927
|
-
--
|
|
928
|
-
|
|
929
|
-
|
|
930
|
-
--[no-]telemetry
|
|
931
|
-
|
|
932
|
-
--verbose Verbose logging.
|
|
924
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
925
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
926
|
+
an agent.
|
|
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.
|
|
931
|
+
--debug Debug logging.
|
|
932
|
+
--dry-run Preview without mutating files or the platform.
|
|
933
|
+
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
934
|
+
the resource's own; `--json` is unaffected.
|
|
935
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
936
|
+
--no-telemetry.
|
|
933
937
|
|
|
934
938
|
GLOBAL FLAGS
|
|
935
939
|
--json Format output as json.
|
|
@@ -950,9 +954,9 @@ List grants.
|
|
|
950
954
|
```
|
|
951
955
|
USAGE
|
|
952
956
|
$ zitadel grants list [--json] [-c <value>] [-s <value>] [-n]
|
|
953
|
-
[--dry-run] [
|
|
957
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
|
|
954
958
|
--page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
|
|
955
|
-
[--sort <value>]
|
|
959
|
+
[--sort <value>]
|
|
956
960
|
|
|
957
961
|
FLAGS
|
|
958
962
|
-a, --all
|
|
@@ -961,16 +965,19 @@ FLAGS
|
|
|
961
965
|
-c, --cwd=<value>
|
|
962
966
|
Project directory to operate on.
|
|
963
967
|
|
|
964
|
-
-e, --environment=<option>
|
|
965
|
-
Target environment (default: development).
|
|
966
|
-
<options: development|preview|production>
|
|
967
|
-
|
|
968
968
|
-n, --non-interactive
|
|
969
969
|
Disable prompts. Required when scripting or running as an agent.
|
|
970
970
|
|
|
971
971
|
-s, --server=<value>
|
|
972
972
|
Override the resolved server URL.
|
|
973
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
|
+
|
|
974
981
|
--debug
|
|
975
982
|
Debug logging.
|
|
976
983
|
|
|
@@ -984,10 +991,10 @@ FLAGS
|
|
|
984
991
|
--filter=<value>...
|
|
985
992
|
Filter as field=operation:value (operation defaults to equals). Fields:
|
|
986
993
|
created_at (equals|not_equals|contains|not_contains|less_than|less_than_or_e
|
|
987
|
-
qual|greater_than|greater_than_or_equal),
|
|
994
|
+
qual|greater_than|greater_than_or_equal), user_id
|
|
988
995
|
(equals|not_equals|contains|not_contains|less_than|less_than_or_equal|greate
|
|
989
|
-
r_than|greater_than_or_equal),
|
|
990
|
-
|
|
996
|
+
r_than|greater_than_or_equal), team_id (equals|not_equals|contains|not_conta
|
|
997
|
+
ins|less_than|less_than_or_equal|greater_than|greater_than_or_equal),
|
|
991
998
|
relation (equals|not_equals|contains|not_contains|less_than|less_than_or_equ
|
|
992
999
|
al|greater_than|greater_than_or_equal), expires_at
|
|
993
1000
|
(equals|not_equals|contains|not_contains|less_than|less_than_or_equal|greate
|
|
@@ -1009,9 +1016,6 @@ FLAGS
|
|
|
1009
1016
|
--[no-]telemetry
|
|
1010
1017
|
Send anonymous usage analytics. Disable with --no-telemetry.
|
|
1011
1018
|
|
|
1012
|
-
--verbose
|
|
1013
|
-
Verbose logging.
|
|
1014
|
-
|
|
1015
1019
|
GLOBAL FLAGS
|
|
1016
1020
|
--json Format output as json.
|
|
1017
1021
|
|
|
@@ -1053,21 +1057,21 @@ Create an identity provider connection.
|
|
|
1053
1057
|
```
|
|
1054
1058
|
USAGE
|
|
1055
1059
|
$ zitadel idps create [--json] [-c <value>] [-s <value>] [-n]
|
|
1056
|
-
[--dry-run] [
|
|
1057
|
-
<value>]
|
|
1060
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--data <value> | --file
|
|
1061
|
+
<value>]
|
|
1058
1062
|
|
|
1059
1063
|
FLAGS
|
|
1060
|
-
-c, --cwd=<value>
|
|
1061
|
-
-
|
|
1062
|
-
|
|
1063
|
-
-
|
|
1064
|
-
|
|
1065
|
-
|
|
1066
|
-
|
|
1067
|
-
--
|
|
1068
|
-
--
|
|
1069
|
-
|
|
1070
|
-
|
|
1064
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1065
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1066
|
+
an agent.
|
|
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.
|
|
1071
|
+
--debug Debug logging.
|
|
1072
|
+
--dry-run Preview without mutating files or the platform.
|
|
1073
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1074
|
+
--no-telemetry.
|
|
1071
1075
|
|
|
1072
1076
|
RAW BODY FLAGS
|
|
1073
1077
|
--data=<value> Whole body as a JSON object, instead of the field flags.
|
|
@@ -1092,27 +1096,25 @@ Get one identity provider connection by id.
|
|
|
1092
1096
|
```
|
|
1093
1097
|
USAGE
|
|
1094
1098
|
$ zitadel idps get ID [--json] [-c <value>] [-s <value>] [-n]
|
|
1095
|
-
[--dry-run] [
|
|
1096
|
-
development|preview|production]
|
|
1099
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
|
|
1097
1100
|
|
|
1098
1101
|
ARGUMENTS
|
|
1099
1102
|
ID identity provider connection id
|
|
1100
1103
|
|
|
1101
1104
|
FLAGS
|
|
1102
|
-
-c, --cwd=<value>
|
|
1103
|
-
-
|
|
1104
|
-
|
|
1105
|
-
-
|
|
1106
|
-
|
|
1107
|
-
|
|
1108
|
-
|
|
1109
|
-
--
|
|
1110
|
-
--
|
|
1111
|
-
|
|
1112
|
-
|
|
1113
|
-
--[no-]telemetry
|
|
1114
|
-
|
|
1115
|
-
--verbose Verbose logging.
|
|
1105
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1106
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1107
|
+
an agent.
|
|
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.
|
|
1112
|
+
--debug Debug logging.
|
|
1113
|
+
--dry-run Preview without mutating files or the platform.
|
|
1114
|
+
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
1115
|
+
the resource's own; `--json` is unaffected.
|
|
1116
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1117
|
+
--no-telemetry.
|
|
1116
1118
|
|
|
1117
1119
|
GLOBAL FLAGS
|
|
1118
1120
|
--json Format output as json.
|
|
@@ -1133,9 +1135,9 @@ List idps.
|
|
|
1133
1135
|
```
|
|
1134
1136
|
USAGE
|
|
1135
1137
|
$ zitadel idps list [--json] [-c <value>] [-s <value>] [-n]
|
|
1136
|
-
[--dry-run] [
|
|
1138
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
|
|
1137
1139
|
--page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
|
|
1138
|
-
[--sort <value>]
|
|
1140
|
+
[--sort <value>]
|
|
1139
1141
|
|
|
1140
1142
|
FLAGS
|
|
1141
1143
|
-a, --all
|
|
@@ -1144,16 +1146,19 @@ FLAGS
|
|
|
1144
1146
|
-c, --cwd=<value>
|
|
1145
1147
|
Project directory to operate on.
|
|
1146
1148
|
|
|
1147
|
-
-e, --environment=<option>
|
|
1148
|
-
Target environment (default: development).
|
|
1149
|
-
<options: development|preview|production>
|
|
1150
|
-
|
|
1151
1149
|
-n, --non-interactive
|
|
1152
1150
|
Disable prompts. Required when scripting or running as an agent.
|
|
1153
1151
|
|
|
1154
1152
|
-s, --server=<value>
|
|
1155
1153
|
Override the resolved server URL.
|
|
1156
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
|
+
|
|
1157
1162
|
--debug
|
|
1158
1163
|
Debug logging.
|
|
1159
1164
|
|
|
@@ -1186,9 +1191,6 @@ FLAGS
|
|
|
1186
1191
|
--[no-]telemetry
|
|
1187
1192
|
Send anonymous usage analytics. Disable with --no-telemetry.
|
|
1188
1193
|
|
|
1189
|
-
--verbose
|
|
1190
|
-
Verbose logging.
|
|
1191
|
-
|
|
1192
1194
|
GLOBAL FLAGS
|
|
1193
1195
|
--json Format output as json.
|
|
1194
1196
|
|
|
@@ -1210,20 +1212,23 @@ Show local Zitadel server logs.
|
|
|
1210
1212
|
```
|
|
1211
1213
|
USAGE
|
|
1212
1214
|
$ zitadel logs [--json] [-c <value>] [-s <value>] [-n]
|
|
1213
|
-
[--dry-run] [
|
|
1215
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--follow] [--tail
|
|
1216
|
+
<value>]
|
|
1214
1217
|
|
|
1215
1218
|
FLAGS
|
|
1216
1219
|
-c, --cwd=<value> Project directory to operate on.
|
|
1217
1220
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1218
1221
|
an agent.
|
|
1219
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.
|
|
1220
1226
|
--debug Debug logging.
|
|
1221
1227
|
--dry-run Preview without mutating files or the platform.
|
|
1222
1228
|
--follow Follow logs.
|
|
1223
1229
|
--tail=<value> [default: 200] Number of lines to show.
|
|
1224
1230
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1225
1231
|
--no-telemetry.
|
|
1226
|
-
--verbose Verbose logging.
|
|
1227
1232
|
|
|
1228
1233
|
GLOBAL FLAGS
|
|
1229
1234
|
--json Format output as json.
|
|
@@ -1239,21 +1244,20 @@ Validate config without mutation and preview the sync diff.
|
|
|
1239
1244
|
```
|
|
1240
1245
|
USAGE
|
|
1241
1246
|
$ zitadel plan [--json] [-c <value>] [-s <value>] [-n]
|
|
1242
|
-
[--dry-run] [
|
|
1243
|
-
development|preview|production]
|
|
1247
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry]
|
|
1244
1248
|
|
|
1245
1249
|
FLAGS
|
|
1246
|
-
-c, --cwd=<value>
|
|
1247
|
-
-
|
|
1248
|
-
|
|
1249
|
-
-
|
|
1250
|
-
|
|
1251
|
-
|
|
1252
|
-
|
|
1253
|
-
--
|
|
1254
|
-
--
|
|
1255
|
-
|
|
1256
|
-
|
|
1250
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1251
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1252
|
+
an agent.
|
|
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.
|
|
1257
|
+
--debug Debug logging.
|
|
1258
|
+
--dry-run Preview without mutating files or the platform.
|
|
1259
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1260
|
+
--no-telemetry.
|
|
1257
1261
|
|
|
1258
1262
|
GLOBAL FLAGS
|
|
1259
1263
|
--json Format output as json.
|
|
@@ -1269,27 +1273,25 @@ Get one project by id.
|
|
|
1269
1273
|
```
|
|
1270
1274
|
USAGE
|
|
1271
1275
|
$ zitadel projects get ID [--json] [-c <value>] [-s <value>] [-n]
|
|
1272
|
-
[--dry-run] [
|
|
1273
|
-
development|preview|production]
|
|
1276
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
|
|
1274
1277
|
|
|
1275
1278
|
ARGUMENTS
|
|
1276
1279
|
ID project id
|
|
1277
1280
|
|
|
1278
1281
|
FLAGS
|
|
1279
|
-
-c, --cwd=<value>
|
|
1280
|
-
-
|
|
1281
|
-
|
|
1282
|
-
-
|
|
1283
|
-
|
|
1284
|
-
|
|
1285
|
-
|
|
1286
|
-
--
|
|
1287
|
-
--
|
|
1288
|
-
|
|
1289
|
-
|
|
1290
|
-
--[no-]telemetry
|
|
1291
|
-
|
|
1292
|
-
--verbose Verbose logging.
|
|
1282
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1283
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1284
|
+
an agent.
|
|
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.
|
|
1289
|
+
--debug Debug logging.
|
|
1290
|
+
--dry-run Preview without mutating files or the platform.
|
|
1291
|
+
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
1292
|
+
the resource's own; `--json` is unaffected.
|
|
1293
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1294
|
+
--no-telemetry.
|
|
1293
1295
|
|
|
1294
1296
|
GLOBAL FLAGS
|
|
1295
1297
|
--json Format output as json.
|
|
@@ -1310,36 +1312,36 @@ List projects.
|
|
|
1310
1312
|
```
|
|
1311
1313
|
USAGE
|
|
1312
1314
|
$ zitadel projects list [--json] [-c <value>] [-s <value>] [-n]
|
|
1313
|
-
[--dry-run] [
|
|
1315
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
|
|
1314
1316
|
--page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
|
|
1315
|
-
[--sort <value>]
|
|
1317
|
+
[--sort <value>]
|
|
1316
1318
|
|
|
1317
1319
|
FLAGS
|
|
1318
|
-
-a, --all
|
|
1319
|
-
-c, --cwd=<value>
|
|
1320
|
-
-
|
|
1321
|
-
|
|
1322
|
-
-
|
|
1323
|
-
|
|
1324
|
-
|
|
1325
|
-
|
|
1326
|
-
--
|
|
1327
|
-
--
|
|
1328
|
-
|
|
1329
|
-
|
|
1330
|
-
|
|
1331
|
-
|
|
1332
|
-
|
|
1333
|
-
|
|
1334
|
-
|
|
1335
|
-
--
|
|
1336
|
-
--
|
|
1337
|
-
|
|
1338
|
-
|
|
1339
|
-
|
|
1340
|
-
|
|
1341
|
-
|
|
1342
|
-
|
|
1320
|
+
-a, --all Fetch every page instead of one.
|
|
1321
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1322
|
+
-n, --non-interactive Disable prompts. Required when scripting or running
|
|
1323
|
+
as an agent.
|
|
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.
|
|
1328
|
+
--debug Debug logging.
|
|
1329
|
+
--dry-run Preview without mutating files or the platform.
|
|
1330
|
+
--fields=<value> Columns to show, comma-separated dot-paths (e.g.
|
|
1331
|
+
id,attributes.email). Defaults to the resource's own
|
|
1332
|
+
columns; `--json` is unaffected.
|
|
1333
|
+
--filter=<value>... Filter as field=operation:value (operation defaults
|
|
1334
|
+
to equals). Fields: created_at (equals|not_equals|co
|
|
1335
|
+
ntains|not_contains|less_than|less_than_or_equal|gre
|
|
1336
|
+
ater_than|greater_than_or_equal).
|
|
1337
|
+
--limit=<value> Page size (server default 20, max 100).
|
|
1338
|
+
--page-token=<value> Continue from a previous page's next_page_token.
|
|
1339
|
+
--plain Tab-separated rows with no header, for piping.
|
|
1340
|
+
Implied when stdout is not a terminal.
|
|
1341
|
+
--sort=<value> Sort as field:direction (asc|desc). Fields:
|
|
1342
|
+
created_at.
|
|
1343
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1344
|
+
--no-telemetry.
|
|
1343
1345
|
|
|
1344
1346
|
GLOBAL FLAGS
|
|
1345
1347
|
--json Format output as json.
|
|
@@ -1362,24 +1364,24 @@ Update a project by id.
|
|
|
1362
1364
|
```
|
|
1363
1365
|
USAGE
|
|
1364
1366
|
$ zitadel projects update ID [--json] [-c <value>] [-s <value>] [-n]
|
|
1365
|
-
[--dry-run] [
|
|
1366
|
-
<value> | --file <value>]
|
|
1367
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--name <value>]
|
|
1368
|
+
[--password-hash <value>] [--data <value> | --file <value>]
|
|
1367
1369
|
|
|
1368
1370
|
ARGUMENTS
|
|
1369
1371
|
ID project id
|
|
1370
1372
|
|
|
1371
1373
|
FLAGS
|
|
1372
|
-
-c, --cwd=<value>
|
|
1373
|
-
-
|
|
1374
|
-
|
|
1375
|
-
-
|
|
1376
|
-
|
|
1377
|
-
|
|
1378
|
-
|
|
1379
|
-
--
|
|
1380
|
-
--
|
|
1381
|
-
|
|
1382
|
-
|
|
1374
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1375
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1376
|
+
an agent.
|
|
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.
|
|
1381
|
+
--debug Debug logging.
|
|
1382
|
+
--dry-run Preview without mutating files or the platform.
|
|
1383
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1384
|
+
--no-telemetry.
|
|
1383
1385
|
|
|
1384
1386
|
RAW BODY FLAGS
|
|
1385
1387
|
--data=<value> Whole body as a JSON object, instead of the field flags.
|
|
@@ -1389,7 +1391,8 @@ GLOBAL FLAGS
|
|
|
1389
1391
|
--json Format output as json.
|
|
1390
1392
|
|
|
1391
1393
|
OPTIONAL FIELD FLAGS
|
|
1392
|
-
--name=<value>
|
|
1394
|
+
--name=<value> The name of the project.
|
|
1395
|
+
--password-hash=<value> The method this project's passwords are hashed with.
|
|
1393
1396
|
|
|
1394
1397
|
DESCRIPTION
|
|
1395
1398
|
Update a project by id.
|
|
@@ -1407,27 +1410,25 @@ Get one release by id.
|
|
|
1407
1410
|
```
|
|
1408
1411
|
USAGE
|
|
1409
1412
|
$ zitadel releases get ID [--json] [-c <value>] [-s <value>] [-n]
|
|
1410
|
-
[--dry-run] [
|
|
1411
|
-
development|preview|production]
|
|
1413
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
|
|
1412
1414
|
|
|
1413
1415
|
ARGUMENTS
|
|
1414
1416
|
ID release id
|
|
1415
1417
|
|
|
1416
1418
|
FLAGS
|
|
1417
|
-
-c, --cwd=<value>
|
|
1418
|
-
-
|
|
1419
|
-
|
|
1420
|
-
-
|
|
1421
|
-
|
|
1422
|
-
|
|
1423
|
-
|
|
1424
|
-
--
|
|
1425
|
-
--
|
|
1426
|
-
|
|
1427
|
-
|
|
1428
|
-
--[no-]telemetry
|
|
1429
|
-
|
|
1430
|
-
--verbose Verbose logging.
|
|
1419
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1420
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1421
|
+
an agent.
|
|
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.
|
|
1426
|
+
--debug Debug logging.
|
|
1427
|
+
--dry-run Preview without mutating files or the platform.
|
|
1428
|
+
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
1429
|
+
the resource's own; `--json` is unaffected.
|
|
1430
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1431
|
+
--no-telemetry.
|
|
1431
1432
|
|
|
1432
1433
|
GLOBAL FLAGS
|
|
1433
1434
|
--json Format output as json.
|
|
@@ -1448,30 +1449,29 @@ List releases.
|
|
|
1448
1449
|
```
|
|
1449
1450
|
USAGE
|
|
1450
1451
|
$ zitadel releases list [--json] [-c <value>] [-s <value>] [-n]
|
|
1451
|
-
[--dry-run] [
|
|
1452
|
-
--page-token <value>] [--fields <value>] [--plain]
|
|
1453
|
-
development|preview|production]
|
|
1452
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
|
|
1453
|
+
--page-token <value>] [--fields <value>] [--plain]
|
|
1454
1454
|
|
|
1455
1455
|
FLAGS
|
|
1456
|
-
-a, --all
|
|
1457
|
-
-c, --cwd=<value>
|
|
1458
|
-
-
|
|
1459
|
-
|
|
1460
|
-
-
|
|
1461
|
-
|
|
1462
|
-
|
|
1463
|
-
|
|
1464
|
-
--
|
|
1465
|
-
--
|
|
1466
|
-
|
|
1467
|
-
|
|
1468
|
-
|
|
1469
|
-
--
|
|
1470
|
-
--
|
|
1471
|
-
|
|
1472
|
-
|
|
1473
|
-
|
|
1474
|
-
|
|
1456
|
+
-a, --all Fetch every page instead of one.
|
|
1457
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1458
|
+
-n, --non-interactive Disable prompts. Required when scripting or running
|
|
1459
|
+
as an agent.
|
|
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.
|
|
1464
|
+
--debug Debug logging.
|
|
1465
|
+
--dry-run Preview without mutating files or the platform.
|
|
1466
|
+
--fields=<value> Columns to show, comma-separated dot-paths (e.g.
|
|
1467
|
+
id,attributes.email). Defaults to the resource's own
|
|
1468
|
+
columns; `--json` is unaffected.
|
|
1469
|
+
--limit=<value> Page size (server default 20, max 100).
|
|
1470
|
+
--page-token=<value> Continue from a previous page's next_page_token.
|
|
1471
|
+
--plain Tab-separated rows with no header, for piping.
|
|
1472
|
+
Implied when stdout is not a terminal.
|
|
1473
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1474
|
+
--no-telemetry.
|
|
1475
1475
|
|
|
1476
1476
|
GLOBAL FLAGS
|
|
1477
1477
|
--json Format output as json.
|
|
@@ -1492,7 +1492,7 @@ Delete the local Zitadel server runtime and data.
|
|
|
1492
1492
|
```
|
|
1493
1493
|
USAGE
|
|
1494
1494
|
$ zitadel reset [--json] [-c <value>] [-s <value>] [-n]
|
|
1495
|
-
[--dry-run] [
|
|
1495
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-f]
|
|
1496
1496
|
|
|
1497
1497
|
FLAGS
|
|
1498
1498
|
-c, --cwd=<value> Project directory to operate on.
|
|
@@ -1501,11 +1501,13 @@ FLAGS
|
|
|
1501
1501
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1502
1502
|
an agent.
|
|
1503
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.
|
|
1504
1507
|
--debug Debug logging.
|
|
1505
1508
|
--dry-run Preview without mutating files or the platform.
|
|
1506
1509
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1507
1510
|
--no-telemetry.
|
|
1508
|
-
--verbose Verbose logging.
|
|
1509
1511
|
|
|
1510
1512
|
GLOBAL FLAGS
|
|
1511
1513
|
--json Format output as json.
|
|
@@ -1521,18 +1523,20 @@ List the resources this CLI manages and what can be done to each.
|
|
|
1521
1523
|
```
|
|
1522
1524
|
USAGE
|
|
1523
1525
|
$ zitadel resources [--json] [-c <value>] [-s <value>] [-n]
|
|
1524
|
-
[--dry-run] [
|
|
1526
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry]
|
|
1525
1527
|
|
|
1526
1528
|
FLAGS
|
|
1527
1529
|
-c, --cwd=<value> Project directory to operate on.
|
|
1528
1530
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1529
1531
|
an agent.
|
|
1530
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.
|
|
1531
1536
|
--debug Debug logging.
|
|
1532
1537
|
--dry-run Preview without mutating files or the platform.
|
|
1533
1538
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1534
1539
|
--no-telemetry.
|
|
1535
|
-
--verbose Verbose logging.
|
|
1536
1540
|
|
|
1537
1541
|
GLOBAL FLAGS
|
|
1538
1542
|
--json Format output as json.
|
|
@@ -1555,27 +1559,25 @@ Get one schema by id.
|
|
|
1555
1559
|
```
|
|
1556
1560
|
USAGE
|
|
1557
1561
|
$ zitadel schemas get SCHEMA [--json] [-c <value>] [-s <value>] [-n]
|
|
1558
|
-
[--dry-run] [
|
|
1559
|
-
development|preview|production]
|
|
1562
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
|
|
1560
1563
|
|
|
1561
1564
|
ARGUMENTS
|
|
1562
1565
|
SCHEMA object type (current revision) or revision id
|
|
1563
1566
|
|
|
1564
1567
|
FLAGS
|
|
1565
|
-
-c, --cwd=<value>
|
|
1566
|
-
-
|
|
1567
|
-
|
|
1568
|
-
-
|
|
1569
|
-
|
|
1570
|
-
|
|
1571
|
-
|
|
1572
|
-
--
|
|
1573
|
-
--
|
|
1574
|
-
|
|
1575
|
-
|
|
1576
|
-
--[no-]telemetry
|
|
1577
|
-
|
|
1578
|
-
--verbose Verbose logging.
|
|
1568
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1569
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1570
|
+
an agent.
|
|
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.
|
|
1575
|
+
--debug Debug logging.
|
|
1576
|
+
--dry-run Preview without mutating files or the platform.
|
|
1577
|
+
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
1578
|
+
the resource's own; `--json` is unaffected.
|
|
1579
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1580
|
+
--no-telemetry.
|
|
1579
1581
|
|
|
1580
1582
|
GLOBAL FLAGS
|
|
1581
1583
|
--json Format output as json.
|
|
@@ -1596,34 +1598,32 @@ List schemas.
|
|
|
1596
1598
|
```
|
|
1597
1599
|
USAGE
|
|
1598
1600
|
$ zitadel schemas list [--json] [-c <value>] [-s <value>] [-n]
|
|
1599
|
-
[--dry-run] [
|
|
1600
|
-
--page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
|
|
1601
|
-
development|preview|production]
|
|
1601
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
|
|
1602
|
+
--page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
|
|
1602
1603
|
|
|
1603
1604
|
FLAGS
|
|
1604
|
-
-a, --all
|
|
1605
|
-
-c, --cwd=<value>
|
|
1606
|
-
-
|
|
1607
|
-
|
|
1608
|
-
-
|
|
1609
|
-
|
|
1610
|
-
|
|
1611
|
-
|
|
1612
|
-
--
|
|
1613
|
-
--
|
|
1614
|
-
|
|
1615
|
-
|
|
1616
|
-
|
|
1617
|
-
|
|
1618
|
-
|
|
1619
|
-
|
|
1620
|
-
--limit=<value>
|
|
1621
|
-
--page-token=<value>
|
|
1622
|
-
--plain
|
|
1623
|
-
|
|
1624
|
-
--[no-]telemetry
|
|
1625
|
-
|
|
1626
|
-
--verbose Verbose logging.
|
|
1605
|
+
-a, --all Fetch every page instead of one.
|
|
1606
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1607
|
+
-n, --non-interactive Disable prompts. Required when scripting or running
|
|
1608
|
+
as an agent.
|
|
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.
|
|
1613
|
+
--debug Debug logging.
|
|
1614
|
+
--dry-run Preview without mutating files or the platform.
|
|
1615
|
+
--fields=<value> Columns to show, comma-separated dot-paths (e.g.
|
|
1616
|
+
id,attributes.email). Defaults to the resource's own
|
|
1617
|
+
columns; `--json` is unaffected.
|
|
1618
|
+
--filter=<value>... Filter as field=operation:value (operation defaults
|
|
1619
|
+
to equals). Fields: object_type (equals), kind
|
|
1620
|
+
(equals), revisions (equals; values all|latest).
|
|
1621
|
+
--limit=<value> Page size (server default 20, max 100).
|
|
1622
|
+
--page-token=<value> Continue from a previous page's next_page_token.
|
|
1623
|
+
--plain Tab-separated rows with no header, for piping.
|
|
1624
|
+
Implied when stdout is not a terminal.
|
|
1625
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1626
|
+
--no-telemetry.
|
|
1627
1627
|
|
|
1628
1628
|
GLOBAL FLAGS
|
|
1629
1629
|
--json Format output as json.
|
|
@@ -1663,27 +1663,25 @@ Get one session by id.
|
|
|
1663
1663
|
```
|
|
1664
1664
|
USAGE
|
|
1665
1665
|
$ zitadel sessions get ID [--json] [-c <value>] [-s <value>] [-n]
|
|
1666
|
-
[--dry-run] [
|
|
1667
|
-
development|preview|production]
|
|
1666
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
|
|
1668
1667
|
|
|
1669
1668
|
ARGUMENTS
|
|
1670
1669
|
ID session id
|
|
1671
1670
|
|
|
1672
1671
|
FLAGS
|
|
1673
|
-
-c, --cwd=<value>
|
|
1674
|
-
-
|
|
1675
|
-
|
|
1676
|
-
-
|
|
1677
|
-
|
|
1678
|
-
|
|
1679
|
-
|
|
1680
|
-
--
|
|
1681
|
-
--
|
|
1682
|
-
|
|
1683
|
-
|
|
1684
|
-
--[no-]telemetry
|
|
1685
|
-
|
|
1686
|
-
--verbose Verbose logging.
|
|
1672
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1673
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1674
|
+
an agent.
|
|
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.
|
|
1679
|
+
--debug Debug logging.
|
|
1680
|
+
--dry-run Preview without mutating files or the platform.
|
|
1681
|
+
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
1682
|
+
the resource's own; `--json` is unaffected.
|
|
1683
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1684
|
+
--no-telemetry.
|
|
1687
1685
|
|
|
1688
1686
|
GLOBAL FLAGS
|
|
1689
1687
|
--json Format output as json.
|
|
@@ -1704,9 +1702,9 @@ List sessions.
|
|
|
1704
1702
|
```
|
|
1705
1703
|
USAGE
|
|
1706
1704
|
$ zitadel sessions list [--json] [-c <value>] [-s <value>] [-n]
|
|
1707
|
-
[--dry-run] [
|
|
1705
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
|
|
1708
1706
|
--page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
|
|
1709
|
-
[--sort <value>]
|
|
1707
|
+
[--sort <value>]
|
|
1710
1708
|
|
|
1711
1709
|
FLAGS
|
|
1712
1710
|
-a, --all
|
|
@@ -1715,16 +1713,19 @@ FLAGS
|
|
|
1715
1713
|
-c, --cwd=<value>
|
|
1716
1714
|
Project directory to operate on.
|
|
1717
1715
|
|
|
1718
|
-
-e, --environment=<option>
|
|
1719
|
-
Target environment (default: development).
|
|
1720
|
-
<options: development|preview|production>
|
|
1721
|
-
|
|
1722
1716
|
-n, --non-interactive
|
|
1723
1717
|
Disable prompts. Required when scripting or running as an agent.
|
|
1724
1718
|
|
|
1725
1719
|
-s, --server=<value>
|
|
1726
1720
|
Override the resolved server URL.
|
|
1727
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
|
+
|
|
1728
1729
|
--debug
|
|
1729
1730
|
Debug logging.
|
|
1730
1731
|
|
|
@@ -1761,9 +1762,6 @@ FLAGS
|
|
|
1761
1762
|
--[no-]telemetry
|
|
1762
1763
|
Send anonymous usage analytics. Disable with --no-telemetry.
|
|
1763
1764
|
|
|
1764
|
-
--verbose
|
|
1765
|
-
Verbose logging.
|
|
1766
|
-
|
|
1767
1765
|
GLOBAL FLAGS
|
|
1768
1766
|
--json Format output as json.
|
|
1769
1767
|
|
|
@@ -1785,26 +1783,25 @@ Revoke a session by id.
|
|
|
1785
1783
|
```
|
|
1786
1784
|
USAGE
|
|
1787
1785
|
$ zitadel sessions revoke ID [--json] [-c <value>] [-s <value>] [-n]
|
|
1788
|
-
[--dry-run] [
|
|
1789
|
-
development|preview|production]
|
|
1786
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-f]
|
|
1790
1787
|
|
|
1791
1788
|
ARGUMENTS
|
|
1792
1789
|
ID session id
|
|
1793
1790
|
|
|
1794
1791
|
FLAGS
|
|
1795
|
-
-c, --cwd=<value>
|
|
1796
|
-
-
|
|
1797
|
-
|
|
1798
|
-
-
|
|
1799
|
-
|
|
1800
|
-
-
|
|
1801
|
-
|
|
1802
|
-
|
|
1803
|
-
|
|
1804
|
-
--
|
|
1805
|
-
--
|
|
1806
|
-
|
|
1807
|
-
|
|
1792
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1793
|
+
-f, --force Revoke the session without the confirmation prompt.
|
|
1794
|
+
Required when non-interactive.
|
|
1795
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1796
|
+
an agent.
|
|
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.
|
|
1801
|
+
--debug Debug logging.
|
|
1802
|
+
--dry-run Preview without mutating files or the platform.
|
|
1803
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1804
|
+
--no-telemetry.
|
|
1808
1805
|
|
|
1809
1806
|
GLOBAL FLAGS
|
|
1810
1807
|
--json Format output as json.
|
|
@@ -1823,18 +1820,19 @@ Create a Zitadel project and scaffold local auth.
|
|
|
1823
1820
|
```
|
|
1824
1821
|
USAGE
|
|
1825
1822
|
$ zitadel setup [--json] [-c <value>] [-s <value>] [-n]
|
|
1826
|
-
[--dry-run] [
|
|
1823
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-f] [--framework
|
|
1827
1824
|
next|nuxt|react|vue|solid|svelte|qwik|angular] [--renderer react]
|
|
1828
1825
|
[--dev-port <value>] [--skip-install] [--preset
|
|
1829
|
-
password-first|passkey-first] [--use-case minimal|consumer|business]
|
|
1830
|
-
[--
|
|
1826
|
+
password-first|passkey-first] [--use-case minimal|consumer|business] [--sso
|
|
1827
|
+
google] [--sso-client-id <value>]
|
|
1831
1828
|
|
|
1832
1829
|
FLAGS
|
|
1833
1830
|
-c, --cwd=<value>
|
|
1834
1831
|
Project directory to operate on.
|
|
1835
1832
|
|
|
1836
1833
|
-f, --force
|
|
1837
|
-
Overwrite managed files that already exist
|
|
1834
|
+
Overwrite managed files that already exist, and scaffold into a non-empty
|
|
1835
|
+
directory.
|
|
1838
1836
|
|
|
1839
1837
|
-n, --non-interactive
|
|
1840
1838
|
Disable prompts. Required when scripting or running as an agent.
|
|
@@ -1842,20 +1840,16 @@ FLAGS
|
|
|
1842
1840
|
-s, --server=<value>
|
|
1843
1841
|
Override the resolved server URL.
|
|
1844
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
|
+
|
|
1845
1850
|
--debug
|
|
1846
1851
|
Debug logging.
|
|
1847
1852
|
|
|
1848
|
-
--design=<option>
|
|
1849
|
-
Login design to eject into .zitadel/branding/ and publish as branding
|
|
1850
|
-
revision 1. Skips the wizard's design question. When omitted in
|
|
1851
|
-
non-interactive runs, the login uses the built-in template; run the
|
|
1852
|
-
`branding eject` command later to customize. Split-family designs (split,
|
|
1853
|
-
split-right, hero) collapse their brand pane by container width: narrow
|
|
1854
|
-
containers — including widget-posture embeds at card width — render the
|
|
1855
|
-
compact brand mark instead (logo_url, else hero_url, from
|
|
1856
|
-
.zitadel/branding/branding.json; hero falls back to editable text).
|
|
1857
|
-
<options: centered|split|split-right|hero|minimal>
|
|
1858
|
-
|
|
1859
1853
|
--dev-port=<value>
|
|
1860
1854
|
Dev-server port; also the issuer origin registered with Zitadel. Defaults to
|
|
1861
1855
|
the detected port. Use distinct ports to run several scaffolded apps side by
|
|
@@ -1880,6 +1874,16 @@ FLAGS
|
|
|
1880
1874
|
--skip-install
|
|
1881
1875
|
Do not install dependencies after setup updates package.json.
|
|
1882
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
|
+
|
|
1883
1887
|
--[no-]telemetry
|
|
1884
1888
|
Send anonymous usage analytics. Disable with --no-telemetry.
|
|
1885
1889
|
|
|
@@ -1888,9 +1892,6 @@ FLAGS
|
|
|
1888
1892
|
minimal).
|
|
1889
1893
|
<options: minimal|consumer|business>
|
|
1890
1894
|
|
|
1891
|
-
--verbose
|
|
1892
|
-
Verbose logging.
|
|
1893
|
-
|
|
1894
1895
|
GLOBAL FLAGS
|
|
1895
1896
|
--json Format output as json.
|
|
1896
1897
|
|
|
@@ -1903,6 +1904,49 @@ EXAMPLES
|
|
|
1903
1904
|
$ zitadel setup --framework react --dev-port 3000
|
|
1904
1905
|
```
|
|
1905
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
|
+
|
|
1906
1950
|
## `zitadel start`
|
|
1907
1951
|
|
|
1908
1952
|
Start a local Zitadel server.
|
|
@@ -1910,7 +1954,7 @@ Start a local Zitadel server.
|
|
|
1910
1954
|
```
|
|
1911
1955
|
USAGE
|
|
1912
1956
|
$ zitadel start [--json] [-c <value>] [-s <value>] [-n]
|
|
1913
|
-
[--dry-run] [
|
|
1957
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--image <value>] [--port
|
|
1914
1958
|
<value>] [--runtime binary|docker]
|
|
1915
1959
|
|
|
1916
1960
|
FLAGS
|
|
@@ -1918,6 +1962,9 @@ FLAGS
|
|
|
1918
1962
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1919
1963
|
an agent.
|
|
1920
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.
|
|
1921
1968
|
--debug Debug logging.
|
|
1922
1969
|
--dry-run Preview without mutating files or the platform.
|
|
1923
1970
|
--image=<value> Container image to run.
|
|
@@ -1926,7 +1973,6 @@ FLAGS
|
|
|
1926
1973
|
<options: binary|docker>
|
|
1927
1974
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1928
1975
|
--no-telemetry.
|
|
1929
|
-
--verbose Verbose logging.
|
|
1930
1976
|
|
|
1931
1977
|
GLOBAL FLAGS
|
|
1932
1978
|
--json Format output as json.
|
|
@@ -1942,18 +1988,20 @@ Summarize the local Zitadel server and project state.
|
|
|
1942
1988
|
```
|
|
1943
1989
|
USAGE
|
|
1944
1990
|
$ zitadel status [--json] [-c <value>] [-s <value>] [-n]
|
|
1945
|
-
[--dry-run] [
|
|
1991
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry]
|
|
1946
1992
|
|
|
1947
1993
|
FLAGS
|
|
1948
1994
|
-c, --cwd=<value> Project directory to operate on.
|
|
1949
1995
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1950
1996
|
an agent.
|
|
1951
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.
|
|
1952
2001
|
--debug Debug logging.
|
|
1953
2002
|
--dry-run Preview without mutating files or the platform.
|
|
1954
2003
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1955
2004
|
--no-telemetry.
|
|
1956
|
-
--verbose Verbose logging.
|
|
1957
2005
|
|
|
1958
2006
|
GLOBAL FLAGS
|
|
1959
2007
|
--json Format output as json.
|
|
@@ -1969,20 +2017,22 @@ Stop the local Zitadel server.
|
|
|
1969
2017
|
```
|
|
1970
2018
|
USAGE
|
|
1971
2019
|
$ zitadel stop [--json] [-c <value>] [-s <value>] [-n]
|
|
1972
|
-
[--dry-run] [
|
|
2020
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--all]
|
|
1973
2021
|
|
|
1974
2022
|
FLAGS
|
|
1975
2023
|
-c, --cwd=<value> Project directory to operate on.
|
|
1976
2024
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1977
2025
|
an agent.
|
|
1978
2026
|
-s, --server=<value> Override the resolved server URL.
|
|
2027
|
+
-v, --verbose Verbose logging.
|
|
1979
2028
|
--all Stop all discovered CLI-managed local Zitadel runtime
|
|
1980
2029
|
processes.
|
|
2030
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2031
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
1981
2032
|
--debug Debug logging.
|
|
1982
2033
|
--dry-run Preview without mutating files or the platform.
|
|
1983
2034
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1984
2035
|
--no-telemetry.
|
|
1985
|
-
--verbose Verbose logging.
|
|
1986
2036
|
|
|
1987
2037
|
GLOBAL FLAGS
|
|
1988
2038
|
--json Format output as json.
|
|
@@ -1998,21 +2048,21 @@ Create a team.
|
|
|
1998
2048
|
```
|
|
1999
2049
|
USAGE
|
|
2000
2050
|
$ zitadel teams create [--json] [-c <value>] [-s <value>] [-n]
|
|
2001
|
-
[--dry-run] [
|
|
2002
|
-
<value> | --file <value>]
|
|
2051
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--name <value>] [--data
|
|
2052
|
+
<value> | --file <value>]
|
|
2003
2053
|
|
|
2004
2054
|
FLAGS
|
|
2005
|
-
-c, --cwd=<value>
|
|
2006
|
-
-
|
|
2007
|
-
|
|
2008
|
-
-
|
|
2009
|
-
|
|
2010
|
-
|
|
2011
|
-
|
|
2012
|
-
--
|
|
2013
|
-
--
|
|
2014
|
-
|
|
2015
|
-
|
|
2055
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2056
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2057
|
+
an agent.
|
|
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.
|
|
2062
|
+
--debug Debug logging.
|
|
2063
|
+
--dry-run Preview without mutating files or the platform.
|
|
2064
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2065
|
+
--no-telemetry.
|
|
2016
2066
|
|
|
2017
2067
|
RAW BODY FLAGS
|
|
2018
2068
|
--data=<value> Whole body as a JSON object, instead of the field flags.
|
|
@@ -2042,26 +2092,25 @@ Deactivate a team by id.
|
|
|
2042
2092
|
```
|
|
2043
2093
|
USAGE
|
|
2044
2094
|
$ zitadel teams deactivate ID [--json] [-c <value>] [-s <value>] [-n]
|
|
2045
|
-
[--dry-run] [
|
|
2046
|
-
development|preview|production]
|
|
2095
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-f]
|
|
2047
2096
|
|
|
2048
2097
|
ARGUMENTS
|
|
2049
2098
|
ID team id
|
|
2050
2099
|
|
|
2051
2100
|
FLAGS
|
|
2052
|
-
-c, --cwd=<value>
|
|
2053
|
-
-
|
|
2054
|
-
|
|
2055
|
-
-
|
|
2056
|
-
|
|
2057
|
-
-
|
|
2058
|
-
|
|
2059
|
-
|
|
2060
|
-
|
|
2061
|
-
--
|
|
2062
|
-
--
|
|
2063
|
-
|
|
2064
|
-
|
|
2101
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2102
|
+
-f, --force Deactivate the team without the confirmation prompt.
|
|
2103
|
+
Required when non-interactive.
|
|
2104
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2105
|
+
an agent.
|
|
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.
|
|
2110
|
+
--debug Debug logging.
|
|
2111
|
+
--dry-run Preview without mutating files or the platform.
|
|
2112
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2113
|
+
--no-telemetry.
|
|
2065
2114
|
|
|
2066
2115
|
GLOBAL FLAGS
|
|
2067
2116
|
--json Format output as json.
|
|
@@ -2080,27 +2129,25 @@ Get one team by id.
|
|
|
2080
2129
|
```
|
|
2081
2130
|
USAGE
|
|
2082
2131
|
$ zitadel teams get ID [--json] [-c <value>] [-s <value>] [-n]
|
|
2083
|
-
[--dry-run] [
|
|
2084
|
-
development|preview|production]
|
|
2132
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
|
|
2085
2133
|
|
|
2086
2134
|
ARGUMENTS
|
|
2087
2135
|
ID team id
|
|
2088
2136
|
|
|
2089
2137
|
FLAGS
|
|
2090
|
-
-c, --cwd=<value>
|
|
2091
|
-
-
|
|
2092
|
-
|
|
2093
|
-
-
|
|
2094
|
-
|
|
2095
|
-
|
|
2096
|
-
|
|
2097
|
-
--
|
|
2098
|
-
--
|
|
2099
|
-
|
|
2100
|
-
|
|
2101
|
-
--[no-]telemetry
|
|
2102
|
-
|
|
2103
|
-
--verbose Verbose logging.
|
|
2138
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2139
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2140
|
+
an agent.
|
|
2141
|
+
-s, --server=<value> Override the resolved server URL.
|
|
2142
|
+
-v, --verbose Verbose logging.
|
|
2143
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2144
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
2145
|
+
--debug Debug logging.
|
|
2146
|
+
--dry-run Preview without mutating files or the platform.
|
|
2147
|
+
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
2148
|
+
the resource's own; `--json` is unaffected.
|
|
2149
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2150
|
+
--no-telemetry.
|
|
2104
2151
|
|
|
2105
2152
|
GLOBAL FLAGS
|
|
2106
2153
|
--json Format output as json.
|
|
@@ -2121,9 +2168,9 @@ List teams.
|
|
|
2121
2168
|
```
|
|
2122
2169
|
USAGE
|
|
2123
2170
|
$ zitadel teams list [--json] [-c <value>] [-s <value>] [-n]
|
|
2124
|
-
[--dry-run] [
|
|
2171
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
|
|
2125
2172
|
--page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
|
|
2126
|
-
[--sort <value>]
|
|
2173
|
+
[--sort <value>]
|
|
2127
2174
|
|
|
2128
2175
|
FLAGS
|
|
2129
2176
|
-a, --all
|
|
@@ -2132,16 +2179,19 @@ FLAGS
|
|
|
2132
2179
|
-c, --cwd=<value>
|
|
2133
2180
|
Project directory to operate on.
|
|
2134
2181
|
|
|
2135
|
-
-e, --environment=<option>
|
|
2136
|
-
Target environment (default: development).
|
|
2137
|
-
<options: development|preview|production>
|
|
2138
|
-
|
|
2139
2182
|
-n, --non-interactive
|
|
2140
2183
|
Disable prompts. Required when scripting or running as an agent.
|
|
2141
2184
|
|
|
2142
2185
|
-s, --server=<value>
|
|
2143
2186
|
Override the resolved server URL.
|
|
2144
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
|
+
|
|
2145
2195
|
--debug
|
|
2146
2196
|
Debug logging.
|
|
2147
2197
|
|
|
@@ -2176,9 +2226,6 @@ FLAGS
|
|
|
2176
2226
|
--[no-]telemetry
|
|
2177
2227
|
Send anonymous usage analytics. Disable with --no-telemetry.
|
|
2178
2228
|
|
|
2179
|
-
--verbose
|
|
2180
|
-
Verbose logging.
|
|
2181
|
-
|
|
2182
2229
|
GLOBAL FLAGS
|
|
2183
2230
|
--json Format output as json.
|
|
2184
2231
|
|
|
@@ -2200,24 +2247,24 @@ Update a team by id.
|
|
|
2200
2247
|
```
|
|
2201
2248
|
USAGE
|
|
2202
2249
|
$ zitadel teams update ID [--json] [-c <value>] [-s <value>] [-n]
|
|
2203
|
-
[--dry-run] [
|
|
2204
|
-
<value> | --file <value>]
|
|
2250
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--name <value>] [--data
|
|
2251
|
+
<value> | --file <value>]
|
|
2205
2252
|
|
|
2206
2253
|
ARGUMENTS
|
|
2207
2254
|
ID team id
|
|
2208
2255
|
|
|
2209
2256
|
FLAGS
|
|
2210
|
-
-c, --cwd=<value>
|
|
2211
|
-
-
|
|
2212
|
-
|
|
2213
|
-
-
|
|
2214
|
-
|
|
2215
|
-
|
|
2216
|
-
|
|
2217
|
-
--
|
|
2218
|
-
--
|
|
2219
|
-
|
|
2220
|
-
|
|
2257
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2258
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2259
|
+
an agent.
|
|
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.
|
|
2264
|
+
--debug Debug logging.
|
|
2265
|
+
--dry-run Preview without mutating files or the platform.
|
|
2266
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2267
|
+
--no-telemetry.
|
|
2221
2268
|
|
|
2222
2269
|
RAW BODY FLAGS
|
|
2223
2270
|
--data=<value> Whole body as a JSON object, instead of the field flags.
|
|
@@ -2245,7 +2292,7 @@ Remove managed files and local Zitadel state.
|
|
|
2245
2292
|
```
|
|
2246
2293
|
USAGE
|
|
2247
2294
|
$ zitadel uninstall [--json] [-c <value>] [-s <value>] [-n]
|
|
2248
|
-
[--dry-run] [
|
|
2295
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-f]
|
|
2249
2296
|
|
|
2250
2297
|
FLAGS
|
|
2251
2298
|
-c, --cwd=<value> Project directory to operate on.
|
|
@@ -2254,11 +2301,13 @@ FLAGS
|
|
|
2254
2301
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2255
2302
|
an agent.
|
|
2256
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.
|
|
2257
2307
|
--debug Debug logging.
|
|
2258
2308
|
--dry-run Preview without mutating files or the platform.
|
|
2259
2309
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2260
2310
|
--no-telemetry.
|
|
2261
|
-
--verbose Verbose logging.
|
|
2262
2311
|
|
|
2263
2312
|
GLOBAL FLAGS
|
|
2264
2313
|
--json Format output as json.
|
|
@@ -2277,22 +2326,21 @@ Create an user.
|
|
|
2277
2326
|
```
|
|
2278
2327
|
USAGE
|
|
2279
2328
|
$ zitadel users create [--json] [-c <value>] [-s <value>] [-n]
|
|
2280
|
-
[--dry-run] [
|
|
2281
|
-
[--attributes <value>...] [--data <value> | --file <value>]
|
|
2282
|
-
development|preview|production]
|
|
2329
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--schema <value>]
|
|
2330
|
+
[--attributes <value>...] [--data <value> | --file <value>]
|
|
2283
2331
|
|
|
2284
2332
|
FLAGS
|
|
2285
|
-
-c, --cwd=<value>
|
|
2286
|
-
-
|
|
2287
|
-
|
|
2288
|
-
-
|
|
2289
|
-
|
|
2290
|
-
|
|
2291
|
-
|
|
2292
|
-
--
|
|
2293
|
-
--
|
|
2294
|
-
|
|
2295
|
-
|
|
2333
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2334
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2335
|
+
an agent.
|
|
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.
|
|
2340
|
+
--debug Debug logging.
|
|
2341
|
+
--dry-run Preview without mutating files or the platform.
|
|
2342
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2343
|
+
--no-telemetry.
|
|
2296
2344
|
|
|
2297
2345
|
REQUIRED FIELD FLAGS
|
|
2298
2346
|
--attributes=<value>... (required) Repeatable attributes entry: key=value for
|
|
@@ -2326,26 +2374,25 @@ Delete an user by id.
|
|
|
2326
2374
|
```
|
|
2327
2375
|
USAGE
|
|
2328
2376
|
$ zitadel users delete ID [--json] [-c <value>] [-s <value>] [-n]
|
|
2329
|
-
[--dry-run] [
|
|
2330
|
-
development|preview|production]
|
|
2377
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-f]
|
|
2331
2378
|
|
|
2332
2379
|
ARGUMENTS
|
|
2333
2380
|
ID user id
|
|
2334
2381
|
|
|
2335
2382
|
FLAGS
|
|
2336
|
-
-c, --cwd=<value>
|
|
2337
|
-
-
|
|
2338
|
-
|
|
2339
|
-
-
|
|
2340
|
-
|
|
2341
|
-
-
|
|
2342
|
-
|
|
2343
|
-
|
|
2344
|
-
|
|
2345
|
-
--
|
|
2346
|
-
--
|
|
2347
|
-
|
|
2348
|
-
|
|
2383
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2384
|
+
-f, --force Delete the user without the confirmation prompt.
|
|
2385
|
+
Required when non-interactive.
|
|
2386
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2387
|
+
an agent.
|
|
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.
|
|
2392
|
+
--debug Debug logging.
|
|
2393
|
+
--dry-run Preview without mutating files or the platform.
|
|
2394
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2395
|
+
--no-telemetry.
|
|
2349
2396
|
|
|
2350
2397
|
GLOBAL FLAGS
|
|
2351
2398
|
--json Format output as json.
|
|
@@ -2364,27 +2411,25 @@ Get one user by id.
|
|
|
2364
2411
|
```
|
|
2365
2412
|
USAGE
|
|
2366
2413
|
$ zitadel users get ID [--json] [-c <value>] [-s <value>] [-n]
|
|
2367
|
-
[--dry-run] [
|
|
2368
|
-
development|preview|production]
|
|
2414
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
|
|
2369
2415
|
|
|
2370
2416
|
ARGUMENTS
|
|
2371
2417
|
ID user id
|
|
2372
2418
|
|
|
2373
2419
|
FLAGS
|
|
2374
|
-
-c, --cwd=<value>
|
|
2375
|
-
-
|
|
2376
|
-
|
|
2377
|
-
-
|
|
2378
|
-
|
|
2379
|
-
|
|
2380
|
-
|
|
2381
|
-
--
|
|
2382
|
-
--
|
|
2383
|
-
|
|
2384
|
-
|
|
2385
|
-
--[no-]telemetry
|
|
2386
|
-
|
|
2387
|
-
--verbose Verbose logging.
|
|
2420
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2421
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2422
|
+
an agent.
|
|
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.
|
|
2427
|
+
--debug Debug logging.
|
|
2428
|
+
--dry-run Preview without mutating files or the platform.
|
|
2429
|
+
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
2430
|
+
the resource's own; `--json` is unaffected.
|
|
2431
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2432
|
+
--no-telemetry.
|
|
2388
2433
|
|
|
2389
2434
|
GLOBAL FLAGS
|
|
2390
2435
|
--json Format output as json.
|
|
@@ -2405,9 +2450,9 @@ List users.
|
|
|
2405
2450
|
```
|
|
2406
2451
|
USAGE
|
|
2407
2452
|
$ zitadel users list [--json] [-c <value>] [-s <value>] [-n]
|
|
2408
|
-
[--dry-run] [
|
|
2453
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
|
|
2409
2454
|
--page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
|
|
2410
|
-
[--sort <value>]
|
|
2455
|
+
[--sort <value>]
|
|
2411
2456
|
|
|
2412
2457
|
FLAGS
|
|
2413
2458
|
-a, --all
|
|
@@ -2416,16 +2461,19 @@ FLAGS
|
|
|
2416
2461
|
-c, --cwd=<value>
|
|
2417
2462
|
Project directory to operate on.
|
|
2418
2463
|
|
|
2419
|
-
-e, --environment=<option>
|
|
2420
|
-
Target environment (default: development).
|
|
2421
|
-
<options: development|preview|production>
|
|
2422
|
-
|
|
2423
2464
|
-n, --non-interactive
|
|
2424
2465
|
Disable prompts. Required when scripting or running as an agent.
|
|
2425
2466
|
|
|
2426
2467
|
-s, --server=<value>
|
|
2427
2468
|
Override the resolved server URL.
|
|
2428
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
|
+
|
|
2429
2477
|
--debug
|
|
2430
2478
|
Debug logging.
|
|
2431
2479
|
|
|
@@ -2466,9 +2514,6 @@ FLAGS
|
|
|
2466
2514
|
--[no-]telemetry
|
|
2467
2515
|
Send anonymous usage analytics. Disable with --no-telemetry.
|
|
2468
2516
|
|
|
2469
|
-
--verbose
|
|
2470
|
-
Verbose logging.
|
|
2471
|
-
|
|
2472
2517
|
GLOBAL FLAGS
|
|
2473
2518
|
--json Format output as json.
|
|
2474
2519
|
|
|
@@ -2490,25 +2535,24 @@ Update an user by id.
|
|
|
2490
2535
|
```
|
|
2491
2536
|
USAGE
|
|
2492
2537
|
$ zitadel users update ID [--json] [-c <value>] [-s <value>] [-n]
|
|
2493
|
-
[--dry-run] [
|
|
2494
|
-
[--attributes <value>...] [--data <value> | --file <value>]
|
|
2495
|
-
development|preview|production]
|
|
2538
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--schema <value>]
|
|
2539
|
+
[--attributes <value>...] [--data <value> | --file <value>]
|
|
2496
2540
|
|
|
2497
2541
|
ARGUMENTS
|
|
2498
2542
|
ID user id
|
|
2499
2543
|
|
|
2500
2544
|
FLAGS
|
|
2501
|
-
-c, --cwd=<value>
|
|
2502
|
-
-
|
|
2503
|
-
|
|
2504
|
-
-
|
|
2505
|
-
|
|
2506
|
-
|
|
2507
|
-
|
|
2508
|
-
--
|
|
2509
|
-
--
|
|
2510
|
-
|
|
2511
|
-
|
|
2545
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2546
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2547
|
+
an agent.
|
|
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.
|
|
2552
|
+
--debug Debug logging.
|
|
2553
|
+
--dry-run Preview without mutating files or the platform.
|
|
2554
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2555
|
+
--no-telemetry.
|
|
2512
2556
|
|
|
2513
2557
|
OPTIONAL FIELD FLAGS
|
|
2514
2558
|
--attributes=<value>... Repeatable attributes entry: key=value for a string,
|
|
@@ -2533,169 +2577,167 @@ EXAMPLES
|
|
|
2533
2577
|
|
|
2534
2578
|
## `zitadel variables delete NAME`
|
|
2535
2579
|
|
|
2536
|
-
Delete one variable from
|
|
2580
|
+
Delete one variable from the project.
|
|
2537
2581
|
|
|
2538
2582
|
```
|
|
2539
2583
|
USAGE
|
|
2540
2584
|
$ zitadel variables delete NAME [--json] [-c <value>] [-s <value>] [-n]
|
|
2541
|
-
[--dry-run] [
|
|
2542
|
-
--project-level] [-f]
|
|
2585
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--project-level] [-f]
|
|
2543
2586
|
|
|
2544
2587
|
ARGUMENTS
|
|
2545
2588
|
NAME Variable name to delete.
|
|
2546
2589
|
|
|
2547
2590
|
FLAGS
|
|
2548
|
-
-c, --cwd=<value>
|
|
2549
|
-
-
|
|
2550
|
-
|
|
2551
|
-
|
|
2552
|
-
|
|
2553
|
-
|
|
2554
|
-
-
|
|
2555
|
-
--
|
|
2556
|
-
|
|
2557
|
-
--
|
|
2558
|
-
|
|
2559
|
-
|
|
2560
|
-
|
|
2561
|
-
|
|
2562
|
-
|
|
2591
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2592
|
+
-f, --force Delete the variable without the confirmation prompt.
|
|
2593
|
+
Required when non-interactive.
|
|
2594
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2595
|
+
an agent.
|
|
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.
|
|
2600
|
+
--debug Debug logging.
|
|
2601
|
+
--dry-run Preview without mutating files or the platform.
|
|
2602
|
+
--project-level Address the project level. Required: it is the only
|
|
2603
|
+
owner the CLI can address today.
|
|
2604
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2605
|
+
--no-telemetry.
|
|
2563
2606
|
|
|
2564
2607
|
GLOBAL FLAGS
|
|
2565
2608
|
--json Format output as json.
|
|
2566
2609
|
|
|
2567
2610
|
DESCRIPTION
|
|
2568
|
-
Delete one variable from
|
|
2611
|
+
Delete one variable from the project.
|
|
2569
2612
|
|
|
2570
2613
|
EXAMPLES
|
|
2571
|
-
$ zitadel variables delete GOOGLE_CLIENT_ID --
|
|
2614
|
+
$ zitadel variables delete GOOGLE_CLIENT_ID --project-level
|
|
2572
2615
|
|
|
2573
2616
|
$ zitadel variables delete GOOGLE_CLIENT_ID --project-level --force
|
|
2574
2617
|
```
|
|
2575
2618
|
|
|
2576
2619
|
## `zitadel variables get NAME`
|
|
2577
2620
|
|
|
2578
|
-
Get one variable from
|
|
2621
|
+
Get one variable from the project.
|
|
2579
2622
|
|
|
2580
2623
|
```
|
|
2581
2624
|
USAGE
|
|
2582
2625
|
$ zitadel variables get NAME [--json] [-c <value>] [-s <value>] [-n]
|
|
2583
|
-
[--dry-run] [
|
|
2584
|
-
--project-level]
|
|
2626
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--project-level]
|
|
2585
2627
|
|
|
2586
2628
|
ARGUMENTS
|
|
2587
2629
|
NAME Variable name to read.
|
|
2588
2630
|
|
|
2589
2631
|
FLAGS
|
|
2590
|
-
-c, --cwd=<value>
|
|
2591
|
-
-
|
|
2592
|
-
|
|
2593
|
-
|
|
2594
|
-
-
|
|
2595
|
-
--
|
|
2596
|
-
|
|
2597
|
-
--
|
|
2598
|
-
|
|
2599
|
-
|
|
2600
|
-
|
|
2601
|
-
|
|
2602
|
-
|
|
2632
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2633
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2634
|
+
an agent.
|
|
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.
|
|
2639
|
+
--debug Debug logging.
|
|
2640
|
+
--dry-run Preview without mutating files or the platform.
|
|
2641
|
+
--project-level Address the project level. Required: it is the only
|
|
2642
|
+
owner the CLI can address today.
|
|
2643
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2644
|
+
--no-telemetry.
|
|
2603
2645
|
|
|
2604
2646
|
GLOBAL FLAGS
|
|
2605
2647
|
--json Format output as json.
|
|
2606
2648
|
|
|
2607
2649
|
DESCRIPTION
|
|
2608
|
-
Get one variable from
|
|
2650
|
+
Get one variable from the project.
|
|
2609
2651
|
|
|
2610
2652
|
EXAMPLES
|
|
2611
|
-
$ zitadel variables get GOOGLE_CLIENT_ID --
|
|
2653
|
+
$ zitadel variables get GOOGLE_CLIENT_ID --project-level
|
|
2612
2654
|
|
|
2613
|
-
$ zitadel variables get GOOGLE_CLIENT_ID --
|
|
2655
|
+
$ zitadel variables get GOOGLE_CLIENT_ID --project-level --json
|
|
2614
2656
|
```
|
|
2615
2657
|
|
|
2616
2658
|
## `zitadel variables list`
|
|
2617
2659
|
|
|
2618
|
-
List the variables entered on
|
|
2660
|
+
List the variables entered on the project.
|
|
2619
2661
|
|
|
2620
2662
|
```
|
|
2621
2663
|
USAGE
|
|
2622
2664
|
$ zitadel variables list [--json] [-c <value>] [-s <value>] [-n]
|
|
2623
|
-
[--dry-run] [
|
|
2624
|
-
|
|
2665
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--project-level]
|
|
2666
|
+
[--plain]
|
|
2625
2667
|
|
|
2626
2668
|
FLAGS
|
|
2627
|
-
-c, --cwd=<value>
|
|
2628
|
-
-
|
|
2629
|
-
|
|
2630
|
-
|
|
2631
|
-
-
|
|
2632
|
-
--
|
|
2633
|
-
|
|
2634
|
-
--
|
|
2635
|
-
|
|
2636
|
-
--
|
|
2637
|
-
|
|
2638
|
-
|
|
2639
|
-
|
|
2640
|
-
|
|
2641
|
-
|
|
2669
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2670
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2671
|
+
an agent.
|
|
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.
|
|
2676
|
+
--debug Debug logging.
|
|
2677
|
+
--dry-run Preview without mutating files or the platform.
|
|
2678
|
+
--plain Tab-separated rows with no header, for piping. Implied
|
|
2679
|
+
when stdout is not a terminal.
|
|
2680
|
+
--project-level Address the project level. Required: it is the only
|
|
2681
|
+
owner the CLI can address today.
|
|
2682
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2683
|
+
--no-telemetry.
|
|
2642
2684
|
|
|
2643
2685
|
GLOBAL FLAGS
|
|
2644
2686
|
--json Format output as json.
|
|
2645
2687
|
|
|
2646
2688
|
DESCRIPTION
|
|
2647
|
-
List the variables entered on
|
|
2689
|
+
List the variables entered on the project.
|
|
2648
2690
|
|
|
2649
2691
|
EXAMPLES
|
|
2650
|
-
$ zitadel variables list --
|
|
2692
|
+
$ zitadel variables list --project-level
|
|
2651
2693
|
|
|
2652
2694
|
$ zitadel variables list --project-level --json
|
|
2653
2695
|
```
|
|
2654
2696
|
|
|
2655
2697
|
## `zitadel variables set NAME`
|
|
2656
2698
|
|
|
2657
|
-
Set one variable on
|
|
2699
|
+
Set one variable on the project.
|
|
2658
2700
|
|
|
2659
2701
|
```
|
|
2660
2702
|
USAGE
|
|
2661
2703
|
$ zitadel variables set NAME [--json] [-c <value>] [-s <value>] [-n]
|
|
2662
|
-
[--dry-run] [
|
|
2663
|
-
|
|
2704
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--project-level]
|
|
2705
|
+
[--secret] [--as string|number|boolean]
|
|
2664
2706
|
|
|
2665
2707
|
ARGUMENTS
|
|
2666
2708
|
NAME Variable name (letters, digits and underscores).
|
|
2667
2709
|
|
|
2668
2710
|
FLAGS
|
|
2669
|
-
-c, --cwd=<value>
|
|
2670
|
-
-
|
|
2671
|
-
|
|
2672
|
-
|
|
2673
|
-
-
|
|
2674
|
-
--as=<option>
|
|
2675
|
-
|
|
2676
|
-
|
|
2677
|
-
|
|
2678
|
-
--
|
|
2679
|
-
|
|
2680
|
-
--
|
|
2681
|
-
|
|
2682
|
-
|
|
2683
|
-
|
|
2684
|
-
|
|
2685
|
-
|
|
2686
|
-
|
|
2687
|
-
|
|
2711
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2712
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2713
|
+
an agent.
|
|
2714
|
+
-s, --server=<value> Override the resolved server URL.
|
|
2715
|
+
-v, --verbose Verbose logging.
|
|
2716
|
+
--as=<option> [default: string] Store the value as this JSON type. A
|
|
2717
|
+
reference to the whole field resolves to that type, so
|
|
2718
|
+
a number stays a number.
|
|
2719
|
+
<options: string|number|boolean>
|
|
2720
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2721
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
2722
|
+
--debug Debug logging.
|
|
2723
|
+
--dry-run Preview without mutating files or the platform.
|
|
2724
|
+
--project-level Address the project level. Required: it is the only
|
|
2725
|
+
owner the CLI can address today.
|
|
2726
|
+
--secret Store the value encrypted. It can be replaced later but
|
|
2727
|
+
never read back.
|
|
2728
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2729
|
+
--no-telemetry.
|
|
2688
2730
|
|
|
2689
2731
|
GLOBAL FLAGS
|
|
2690
2732
|
--json Format output as json.
|
|
2691
2733
|
|
|
2692
2734
|
DESCRIPTION
|
|
2693
|
-
Set one variable on
|
|
2735
|
+
Set one variable on the project.
|
|
2694
2736
|
|
|
2695
2737
|
EXAMPLES
|
|
2696
|
-
$ zitadel variables set GOOGLE_CLIENT_ID --
|
|
2738
|
+
$ zitadel variables set GOOGLE_CLIENT_ID --project-level
|
|
2697
2739
|
|
|
2698
|
-
$ zitadel variables set GOOGLE_CLIENT_SECRET --
|
|
2740
|
+
$ zitadel variables set GOOGLE_CLIENT_SECRET --project-level --secret < secret.txt
|
|
2699
2741
|
|
|
2700
2742
|
$ zitadel variables set SESSION_TTL --project-level --as number
|
|
2701
2743
|
```
|