@zitadel/cli 0.1.0 → 0.3.0
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 +2219 -840
- package/dist/index.mjs +9497 -9715
- package/dist/index.mjs.map +1 -1
- package/dist/lib/oclif/help.mjs +66 -20
- package/dist/lib/oclif/help.mjs.map +1 -1
- package/dist/skills-hint-N1H5-ny1.mjs +4444 -0
- package/dist/skills-hint-N1H5-ny1.mjs.map +1 -0
- package/oclif.manifest.json +4221 -1311
- package/package.json +50 -18
- package/skills/zitadel-cli/SKILL.md +198 -58
- package/skills/zitadel-cli/references/driving-login-ui.md +50 -15
- package/dist/skills-hint-BSspFzhr.mjs +0 -173
- package/dist/skills-hint-BSspFzhr.mjs.map +0 -1
package/README.md
CHANGED
|
@@ -106,12 +106,17 @@ and agent UIs may display stderr package-manager progress together with stdout.
|
|
|
106
106
|
- `zitadel doctor`: verify the local runtime and generated project files
|
|
107
107
|
(including scaffold drift and dependency-version alignment)
|
|
108
108
|
- `zitadel status`: summarise the local runtime and project
|
|
109
|
-
- `zitadel
|
|
110
|
-
-
|
|
109
|
+
- `zitadel deploy`: build a release from `.zitadel/` and deploy it to the
|
|
110
|
+
project's primary origins (`--dry-run` validates and previews only)
|
|
111
|
+
- `zitadel pull`: rebuild `.zitadel/` from the revisions a released snapshot
|
|
112
|
+
pins — the inverse of deploy — for `latest`, a release id, or a deployment id
|
|
111
113
|
- `zitadel branding eject`: scaffold an editable login template from a design
|
|
112
114
|
- `zitadel schemas list`: list the project's user schemas
|
|
113
|
-
- `zitadel
|
|
114
|
-
|
|
115
|
+
- `zitadel variable set|get|list|rm`: manage the project's variables and secrets
|
|
116
|
+
(`--preview` for a preview override); `zitadel variable resolve` shows what a
|
|
117
|
+
target's live deployment runs
|
|
118
|
+
- `zitadel origin add|list|rm`: manage the origin patterns the project admits
|
|
119
|
+
(`--kind primary|preview`)
|
|
115
120
|
- `zitadel eject`: remove what setup wrote (alias: `zitadel uninstall`)
|
|
116
121
|
- `zitadel start|stop|logs|reset`: manage the local runtime
|
|
117
122
|
|
|
@@ -125,7 +130,8 @@ which ships in this package.
|
|
|
125
130
|
<summary>Full command reference</summary>
|
|
126
131
|
|
|
127
132
|
<!-- commands -->
|
|
128
|
-
* [`zitadel
|
|
133
|
+
* [`zitadel api [OPERATION]`](#zitadel-api-operation)
|
|
134
|
+
* [`zitadel api ls [FILTER]`](#zitadel-api-ls-filter)
|
|
129
135
|
* [`zitadel auth-method passkey disable`](#zitadel-auth-method-passkey-disable)
|
|
130
136
|
* [`zitadel auth-method passkey enable`](#zitadel-auth-method-passkey-enable)
|
|
131
137
|
* [`zitadel auth-method password disable`](#zitadel-auth-method-password-disable)
|
|
@@ -139,8 +145,16 @@ which ships in this package.
|
|
|
139
145
|
* [`zitadel claim`](#zitadel-claim)
|
|
140
146
|
* [`zitadel commands`](#zitadel-commands)
|
|
141
147
|
* [`zitadel console`](#zitadel-console)
|
|
148
|
+
* [`zitadel deploy`](#zitadel-deploy)
|
|
149
|
+
* [`zitadel deployment create`](#zitadel-deployment-create)
|
|
150
|
+
* [`zitadel deployment get DEPLOYMENT_ID`](#zitadel-deployment-get-deployment_id)
|
|
151
|
+
* [`zitadel deployment list`](#zitadel-deployment-list)
|
|
152
|
+
* [`zitadel deployment rollback [DEPLOYMENT_ID]`](#zitadel-deployment-rollback-deployment_id)
|
|
142
153
|
* [`zitadel doctor`](#zitadel-doctor)
|
|
143
154
|
* [`zitadel eject`](#zitadel-eject)
|
|
155
|
+
* [`zitadel env`](#zitadel-env)
|
|
156
|
+
* [`zitadel env add NAME`](#zitadel-env-add-name)
|
|
157
|
+
* [`zitadel env list`](#zitadel-env-list)
|
|
144
158
|
* [`zitadel events get ID`](#zitadel-events-get-id)
|
|
145
159
|
* [`zitadel events list`](#zitadel-events-list)
|
|
146
160
|
* [`zitadel flow-definitions get FLOW`](#zitadel-flow-definitions-get-flow)
|
|
@@ -154,12 +168,22 @@ which ships in this package.
|
|
|
154
168
|
* [`zitadel idps get ID`](#zitadel-idps-get-id)
|
|
155
169
|
* [`zitadel idps list`](#zitadel-idps-list)
|
|
156
170
|
* [`zitadel logs`](#zitadel-logs)
|
|
157
|
-
* [`zitadel
|
|
171
|
+
* [`zitadel origin add PATTERN`](#zitadel-origin-add-pattern)
|
|
172
|
+
* [`zitadel origin list`](#zitadel-origin-list)
|
|
173
|
+
* [`zitadel origin rm PATTERN`](#zitadel-origin-rm-pattern)
|
|
174
|
+
* [`zitadel policies get POLICY`](#zitadel-policies-get-policy)
|
|
175
|
+
* [`zitadel policies list`](#zitadel-policies-list)
|
|
176
|
+
* [`zitadel preview`](#zitadel-preview)
|
|
177
|
+
* [`zitadel preview list`](#zitadel-preview-list)
|
|
178
|
+
* [`zitadel preview rm URL`](#zitadel-preview-rm-url)
|
|
158
179
|
* [`zitadel projects get ID`](#zitadel-projects-get-id)
|
|
159
180
|
* [`zitadel projects list`](#zitadel-projects-list)
|
|
160
181
|
* [`zitadel projects update ID`](#zitadel-projects-update-id)
|
|
161
|
-
* [`zitadel
|
|
162
|
-
* [`zitadel
|
|
182
|
+
* [`zitadel pull [TARGET]`](#zitadel-pull-target)
|
|
183
|
+
* [`zitadel release create`](#zitadel-release-create)
|
|
184
|
+
* [`zitadel release get ID`](#zitadel-release-get-id)
|
|
185
|
+
* [`zitadel release list`](#zitadel-release-list)
|
|
186
|
+
* [`zitadel release revoke RELEASE_ID`](#zitadel-release-revoke-release_id)
|
|
163
187
|
* [`zitadel reset`](#zitadel-reset)
|
|
164
188
|
* [`zitadel resources`](#zitadel-resources)
|
|
165
189
|
* [`zitadel schemas get SCHEMA`](#zitadel-schemas-get-schema)
|
|
@@ -183,21 +207,88 @@ which ships in this package.
|
|
|
183
207
|
* [`zitadel users get ID`](#zitadel-users-get-id)
|
|
184
208
|
* [`zitadel users list`](#zitadel-users-list)
|
|
185
209
|
* [`zitadel users update ID`](#zitadel-users-update-id)
|
|
186
|
-
* [`zitadel
|
|
187
|
-
* [`zitadel
|
|
188
|
-
* [`zitadel
|
|
189
|
-
* [`zitadel
|
|
210
|
+
* [`zitadel variable get NAME`](#zitadel-variable-get-name)
|
|
211
|
+
* [`zitadel variable list`](#zitadel-variable-list)
|
|
212
|
+
* [`zitadel variable resolve`](#zitadel-variable-resolve)
|
|
213
|
+
* [`zitadel variable rm NAME`](#zitadel-variable-rm-name)
|
|
214
|
+
* [`zitadel variable set NAME [VALUE]`](#zitadel-variable-set-name-value)
|
|
190
215
|
* [`zitadel version`](#zitadel-version)
|
|
191
216
|
* [`zitadel which`](#zitadel-which)
|
|
192
217
|
|
|
193
|
-
## `zitadel
|
|
218
|
+
## `zitadel api [OPERATION]`
|
|
194
219
|
|
|
195
|
-
|
|
220
|
+
Call any operation of the Zitadel API, with this project's server and project secret.
|
|
196
221
|
|
|
197
222
|
```
|
|
198
223
|
USAGE
|
|
199
|
-
$ zitadel
|
|
200
|
-
[--dry-run] [-v] [--debug] [--color] [--telemetry]
|
|
224
|
+
$ zitadel api [OPERATION...] [--json] [-c <value>] [-s <value>]
|
|
225
|
+
[-n] [--dry-run] [-v] [--debug] [--color] [--telemetry] [-X
|
|
226
|
+
GET|POST|PUT|PATCH|DELETE] [-F <value>...] [--input <value>] [--paginate]
|
|
227
|
+
|
|
228
|
+
ARGUMENTS
|
|
229
|
+
[OPERATION...] An operationId (queryUsers) or a path (/users/query), then the
|
|
230
|
+
path parameters. Omit it to choose one.
|
|
231
|
+
|
|
232
|
+
FLAGS
|
|
233
|
+
-F, --field=<value>... A field: name=value, or name:=json for
|
|
234
|
+
JSON, typed by the operation's schema.
|
|
235
|
+
A query parameter's name sets it; any
|
|
236
|
+
other name is a dot path into the
|
|
237
|
+
body. Repeatable.
|
|
238
|
+
-X, --method=GET|POST|PUT|PATCH|DELETE The HTTP method, to choose among a
|
|
239
|
+
path's operations.
|
|
240
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
241
|
+
-n, --non-interactive Disable prompts. Required when
|
|
242
|
+
scripting or running as an agent.
|
|
243
|
+
-s, --server=<value> Override the resolved server URL.
|
|
244
|
+
-v, --verbose Verbose logging.
|
|
245
|
+
--[no-]color Colorize human output. Disable with
|
|
246
|
+
--no-color; NO_COLOR and FORCE_COLOR
|
|
247
|
+
are honored too.
|
|
248
|
+
--debug Debug logging.
|
|
249
|
+
--dry-run Preview without mutating files or the
|
|
250
|
+
platform.
|
|
251
|
+
--input=<value> Read the JSON body from a file, or
|
|
252
|
+
from stdin with -. --field lays over
|
|
253
|
+
it.
|
|
254
|
+
--paginate Follow next_page_token to the last
|
|
255
|
+
page, and answer with every page's
|
|
256
|
+
items in one list.
|
|
257
|
+
--[no-]telemetry Send anonymous usage analytics.
|
|
258
|
+
Disable with --no-telemetry.
|
|
259
|
+
|
|
260
|
+
GLOBAL FLAGS
|
|
261
|
+
--json Format output as json.
|
|
262
|
+
|
|
263
|
+
DESCRIPTION
|
|
264
|
+
Call any operation of the Zitadel API, with this project's server and project
|
|
265
|
+
secret.
|
|
266
|
+
|
|
267
|
+
EXAMPLES
|
|
268
|
+
$ zitadel api queryUsers -F limit=5
|
|
269
|
+
|
|
270
|
+
$ zitadel api GetUserByID user_01JZ8Y3V4Q0K7N2M5P6R8S9T0W
|
|
271
|
+
|
|
272
|
+
$ zitadel api /users/user_01JZ8Y3V4Q0K7N2M5P6R8S9T0W/passkeys --json
|
|
273
|
+
|
|
274
|
+
$ zitadel api listEvents -F category=auth --paginate --json
|
|
275
|
+
|
|
276
|
+
$ zitadel api createTeam -F name=Support --dry-run
|
|
277
|
+
|
|
278
|
+
$ zitadel api createTeam --input - < team.json
|
|
279
|
+
```
|
|
280
|
+
|
|
281
|
+
## `zitadel api ls [FILTER]`
|
|
282
|
+
|
|
283
|
+
List the operations of the Zitadel API that `zitadel api` calls.
|
|
284
|
+
|
|
285
|
+
```
|
|
286
|
+
USAGE
|
|
287
|
+
$ zitadel api ls [FILTER] [--json] [-c <value>] [-s <value>] [-n]
|
|
288
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--tag <value>]
|
|
289
|
+
|
|
290
|
+
ARGUMENTS
|
|
291
|
+
[FILTER] Only operations whose id, path, summary or tag contains this text.
|
|
201
292
|
|
|
202
293
|
FLAGS
|
|
203
294
|
-c, --cwd=<value> Project directory to operate on.
|
|
@@ -209,6 +300,8 @@ FLAGS
|
|
|
209
300
|
NO_COLOR and FORCE_COLOR are honored too.
|
|
210
301
|
--debug Debug logging.
|
|
211
302
|
--dry-run Preview without mutating files or the platform.
|
|
303
|
+
--tag=<value> Only the operations of this part of the API (Users,
|
|
304
|
+
Teams, …).
|
|
212
305
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
213
306
|
--no-telemetry.
|
|
214
307
|
|
|
@@ -216,7 +309,16 @@ GLOBAL FLAGS
|
|
|
216
309
|
--json Format output as json.
|
|
217
310
|
|
|
218
311
|
DESCRIPTION
|
|
219
|
-
|
|
312
|
+
List the operations of the Zitadel API that `zitadel api` calls.
|
|
313
|
+
|
|
314
|
+
EXAMPLES
|
|
315
|
+
$ zitadel api ls
|
|
316
|
+
|
|
317
|
+
$ zitadel api ls passkey
|
|
318
|
+
|
|
319
|
+
$ zitadel api ls --tag Users --json
|
|
320
|
+
|
|
321
|
+
$ zitadel api ls --json | jq -r '.data.operations[] | select(.command == null) | .id'
|
|
220
322
|
```
|
|
221
323
|
|
|
222
324
|
## `zitadel auth-method passkey disable`
|
|
@@ -225,8 +327,8 @@ Disable passkey sign-in for a user schema.
|
|
|
225
327
|
|
|
226
328
|
```
|
|
227
329
|
USAGE
|
|
228
|
-
$ zitadel auth-method passkey disable [
|
|
229
|
-
[--
|
|
330
|
+
$ zitadel auth-method passkey disable [-c <value>] [-s <value>] [-n] [--dry-run] [-v]
|
|
331
|
+
[--debug] [--color] [--telemetry] [--schema <value>] [-f]
|
|
230
332
|
|
|
231
333
|
FLAGS
|
|
232
334
|
-c, --cwd=<value> Project directory to operate on.
|
|
@@ -245,9 +347,6 @@ FLAGS
|
|
|
245
347
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
246
348
|
--no-telemetry.
|
|
247
349
|
|
|
248
|
-
GLOBAL FLAGS
|
|
249
|
-
--json Format output as json.
|
|
250
|
-
|
|
251
350
|
DESCRIPTION
|
|
252
351
|
Disable passkey sign-in for a user schema.
|
|
253
352
|
|
|
@@ -263,8 +362,8 @@ Enable passkey sign-in for a user schema.
|
|
|
263
362
|
|
|
264
363
|
```
|
|
265
364
|
USAGE
|
|
266
|
-
$ zitadel auth-method passkey enable [
|
|
267
|
-
[--
|
|
365
|
+
$ zitadel auth-method passkey enable [-c <value>] [-s <value>] [-n] [--dry-run] [-v]
|
|
366
|
+
[--debug] [--color] [--telemetry] [--schema <value>]
|
|
268
367
|
|
|
269
368
|
FLAGS
|
|
270
369
|
-c, --cwd=<value> Project directory to operate on.
|
|
@@ -281,9 +380,6 @@ FLAGS
|
|
|
281
380
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
282
381
|
--no-telemetry.
|
|
283
382
|
|
|
284
|
-
GLOBAL FLAGS
|
|
285
|
-
--json Format output as json.
|
|
286
|
-
|
|
287
383
|
DESCRIPTION
|
|
288
384
|
Enable passkey sign-in for a user schema.
|
|
289
385
|
|
|
@@ -299,8 +395,8 @@ Disable password sign-in for a user schema.
|
|
|
299
395
|
|
|
300
396
|
```
|
|
301
397
|
USAGE
|
|
302
|
-
$ zitadel auth-method password disable [
|
|
303
|
-
[--
|
|
398
|
+
$ zitadel auth-method password disable [-c <value>] [-s <value>] [-n] [--dry-run] [-v]
|
|
399
|
+
[--debug] [--color] [--telemetry] [--schema <value>] [-f]
|
|
304
400
|
|
|
305
401
|
FLAGS
|
|
306
402
|
-c, --cwd=<value> Project directory to operate on.
|
|
@@ -319,9 +415,6 @@ FLAGS
|
|
|
319
415
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
320
416
|
--no-telemetry.
|
|
321
417
|
|
|
322
|
-
GLOBAL FLAGS
|
|
323
|
-
--json Format output as json.
|
|
324
|
-
|
|
325
418
|
DESCRIPTION
|
|
326
419
|
Disable password sign-in for a user schema.
|
|
327
420
|
|
|
@@ -337,8 +430,8 @@ Enable password sign-in for a user schema.
|
|
|
337
430
|
|
|
338
431
|
```
|
|
339
432
|
USAGE
|
|
340
|
-
$ zitadel auth-method password enable [
|
|
341
|
-
[--
|
|
433
|
+
$ zitadel auth-method password enable [-c <value>] [-s <value>] [-n] [--dry-run] [-v]
|
|
434
|
+
[--debug] [--color] [--telemetry] [--schema <value>]
|
|
342
435
|
|
|
343
436
|
FLAGS
|
|
344
437
|
-c, --cwd=<value> Project directory to operate on.
|
|
@@ -355,9 +448,6 @@ FLAGS
|
|
|
355
448
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
356
449
|
--no-telemetry.
|
|
357
450
|
|
|
358
|
-
GLOBAL FLAGS
|
|
359
|
-
--json Format output as json.
|
|
360
|
-
|
|
361
451
|
DESCRIPTION
|
|
362
452
|
Enable password sign-in for a user schema.
|
|
363
453
|
|
|
@@ -373,9 +463,9 @@ Remove an identity provider from a user schema.
|
|
|
373
463
|
|
|
374
464
|
```
|
|
375
465
|
USAGE
|
|
376
|
-
$ zitadel auth-method sso disable [
|
|
377
|
-
[--
|
|
378
|
-
[
|
|
466
|
+
$ zitadel auth-method sso disable [-c <value>] [-s <value>] [-n] [--dry-run] [-v]
|
|
467
|
+
[--debug] [--color] [--telemetry] [--schema <value>] [--provider <value>]
|
|
468
|
+
[-f]
|
|
379
469
|
|
|
380
470
|
FLAGS
|
|
381
471
|
-c, --cwd=<value> Project directory to operate on.
|
|
@@ -395,9 +485,6 @@ FLAGS
|
|
|
395
485
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
396
486
|
--no-telemetry.
|
|
397
487
|
|
|
398
|
-
GLOBAL FLAGS
|
|
399
|
-
--json Format output as json.
|
|
400
|
-
|
|
401
488
|
DESCRIPTION
|
|
402
489
|
Remove an identity provider from a user schema.
|
|
403
490
|
|
|
@@ -413,13 +500,18 @@ Add an identity provider to a user schema.
|
|
|
413
500
|
|
|
414
501
|
```
|
|
415
502
|
USAGE
|
|
416
|
-
$ zitadel auth-method sso enable [
|
|
417
|
-
[--
|
|
418
|
-
[--provider google|custom] [--slug <value>]
|
|
419
|
-
[--issuer <value>] [--scopes <value>] [--client-id
|
|
503
|
+
$ zitadel auth-method sso enable [-c <value>] [-s <value>] [-n] [--dry-run] [-v]
|
|
504
|
+
[--debug] [--color] [--telemetry] [-e <value>] [--env-file <value>]
|
|
505
|
+
[--schema <value>] [--provider google|custom] [--slug <value>]
|
|
506
|
+
[--display-name <value>] [--issuer <value>] [--scopes <value>] [--client-id
|
|
507
|
+
<value>]
|
|
420
508
|
|
|
421
509
|
FLAGS
|
|
422
510
|
-c, --cwd=<value> Project directory to operate on.
|
|
511
|
+
-e, --env=<value> Environment to run against, e.g. production.
|
|
512
|
+
Defaults to ZITADEL_ENV, then the hosting
|
|
513
|
+
platform's build (VERCEL_ENV, or Netlify's
|
|
514
|
+
CONTEXT), then development.
|
|
423
515
|
-n, --non-interactive Disable prompts. Required when scripting or
|
|
424
516
|
running as an agent.
|
|
425
517
|
-s, --server=<value> Override the resolved server URL.
|
|
@@ -432,10 +524,14 @@ FLAGS
|
|
|
432
524
|
--display-name=<value> Name shown on the custom connection's sign-in
|
|
433
525
|
button.
|
|
434
526
|
--dry-run Preview without mutating files or the platform.
|
|
527
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
528
|
+
process environment. A relative path is read from
|
|
529
|
+
the current directory, not from --cwd. Cannot be
|
|
530
|
+
combined with --env.
|
|
435
531
|
--issuer=<value> Issuer URL of the custom provider. Its endpoints
|
|
436
532
|
are found by OIDC discovery.
|
|
437
|
-
--provider=<option> Identity provider to enable, or "custom" for
|
|
438
|
-
|
|
533
|
+
--provider=<option> Identity provider to enable, or "custom" for a
|
|
534
|
+
custom OpenID Connect (OIDC) provider.
|
|
439
535
|
<options: google|custom>
|
|
440
536
|
--schema=<value> User schema to change. Required when the Project
|
|
441
537
|
has more than one.
|
|
@@ -447,9 +543,6 @@ FLAGS
|
|
|
447
543
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
448
544
|
--no-telemetry.
|
|
449
545
|
|
|
450
|
-
GLOBAL FLAGS
|
|
451
|
-
--json Format output as json.
|
|
452
|
-
|
|
453
546
|
DESCRIPTION
|
|
454
547
|
Add an identity provider to a user schema.
|
|
455
548
|
|
|
@@ -536,25 +629,33 @@ Get one branding revision by id.
|
|
|
536
629
|
```
|
|
537
630
|
USAGE
|
|
538
631
|
$ zitadel branding get ID [--json] [-c <value>] [-s <value>] [-n]
|
|
539
|
-
[--dry-run] [-v] [--debug] [--color] [--telemetry] [
|
|
632
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
633
|
+
<value>] [--fields <value>]
|
|
540
634
|
|
|
541
635
|
ARGUMENTS
|
|
542
636
|
ID branding revision id
|
|
543
637
|
|
|
544
638
|
FLAGS
|
|
545
|
-
-c, --cwd=<value>
|
|
546
|
-
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
--
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
--
|
|
557
|
-
|
|
639
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
640
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
641
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
642
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
643
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
644
|
+
an agent.
|
|
645
|
+
-s, --server=<value> Override the resolved server URL.
|
|
646
|
+
-v, --verbose Verbose logging.
|
|
647
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
648
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
649
|
+
--debug Debug logging.
|
|
650
|
+
--dry-run Preview without mutating files or the platform.
|
|
651
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
652
|
+
process environment. A relative path is read from the
|
|
653
|
+
current directory, not from --cwd. Cannot be combined
|
|
654
|
+
with --env.
|
|
655
|
+
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
656
|
+
the resource's own; `--json` is unaffected.
|
|
657
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
658
|
+
--no-telemetry.
|
|
558
659
|
|
|
559
660
|
GLOBAL FLAGS
|
|
560
661
|
--json Format output as json.
|
|
@@ -575,26 +676,33 @@ List branding.
|
|
|
575
676
|
```
|
|
576
677
|
USAGE
|
|
577
678
|
$ zitadel branding list [--json] [-c <value>] [-s <value>] [-n]
|
|
578
|
-
[--dry-run] [-v] [--debug] [--color] [--telemetry] [
|
|
579
|
-
[--plain]
|
|
679
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
680
|
+
<value>] [--fields <value>] [--plain]
|
|
580
681
|
|
|
581
682
|
FLAGS
|
|
582
|
-
-c, --cwd=<value>
|
|
583
|
-
-
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
-
|
|
587
|
-
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
--
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
--
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
|
|
683
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
684
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
685
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
686
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
687
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
688
|
+
an agent.
|
|
689
|
+
-s, --server=<value> Override the resolved server URL.
|
|
690
|
+
-v, --verbose Verbose logging.
|
|
691
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
692
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
693
|
+
--debug Debug logging.
|
|
694
|
+
--dry-run Preview without mutating files or the platform.
|
|
695
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
696
|
+
process environment. A relative path is read from the
|
|
697
|
+
current directory, not from --cwd. Cannot be combined
|
|
698
|
+
with --env.
|
|
699
|
+
--fields=<value> Columns to show, comma-separated dot-paths (e.g.
|
|
700
|
+
id,attributes.email). Defaults to the resource's own
|
|
701
|
+
columns; `--json` is unaffected.
|
|
702
|
+
--plain Tab-separated rows with no header, for piping. Implied
|
|
703
|
+
when stdout is not a terminal.
|
|
704
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
705
|
+
--no-telemetry.
|
|
598
706
|
|
|
599
707
|
GLOBAL FLAGS
|
|
600
708
|
--json Format output as json.
|
|
@@ -613,24 +721,38 @@ Claim this project to make it permanent. Opens a browser to create an account or
|
|
|
613
721
|
```
|
|
614
722
|
USAGE
|
|
615
723
|
$ zitadel claim [--json] [-c <value>] [-s <value>] [-n]
|
|
616
|
-
[--dry-run] [-v] [--debug] [--color] [--telemetry] [
|
|
724
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
725
|
+
<value>] [--no-open] [--no-wait | --challenge-id <value> | --timeout
|
|
617
726
|
<value>]
|
|
618
727
|
|
|
619
728
|
FLAGS
|
|
620
|
-
-c, --cwd=<value>
|
|
621
|
-
-
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
|
|
625
|
-
|
|
626
|
-
|
|
627
|
-
|
|
628
|
-
|
|
629
|
-
--
|
|
630
|
-
|
|
631
|
-
|
|
632
|
-
|
|
633
|
-
|
|
729
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
730
|
+
-e, --env=<value> Environment to run against, e.g. production.
|
|
731
|
+
Defaults to ZITADEL_ENV, then the hosting
|
|
732
|
+
platform's build (VERCEL_ENV, or Netlify's
|
|
733
|
+
CONTEXT), then development.
|
|
734
|
+
-n, --non-interactive Disable prompts. Required when scripting or
|
|
735
|
+
running as an agent.
|
|
736
|
+
-s, --server=<value> Override the resolved server URL.
|
|
737
|
+
-v, --verbose Verbose logging.
|
|
738
|
+
--challenge-id=<value> Wait for the link a --no-wait run printed, instead
|
|
739
|
+
of creating a new one.
|
|
740
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
741
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
742
|
+
--debug Debug logging.
|
|
743
|
+
--dry-run Preview without mutating files or the platform.
|
|
744
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
745
|
+
process environment. A relative path is read from
|
|
746
|
+
the current directory, not from --cwd. Cannot be
|
|
747
|
+
combined with --env.
|
|
748
|
+
--no-open Print the link instead of opening a browser.
|
|
749
|
+
--no-wait Print the link and exit, without opening a browser
|
|
750
|
+
or waiting for the browser step. The result names
|
|
751
|
+
the command that waits for it.
|
|
752
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
753
|
+
--no-telemetry.
|
|
754
|
+
--timeout=<value> Seconds to wait for the browser step. Defaults to
|
|
755
|
+
the link's own expiry (10 minutes).
|
|
634
756
|
|
|
635
757
|
GLOBAL FLAGS
|
|
636
758
|
--json Format output as json.
|
|
@@ -645,6 +767,10 @@ EXAMPLES
|
|
|
645
767
|
$ zitadel claim --no-open
|
|
646
768
|
|
|
647
769
|
$ zitadel claim --timeout 120
|
|
770
|
+
|
|
771
|
+
$ zitadel claim --no-wait
|
|
772
|
+
|
|
773
|
+
$ zitadel claim --challenge-id ch_01J0Z9KX7Y0Q2Y7JX5M9K2YF3C
|
|
648
774
|
```
|
|
649
775
|
|
|
650
776
|
## `zitadel commands`
|
|
@@ -679,7 +805,7 @@ _See code: [@oclif/plugin-commands](https://github.com/oclif/plugin-commands/blo
|
|
|
679
805
|
|
|
680
806
|
## `zitadel console`
|
|
681
807
|
|
|
682
|
-
Open the local console, signed in as the local admin
|
|
808
|
+
Open the local console, signed in as the local admin.
|
|
683
809
|
|
|
684
810
|
```
|
|
685
811
|
USAGE
|
|
@@ -704,11 +830,11 @@ GLOBAL FLAGS
|
|
|
704
830
|
--json Format output as json.
|
|
705
831
|
|
|
706
832
|
DESCRIPTION
|
|
707
|
-
Open the local console, signed in as the local admin
|
|
708
|
-
start`.
|
|
833
|
+
Open the local console, signed in as the local admin.
|
|
709
834
|
|
|
710
|
-
|
|
711
|
-
|
|
835
|
+
The local admin is the one `zitadel start` created. Run this in the directory
|
|
836
|
+
`zitadel start` ran in, or one inside it: the local admin is read from the
|
|
837
|
+
nearest `.zitadel/local/` on the way up.
|
|
712
838
|
|
|
713
839
|
EXAMPLES
|
|
714
840
|
$ zitadel console
|
|
@@ -716,18 +842,22 @@ EXAMPLES
|
|
|
716
842
|
$ zitadel console --no-open
|
|
717
843
|
```
|
|
718
844
|
|
|
719
|
-
## `zitadel
|
|
845
|
+
## `zitadel deploy`
|
|
720
846
|
|
|
721
|
-
|
|
847
|
+
Apply your local configuration to Zitadel.
|
|
722
848
|
|
|
723
849
|
```
|
|
724
850
|
USAGE
|
|
725
|
-
$ zitadel
|
|
726
|
-
[--dry-run] [-v] [--debug] [--color] [--telemetry] [
|
|
727
|
-
|
|
851
|
+
$ zitadel deploy [--json] [-c <value>] [-s <value>] [-n]
|
|
852
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
853
|
+
<value>] [-m <value>]
|
|
728
854
|
|
|
729
855
|
FLAGS
|
|
730
856
|
-c, --cwd=<value> Project directory to operate on.
|
|
857
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
858
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
859
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
860
|
+
-m, --message=<value> A short summary of what this release changes.
|
|
731
861
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
732
862
|
an agent.
|
|
733
863
|
-s, --server=<value> Override the resolved server URL.
|
|
@@ -736,12 +866,10 @@ FLAGS
|
|
|
736
866
|
NO_COLOR and FORCE_COLOR are honored too.
|
|
737
867
|
--debug Debug logging.
|
|
738
868
|
--dry-run Preview without mutating files or the platform.
|
|
739
|
-
--
|
|
740
|
-
|
|
741
|
-
|
|
742
|
-
|
|
743
|
-
--runtime=<option> Local runtime backend.
|
|
744
|
-
<options: binary|docker>
|
|
869
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
870
|
+
process environment. A relative path is read from the
|
|
871
|
+
current directory, not from --cwd. Cannot be combined
|
|
872
|
+
with --env.
|
|
745
873
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
746
874
|
--no-telemetry.
|
|
747
875
|
|
|
@@ -749,175 +877,262 @@ GLOBAL FLAGS
|
|
|
749
877
|
--json Format output as json.
|
|
750
878
|
|
|
751
879
|
DESCRIPTION
|
|
752
|
-
|
|
880
|
+
Apply your local configuration to Zitadel.
|
|
881
|
+
|
|
882
|
+
Builds a release from .zitadel/ and deploys it to the project. Use --dry-run
|
|
883
|
+
to preview what would change.
|
|
884
|
+
|
|
885
|
+
EXAMPLES
|
|
886
|
+
$ zitadel deploy -m 'add phone_number to human-user'
|
|
887
|
+
|
|
888
|
+
$ zitadel deploy --dry-run
|
|
753
889
|
```
|
|
754
890
|
|
|
755
|
-
## `zitadel
|
|
891
|
+
## `zitadel deployment create`
|
|
756
892
|
|
|
757
|
-
|
|
893
|
+
Deploy an existing release to the project's origins.
|
|
758
894
|
|
|
759
895
|
```
|
|
760
896
|
USAGE
|
|
761
|
-
$ zitadel
|
|
762
|
-
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-
|
|
897
|
+
$ zitadel deployment create --release <value> [--json] [-c <value>] [-s
|
|
898
|
+
<value>] [-n] [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e
|
|
899
|
+
<value>] [--env-file <value>] [-m <value>]
|
|
763
900
|
|
|
764
901
|
FLAGS
|
|
765
|
-
-c, --cwd=<value>
|
|
766
|
-
-
|
|
767
|
-
|
|
768
|
-
|
|
769
|
-
|
|
770
|
-
-
|
|
771
|
-
|
|
772
|
-
|
|
773
|
-
|
|
774
|
-
--
|
|
775
|
-
|
|
776
|
-
--
|
|
777
|
-
|
|
902
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
903
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
904
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
905
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
906
|
+
-m, --message=<value> A short summary of why this deploys.
|
|
907
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
908
|
+
an agent.
|
|
909
|
+
-s, --server=<value> Override the resolved server URL.
|
|
910
|
+
-v, --verbose Verbose logging.
|
|
911
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
912
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
913
|
+
--debug Debug logging.
|
|
914
|
+
--dry-run Preview without mutating files or the platform.
|
|
915
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
916
|
+
process environment. A relative path is read from the
|
|
917
|
+
current directory, not from --cwd. Cannot be combined
|
|
918
|
+
with --env.
|
|
919
|
+
--release=<value> (required) The release id to deploy.
|
|
920
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
921
|
+
--no-telemetry.
|
|
778
922
|
|
|
779
923
|
GLOBAL FLAGS
|
|
780
924
|
--json Format output as json.
|
|
781
925
|
|
|
782
926
|
DESCRIPTION
|
|
783
|
-
|
|
927
|
+
Deploy an existing release to the project's origins.
|
|
784
928
|
|
|
785
|
-
|
|
786
|
-
$ zitadel
|
|
929
|
+
EXAMPLES
|
|
930
|
+
$ zitadel deployment create --release rel_01KX3RG8A7F0N9WD3P2E4YM5C1
|
|
787
931
|
```
|
|
788
932
|
|
|
789
|
-
## `zitadel
|
|
933
|
+
## `zitadel deployment get DEPLOYMENT_ID`
|
|
790
934
|
|
|
791
|
-
|
|
935
|
+
Read one deployment by id.
|
|
792
936
|
|
|
793
937
|
```
|
|
794
938
|
USAGE
|
|
795
|
-
$ zitadel
|
|
796
|
-
[--dry-run] [-v] [--debug] [--color] [--telemetry] [
|
|
939
|
+
$ zitadel deployment get DEPLOYMENT_ID [--json] [-c <value>] [-s <value>]
|
|
940
|
+
[-n] [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>]
|
|
941
|
+
[--env-file <value>]
|
|
797
942
|
|
|
798
943
|
ARGUMENTS
|
|
799
|
-
|
|
944
|
+
DEPLOYMENT_ID The deployment to read.
|
|
800
945
|
|
|
801
946
|
FLAGS
|
|
802
|
-
-c, --cwd=<value>
|
|
803
|
-
-
|
|
804
|
-
|
|
805
|
-
|
|
806
|
-
-
|
|
807
|
-
|
|
808
|
-
|
|
809
|
-
|
|
810
|
-
--
|
|
811
|
-
|
|
812
|
-
|
|
813
|
-
--
|
|
814
|
-
|
|
947
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
948
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
949
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
950
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
951
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
952
|
+
an agent.
|
|
953
|
+
-s, --server=<value> Override the resolved server URL.
|
|
954
|
+
-v, --verbose Verbose logging.
|
|
955
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
956
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
957
|
+
--debug Debug logging.
|
|
958
|
+
--dry-run Preview without mutating files or the platform.
|
|
959
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
960
|
+
process environment. A relative path is read from the
|
|
961
|
+
current directory, not from --cwd. Cannot be combined
|
|
962
|
+
with --env.
|
|
963
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
964
|
+
--no-telemetry.
|
|
815
965
|
|
|
816
966
|
GLOBAL FLAGS
|
|
817
967
|
--json Format output as json.
|
|
818
968
|
|
|
819
969
|
DESCRIPTION
|
|
820
|
-
|
|
970
|
+
Read one deployment by id.
|
|
821
971
|
|
|
822
972
|
EXAMPLES
|
|
823
|
-
$ zitadel
|
|
824
|
-
|
|
825
|
-
$ zitadel events get <id> --json
|
|
973
|
+
$ zitadel deployment get dep_01KX5N7C9D2E7F0N9WD3P2E4YM6
|
|
826
974
|
```
|
|
827
975
|
|
|
828
|
-
## `zitadel
|
|
976
|
+
## `zitadel deployment list`
|
|
829
977
|
|
|
830
|
-
List
|
|
978
|
+
List the project's deployments, newest first.
|
|
831
979
|
|
|
832
980
|
```
|
|
833
981
|
USAGE
|
|
834
|
-
$ zitadel
|
|
835
|
-
[--dry-run] [-v] [--debug] [--color] [--telemetry] [
|
|
836
|
-
|
|
837
|
-
|
|
982
|
+
$ zitadel deployment list [--json] [-c <value>] [-s <value>] [-n]
|
|
983
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
984
|
+
<value>] [--origin <value>] [--live] [--limit <value>] [-a | --page-token
|
|
985
|
+
<value>] [--plain]
|
|
838
986
|
|
|
839
987
|
FLAGS
|
|
840
|
-
-a, --all
|
|
841
|
-
|
|
842
|
-
|
|
843
|
-
|
|
844
|
-
|
|
988
|
+
-a, --all Fetch every page instead of one.
|
|
989
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
990
|
+
-e, --env=<value> Environment to run against, e.g. production.
|
|
991
|
+
Defaults to ZITADEL_ENV, then the hosting platform's
|
|
992
|
+
build (VERCEL_ENV, or Netlify's CONTEXT), then
|
|
993
|
+
development.
|
|
994
|
+
-n, --non-interactive Disable prompts. Required when scripting or running
|
|
995
|
+
as an agent.
|
|
996
|
+
-s, --server=<value> Override the resolved server URL.
|
|
997
|
+
-v, --verbose Verbose logging.
|
|
998
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
999
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
1000
|
+
--debug Debug logging.
|
|
1001
|
+
--dry-run Preview without mutating files or the platform.
|
|
1002
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
1003
|
+
process environment. A relative path is read from
|
|
1004
|
+
the current directory, not from --cwd. Cannot be
|
|
1005
|
+
combined with --env.
|
|
1006
|
+
--limit=<value> Page size (server default 20, max 100).
|
|
1007
|
+
--live What each target serves now, not the full history.
|
|
1008
|
+
--origin=<value> Only deployments that targeted this origin.
|
|
1009
|
+
--page-token=<value> Continue from a previous page's next_page_token.
|
|
1010
|
+
--plain Tab-separated rows with no header, for piping.
|
|
1011
|
+
Implied when stdout is not a terminal.
|
|
1012
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1013
|
+
--no-telemetry.
|
|
845
1014
|
|
|
846
|
-
|
|
847
|
-
|
|
1015
|
+
GLOBAL FLAGS
|
|
1016
|
+
--json Format output as json.
|
|
848
1017
|
|
|
849
|
-
|
|
850
|
-
|
|
1018
|
+
DESCRIPTION
|
|
1019
|
+
List the project's deployments, newest first.
|
|
851
1020
|
|
|
852
|
-
|
|
853
|
-
|
|
1021
|
+
EXAMPLES
|
|
1022
|
+
$ zitadel deployment list
|
|
854
1023
|
|
|
855
|
-
--
|
|
856
|
-
Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are
|
|
857
|
-
honored too.
|
|
1024
|
+
$ zitadel deployment list --all
|
|
858
1025
|
|
|
859
|
-
--
|
|
860
|
-
Debug logging.
|
|
1026
|
+
$ zitadel deployment list --live
|
|
861
1027
|
|
|
862
|
-
--
|
|
863
|
-
|
|
1028
|
+
$ zitadel deployment list --origin https://app.acme.com
|
|
1029
|
+
```
|
|
864
1030
|
|
|
865
|
-
|
|
866
|
-
Columns to show, comma-separated dot-paths (e.g. id,attributes.email).
|
|
867
|
-
Defaults to the resource's own columns; `--json` is unaffected.
|
|
1031
|
+
## `zitadel deployment rollback [DEPLOYMENT_ID]`
|
|
868
1032
|
|
|
869
|
-
|
|
870
|
-
Filter as field=operation:value (operation defaults to equals). Fields:
|
|
871
|
-
category (equals; values request|auth|session|admin|entity|signal; repeats
|
|
872
|
-
widen), event_type (equals; repeats widen), actor_id (equals), session_id
|
|
873
|
-
(equals), flow_id (equals), request_id (equals), entity_type (equals),
|
|
874
|
-
entity_id (equals), team_id (equals), created_at
|
|
875
|
-
(greater_than_or_equal|less_than).
|
|
1033
|
+
Roll back to an earlier deployment.
|
|
876
1034
|
|
|
877
|
-
|
|
878
|
-
|
|
1035
|
+
```
|
|
1036
|
+
USAGE
|
|
1037
|
+
$ zitadel deployment rollback [DEPLOYMENT_ID] [--json] [-c <value>] [-s
|
|
1038
|
+
<value>] [-n] [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e
|
|
1039
|
+
<value>] [--env-file <value>] [-f]
|
|
879
1040
|
|
|
880
|
-
|
|
881
|
-
|
|
1041
|
+
ARGUMENTS
|
|
1042
|
+
[DEPLOYMENT_ID] The deployment to re-apply. Omit to undo the last deploy.
|
|
882
1043
|
|
|
883
|
-
|
|
884
|
-
|
|
885
|
-
|
|
886
|
-
|
|
887
|
-
|
|
888
|
-
|
|
889
|
-
|
|
890
|
-
--
|
|
891
|
-
|
|
1044
|
+
FLAGS
|
|
1045
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1046
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
1047
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
1048
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
1049
|
+
-f, --force Roll back without the confirmation prompt. Required
|
|
1050
|
+
when non-interactive.
|
|
1051
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1052
|
+
an agent.
|
|
1053
|
+
-s, --server=<value> Override the resolved server URL.
|
|
1054
|
+
-v, --verbose Verbose logging.
|
|
1055
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
1056
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
1057
|
+
--debug Debug logging.
|
|
1058
|
+
--dry-run Preview without mutating files or the platform.
|
|
1059
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
1060
|
+
process environment. A relative path is read from the
|
|
1061
|
+
current directory, not from --cwd. Cannot be combined
|
|
1062
|
+
with --env.
|
|
1063
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1064
|
+
--no-telemetry.
|
|
892
1065
|
|
|
893
1066
|
GLOBAL FLAGS
|
|
894
1067
|
--json Format output as json.
|
|
895
1068
|
|
|
896
1069
|
DESCRIPTION
|
|
897
|
-
|
|
1070
|
+
Roll back to an earlier deployment.
|
|
898
1071
|
|
|
899
1072
|
EXAMPLES
|
|
900
|
-
$ zitadel
|
|
1073
|
+
$ zitadel deployment rollback
|
|
901
1074
|
|
|
902
|
-
$ zitadel
|
|
1075
|
+
$ zitadel deployment rollback dep_01KX5N7C9D2E7F0N9WD3P2E4YM6
|
|
903
1076
|
|
|
904
|
-
$ zitadel
|
|
1077
|
+
$ zitadel deployment rollback --force
|
|
905
1078
|
```
|
|
906
1079
|
|
|
907
|
-
## `zitadel
|
|
1080
|
+
## `zitadel doctor`
|
|
908
1081
|
|
|
909
|
-
|
|
1082
|
+
Verify local runtime and project state.
|
|
910
1083
|
|
|
911
1084
|
```
|
|
912
1085
|
USAGE
|
|
913
|
-
$ zitadel
|
|
914
|
-
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--
|
|
1086
|
+
$ zitadel doctor [--json] [-c <value>] [-s <value>] [-n]
|
|
1087
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--fix] [--image <value>]
|
|
1088
|
+
[--port <value>] [--runtime binary|docker] [-e <value>] [--env-file <value>]
|
|
915
1089
|
|
|
916
|
-
|
|
917
|
-
|
|
1090
|
+
FLAGS
|
|
1091
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1092
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
1093
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
1094
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
1095
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1096
|
+
an agent.
|
|
1097
|
+
-s, --server=<value> Override the resolved server URL.
|
|
1098
|
+
-v, --verbose Verbose logging.
|
|
1099
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
1100
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
1101
|
+
--debug Debug logging.
|
|
1102
|
+
--dry-run Preview without mutating files or the platform.
|
|
1103
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
1104
|
+
process environment. A relative path is read from the
|
|
1105
|
+
current directory, not from --cwd. Cannot be combined
|
|
1106
|
+
with --env.
|
|
1107
|
+
--fix Repair missing files and stale managed wiring.
|
|
1108
|
+
--image=<value> Container image to check.
|
|
1109
|
+
--port=<value> Local HTTP port to check. Defaults to the port this
|
|
1110
|
+
directory's server uses.
|
|
1111
|
+
--runtime=<option> Local runtime backend.
|
|
1112
|
+
<options: binary|docker>
|
|
1113
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1114
|
+
--no-telemetry.
|
|
1115
|
+
|
|
1116
|
+
GLOBAL FLAGS
|
|
1117
|
+
--json Format output as json.
|
|
1118
|
+
|
|
1119
|
+
DESCRIPTION
|
|
1120
|
+
Verify local runtime and project state.
|
|
1121
|
+
```
|
|
1122
|
+
|
|
1123
|
+
## `zitadel eject`
|
|
1124
|
+
|
|
1125
|
+
Remove managed files and local Zitadel state.
|
|
1126
|
+
|
|
1127
|
+
```
|
|
1128
|
+
USAGE
|
|
1129
|
+
$ zitadel eject [--json] [-c <value>] [-s <value>] [-n]
|
|
1130
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-f]
|
|
918
1131
|
|
|
919
1132
|
FLAGS
|
|
920
1133
|
-c, --cwd=<value> Project directory to operate on.
|
|
1134
|
+
-f, --force Remove the managed files without the confirmation
|
|
1135
|
+
prompt.
|
|
921
1136
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
922
1137
|
an agent.
|
|
923
1138
|
-s, --server=<value> Override the resolved server URL.
|
|
@@ -926,8 +1141,6 @@ FLAGS
|
|
|
926
1141
|
NO_COLOR and FORCE_COLOR are honored too.
|
|
927
1142
|
--debug Debug logging.
|
|
928
1143
|
--dry-run Preview without mutating files or the platform.
|
|
929
|
-
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
930
|
-
the resource's own; `--json` is unaffected.
|
|
931
1144
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
932
1145
|
--no-telemetry.
|
|
933
1146
|
|
|
@@ -935,73 +1148,68 @@ GLOBAL FLAGS
|
|
|
935
1148
|
--json Format output as json.
|
|
936
1149
|
|
|
937
1150
|
DESCRIPTION
|
|
938
|
-
|
|
939
|
-
|
|
940
|
-
EXAMPLES
|
|
941
|
-
$ zitadel flow-definitions get <id>
|
|
1151
|
+
Remove managed files and local Zitadel state.
|
|
942
1152
|
|
|
943
|
-
|
|
1153
|
+
ALIASES
|
|
1154
|
+
$ zitadel uninstall
|
|
944
1155
|
```
|
|
945
1156
|
|
|
946
|
-
## `zitadel
|
|
1157
|
+
## `zitadel env`
|
|
947
1158
|
|
|
948
|
-
|
|
1159
|
+
Show which server and project resolve, and where each value came from.
|
|
949
1160
|
|
|
950
1161
|
```
|
|
951
1162
|
USAGE
|
|
952
|
-
$ zitadel
|
|
953
|
-
[--dry-run] [-v] [--debug] [--color] [--telemetry] [
|
|
954
|
-
|
|
1163
|
+
$ zitadel env [--json] [-c <value>] [-s <value>] [-n]
|
|
1164
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
1165
|
+
<value>]
|
|
955
1166
|
|
|
956
1167
|
FLAGS
|
|
957
|
-
-
|
|
958
|
-
-
|
|
959
|
-
|
|
960
|
-
|
|
961
|
-
-
|
|
962
|
-
|
|
963
|
-
|
|
964
|
-
|
|
965
|
-
--
|
|
966
|
-
|
|
967
|
-
--
|
|
968
|
-
|
|
969
|
-
|
|
970
|
-
|
|
971
|
-
|
|
972
|
-
|
|
973
|
-
--
|
|
974
|
-
|
|
975
|
-
--plain Tab-separated rows with no header, for piping.
|
|
976
|
-
Implied when stdout is not a terminal.
|
|
977
|
-
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
978
|
-
--no-telemetry.
|
|
1168
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1169
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
1170
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
1171
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
1172
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1173
|
+
an agent.
|
|
1174
|
+
-s, --server=<value> Override the resolved server URL.
|
|
1175
|
+
-v, --verbose Verbose logging.
|
|
1176
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
1177
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
1178
|
+
--debug Debug logging.
|
|
1179
|
+
--dry-run Preview without mutating files or the platform.
|
|
1180
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
1181
|
+
process environment. A relative path is read from the
|
|
1182
|
+
current directory, not from --cwd. Cannot be combined
|
|
1183
|
+
with --env.
|
|
1184
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1185
|
+
--no-telemetry.
|
|
979
1186
|
|
|
980
1187
|
GLOBAL FLAGS
|
|
981
1188
|
--json Format output as json.
|
|
982
1189
|
|
|
983
1190
|
DESCRIPTION
|
|
984
|
-
|
|
1191
|
+
Show which server and project resolve, and where each value came from.
|
|
985
1192
|
|
|
986
1193
|
EXAMPLES
|
|
987
|
-
$ zitadel
|
|
1194
|
+
$ zitadel env
|
|
988
1195
|
|
|
989
|
-
$ zitadel
|
|
1196
|
+
$ zitadel env --env production
|
|
990
1197
|
|
|
991
|
-
$ zitadel
|
|
1198
|
+
$ zitadel env --env-file ./infra/acme-staging.env
|
|
992
1199
|
```
|
|
993
1200
|
|
|
994
|
-
## `zitadel
|
|
1201
|
+
## `zitadel env add NAME`
|
|
995
1202
|
|
|
996
|
-
|
|
1203
|
+
Bind an environment to a project, creating the project if needed.
|
|
997
1204
|
|
|
998
1205
|
```
|
|
999
1206
|
USAGE
|
|
1000
|
-
$ zitadel
|
|
1001
|
-
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--
|
|
1002
|
-
|
|
1003
|
-
|
|
1004
|
-
|
|
1207
|
+
$ zitadel env add NAME [--json] [-c <value>] [-s <value>] [-n]
|
|
1208
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--project <value>]
|
|
1209
|
+
[--app-url <value>] [--force]
|
|
1210
|
+
|
|
1211
|
+
ARGUMENTS
|
|
1212
|
+
NAME The environment name, e.g. production.
|
|
1005
1213
|
|
|
1006
1214
|
FLAGS
|
|
1007
1215
|
-c, --cwd=<value> Project directory to operate on.
|
|
@@ -1009,140 +1217,133 @@ FLAGS
|
|
|
1009
1217
|
an agent.
|
|
1010
1218
|
-s, --server=<value> Override the resolved server URL.
|
|
1011
1219
|
-v, --verbose Verbose logging.
|
|
1220
|
+
--app-url=<value> The URL this environment's app is served from. It
|
|
1221
|
+
becomes ZITADEL_ISSUER and is registered with a new
|
|
1222
|
+
project.
|
|
1012
1223
|
--[no-]color Colorize human output. Disable with --no-color;
|
|
1013
1224
|
NO_COLOR and FORCE_COLOR are honored too.
|
|
1014
1225
|
--debug Debug logging.
|
|
1015
1226
|
--dry-run Preview without mutating files or the platform.
|
|
1227
|
+
--force Overwrite an existing .env.<name>.local.
|
|
1228
|
+
--project=<value> Bind this existing project instead of creating one. Its
|
|
1229
|
+
secrets come from ZITADEL_PROJECT_SECRET and
|
|
1230
|
+
ZITADEL_PREVIEW_TOKEN in the process environment.
|
|
1016
1231
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1017
1232
|
--no-telemetry.
|
|
1018
1233
|
|
|
1019
|
-
RAW BODY FLAGS
|
|
1020
|
-
--data=<value> Whole body as a JSON object. Field flags and --set apply
|
|
1021
|
-
over it.
|
|
1022
|
-
--file=<value> Read the body from a JSON file; `-` reads stdin. Field flags
|
|
1023
|
-
and --set apply over it.
|
|
1024
|
-
--set=<value>... Set one field by its dot path: path=value, or path:=json for
|
|
1025
|
-
JSON. Repeatable; applied after the field flags, in order. A
|
|
1026
|
-
key that contains a dot is set through its parent: --set
|
|
1027
|
-
'parent:={"a.b":"x"}'.
|
|
1028
|
-
|
|
1029
|
-
OPTIONAL FIELD FLAGS
|
|
1030
|
-
--expires-at=<value> Optional expiry.
|
|
1031
|
-
|
|
1032
1234
|
GLOBAL FLAGS
|
|
1033
1235
|
--json Format output as json.
|
|
1034
1236
|
|
|
1035
|
-
REQUIRED FIELD FLAGS
|
|
1036
|
-
--relation=<option> (required) Catalog relation on `object_type` `project`.
|
|
1037
|
-
<options: viewer|editor|admin>
|
|
1038
|
-
|
|
1039
|
-
TEAM FIELD FLAGS
|
|
1040
|
-
--team-name=<value> Team name, unique per project case-insensitively.
|
|
1041
|
-
--team-team-id=<value>
|
|
1042
|
-
|
|
1043
|
-
USER FIELD FLAGS
|
|
1044
|
-
--user-identifier=<value> The user schema's designated identifier
|
|
1045
|
-
(`x-identifier`), looked up in the platform
|
|
1046
|
-
project.
|
|
1047
|
-
--user-user-id=<value>
|
|
1048
|
-
|
|
1049
1237
|
DESCRIPTION
|
|
1050
|
-
|
|
1238
|
+
Bind an environment to a project, creating the project if needed.
|
|
1051
1239
|
|
|
1052
1240
|
EXAMPLES
|
|
1053
|
-
$ zitadel
|
|
1241
|
+
$ zitadel env add production --server https://api.zitadel.cloud --app-url https://app.acme.com
|
|
1054
1242
|
|
|
1055
|
-
$ zitadel
|
|
1056
|
-
|
|
1057
|
-
$ zitadel grants create --file ./grant.json
|
|
1243
|
+
$ zitadel env add staging --server https://api.zitadel.cloud --project proj_01K9AA9M3K7E2QX8VB4T
|
|
1058
1244
|
```
|
|
1059
1245
|
|
|
1060
|
-
## `zitadel
|
|
1246
|
+
## `zitadel env list`
|
|
1061
1247
|
|
|
1062
|
-
|
|
1248
|
+
List the environments bound in this directory's .env files.
|
|
1063
1249
|
|
|
1064
1250
|
```
|
|
1065
1251
|
USAGE
|
|
1066
|
-
$ zitadel
|
|
1067
|
-
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-
|
|
1068
|
-
|
|
1069
|
-
ARGUMENTS
|
|
1070
|
-
ID grant id
|
|
1252
|
+
$ zitadel env list [--json] [-c <value>] [-s <value>] [-n]
|
|
1253
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
1254
|
+
<value>] [--plain]
|
|
1071
1255
|
|
|
1072
1256
|
FLAGS
|
|
1073
|
-
-c, --cwd=<value>
|
|
1074
|
-
-
|
|
1075
|
-
|
|
1076
|
-
|
|
1077
|
-
|
|
1078
|
-
|
|
1079
|
-
-
|
|
1080
|
-
|
|
1081
|
-
|
|
1082
|
-
|
|
1083
|
-
--
|
|
1084
|
-
--
|
|
1085
|
-
|
|
1257
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1258
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
1259
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
1260
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
1261
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1262
|
+
an agent.
|
|
1263
|
+
-s, --server=<value> Override the resolved server URL.
|
|
1264
|
+
-v, --verbose Verbose logging.
|
|
1265
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
1266
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
1267
|
+
--debug Debug logging.
|
|
1268
|
+
--dry-run Preview without mutating files or the platform.
|
|
1269
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
1270
|
+
process environment. A relative path is read from the
|
|
1271
|
+
current directory, not from --cwd. Cannot be combined
|
|
1272
|
+
with --env.
|
|
1273
|
+
--plain Tab-separated rows with no header, for piping. Implied
|
|
1274
|
+
when stdout is not a terminal.
|
|
1275
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1276
|
+
--no-telemetry.
|
|
1086
1277
|
|
|
1087
1278
|
GLOBAL FLAGS
|
|
1088
1279
|
--json Format output as json.
|
|
1089
1280
|
|
|
1090
1281
|
DESCRIPTION
|
|
1091
|
-
|
|
1282
|
+
List the environments bound in this directory's .env files.
|
|
1092
1283
|
|
|
1093
1284
|
EXAMPLES
|
|
1094
|
-
$ zitadel
|
|
1285
|
+
$ zitadel env list
|
|
1286
|
+
|
|
1287
|
+
$ zitadel env list --plain
|
|
1095
1288
|
```
|
|
1096
1289
|
|
|
1097
|
-
## `zitadel
|
|
1290
|
+
## `zitadel events get ID`
|
|
1098
1291
|
|
|
1099
|
-
Get one
|
|
1292
|
+
Get one event by id.
|
|
1100
1293
|
|
|
1101
1294
|
```
|
|
1102
1295
|
USAGE
|
|
1103
|
-
$ zitadel
|
|
1104
|
-
[--dry-run] [-v] [--debug] [--color] [--telemetry] [
|
|
1296
|
+
$ zitadel events get ID [--json] [-c <value>] [-s <value>] [-n]
|
|
1297
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
1298
|
+
<value>] [--fields <value>]
|
|
1105
1299
|
|
|
1106
1300
|
ARGUMENTS
|
|
1107
|
-
ID
|
|
1301
|
+
ID event id
|
|
1108
1302
|
|
|
1109
1303
|
FLAGS
|
|
1110
|
-
-c, --cwd=<value>
|
|
1111
|
-
-
|
|
1112
|
-
|
|
1113
|
-
|
|
1114
|
-
-
|
|
1115
|
-
|
|
1116
|
-
|
|
1117
|
-
|
|
1118
|
-
--
|
|
1119
|
-
|
|
1120
|
-
|
|
1121
|
-
--
|
|
1122
|
-
|
|
1304
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1305
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
1306
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
1307
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
1308
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1309
|
+
an agent.
|
|
1310
|
+
-s, --server=<value> Override the resolved server URL.
|
|
1311
|
+
-v, --verbose Verbose logging.
|
|
1312
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
1313
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
1314
|
+
--debug Debug logging.
|
|
1315
|
+
--dry-run Preview without mutating files or the platform.
|
|
1316
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
1317
|
+
process environment. A relative path is read from the
|
|
1318
|
+
current directory, not from --cwd. Cannot be combined
|
|
1319
|
+
with --env.
|
|
1320
|
+
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
1321
|
+
the resource's own; `--json` is unaffected.
|
|
1322
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1323
|
+
--no-telemetry.
|
|
1123
1324
|
|
|
1124
1325
|
GLOBAL FLAGS
|
|
1125
1326
|
--json Format output as json.
|
|
1126
1327
|
|
|
1127
1328
|
DESCRIPTION
|
|
1128
|
-
Get one
|
|
1329
|
+
Get one event by id.
|
|
1129
1330
|
|
|
1130
1331
|
EXAMPLES
|
|
1131
|
-
$ zitadel
|
|
1332
|
+
$ zitadel events get <id>
|
|
1132
1333
|
|
|
1133
|
-
$ zitadel
|
|
1334
|
+
$ zitadel events get <id> --json
|
|
1134
1335
|
```
|
|
1135
1336
|
|
|
1136
|
-
## `zitadel
|
|
1337
|
+
## `zitadel events list`
|
|
1137
1338
|
|
|
1138
|
-
List
|
|
1339
|
+
List events.
|
|
1139
1340
|
|
|
1140
1341
|
```
|
|
1141
1342
|
USAGE
|
|
1142
|
-
$ zitadel
|
|
1143
|
-
[--dry-run] [-v] [--debug] [--color] [--telemetry] [
|
|
1144
|
-
|
|
1145
|
-
[--sort <value>]
|
|
1343
|
+
$ zitadel events list [--json] [-c <value>] [-s <value>] [-n]
|
|
1344
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
1345
|
+
<value>] [--limit <value>] [-a | --page-token <value>] [--fields <value>]
|
|
1346
|
+
[--plain] [--filter <value>...] [--sort <value>]
|
|
1146
1347
|
|
|
1147
1348
|
FLAGS
|
|
1148
1349
|
-a, --all
|
|
@@ -1151,6 +1352,11 @@ FLAGS
|
|
|
1151
1352
|
-c, --cwd=<value>
|
|
1152
1353
|
Project directory to operate on.
|
|
1153
1354
|
|
|
1355
|
+
-e, --env=<value>
|
|
1356
|
+
Environment to run against, e.g. production. Defaults to ZITADEL_ENV, then
|
|
1357
|
+
the hosting platform's build (VERCEL_ENV, or Netlify's CONTEXT), then
|
|
1358
|
+
development.
|
|
1359
|
+
|
|
1154
1360
|
-n, --non-interactive
|
|
1155
1361
|
Disable prompts. Required when scripting or running as an agent.
|
|
1156
1362
|
|
|
@@ -1170,21 +1376,22 @@ FLAGS
|
|
|
1170
1376
|
--dry-run
|
|
1171
1377
|
Preview without mutating files or the platform.
|
|
1172
1378
|
|
|
1379
|
+
--env-file=<value>
|
|
1380
|
+
Read ZITADEL_* values from this file ahead of the process environment. A
|
|
1381
|
+
relative path is read from the current directory, not from --cwd. Cannot be
|
|
1382
|
+
combined with --env.
|
|
1383
|
+
|
|
1173
1384
|
--fields=<value>
|
|
1174
1385
|
Columns to show, comma-separated dot-paths (e.g. id,attributes.email).
|
|
1175
1386
|
Defaults to the resource's own columns; `--json` is unaffected.
|
|
1176
1387
|
|
|
1177
1388
|
--filter=<value>...
|
|
1178
1389
|
Filter as field=operation:value (operation defaults to equals). Fields:
|
|
1179
|
-
|
|
1180
|
-
|
|
1181
|
-
(equals
|
|
1182
|
-
|
|
1183
|
-
|
|
1184
|
-
relation (equals|not_equals|contains|not_contains|less_than|less_than_or_equ
|
|
1185
|
-
al|greater_than|greater_than_or_equal), expires_at
|
|
1186
|
-
(equals|not_equals|contains|not_contains|less_than|less_than_or_equal|greate
|
|
1187
|
-
r_than|greater_than_or_equal).
|
|
1390
|
+
category (equals; values request|auth|session|admin|entity|signal; repeats
|
|
1391
|
+
widen), event_type (equals; repeats widen), actor_id (equals), session_id
|
|
1392
|
+
(equals), flow_id (equals), request_id (equals), entity_type (equals),
|
|
1393
|
+
entity_id (equals), team_id (equals), created_at
|
|
1394
|
+
(greater_than_or_equal|less_than).
|
|
1188
1395
|
|
|
1189
1396
|
--limit=<value>
|
|
1190
1397
|
Page size (server default 20, max 100).
|
|
@@ -1197,7 +1404,7 @@ FLAGS
|
|
|
1197
1404
|
terminal.
|
|
1198
1405
|
|
|
1199
1406
|
--sort=<value>
|
|
1200
|
-
Sort as field:direction (asc|desc). Fields:
|
|
1407
|
+
Sort as field:direction (asc|desc). Fields: occurred_at.
|
|
1201
1408
|
|
|
1202
1409
|
--[no-]telemetry
|
|
1203
1410
|
Send anonymous usage analytics. Disable with --no-telemetry.
|
|
@@ -1206,23 +1413,386 @@ GLOBAL FLAGS
|
|
|
1206
1413
|
--json Format output as json.
|
|
1207
1414
|
|
|
1208
1415
|
DESCRIPTION
|
|
1209
|
-
List
|
|
1416
|
+
List events.
|
|
1210
1417
|
|
|
1211
1418
|
EXAMPLES
|
|
1212
|
-
$ zitadel
|
|
1419
|
+
$ zitadel events list --json
|
|
1213
1420
|
|
|
1214
|
-
$ zitadel
|
|
1421
|
+
$ zitadel events list --all --json
|
|
1215
1422
|
|
|
1216
|
-
$ zitadel
|
|
1423
|
+
$ zitadel events list --filter category=equals:<value> --sort occurred_at:desc
|
|
1217
1424
|
```
|
|
1218
1425
|
|
|
1219
|
-
## `zitadel
|
|
1426
|
+
## `zitadel flow-definitions get FLOW`
|
|
1220
1427
|
|
|
1221
|
-
|
|
1428
|
+
Get one flow definition by flow name (newest revision) or revision id.
|
|
1222
1429
|
|
|
1223
1430
|
```
|
|
1224
1431
|
USAGE
|
|
1225
|
-
$ zitadel
|
|
1432
|
+
$ zitadel flow-definitions get FLOW [--json] [-c <value>] [-s <value>] [-n]
|
|
1433
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
1434
|
+
<value>] [--fields <value>]
|
|
1435
|
+
|
|
1436
|
+
ARGUMENTS
|
|
1437
|
+
FLOW flow name (newest revision) or revision id
|
|
1438
|
+
|
|
1439
|
+
FLAGS
|
|
1440
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1441
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
1442
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
1443
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
1444
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1445
|
+
an agent.
|
|
1446
|
+
-s, --server=<value> Override the resolved server URL.
|
|
1447
|
+
-v, --verbose Verbose logging.
|
|
1448
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
1449
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
1450
|
+
--debug Debug logging.
|
|
1451
|
+
--dry-run Preview without mutating files or the platform.
|
|
1452
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
1453
|
+
process environment. A relative path is read from the
|
|
1454
|
+
current directory, not from --cwd. Cannot be combined
|
|
1455
|
+
with --env.
|
|
1456
|
+
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
1457
|
+
the resource's own; `--json` is unaffected.
|
|
1458
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1459
|
+
--no-telemetry.
|
|
1460
|
+
|
|
1461
|
+
GLOBAL FLAGS
|
|
1462
|
+
--json Format output as json.
|
|
1463
|
+
|
|
1464
|
+
DESCRIPTION
|
|
1465
|
+
Get one flow definition by flow name (newest revision) or revision id.
|
|
1466
|
+
|
|
1467
|
+
EXAMPLES
|
|
1468
|
+
$ zitadel flow-definitions get <flow>
|
|
1469
|
+
|
|
1470
|
+
$ zitadel flow-definitions get <flow> --json
|
|
1471
|
+
```
|
|
1472
|
+
|
|
1473
|
+
## `zitadel flow-definitions list`
|
|
1474
|
+
|
|
1475
|
+
List flow-definitions.
|
|
1476
|
+
|
|
1477
|
+
```
|
|
1478
|
+
USAGE
|
|
1479
|
+
$ zitadel flow-definitions list [--json] [-c <value>] [-s <value>] [-n]
|
|
1480
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
1481
|
+
<value>] [--limit <value>] [-a | --page-token <value>] [--fields <value>]
|
|
1482
|
+
[--plain] [--filter <value>...]
|
|
1483
|
+
|
|
1484
|
+
FLAGS
|
|
1485
|
+
-a, --all Fetch every page instead of one.
|
|
1486
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1487
|
+
-e, --env=<value> Environment to run against, e.g. production.
|
|
1488
|
+
Defaults to ZITADEL_ENV, then the hosting platform's
|
|
1489
|
+
build (VERCEL_ENV, or Netlify's CONTEXT), then
|
|
1490
|
+
development.
|
|
1491
|
+
-n, --non-interactive Disable prompts. Required when scripting or running
|
|
1492
|
+
as an agent.
|
|
1493
|
+
-s, --server=<value> Override the resolved server URL.
|
|
1494
|
+
-v, --verbose Verbose logging.
|
|
1495
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
1496
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
1497
|
+
--debug Debug logging.
|
|
1498
|
+
--dry-run Preview without mutating files or the platform.
|
|
1499
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
1500
|
+
process environment. A relative path is read from
|
|
1501
|
+
the current directory, not from --cwd. Cannot be
|
|
1502
|
+
combined with --env.
|
|
1503
|
+
--fields=<value> Columns to show, comma-separated dot-paths (e.g.
|
|
1504
|
+
id,attributes.email). Defaults to the resource's own
|
|
1505
|
+
columns; `--json` is unaffected.
|
|
1506
|
+
--filter=<value>... Filter as field=operation:value (operation defaults
|
|
1507
|
+
to equals). Fields: name (equals), purpose (equals),
|
|
1508
|
+
revisions (equals; values all|latest).
|
|
1509
|
+
--limit=<value> Page size (server default 20, max 100).
|
|
1510
|
+
--page-token=<value> Continue from a previous page's next_page_token.
|
|
1511
|
+
--plain Tab-separated rows with no header, for piping.
|
|
1512
|
+
Implied when stdout is not a terminal.
|
|
1513
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1514
|
+
--no-telemetry.
|
|
1515
|
+
|
|
1516
|
+
GLOBAL FLAGS
|
|
1517
|
+
--json Format output as json.
|
|
1518
|
+
|
|
1519
|
+
DESCRIPTION
|
|
1520
|
+
List flow-definitions.
|
|
1521
|
+
|
|
1522
|
+
EXAMPLES
|
|
1523
|
+
$ zitadel flow-definitions list --json
|
|
1524
|
+
|
|
1525
|
+
$ zitadel flow-definitions list --all --json
|
|
1526
|
+
|
|
1527
|
+
$ zitadel flow-definitions list --filter name=equals:<value>
|
|
1528
|
+
```
|
|
1529
|
+
|
|
1530
|
+
## `zitadel grants create`
|
|
1531
|
+
|
|
1532
|
+
Create a grant.
|
|
1533
|
+
|
|
1534
|
+
```
|
|
1535
|
+
USAGE
|
|
1536
|
+
$ zitadel grants create [--json] [-c <value>] [-s <value>] [-n]
|
|
1537
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
1538
|
+
<value>] [--relation viewer|editor|admin] [--expires-at <value>]
|
|
1539
|
+
[--user-user-id <value>] [--user-identifier <value>] [--team-team-id
|
|
1540
|
+
<value>] [--team-name <value>] [--data <value> | --file <value>] [--set
|
|
1541
|
+
<value>...]
|
|
1542
|
+
|
|
1543
|
+
FLAGS
|
|
1544
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1545
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
1546
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
1547
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
1548
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1549
|
+
an agent.
|
|
1550
|
+
-s, --server=<value> Override the resolved server URL.
|
|
1551
|
+
-v, --verbose Verbose logging.
|
|
1552
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
1553
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
1554
|
+
--debug Debug logging.
|
|
1555
|
+
--dry-run Preview without mutating files or the platform.
|
|
1556
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
1557
|
+
process environment. A relative path is read from the
|
|
1558
|
+
current directory, not from --cwd. Cannot be combined
|
|
1559
|
+
with --env.
|
|
1560
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1561
|
+
--no-telemetry.
|
|
1562
|
+
|
|
1563
|
+
RAW BODY FLAGS
|
|
1564
|
+
--data=<value> Whole body as a JSON object. Field flags and --set apply
|
|
1565
|
+
over it.
|
|
1566
|
+
--file=<value> Read the body from a JSON file; `-` reads stdin. Field flags
|
|
1567
|
+
and --set apply over it.
|
|
1568
|
+
--set=<value>... Set one field by its dot path: path=value, or path:=json for
|
|
1569
|
+
JSON. Repeatable; applied after the field flags, in order. A
|
|
1570
|
+
key that contains a dot is set through its parent: --set
|
|
1571
|
+
'parent:={"a.b":"x"}'.
|
|
1572
|
+
|
|
1573
|
+
OPTIONAL FIELD FLAGS
|
|
1574
|
+
--expires-at=<value> Optional expiry.
|
|
1575
|
+
|
|
1576
|
+
GLOBAL FLAGS
|
|
1577
|
+
--json Format output as json.
|
|
1578
|
+
|
|
1579
|
+
REQUIRED FIELD FLAGS
|
|
1580
|
+
--relation=<option> (required) Catalog relation on `object_type` `project`.
|
|
1581
|
+
<options: viewer|editor|admin>
|
|
1582
|
+
|
|
1583
|
+
TEAM FIELD FLAGS
|
|
1584
|
+
--team-name=<value> Team name, unique per project case-insensitively.
|
|
1585
|
+
--team-team-id=<value>
|
|
1586
|
+
|
|
1587
|
+
USER FIELD FLAGS
|
|
1588
|
+
--user-identifier=<value> The user schema's designated identifier
|
|
1589
|
+
(`x-identifier`), looked up in the platform
|
|
1590
|
+
project.
|
|
1591
|
+
--user-user-id=<value>
|
|
1592
|
+
|
|
1593
|
+
DESCRIPTION
|
|
1594
|
+
Create a grant.
|
|
1595
|
+
|
|
1596
|
+
EXAMPLES
|
|
1597
|
+
$ zitadel grants create --relation viewer --user-identifier alice@acme.com --json
|
|
1598
|
+
|
|
1599
|
+
$ zitadel grants create --data '{...}' --json
|
|
1600
|
+
|
|
1601
|
+
$ zitadel grants create --file ./grant.json
|
|
1602
|
+
```
|
|
1603
|
+
|
|
1604
|
+
## `zitadel grants delete ID`
|
|
1605
|
+
|
|
1606
|
+
Delete a grant by id.
|
|
1607
|
+
|
|
1608
|
+
```
|
|
1609
|
+
USAGE
|
|
1610
|
+
$ zitadel grants delete ID [--json] [-c <value>] [-s <value>] [-n]
|
|
1611
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
1612
|
+
<value>] [-f]
|
|
1613
|
+
|
|
1614
|
+
ARGUMENTS
|
|
1615
|
+
ID grant id
|
|
1616
|
+
|
|
1617
|
+
FLAGS
|
|
1618
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1619
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
1620
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
1621
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
1622
|
+
-f, --force Delete the grant without the confirmation prompt.
|
|
1623
|
+
Required when non-interactive.
|
|
1624
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1625
|
+
an agent.
|
|
1626
|
+
-s, --server=<value> Override the resolved server URL.
|
|
1627
|
+
-v, --verbose Verbose logging.
|
|
1628
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
1629
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
1630
|
+
--debug Debug logging.
|
|
1631
|
+
--dry-run Preview without mutating files or the platform.
|
|
1632
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
1633
|
+
process environment. A relative path is read from the
|
|
1634
|
+
current directory, not from --cwd. Cannot be combined
|
|
1635
|
+
with --env.
|
|
1636
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1637
|
+
--no-telemetry.
|
|
1638
|
+
|
|
1639
|
+
GLOBAL FLAGS
|
|
1640
|
+
--json Format output as json.
|
|
1641
|
+
|
|
1642
|
+
DESCRIPTION
|
|
1643
|
+
Delete a grant by id.
|
|
1644
|
+
|
|
1645
|
+
EXAMPLES
|
|
1646
|
+
$ zitadel grants delete <id> --force --json
|
|
1647
|
+
```
|
|
1648
|
+
|
|
1649
|
+
## `zitadel grants get ID`
|
|
1650
|
+
|
|
1651
|
+
Get one grant by id.
|
|
1652
|
+
|
|
1653
|
+
```
|
|
1654
|
+
USAGE
|
|
1655
|
+
$ zitadel grants get ID [--json] [-c <value>] [-s <value>] [-n]
|
|
1656
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
1657
|
+
<value>] [--fields <value>]
|
|
1658
|
+
|
|
1659
|
+
ARGUMENTS
|
|
1660
|
+
ID grant id
|
|
1661
|
+
|
|
1662
|
+
FLAGS
|
|
1663
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1664
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
1665
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
1666
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
1667
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1668
|
+
an agent.
|
|
1669
|
+
-s, --server=<value> Override the resolved server URL.
|
|
1670
|
+
-v, --verbose Verbose logging.
|
|
1671
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
1672
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
1673
|
+
--debug Debug logging.
|
|
1674
|
+
--dry-run Preview without mutating files or the platform.
|
|
1675
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
1676
|
+
process environment. A relative path is read from the
|
|
1677
|
+
current directory, not from --cwd. Cannot be combined
|
|
1678
|
+
with --env.
|
|
1679
|
+
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
1680
|
+
the resource's own; `--json` is unaffected.
|
|
1681
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1682
|
+
--no-telemetry.
|
|
1683
|
+
|
|
1684
|
+
GLOBAL FLAGS
|
|
1685
|
+
--json Format output as json.
|
|
1686
|
+
|
|
1687
|
+
DESCRIPTION
|
|
1688
|
+
Get one grant by id.
|
|
1689
|
+
|
|
1690
|
+
EXAMPLES
|
|
1691
|
+
$ zitadel grants get <id>
|
|
1692
|
+
|
|
1693
|
+
$ zitadel grants get <id> --json
|
|
1694
|
+
```
|
|
1695
|
+
|
|
1696
|
+
## `zitadel grants list`
|
|
1697
|
+
|
|
1698
|
+
List grants.
|
|
1699
|
+
|
|
1700
|
+
```
|
|
1701
|
+
USAGE
|
|
1702
|
+
$ zitadel grants list [--json] [-c <value>] [-s <value>] [-n]
|
|
1703
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
1704
|
+
<value>] [--limit <value>] [-a | --page-token <value>] [--fields <value>]
|
|
1705
|
+
[--plain] [--filter <value>...] [--sort <value>]
|
|
1706
|
+
|
|
1707
|
+
FLAGS
|
|
1708
|
+
-a, --all
|
|
1709
|
+
Fetch every page instead of one.
|
|
1710
|
+
|
|
1711
|
+
-c, --cwd=<value>
|
|
1712
|
+
Project directory to operate on.
|
|
1713
|
+
|
|
1714
|
+
-e, --env=<value>
|
|
1715
|
+
Environment to run against, e.g. production. Defaults to ZITADEL_ENV, then
|
|
1716
|
+
the hosting platform's build (VERCEL_ENV, or Netlify's CONTEXT), then
|
|
1717
|
+
development.
|
|
1718
|
+
|
|
1719
|
+
-n, --non-interactive
|
|
1720
|
+
Disable prompts. Required when scripting or running as an agent.
|
|
1721
|
+
|
|
1722
|
+
-s, --server=<value>
|
|
1723
|
+
Override the resolved server URL.
|
|
1724
|
+
|
|
1725
|
+
-v, --verbose
|
|
1726
|
+
Verbose logging.
|
|
1727
|
+
|
|
1728
|
+
--[no-]color
|
|
1729
|
+
Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are
|
|
1730
|
+
honored too.
|
|
1731
|
+
|
|
1732
|
+
--debug
|
|
1733
|
+
Debug logging.
|
|
1734
|
+
|
|
1735
|
+
--dry-run
|
|
1736
|
+
Preview without mutating files or the platform.
|
|
1737
|
+
|
|
1738
|
+
--env-file=<value>
|
|
1739
|
+
Read ZITADEL_* values from this file ahead of the process environment. A
|
|
1740
|
+
relative path is read from the current directory, not from --cwd. Cannot be
|
|
1741
|
+
combined with --env.
|
|
1742
|
+
|
|
1743
|
+
--fields=<value>
|
|
1744
|
+
Columns to show, comma-separated dot-paths (e.g. id,attributes.email).
|
|
1745
|
+
Defaults to the resource's own columns; `--json` is unaffected.
|
|
1746
|
+
|
|
1747
|
+
--filter=<value>...
|
|
1748
|
+
Filter as field=operation:value (operation defaults to equals). Fields:
|
|
1749
|
+
created_at (equals|not_equals|contains|not_contains|less_than|less_than_or_e
|
|
1750
|
+
qual|greater_than|greater_than_or_equal), user_id
|
|
1751
|
+
(equals|not_equals|contains|not_contains|less_than|less_than_or_equal|greate
|
|
1752
|
+
r_than|greater_than_or_equal), team_id (equals|not_equals|contains|not_conta
|
|
1753
|
+
ins|less_than|less_than_or_equal|greater_than|greater_than_or_equal),
|
|
1754
|
+
relation (equals|not_equals|contains|not_contains|less_than|less_than_or_equ
|
|
1755
|
+
al|greater_than|greater_than_or_equal), expires_at
|
|
1756
|
+
(equals|not_equals|contains|not_contains|less_than|less_than_or_equal|greate
|
|
1757
|
+
r_than|greater_than_or_equal).
|
|
1758
|
+
|
|
1759
|
+
--limit=<value>
|
|
1760
|
+
Page size (server default 20, max 100).
|
|
1761
|
+
|
|
1762
|
+
--page-token=<value>
|
|
1763
|
+
Continue from a previous page's next_page_token.
|
|
1764
|
+
|
|
1765
|
+
--plain
|
|
1766
|
+
Tab-separated rows with no header, for piping. Implied when stdout is not a
|
|
1767
|
+
terminal.
|
|
1768
|
+
|
|
1769
|
+
--sort=<value>
|
|
1770
|
+
Sort as field:direction (asc|desc). Fields: created_at, expires_at, id.
|
|
1771
|
+
|
|
1772
|
+
--[no-]telemetry
|
|
1773
|
+
Send anonymous usage analytics. Disable with --no-telemetry.
|
|
1774
|
+
|
|
1775
|
+
GLOBAL FLAGS
|
|
1776
|
+
--json Format output as json.
|
|
1777
|
+
|
|
1778
|
+
DESCRIPTION
|
|
1779
|
+
List grants.
|
|
1780
|
+
|
|
1781
|
+
EXAMPLES
|
|
1782
|
+
$ zitadel grants list --json
|
|
1783
|
+
|
|
1784
|
+
$ zitadel grants list --all --json
|
|
1785
|
+
|
|
1786
|
+
$ zitadel grants list --filter created_at=equals:<value> --sort created_at:desc
|
|
1787
|
+
```
|
|
1788
|
+
|
|
1789
|
+
## `zitadel help [COMMAND]`
|
|
1790
|
+
|
|
1791
|
+
Display help for zitadel.
|
|
1792
|
+
|
|
1793
|
+
```
|
|
1794
|
+
USAGE
|
|
1795
|
+
$ zitadel help [COMMAND...] [-n]
|
|
1226
1796
|
|
|
1227
1797
|
ARGUMENTS
|
|
1228
1798
|
[COMMAND...] Command to show help for.
|
|
@@ -1243,30 +1813,38 @@ Create an identity provider connection.
|
|
|
1243
1813
|
```
|
|
1244
1814
|
USAGE
|
|
1245
1815
|
$ zitadel idps create [--json] [-c <value>] [-s <value>] [-n]
|
|
1246
|
-
[--dry-run] [-v] [--debug] [--color] [--telemetry] [
|
|
1247
|
-
|
|
1248
|
-
[--
|
|
1249
|
-
<value>...] [--
|
|
1250
|
-
[--oidc-
|
|
1251
|
-
[--oidc-
|
|
1252
|
-
[--oidc-
|
|
1253
|
-
[--oidc-client-
|
|
1254
|
-
|
|
1255
|
-
[--oidc-
|
|
1256
|
-
[--
|
|
1816
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
1817
|
+
<value>] [--slug <value>] [--protocol oidc] [--template <value>]
|
|
1818
|
+
[--display-name <value>] [--subject-claim <value>] [--claim-mapping
|
|
1819
|
+
<value>...] [--verified-claims <value>...] [--provisioning-creation
|
|
1820
|
+
disabled|auto] [--oidc-issuer <value>] [--oidc-jwks-uri <value>]
|
|
1821
|
+
[--oidc-id-token-mapping] [--oidc-authorization-endpoint <value>]
|
|
1822
|
+
[--oidc-token-endpoint <value>] [--oidc-userinfo-endpoint <value>]
|
|
1823
|
+
[--oidc-client-id <value>] [--oidc-client-secret <value>]
|
|
1824
|
+
[--oidc-token-endpoint-auth-method client_secret_basic|client_secret_post]
|
|
1825
|
+
[--oidc-scopes <value>...] [--oidc-pkce-enabled]
|
|
1826
|
+
[--oidc-static-authorize-parameters <value>...] [--data <value> | --file
|
|
1827
|
+
<value>] [--set <value>...]
|
|
1257
1828
|
|
|
1258
1829
|
FLAGS
|
|
1259
|
-
-c, --cwd=<value>
|
|
1260
|
-
-
|
|
1261
|
-
|
|
1262
|
-
|
|
1263
|
-
-
|
|
1264
|
-
|
|
1265
|
-
|
|
1266
|
-
|
|
1267
|
-
--
|
|
1268
|
-
|
|
1269
|
-
|
|
1830
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1831
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
1832
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
1833
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
1834
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1835
|
+
an agent.
|
|
1836
|
+
-s, --server=<value> Override the resolved server URL.
|
|
1837
|
+
-v, --verbose Verbose logging.
|
|
1838
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
1839
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
1840
|
+
--debug Debug logging.
|
|
1841
|
+
--dry-run Preview without mutating files or the platform.
|
|
1842
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
1843
|
+
process environment. A relative path is read from the
|
|
1844
|
+
current directory, not from --cwd. Cannot be combined
|
|
1845
|
+
with --env.
|
|
1846
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1847
|
+
--no-telemetry.
|
|
1270
1848
|
|
|
1271
1849
|
OPTIONAL FIELD FLAGS
|
|
1272
1850
|
--claim-mapping=<value>... Repeatable claim_mapping entry: key=value for a
|
|
@@ -1368,11 +1946,143 @@ Get one identity provider connection by id.
|
|
|
1368
1946
|
```
|
|
1369
1947
|
USAGE
|
|
1370
1948
|
$ zitadel idps get ID [--json] [-c <value>] [-s <value>] [-n]
|
|
1371
|
-
[--dry-run] [-v] [--debug] [--color] [--telemetry] [
|
|
1949
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
1950
|
+
<value>] [--fields <value>]
|
|
1372
1951
|
|
|
1373
1952
|
ARGUMENTS
|
|
1374
1953
|
ID identity provider connection id
|
|
1375
1954
|
|
|
1955
|
+
FLAGS
|
|
1956
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1957
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
1958
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
1959
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
1960
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1961
|
+
an agent.
|
|
1962
|
+
-s, --server=<value> Override the resolved server URL.
|
|
1963
|
+
-v, --verbose Verbose logging.
|
|
1964
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
1965
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
1966
|
+
--debug Debug logging.
|
|
1967
|
+
--dry-run Preview without mutating files or the platform.
|
|
1968
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
1969
|
+
process environment. A relative path is read from the
|
|
1970
|
+
current directory, not from --cwd. Cannot be combined
|
|
1971
|
+
with --env.
|
|
1972
|
+
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
1973
|
+
the resource's own; `--json` is unaffected.
|
|
1974
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1975
|
+
--no-telemetry.
|
|
1976
|
+
|
|
1977
|
+
GLOBAL FLAGS
|
|
1978
|
+
--json Format output as json.
|
|
1979
|
+
|
|
1980
|
+
DESCRIPTION
|
|
1981
|
+
Get one identity provider connection by id.
|
|
1982
|
+
|
|
1983
|
+
EXAMPLES
|
|
1984
|
+
$ zitadel idps get <id>
|
|
1985
|
+
|
|
1986
|
+
$ zitadel idps get <id> --json
|
|
1987
|
+
```
|
|
1988
|
+
|
|
1989
|
+
## `zitadel idps list`
|
|
1990
|
+
|
|
1991
|
+
List idps.
|
|
1992
|
+
|
|
1993
|
+
```
|
|
1994
|
+
USAGE
|
|
1995
|
+
$ zitadel idps list [--json] [-c <value>] [-s <value>] [-n]
|
|
1996
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
1997
|
+
<value>] [--limit <value>] [-a | --page-token <value>] [--fields <value>]
|
|
1998
|
+
[--plain] [--filter <value>...] [--sort <value>]
|
|
1999
|
+
|
|
2000
|
+
FLAGS
|
|
2001
|
+
-a, --all
|
|
2002
|
+
Fetch every page instead of one.
|
|
2003
|
+
|
|
2004
|
+
-c, --cwd=<value>
|
|
2005
|
+
Project directory to operate on.
|
|
2006
|
+
|
|
2007
|
+
-e, --env=<value>
|
|
2008
|
+
Environment to run against, e.g. production. Defaults to ZITADEL_ENV, then
|
|
2009
|
+
the hosting platform's build (VERCEL_ENV, or Netlify's CONTEXT), then
|
|
2010
|
+
development.
|
|
2011
|
+
|
|
2012
|
+
-n, --non-interactive
|
|
2013
|
+
Disable prompts. Required when scripting or running as an agent.
|
|
2014
|
+
|
|
2015
|
+
-s, --server=<value>
|
|
2016
|
+
Override the resolved server URL.
|
|
2017
|
+
|
|
2018
|
+
-v, --verbose
|
|
2019
|
+
Verbose logging.
|
|
2020
|
+
|
|
2021
|
+
--[no-]color
|
|
2022
|
+
Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are
|
|
2023
|
+
honored too.
|
|
2024
|
+
|
|
2025
|
+
--debug
|
|
2026
|
+
Debug logging.
|
|
2027
|
+
|
|
2028
|
+
--dry-run
|
|
2029
|
+
Preview without mutating files or the platform.
|
|
2030
|
+
|
|
2031
|
+
--env-file=<value>
|
|
2032
|
+
Read ZITADEL_* values from this file ahead of the process environment. A
|
|
2033
|
+
relative path is read from the current directory, not from --cwd. Cannot be
|
|
2034
|
+
combined with --env.
|
|
2035
|
+
|
|
2036
|
+
--fields=<value>
|
|
2037
|
+
Columns to show, comma-separated dot-paths (e.g. id,attributes.email).
|
|
2038
|
+
Defaults to the resource's own columns; `--json` is unaffected.
|
|
2039
|
+
|
|
2040
|
+
--filter=<value>...
|
|
2041
|
+
Filter as field=operation:value (operation defaults to equals). Fields: slug
|
|
2042
|
+
(equals|not_equals|contains|not_contains|less_than|less_than_or_equal|greate
|
|
2043
|
+
r_than|greater_than_or_equal), created_at (equals|not_equals|contains|not_co
|
|
2044
|
+
ntains|less_than|less_than_or_equal|greater_than|greater_than_or_equal).
|
|
2045
|
+
|
|
2046
|
+
--limit=<value>
|
|
2047
|
+
Page size (server default 20, max 100).
|
|
2048
|
+
|
|
2049
|
+
--page-token=<value>
|
|
2050
|
+
Continue from a previous page's next_page_token.
|
|
2051
|
+
|
|
2052
|
+
--plain
|
|
2053
|
+
Tab-separated rows with no header, for piping. Implied when stdout is not a
|
|
2054
|
+
terminal.
|
|
2055
|
+
|
|
2056
|
+
--sort=<value>
|
|
2057
|
+
Sort as field:direction (asc|desc). Fields: slug, created_at.
|
|
2058
|
+
|
|
2059
|
+
--[no-]telemetry
|
|
2060
|
+
Send anonymous usage analytics. Disable with --no-telemetry.
|
|
2061
|
+
|
|
2062
|
+
GLOBAL FLAGS
|
|
2063
|
+
--json Format output as json.
|
|
2064
|
+
|
|
2065
|
+
DESCRIPTION
|
|
2066
|
+
List idps.
|
|
2067
|
+
|
|
2068
|
+
EXAMPLES
|
|
2069
|
+
$ zitadel idps list --json
|
|
2070
|
+
|
|
2071
|
+
$ zitadel idps list --all --json
|
|
2072
|
+
|
|
2073
|
+
$ zitadel idps list --filter slug=equals:<value> --sort slug:desc
|
|
2074
|
+
```
|
|
2075
|
+
|
|
2076
|
+
## `zitadel logs`
|
|
2077
|
+
|
|
2078
|
+
Show local Zitadel server logs.
|
|
2079
|
+
|
|
2080
|
+
```
|
|
2081
|
+
USAGE
|
|
2082
|
+
$ zitadel logs [--json] [-c <value>] [-s <value>] [-n]
|
|
2083
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--follow] [--level
|
|
2084
|
+
debug|info|warn|error] [--tail <value>]
|
|
2085
|
+
|
|
1376
2086
|
FLAGS
|
|
1377
2087
|
-c, --cwd=<value> Project directory to operate on.
|
|
1378
2088
|
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
@@ -1383,8 +2093,11 @@ FLAGS
|
|
|
1383
2093
|
NO_COLOR and FORCE_COLOR are honored too.
|
|
1384
2094
|
--debug Debug logging.
|
|
1385
2095
|
--dry-run Preview without mutating files or the platform.
|
|
1386
|
-
--
|
|
1387
|
-
|
|
2096
|
+
--follow Keep printing lines as the server writes them.
|
|
2097
|
+
--level=<option> Show only lines at this level or above.
|
|
2098
|
+
<options: debug|info|warn|error>
|
|
2099
|
+
--tail=<value> [default: 200] Number of lines to show, counting only
|
|
2100
|
+
those --level shows.
|
|
1388
2101
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1389
2102
|
--no-telemetry.
|
|
1390
2103
|
|
|
@@ -1392,150 +2105,405 @@ GLOBAL FLAGS
|
|
|
1392
2105
|
--json Format output as json.
|
|
1393
2106
|
|
|
1394
2107
|
DESCRIPTION
|
|
1395
|
-
|
|
2108
|
+
Show local Zitadel server logs.
|
|
2109
|
+
|
|
2110
|
+
On a terminal, warnings are yellow and errors red. Run it in the directory
|
|
2111
|
+
`zitadel start` ran in, or one inside it: the server is found from the nearest
|
|
2112
|
+
`.zitadel/local/` on the way up.
|
|
2113
|
+
|
|
2114
|
+
EXAMPLES
|
|
2115
|
+
$ zitadel logs --follow
|
|
2116
|
+
|
|
2117
|
+
$ zitadel logs --level warn
|
|
2118
|
+
```
|
|
2119
|
+
|
|
2120
|
+
## `zitadel origin add PATTERN`
|
|
2121
|
+
|
|
2122
|
+
Add an origin pattern to the project.
|
|
2123
|
+
|
|
2124
|
+
```
|
|
2125
|
+
USAGE
|
|
2126
|
+
$ zitadel origin add PATTERN --kind primary|preview [--json] [-c
|
|
2127
|
+
<value>] [-s <value>] [-n] [--dry-run] [-v] [--debug] [--color]
|
|
2128
|
+
[--telemetry] [-e <value>] [--env-file <value>]
|
|
2129
|
+
|
|
2130
|
+
ARGUMENTS
|
|
2131
|
+
PATTERN The origin pattern to add.
|
|
2132
|
+
|
|
2133
|
+
FLAGS
|
|
2134
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2135
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
2136
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
2137
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
2138
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2139
|
+
an agent.
|
|
2140
|
+
-s, --server=<value> Override the resolved server URL.
|
|
2141
|
+
-v, --verbose Verbose logging.
|
|
2142
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2143
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
2144
|
+
--debug Debug logging.
|
|
2145
|
+
--dry-run Preview without mutating files or the platform.
|
|
2146
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
2147
|
+
process environment. A relative path is read from the
|
|
2148
|
+
current directory, not from --cwd. Cannot be combined
|
|
2149
|
+
with --env.
|
|
2150
|
+
--kind=<option> (required) What the pattern is for.
|
|
2151
|
+
<options: primary|preview>
|
|
2152
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2153
|
+
--no-telemetry.
|
|
2154
|
+
|
|
2155
|
+
GLOBAL FLAGS
|
|
2156
|
+
--json Format output as json.
|
|
2157
|
+
|
|
2158
|
+
DESCRIPTION
|
|
2159
|
+
Add an origin pattern to the project.
|
|
2160
|
+
|
|
2161
|
+
EXAMPLES
|
|
2162
|
+
$ zitadel origin add https://app.acme.com --kind primary
|
|
2163
|
+
|
|
2164
|
+
$ zitadel origin add 'https://*-acme.vercel.app' --kind preview
|
|
2165
|
+
```
|
|
2166
|
+
|
|
2167
|
+
## `zitadel origin list`
|
|
2168
|
+
|
|
2169
|
+
List the origin patterns on the project.
|
|
2170
|
+
|
|
2171
|
+
```
|
|
2172
|
+
USAGE
|
|
2173
|
+
$ zitadel origin list [--json] [-c <value>] [-s <value>] [-n]
|
|
2174
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
2175
|
+
<value>] [--plain]
|
|
2176
|
+
|
|
2177
|
+
FLAGS
|
|
2178
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2179
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
2180
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
2181
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
2182
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2183
|
+
an agent.
|
|
2184
|
+
-s, --server=<value> Override the resolved server URL.
|
|
2185
|
+
-v, --verbose Verbose logging.
|
|
2186
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2187
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
2188
|
+
--debug Debug logging.
|
|
2189
|
+
--dry-run Preview without mutating files or the platform.
|
|
2190
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
2191
|
+
process environment. A relative path is read from the
|
|
2192
|
+
current directory, not from --cwd. Cannot be combined
|
|
2193
|
+
with --env.
|
|
2194
|
+
--plain Tab-separated rows with no header, for piping. Implied
|
|
2195
|
+
when stdout is not a terminal.
|
|
2196
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2197
|
+
--no-telemetry.
|
|
2198
|
+
|
|
2199
|
+
GLOBAL FLAGS
|
|
2200
|
+
--json Format output as json.
|
|
2201
|
+
|
|
2202
|
+
DESCRIPTION
|
|
2203
|
+
List the origin patterns on the project.
|
|
2204
|
+
|
|
2205
|
+
EXAMPLES
|
|
2206
|
+
$ zitadel origin list
|
|
2207
|
+
|
|
2208
|
+
$ zitadel origin list --plain
|
|
2209
|
+
```
|
|
2210
|
+
|
|
2211
|
+
## `zitadel origin rm PATTERN`
|
|
2212
|
+
|
|
2213
|
+
Remove an origin pattern from the project.
|
|
2214
|
+
|
|
2215
|
+
```
|
|
2216
|
+
USAGE
|
|
2217
|
+
$ zitadel origin rm PATTERN [--json] [-c <value>] [-s <value>] [-n]
|
|
2218
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
2219
|
+
<value>] [-f]
|
|
2220
|
+
|
|
2221
|
+
ARGUMENTS
|
|
2222
|
+
PATTERN The origin pattern to remove.
|
|
2223
|
+
|
|
2224
|
+
FLAGS
|
|
2225
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2226
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
2227
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
2228
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
2229
|
+
-f, --force Remove the pattern without the confirmation prompt.
|
|
2230
|
+
Required when non-interactive.
|
|
2231
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2232
|
+
an agent.
|
|
2233
|
+
-s, --server=<value> Override the resolved server URL.
|
|
2234
|
+
-v, --verbose Verbose logging.
|
|
2235
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2236
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
2237
|
+
--debug Debug logging.
|
|
2238
|
+
--dry-run Preview without mutating files or the platform.
|
|
2239
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
2240
|
+
process environment. A relative path is read from the
|
|
2241
|
+
current directory, not from --cwd. Cannot be combined
|
|
2242
|
+
with --env.
|
|
2243
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2244
|
+
--no-telemetry.
|
|
2245
|
+
|
|
2246
|
+
GLOBAL FLAGS
|
|
2247
|
+
--json Format output as json.
|
|
2248
|
+
|
|
2249
|
+
DESCRIPTION
|
|
2250
|
+
Remove an origin pattern from the project.
|
|
2251
|
+
|
|
2252
|
+
EXAMPLES
|
|
2253
|
+
$ zitadel origin rm https://app.acme.com
|
|
2254
|
+
|
|
2255
|
+
$ zitadel origin rm https://app.acme.com --force
|
|
2256
|
+
```
|
|
2257
|
+
|
|
2258
|
+
## `zitadel policies get POLICY`
|
|
2259
|
+
|
|
2260
|
+
Get one policy by policy id or operation.
|
|
2261
|
+
|
|
2262
|
+
```
|
|
2263
|
+
USAGE
|
|
2264
|
+
$ zitadel policies get POLICY [--json] [-c <value>] [-s <value>] [-n]
|
|
2265
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
2266
|
+
<value>] [--fields <value>]
|
|
2267
|
+
|
|
2268
|
+
ARGUMENTS
|
|
2269
|
+
POLICY policy id or operation
|
|
2270
|
+
|
|
2271
|
+
FLAGS
|
|
2272
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2273
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
2274
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
2275
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
2276
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2277
|
+
an agent.
|
|
2278
|
+
-s, --server=<value> Override the resolved server URL.
|
|
2279
|
+
-v, --verbose Verbose logging.
|
|
2280
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2281
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
2282
|
+
--debug Debug logging.
|
|
2283
|
+
--dry-run Preview without mutating files or the platform.
|
|
2284
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
2285
|
+
process environment. A relative path is read from the
|
|
2286
|
+
current directory, not from --cwd. Cannot be combined
|
|
2287
|
+
with --env.
|
|
2288
|
+
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
2289
|
+
the resource's own; `--json` is unaffected.
|
|
2290
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2291
|
+
--no-telemetry.
|
|
2292
|
+
|
|
2293
|
+
GLOBAL FLAGS
|
|
2294
|
+
--json Format output as json.
|
|
2295
|
+
|
|
2296
|
+
DESCRIPTION
|
|
2297
|
+
Get one policy by policy id or operation.
|
|
1396
2298
|
|
|
1397
2299
|
EXAMPLES
|
|
1398
|
-
$ zitadel
|
|
2300
|
+
$ zitadel policies get <policy>
|
|
1399
2301
|
|
|
1400
|
-
$ zitadel
|
|
2302
|
+
$ zitadel policies get <policy> --json
|
|
1401
2303
|
```
|
|
1402
2304
|
|
|
1403
|
-
## `zitadel
|
|
2305
|
+
## `zitadel policies list`
|
|
1404
2306
|
|
|
1405
|
-
List
|
|
2307
|
+
List policies.
|
|
1406
2308
|
|
|
1407
2309
|
```
|
|
1408
2310
|
USAGE
|
|
1409
|
-
$ zitadel
|
|
1410
|
-
[--dry-run] [-v] [--debug] [--color] [--telemetry] [
|
|
1411
|
-
|
|
1412
|
-
[--
|
|
2311
|
+
$ zitadel policies list [--json] [-c <value>] [-s <value>] [-n]
|
|
2312
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
2313
|
+
<value>] [--limit <value>] [-a | --page-token <value>] [--fields <value>]
|
|
2314
|
+
[--plain] [--filter <value>...]
|
|
1413
2315
|
|
|
1414
2316
|
FLAGS
|
|
1415
|
-
-a, --all
|
|
1416
|
-
|
|
1417
|
-
|
|
1418
|
-
|
|
1419
|
-
|
|
1420
|
-
|
|
1421
|
-
-n, --non-interactive
|
|
1422
|
-
|
|
1423
|
-
|
|
1424
|
-
-
|
|
1425
|
-
|
|
1426
|
-
|
|
1427
|
-
|
|
1428
|
-
|
|
1429
|
-
|
|
1430
|
-
|
|
1431
|
-
|
|
1432
|
-
|
|
2317
|
+
-a, --all Fetch every page instead of one.
|
|
2318
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2319
|
+
-e, --env=<value> Environment to run against, e.g. production.
|
|
2320
|
+
Defaults to ZITADEL_ENV, then the hosting platform's
|
|
2321
|
+
build (VERCEL_ENV, or Netlify's CONTEXT), then
|
|
2322
|
+
development.
|
|
2323
|
+
-n, --non-interactive Disable prompts. Required when scripting or running
|
|
2324
|
+
as an agent.
|
|
2325
|
+
-s, --server=<value> Override the resolved server URL.
|
|
2326
|
+
-v, --verbose Verbose logging.
|
|
2327
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2328
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
2329
|
+
--debug Debug logging.
|
|
2330
|
+
--dry-run Preview without mutating files or the platform.
|
|
2331
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
2332
|
+
process environment. A relative path is read from
|
|
2333
|
+
the current directory, not from --cwd. Cannot be
|
|
2334
|
+
combined with --env.
|
|
2335
|
+
--fields=<value> Columns to show, comma-separated dot-paths (e.g.
|
|
2336
|
+
id,attributes.email). Defaults to the resource's own
|
|
2337
|
+
columns; `--json` is unaffected.
|
|
2338
|
+
--filter=<value>... Filter as field=operation:value (operation defaults
|
|
2339
|
+
to equals). Fields: operation (equals).
|
|
2340
|
+
--limit=<value> Page size (server default 20, max 100).
|
|
2341
|
+
--page-token=<value> Continue from a previous page's next_page_token.
|
|
2342
|
+
--plain Tab-separated rows with no header, for piping.
|
|
2343
|
+
Implied when stdout is not a terminal.
|
|
2344
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2345
|
+
--no-telemetry.
|
|
1433
2346
|
|
|
1434
|
-
|
|
1435
|
-
|
|
2347
|
+
GLOBAL FLAGS
|
|
2348
|
+
--json Format output as json.
|
|
1436
2349
|
|
|
1437
|
-
|
|
1438
|
-
|
|
2350
|
+
DESCRIPTION
|
|
2351
|
+
List policies.
|
|
1439
2352
|
|
|
1440
|
-
|
|
1441
|
-
|
|
1442
|
-
Defaults to the resource's own columns; `--json` is unaffected.
|
|
2353
|
+
EXAMPLES
|
|
2354
|
+
$ zitadel policies list --json
|
|
1443
2355
|
|
|
1444
|
-
--
|
|
1445
|
-
Filter as field=operation:value (operation defaults to equals). Fields: slug
|
|
1446
|
-
(equals|not_equals|contains|not_contains|less_than|less_than_or_equal|greate
|
|
1447
|
-
r_than|greater_than_or_equal), created_at (equals|not_equals|contains|not_co
|
|
1448
|
-
ntains|less_than|less_than_or_equal|greater_than|greater_than_or_equal).
|
|
2356
|
+
$ zitadel policies list --all --json
|
|
1449
2357
|
|
|
1450
|
-
--
|
|
1451
|
-
|
|
2358
|
+
$ zitadel policies list --filter operation=equals:<value>
|
|
2359
|
+
```
|
|
1452
2360
|
|
|
1453
|
-
|
|
1454
|
-
Continue from a previous page's next_page_token.
|
|
2361
|
+
## `zitadel preview`
|
|
1455
2362
|
|
|
1456
|
-
|
|
1457
|
-
Tab-separated rows with no header, for piping. Implied when stdout is not a
|
|
1458
|
-
terminal.
|
|
2363
|
+
Deploy a release from .zitadel/ to a pull-request build's preview URLs.
|
|
1459
2364
|
|
|
1460
|
-
|
|
1461
|
-
|
|
2365
|
+
```
|
|
2366
|
+
USAGE
|
|
2367
|
+
$ zitadel preview [--json] [-c <value>] [-s <value>] [-n]
|
|
2368
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
2369
|
+
<value>] [--origin <value>...] [--ttl <value>] [--strict]
|
|
1462
2370
|
|
|
1463
|
-
|
|
1464
|
-
|
|
2371
|
+
FLAGS
|
|
2372
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2373
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
2374
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
2375
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
2376
|
+
-n, --non-interactive Disable prompts. Required when scripting or running
|
|
2377
|
+
as an agent.
|
|
2378
|
+
-s, --server=<value> Override the resolved server URL.
|
|
2379
|
+
-v, --verbose Verbose logging.
|
|
2380
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2381
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
2382
|
+
--debug Debug logging.
|
|
2383
|
+
--dry-run Preview without mutating files or the platform.
|
|
2384
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
2385
|
+
process environment. A relative path is read from the
|
|
2386
|
+
current directory, not from --cwd. Cannot be combined
|
|
2387
|
+
with --env.
|
|
2388
|
+
--origin=<value>... A preview URL to deploy to, instead of detecting them
|
|
2389
|
+
from the platform build. Repeatable.
|
|
2390
|
+
--strict Fail instead of warning when no preview credential
|
|
2391
|
+
(ZITADEL_PROJECT_SECRET) is set.
|
|
2392
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2393
|
+
--no-telemetry.
|
|
2394
|
+
--ttl=<value> How long each preview stays live, e.g. 7d, 12h or
|
|
2395
|
+
90m. Between 60s and 365d. Omitted, the project's
|
|
2396
|
+
default applies.
|
|
1465
2397
|
|
|
1466
2398
|
GLOBAL FLAGS
|
|
1467
2399
|
--json Format output as json.
|
|
1468
2400
|
|
|
1469
2401
|
DESCRIPTION
|
|
1470
|
-
|
|
2402
|
+
Deploy a release from .zitadel/ to a pull-request build's preview URLs.
|
|
1471
2403
|
|
|
1472
2404
|
EXAMPLES
|
|
1473
|
-
$ zitadel
|
|
2405
|
+
$ zitadel preview
|
|
1474
2406
|
|
|
1475
|
-
$ zitadel
|
|
2407
|
+
$ zitadel preview --origin https://acme-git-sso-acmeinc.vercel.app
|
|
1476
2408
|
|
|
1477
|
-
$ zitadel
|
|
2409
|
+
$ zitadel preview --ttl 24h
|
|
1478
2410
|
```
|
|
1479
2411
|
|
|
1480
|
-
## `zitadel
|
|
2412
|
+
## `zitadel preview list`
|
|
1481
2413
|
|
|
1482
|
-
|
|
2414
|
+
List the project's live previews, newest first.
|
|
1483
2415
|
|
|
1484
2416
|
```
|
|
1485
2417
|
USAGE
|
|
1486
|
-
$ zitadel
|
|
1487
|
-
[--dry-run] [-v] [--debug] [--color] [--telemetry] [
|
|
1488
|
-
<value>]
|
|
2418
|
+
$ zitadel preview list [--json] [-c <value>] [-s <value>] [-n]
|
|
2419
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
2420
|
+
<value>] [--limit <value>] [-a | --page-token <value>] [--plain]
|
|
1489
2421
|
|
|
1490
2422
|
FLAGS
|
|
1491
|
-
-
|
|
1492
|
-
-
|
|
1493
|
-
|
|
1494
|
-
|
|
1495
|
-
|
|
1496
|
-
|
|
1497
|
-
|
|
1498
|
-
|
|
1499
|
-
|
|
1500
|
-
|
|
1501
|
-
--
|
|
1502
|
-
|
|
1503
|
-
|
|
2423
|
+
-a, --all Fetch every page instead of one.
|
|
2424
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2425
|
+
-e, --env=<value> Environment to run against, e.g. production.
|
|
2426
|
+
Defaults to ZITADEL_ENV, then the hosting platform's
|
|
2427
|
+
build (VERCEL_ENV, or Netlify's CONTEXT), then
|
|
2428
|
+
development.
|
|
2429
|
+
-n, --non-interactive Disable prompts. Required when scripting or running
|
|
2430
|
+
as an agent.
|
|
2431
|
+
-s, --server=<value> Override the resolved server URL.
|
|
2432
|
+
-v, --verbose Verbose logging.
|
|
2433
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2434
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
2435
|
+
--debug Debug logging.
|
|
2436
|
+
--dry-run Preview without mutating files or the platform.
|
|
2437
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
2438
|
+
process environment. A relative path is read from
|
|
2439
|
+
the current directory, not from --cwd. Cannot be
|
|
2440
|
+
combined with --env.
|
|
2441
|
+
--limit=<value> Page size (server default 20, max 100).
|
|
2442
|
+
--page-token=<value> Continue from a previous page's next_page_token.
|
|
2443
|
+
--plain Tab-separated rows with no header, for piping.
|
|
2444
|
+
Implied when stdout is not a terminal.
|
|
2445
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2446
|
+
--no-telemetry.
|
|
1504
2447
|
|
|
1505
2448
|
GLOBAL FLAGS
|
|
1506
2449
|
--json Format output as json.
|
|
1507
2450
|
|
|
1508
2451
|
DESCRIPTION
|
|
1509
|
-
|
|
2452
|
+
List the project's live previews, newest first.
|
|
2453
|
+
|
|
2454
|
+
EXAMPLES
|
|
2455
|
+
$ zitadel preview list
|
|
2456
|
+
|
|
2457
|
+
$ zitadel preview list --all
|
|
2458
|
+
|
|
2459
|
+
$ zitadel preview list --plain
|
|
1510
2460
|
```
|
|
1511
2461
|
|
|
1512
|
-
## `zitadel
|
|
2462
|
+
## `zitadel preview rm URL`
|
|
1513
2463
|
|
|
1514
|
-
|
|
2464
|
+
Remove a live preview from the project.
|
|
1515
2465
|
|
|
1516
2466
|
```
|
|
1517
2467
|
USAGE
|
|
1518
|
-
$ zitadel
|
|
1519
|
-
[--dry-run] [-v] [--debug] [--color] [--telemetry]
|
|
2468
|
+
$ zitadel preview rm URL [--json] [-c <value>] [-s <value>] [-n]
|
|
2469
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
2470
|
+
<value>] [-f]
|
|
2471
|
+
|
|
2472
|
+
ARGUMENTS
|
|
2473
|
+
URL The preview URL to remove.
|
|
1520
2474
|
|
|
1521
2475
|
FLAGS
|
|
1522
|
-
-c, --cwd=<value>
|
|
1523
|
-
-
|
|
1524
|
-
|
|
1525
|
-
|
|
1526
|
-
-
|
|
1527
|
-
|
|
1528
|
-
|
|
1529
|
-
|
|
1530
|
-
|
|
1531
|
-
|
|
1532
|
-
|
|
2476
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2477
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
2478
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
2479
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
2480
|
+
-f, --force Remove the preview without the confirmation prompt.
|
|
2481
|
+
Required when non-interactive.
|
|
2482
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2483
|
+
an agent.
|
|
2484
|
+
-s, --server=<value> Override the resolved server URL.
|
|
2485
|
+
-v, --verbose Verbose logging.
|
|
2486
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2487
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
2488
|
+
--debug Debug logging.
|
|
2489
|
+
--dry-run Preview without mutating files or the platform.
|
|
2490
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
2491
|
+
process environment. A relative path is read from the
|
|
2492
|
+
current directory, not from --cwd. Cannot be combined
|
|
2493
|
+
with --env.
|
|
2494
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2495
|
+
--no-telemetry.
|
|
1533
2496
|
|
|
1534
2497
|
GLOBAL FLAGS
|
|
1535
2498
|
--json Format output as json.
|
|
1536
2499
|
|
|
1537
2500
|
DESCRIPTION
|
|
1538
|
-
|
|
2501
|
+
Remove a live preview from the project.
|
|
2502
|
+
|
|
2503
|
+
EXAMPLES
|
|
2504
|
+
$ zitadel preview rm https://acme-git-sso-acmeinc.vercel.app
|
|
2505
|
+
|
|
2506
|
+
$ zitadel preview rm https://acme-git-sso-acmeinc.vercel.app --force
|
|
1539
2507
|
```
|
|
1540
2508
|
|
|
1541
2509
|
## `zitadel projects get ID`
|
|
@@ -1545,25 +2513,33 @@ Get one project by id.
|
|
|
1545
2513
|
```
|
|
1546
2514
|
USAGE
|
|
1547
2515
|
$ zitadel projects get ID [--json] [-c <value>] [-s <value>] [-n]
|
|
1548
|
-
[--dry-run] [-v] [--debug] [--color] [--telemetry] [
|
|
2516
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
2517
|
+
<value>] [--fields <value>]
|
|
1549
2518
|
|
|
1550
2519
|
ARGUMENTS
|
|
1551
2520
|
ID project id
|
|
1552
2521
|
|
|
1553
2522
|
FLAGS
|
|
1554
|
-
-c, --cwd=<value>
|
|
1555
|
-
-
|
|
1556
|
-
|
|
1557
|
-
|
|
1558
|
-
-
|
|
1559
|
-
|
|
1560
|
-
|
|
1561
|
-
|
|
1562
|
-
--
|
|
1563
|
-
|
|
1564
|
-
|
|
1565
|
-
--
|
|
1566
|
-
|
|
2523
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2524
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
2525
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
2526
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
2527
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2528
|
+
an agent.
|
|
2529
|
+
-s, --server=<value> Override the resolved server URL.
|
|
2530
|
+
-v, --verbose Verbose logging.
|
|
2531
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2532
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
2533
|
+
--debug Debug logging.
|
|
2534
|
+
--dry-run Preview without mutating files or the platform.
|
|
2535
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
2536
|
+
process environment. A relative path is read from the
|
|
2537
|
+
current directory, not from --cwd. Cannot be combined
|
|
2538
|
+
with --env.
|
|
2539
|
+
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
2540
|
+
the resource's own; `--json` is unaffected.
|
|
2541
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2542
|
+
--no-telemetry.
|
|
1567
2543
|
|
|
1568
2544
|
GLOBAL FLAGS
|
|
1569
2545
|
--json Format output as json.
|
|
@@ -1584,13 +2560,17 @@ List projects.
|
|
|
1584
2560
|
```
|
|
1585
2561
|
USAGE
|
|
1586
2562
|
$ zitadel projects list [--json] [-c <value>] [-s <value>] [-n]
|
|
1587
|
-
[--dry-run] [-v] [--debug] [--color] [--telemetry] [
|
|
1588
|
-
|
|
1589
|
-
[--sort <value>]
|
|
2563
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
2564
|
+
<value>] [--limit <value>] [-a | --page-token <value>] [--fields <value>]
|
|
2565
|
+
[--plain] [--filter <value>...] [--sort <value>]
|
|
1590
2566
|
|
|
1591
2567
|
FLAGS
|
|
1592
2568
|
-a, --all Fetch every page instead of one.
|
|
1593
2569
|
-c, --cwd=<value> Project directory to operate on.
|
|
2570
|
+
-e, --env=<value> Environment to run against, e.g. production.
|
|
2571
|
+
Defaults to ZITADEL_ENV, then the hosting platform's
|
|
2572
|
+
build (VERCEL_ENV, or Netlify's CONTEXT), then
|
|
2573
|
+
development.
|
|
1594
2574
|
-n, --non-interactive Disable prompts. Required when scripting or running
|
|
1595
2575
|
as an agent.
|
|
1596
2576
|
-s, --server=<value> Override the resolved server URL.
|
|
@@ -1599,6 +2579,10 @@ FLAGS
|
|
|
1599
2579
|
NO_COLOR and FORCE_COLOR are honored too.
|
|
1600
2580
|
--debug Debug logging.
|
|
1601
2581
|
--dry-run Preview without mutating files or the platform.
|
|
2582
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
2583
|
+
process environment. A relative path is read from
|
|
2584
|
+
the current directory, not from --cwd. Cannot be
|
|
2585
|
+
combined with --env.
|
|
1602
2586
|
--fields=<value> Columns to show, comma-separated dot-paths (e.g.
|
|
1603
2587
|
id,attributes.email). Defaults to the resource's own
|
|
1604
2588
|
columns; `--json` is unaffected.
|
|
@@ -1636,29 +2620,37 @@ Update a project by id.
|
|
|
1636
2620
|
```
|
|
1637
2621
|
USAGE
|
|
1638
2622
|
$ zitadel projects update ID [--json] [-c <value>] [-s <value>] [-n]
|
|
1639
|
-
[--dry-run] [-v] [--debug] [--color] [--telemetry] [
|
|
1640
|
-
[--password-hash-algorithm
|
|
1641
|
-
|
|
1642
|
-
<value>] [--password-hash-params-
|
|
1643
|
-
[--password-hash-params-
|
|
1644
|
-
<value>] [--password-hash-params-
|
|
1645
|
-
[--
|
|
2623
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
2624
|
+
<value>] [--name <value>] [--password-hash-algorithm
|
|
2625
|
+
argon2i|argon2id|bcrypt|scrypt|pbkdf2|sha2] [--password-hash-params-time
|
|
2626
|
+
<value>] [--password-hash-params-memory <value>]
|
|
2627
|
+
[--password-hash-params-threads <value>] [--password-hash-params-cost
|
|
2628
|
+
<value>] [--password-hash-params-rounds <value>]
|
|
2629
|
+
[--password-hash-params-hash sha1|sha224|sha256|sha384|sha512] [--data
|
|
2630
|
+
<value> | --file <value>] [--set <value>...]
|
|
1646
2631
|
|
|
1647
2632
|
ARGUMENTS
|
|
1648
2633
|
ID project id
|
|
1649
2634
|
|
|
1650
2635
|
FLAGS
|
|
1651
|
-
-c, --cwd=<value>
|
|
1652
|
-
-
|
|
1653
|
-
|
|
1654
|
-
|
|
1655
|
-
-
|
|
1656
|
-
|
|
1657
|
-
|
|
1658
|
-
|
|
1659
|
-
--
|
|
1660
|
-
|
|
1661
|
-
|
|
2636
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2637
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
2638
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
2639
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
2640
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2641
|
+
an agent.
|
|
2642
|
+
-s, --server=<value> Override the resolved server URL.
|
|
2643
|
+
-v, --verbose Verbose logging.
|
|
2644
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2645
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
2646
|
+
--debug Debug logging.
|
|
2647
|
+
--dry-run Preview without mutating files or the platform.
|
|
2648
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
2649
|
+
process environment. A relative path is read from the
|
|
2650
|
+
current directory, not from --cwd. Cannot be combined
|
|
2651
|
+
with --env.
|
|
2652
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2653
|
+
--no-telemetry.
|
|
1662
2654
|
|
|
1663
2655
|
RAW BODY FLAGS
|
|
1664
2656
|
--data=<value> Whole body as a JSON object. Field flags and --set apply
|
|
@@ -1670,62 +2662,163 @@ RAW BODY FLAGS
|
|
|
1670
2662
|
key that contains a dot is set through its parent: --set
|
|
1671
2663
|
'parent:={"a.b":"x"}'.
|
|
1672
2664
|
|
|
1673
|
-
GLOBAL FLAGS
|
|
1674
|
-
--json Format output as json.
|
|
2665
|
+
GLOBAL FLAGS
|
|
2666
|
+
--json Format output as json.
|
|
2667
|
+
|
|
2668
|
+
OPTIONAL FIELD FLAGS
|
|
2669
|
+
--name=<value> The name of the project.
|
|
2670
|
+
|
|
2671
|
+
PASSWORD HASH FIELD FLAGS
|
|
2672
|
+
--password-hash-algorithm=<option> (required with password_hash.*) The
|
|
2673
|
+
hashing algorithm.
|
|
2674
|
+
<options: argon2i|argon2id|bcrypt|scry
|
|
2675
|
+
pt|pbkdf2|sha2>
|
|
2676
|
+
--password-hash-params-cost=<value> bcrypt cost, or scrypt's log2 of the
|
|
2677
|
+
CPU/memory cost.
|
|
2678
|
+
--password-hash-params-hash=<option> The underlying hash.
|
|
2679
|
+
<options:
|
|
2680
|
+
sha1|sha224|sha256|sha384|sha512>
|
|
2681
|
+
--password-hash-params-memory=<value> argon2 memory in KiB.
|
|
2682
|
+
--password-hash-params-rounds=<value> pbkdf2 or sha2 iteration count.
|
|
2683
|
+
--password-hash-params-threads=<value> argon2 lanes.
|
|
2684
|
+
--password-hash-params-time=<value> argon2 passes over memory.
|
|
2685
|
+
|
|
2686
|
+
DESCRIPTION
|
|
2687
|
+
Update a project by id.
|
|
2688
|
+
|
|
2689
|
+
EXAMPLES
|
|
2690
|
+
$ zitadel projects update <id> --data '{...}' --json
|
|
2691
|
+
|
|
2692
|
+
$ zitadel projects update <id> --file ./project.json
|
|
2693
|
+
```
|
|
2694
|
+
|
|
2695
|
+
## `zitadel pull [TARGET]`
|
|
2696
|
+
|
|
2697
|
+
Rebuild your .zitadel/ files from a release.
|
|
2698
|
+
|
|
2699
|
+
```
|
|
2700
|
+
USAGE
|
|
2701
|
+
$ zitadel pull [TARGET] [--json] [-c <value>] [-s <value>] [-n]
|
|
2702
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
2703
|
+
<value>]
|
|
2704
|
+
|
|
2705
|
+
ARGUMENTS
|
|
2706
|
+
[TARGET] [default: latest] What to pull: 'latest' (the live release), a
|
|
2707
|
+
release id (rel_…), or a deployment id (dep_…).
|
|
2708
|
+
|
|
2709
|
+
FLAGS
|
|
2710
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2711
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
2712
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
2713
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
2714
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2715
|
+
an agent.
|
|
2716
|
+
-s, --server=<value> Override the resolved server URL.
|
|
2717
|
+
-v, --verbose Verbose logging.
|
|
2718
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2719
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
2720
|
+
--debug Debug logging.
|
|
2721
|
+
--dry-run Preview without mutating files or the platform.
|
|
2722
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
2723
|
+
process environment. A relative path is read from the
|
|
2724
|
+
current directory, not from --cwd. Cannot be combined
|
|
2725
|
+
with --env.
|
|
2726
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2727
|
+
--no-telemetry.
|
|
2728
|
+
|
|
2729
|
+
GLOBAL FLAGS
|
|
2730
|
+
--json Format output as json.
|
|
2731
|
+
|
|
2732
|
+
DESCRIPTION
|
|
2733
|
+
Rebuild your .zitadel/ files from a release.
|
|
2734
|
+
|
|
2735
|
+
Writes .zitadel/ from the revisions a released snapshot pins.
|
|
2736
|
+
|
|
2737
|
+
EXAMPLES
|
|
2738
|
+
$ zitadel pull
|
|
2739
|
+
|
|
2740
|
+
$ zitadel pull rel_01KX3RG8A7F0N9WD3P2E4YM5C1
|
|
2741
|
+
|
|
2742
|
+
$ zitadel pull dep_01KX5N7C9D2E7F0N9WD3P2E4YM6
|
|
2743
|
+
```
|
|
2744
|
+
|
|
2745
|
+
## `zitadel release create`
|
|
1675
2746
|
|
|
1676
|
-
|
|
1677
|
-
--name=<value> The name of the project.
|
|
2747
|
+
Build a release from .zitadel/ without deploying it.
|
|
1678
2748
|
|
|
1679
|
-
|
|
1680
|
-
|
|
1681
|
-
|
|
1682
|
-
|
|
1683
|
-
|
|
1684
|
-
|
|
1685
|
-
|
|
1686
|
-
--
|
|
1687
|
-
|
|
1688
|
-
|
|
1689
|
-
|
|
1690
|
-
--
|
|
1691
|
-
--
|
|
1692
|
-
|
|
2749
|
+
```
|
|
2750
|
+
USAGE
|
|
2751
|
+
$ zitadel release create [--json] [-c <value>] [-s <value>] [-n]
|
|
2752
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
2753
|
+
<value>] [-m <value>]
|
|
2754
|
+
|
|
2755
|
+
FLAGS
|
|
2756
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2757
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
2758
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
2759
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
2760
|
+
-m, --message=<value> A short summary of what this release changes.
|
|
2761
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2762
|
+
an agent.
|
|
2763
|
+
-s, --server=<value> Override the resolved server URL.
|
|
2764
|
+
-v, --verbose Verbose logging.
|
|
2765
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2766
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
2767
|
+
--debug Debug logging.
|
|
2768
|
+
--dry-run Preview without mutating files or the platform.
|
|
2769
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
2770
|
+
process environment. A relative path is read from the
|
|
2771
|
+
current directory, not from --cwd. Cannot be combined
|
|
2772
|
+
with --env.
|
|
2773
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2774
|
+
--no-telemetry.
|
|
2775
|
+
|
|
2776
|
+
GLOBAL FLAGS
|
|
2777
|
+
--json Format output as json.
|
|
1693
2778
|
|
|
1694
2779
|
DESCRIPTION
|
|
1695
|
-
|
|
2780
|
+
Build a release from .zitadel/ without deploying it.
|
|
1696
2781
|
|
|
1697
2782
|
EXAMPLES
|
|
1698
|
-
$ zitadel
|
|
2783
|
+
$ zitadel release create
|
|
1699
2784
|
|
|
1700
|
-
$ zitadel
|
|
2785
|
+
$ zitadel release create -m 'add phone_number to human-user'
|
|
1701
2786
|
```
|
|
1702
2787
|
|
|
1703
|
-
## `zitadel
|
|
2788
|
+
## `zitadel release get ID`
|
|
1704
2789
|
|
|
1705
2790
|
Get one release by id.
|
|
1706
2791
|
|
|
1707
2792
|
```
|
|
1708
2793
|
USAGE
|
|
1709
|
-
$ zitadel
|
|
1710
|
-
[--dry-run] [-v] [--debug] [--color] [--telemetry] [
|
|
2794
|
+
$ zitadel release get ID [--json] [-c <value>] [-s <value>] [-n]
|
|
2795
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
2796
|
+
<value>] [--fields <value>]
|
|
1711
2797
|
|
|
1712
2798
|
ARGUMENTS
|
|
1713
2799
|
ID release id
|
|
1714
2800
|
|
|
1715
2801
|
FLAGS
|
|
1716
|
-
-c, --cwd=<value>
|
|
1717
|
-
-
|
|
1718
|
-
|
|
1719
|
-
|
|
1720
|
-
-
|
|
1721
|
-
|
|
1722
|
-
|
|
1723
|
-
|
|
1724
|
-
--
|
|
1725
|
-
|
|
1726
|
-
|
|
1727
|
-
--
|
|
1728
|
-
|
|
2802
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2803
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
2804
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
2805
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
2806
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2807
|
+
an agent.
|
|
2808
|
+
-s, --server=<value> Override the resolved server URL.
|
|
2809
|
+
-v, --verbose Verbose logging.
|
|
2810
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2811
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
2812
|
+
--debug Debug logging.
|
|
2813
|
+
--dry-run Preview without mutating files or the platform.
|
|
2814
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
2815
|
+
process environment. A relative path is read from the
|
|
2816
|
+
current directory, not from --cwd. Cannot be combined
|
|
2817
|
+
with --env.
|
|
2818
|
+
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
2819
|
+
the resource's own; `--json` is unaffected.
|
|
2820
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2821
|
+
--no-telemetry.
|
|
1729
2822
|
|
|
1730
2823
|
GLOBAL FLAGS
|
|
1731
2824
|
--json Format output as json.
|
|
@@ -1734,24 +2827,29 @@ DESCRIPTION
|
|
|
1734
2827
|
Get one release by id.
|
|
1735
2828
|
|
|
1736
2829
|
EXAMPLES
|
|
1737
|
-
$ zitadel
|
|
2830
|
+
$ zitadel release get <id>
|
|
1738
2831
|
|
|
1739
|
-
$ zitadel
|
|
2832
|
+
$ zitadel release get <id> --json
|
|
1740
2833
|
```
|
|
1741
2834
|
|
|
1742
|
-
## `zitadel
|
|
2835
|
+
## `zitadel release list`
|
|
1743
2836
|
|
|
1744
|
-
List
|
|
2837
|
+
List release.
|
|
1745
2838
|
|
|
1746
2839
|
```
|
|
1747
2840
|
USAGE
|
|
1748
|
-
$ zitadel
|
|
1749
|
-
[--dry-run] [-v] [--debug] [--color] [--telemetry] [
|
|
1750
|
-
--page-token <value>] [--fields <value>]
|
|
2841
|
+
$ zitadel release list [--json] [-c <value>] [-s <value>] [-n]
|
|
2842
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
2843
|
+
<value>] [--limit <value>] [-a | --page-token <value>] [--fields <value>]
|
|
2844
|
+
[--plain]
|
|
1751
2845
|
|
|
1752
2846
|
FLAGS
|
|
1753
2847
|
-a, --all Fetch every page instead of one.
|
|
1754
2848
|
-c, --cwd=<value> Project directory to operate on.
|
|
2849
|
+
-e, --env=<value> Environment to run against, e.g. production.
|
|
2850
|
+
Defaults to ZITADEL_ENV, then the hosting platform's
|
|
2851
|
+
build (VERCEL_ENV, or Netlify's CONTEXT), then
|
|
2852
|
+
development.
|
|
1755
2853
|
-n, --non-interactive Disable prompts. Required when scripting or running
|
|
1756
2854
|
as an agent.
|
|
1757
2855
|
-s, --server=<value> Override the resolved server URL.
|
|
@@ -1760,6 +2858,10 @@ FLAGS
|
|
|
1760
2858
|
NO_COLOR and FORCE_COLOR are honored too.
|
|
1761
2859
|
--debug Debug logging.
|
|
1762
2860
|
--dry-run Preview without mutating files or the platform.
|
|
2861
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
2862
|
+
process environment. A relative path is read from
|
|
2863
|
+
the current directory, not from --cwd. Cannot be
|
|
2864
|
+
combined with --env.
|
|
1763
2865
|
--fields=<value> Columns to show, comma-separated dot-paths (e.g.
|
|
1764
2866
|
id,attributes.email). Defaults to the resource's own
|
|
1765
2867
|
columns; `--json` is unaffected.
|
|
@@ -1774,12 +2876,59 @@ GLOBAL FLAGS
|
|
|
1774
2876
|
--json Format output as json.
|
|
1775
2877
|
|
|
1776
2878
|
DESCRIPTION
|
|
1777
|
-
List
|
|
2879
|
+
List release.
|
|
2880
|
+
|
|
2881
|
+
EXAMPLES
|
|
2882
|
+
$ zitadel release list --json
|
|
2883
|
+
|
|
2884
|
+
$ zitadel release list --all --json
|
|
2885
|
+
```
|
|
2886
|
+
|
|
2887
|
+
## `zitadel release revoke RELEASE_ID`
|
|
2888
|
+
|
|
2889
|
+
Revoke a release so its content is never served again.
|
|
2890
|
+
|
|
2891
|
+
```
|
|
2892
|
+
USAGE
|
|
2893
|
+
$ zitadel release revoke RELEASE_ID [--json] [-c <value>] [-s <value>]
|
|
2894
|
+
[-n] [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>]
|
|
2895
|
+
[--env-file <value>] [-f]
|
|
2896
|
+
|
|
2897
|
+
ARGUMENTS
|
|
2898
|
+
RELEASE_ID The release to revoke.
|
|
2899
|
+
|
|
2900
|
+
FLAGS
|
|
2901
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2902
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
2903
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
2904
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
2905
|
+
-f, --force Revoke without the confirmation prompt. Required when
|
|
2906
|
+
non-interactive.
|
|
2907
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2908
|
+
an agent.
|
|
2909
|
+
-s, --server=<value> Override the resolved server URL.
|
|
2910
|
+
-v, --verbose Verbose logging.
|
|
2911
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2912
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
2913
|
+
--debug Debug logging.
|
|
2914
|
+
--dry-run Preview without mutating files or the platform.
|
|
2915
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
2916
|
+
process environment. A relative path is read from the
|
|
2917
|
+
current directory, not from --cwd. Cannot be combined
|
|
2918
|
+
with --env.
|
|
2919
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2920
|
+
--no-telemetry.
|
|
2921
|
+
|
|
2922
|
+
GLOBAL FLAGS
|
|
2923
|
+
--json Format output as json.
|
|
2924
|
+
|
|
2925
|
+
DESCRIPTION
|
|
2926
|
+
Revoke a release so its content is never served again.
|
|
1778
2927
|
|
|
1779
2928
|
EXAMPLES
|
|
1780
|
-
$ zitadel
|
|
2929
|
+
$ zitadel release revoke rel_01KX3RG8A7F0N9WD3P2E4YM5C1
|
|
1781
2930
|
|
|
1782
|
-
$ zitadel
|
|
2931
|
+
$ zitadel release revoke rel_01KX3RG8A7F0N9WD3P2E4YM5C1 --force
|
|
1783
2932
|
```
|
|
1784
2933
|
|
|
1785
2934
|
## `zitadel reset`
|
|
@@ -1815,12 +2964,12 @@ DESCRIPTION
|
|
|
1815
2964
|
|
|
1816
2965
|
## `zitadel resources`
|
|
1817
2966
|
|
|
1818
|
-
List the resources this CLI manages
|
|
2967
|
+
List the resources this CLI manages.
|
|
1819
2968
|
|
|
1820
2969
|
```
|
|
1821
2970
|
USAGE
|
|
1822
2971
|
$ zitadel resources [--json] [-c <value>] [-s <value>] [-n]
|
|
1823
|
-
[--dry-run] [-v] [--debug] [--color] [--telemetry]
|
|
2972
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--plain]
|
|
1824
2973
|
|
|
1825
2974
|
FLAGS
|
|
1826
2975
|
-c, --cwd=<value> Project directory to operate on.
|
|
@@ -1832,6 +2981,8 @@ FLAGS
|
|
|
1832
2981
|
NO_COLOR and FORCE_COLOR are honored too.
|
|
1833
2982
|
--debug Debug logging.
|
|
1834
2983
|
--dry-run Preview without mutating files or the platform.
|
|
2984
|
+
--plain Tab-separated rows with no header, for piping. Implied
|
|
2985
|
+
when stdout is not a terminal.
|
|
1835
2986
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1836
2987
|
--no-telemetry.
|
|
1837
2988
|
|
|
@@ -1839,53 +2990,63 @@ GLOBAL FLAGS
|
|
|
1839
2990
|
--json Format output as json.
|
|
1840
2991
|
|
|
1841
2992
|
DESCRIPTION
|
|
1842
|
-
List the resources this CLI manages
|
|
2993
|
+
List the resources this CLI manages.
|
|
2994
|
+
|
|
2995
|
+
Shows what can be done to each.
|
|
1843
2996
|
|
|
1844
2997
|
EXAMPLES
|
|
1845
2998
|
$ zitadel resources
|
|
1846
2999
|
|
|
1847
3000
|
$ zitadel resources --json
|
|
1848
3001
|
|
|
1849
|
-
$ zitadel resources --json | jq -r '.data.
|
|
3002
|
+
$ zitadel resources --json | jq -r '.data.items[] | "\(.topic): \(.verbs | join(", "))"'
|
|
1850
3003
|
```
|
|
1851
3004
|
|
|
1852
3005
|
## `zitadel schemas get SCHEMA`
|
|
1853
3006
|
|
|
1854
|
-
Get one schema by id.
|
|
3007
|
+
Get one schema by object type (current revision) or revision id.
|
|
1855
3008
|
|
|
1856
3009
|
```
|
|
1857
3010
|
USAGE
|
|
1858
3011
|
$ zitadel schemas get SCHEMA [--json] [-c <value>] [-s <value>] [-n]
|
|
1859
|
-
[--dry-run] [-v] [--debug] [--color] [--telemetry] [
|
|
3012
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
3013
|
+
<value>] [--fields <value>]
|
|
1860
3014
|
|
|
1861
3015
|
ARGUMENTS
|
|
1862
3016
|
SCHEMA object type (current revision) or revision id
|
|
1863
3017
|
|
|
1864
3018
|
FLAGS
|
|
1865
|
-
-c, --cwd=<value>
|
|
1866
|
-
-
|
|
1867
|
-
|
|
1868
|
-
|
|
1869
|
-
-
|
|
1870
|
-
|
|
1871
|
-
|
|
1872
|
-
|
|
1873
|
-
--
|
|
1874
|
-
|
|
1875
|
-
|
|
1876
|
-
--
|
|
1877
|
-
|
|
3019
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
3020
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
3021
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
3022
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
3023
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
3024
|
+
an agent.
|
|
3025
|
+
-s, --server=<value> Override the resolved server URL.
|
|
3026
|
+
-v, --verbose Verbose logging.
|
|
3027
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
3028
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
3029
|
+
--debug Debug logging.
|
|
3030
|
+
--dry-run Preview without mutating files or the platform.
|
|
3031
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
3032
|
+
process environment. A relative path is read from the
|
|
3033
|
+
current directory, not from --cwd. Cannot be combined
|
|
3034
|
+
with --env.
|
|
3035
|
+
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
3036
|
+
the resource's own; `--json` is unaffected.
|
|
3037
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
3038
|
+
--no-telemetry.
|
|
1878
3039
|
|
|
1879
3040
|
GLOBAL FLAGS
|
|
1880
3041
|
--json Format output as json.
|
|
1881
3042
|
|
|
1882
3043
|
DESCRIPTION
|
|
1883
|
-
Get one schema by id.
|
|
3044
|
+
Get one schema by object type (current revision) or revision id.
|
|
1884
3045
|
|
|
1885
3046
|
EXAMPLES
|
|
1886
|
-
$ zitadel schemas get <
|
|
3047
|
+
$ zitadel schemas get <schema>
|
|
1887
3048
|
|
|
1888
|
-
$ zitadel schemas get <
|
|
3049
|
+
$ zitadel schemas get <schema> --json
|
|
1889
3050
|
```
|
|
1890
3051
|
|
|
1891
3052
|
## `zitadel schemas list`
|
|
@@ -1895,12 +3056,17 @@ List schemas.
|
|
|
1895
3056
|
```
|
|
1896
3057
|
USAGE
|
|
1897
3058
|
$ zitadel schemas list [--json] [-c <value>] [-s <value>] [-n]
|
|
1898
|
-
[--dry-run] [-v] [--debug] [--color] [--telemetry] [
|
|
1899
|
-
|
|
3059
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
3060
|
+
<value>] [--limit <value>] [-a | --page-token <value>] [--fields <value>]
|
|
3061
|
+
[--plain] [--filter <value>...]
|
|
1900
3062
|
|
|
1901
3063
|
FLAGS
|
|
1902
3064
|
-a, --all Fetch every page instead of one.
|
|
1903
3065
|
-c, --cwd=<value> Project directory to operate on.
|
|
3066
|
+
-e, --env=<value> Environment to run against, e.g. production.
|
|
3067
|
+
Defaults to ZITADEL_ENV, then the hosting platform's
|
|
3068
|
+
build (VERCEL_ENV, or Netlify's CONTEXT), then
|
|
3069
|
+
development.
|
|
1904
3070
|
-n, --non-interactive Disable prompts. Required when scripting or running
|
|
1905
3071
|
as an agent.
|
|
1906
3072
|
-s, --server=<value> Override the resolved server URL.
|
|
@@ -1909,6 +3075,10 @@ FLAGS
|
|
|
1909
3075
|
NO_COLOR and FORCE_COLOR are honored too.
|
|
1910
3076
|
--debug Debug logging.
|
|
1911
3077
|
--dry-run Preview without mutating files or the platform.
|
|
3078
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
3079
|
+
process environment. A relative path is read from
|
|
3080
|
+
the current directory, not from --cwd. Cannot be
|
|
3081
|
+
combined with --env.
|
|
1912
3082
|
--fields=<value> Columns to show, comma-separated dot-paths (e.g.
|
|
1913
3083
|
id,attributes.email). Defaults to the resource's own
|
|
1914
3084
|
columns; `--json` is unaffected.
|
|
@@ -1960,25 +3130,33 @@ Get one session by id.
|
|
|
1960
3130
|
```
|
|
1961
3131
|
USAGE
|
|
1962
3132
|
$ zitadel sessions get ID [--json] [-c <value>] [-s <value>] [-n]
|
|
1963
|
-
[--dry-run] [-v] [--debug] [--color] [--telemetry] [
|
|
3133
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
3134
|
+
<value>] [--fields <value>]
|
|
1964
3135
|
|
|
1965
3136
|
ARGUMENTS
|
|
1966
3137
|
ID session id
|
|
1967
3138
|
|
|
1968
3139
|
FLAGS
|
|
1969
|
-
-c, --cwd=<value>
|
|
1970
|
-
-
|
|
1971
|
-
|
|
1972
|
-
|
|
1973
|
-
-
|
|
1974
|
-
|
|
1975
|
-
|
|
1976
|
-
|
|
1977
|
-
--
|
|
1978
|
-
|
|
1979
|
-
|
|
1980
|
-
--
|
|
1981
|
-
|
|
3140
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
3141
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
3142
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
3143
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
3144
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
3145
|
+
an agent.
|
|
3146
|
+
-s, --server=<value> Override the resolved server URL.
|
|
3147
|
+
-v, --verbose Verbose logging.
|
|
3148
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
3149
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
3150
|
+
--debug Debug logging.
|
|
3151
|
+
--dry-run Preview without mutating files or the platform.
|
|
3152
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
3153
|
+
process environment. A relative path is read from the
|
|
3154
|
+
current directory, not from --cwd. Cannot be combined
|
|
3155
|
+
with --env.
|
|
3156
|
+
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
3157
|
+
the resource's own; `--json` is unaffected.
|
|
3158
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
3159
|
+
--no-telemetry.
|
|
1982
3160
|
|
|
1983
3161
|
GLOBAL FLAGS
|
|
1984
3162
|
--json Format output as json.
|
|
@@ -1999,9 +3177,9 @@ List sessions.
|
|
|
1999
3177
|
```
|
|
2000
3178
|
USAGE
|
|
2001
3179
|
$ zitadel sessions list [--json] [-c <value>] [-s <value>] [-n]
|
|
2002
|
-
[--dry-run] [-v] [--debug] [--color] [--telemetry] [
|
|
2003
|
-
|
|
2004
|
-
[--sort <value>]
|
|
3180
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
3181
|
+
<value>] [--limit <value>] [-a | --page-token <value>] [--fields <value>]
|
|
3182
|
+
[--plain] [--filter <value>...] [--sort <value>]
|
|
2005
3183
|
|
|
2006
3184
|
FLAGS
|
|
2007
3185
|
-a, --all
|
|
@@ -2010,6 +3188,11 @@ FLAGS
|
|
|
2010
3188
|
-c, --cwd=<value>
|
|
2011
3189
|
Project directory to operate on.
|
|
2012
3190
|
|
|
3191
|
+
-e, --env=<value>
|
|
3192
|
+
Environment to run against, e.g. production. Defaults to ZITADEL_ENV, then
|
|
3193
|
+
the hosting platform's build (VERCEL_ENV, or Netlify's CONTEXT), then
|
|
3194
|
+
development.
|
|
3195
|
+
|
|
2013
3196
|
-n, --non-interactive
|
|
2014
3197
|
Disable prompts. Required when scripting or running as an agent.
|
|
2015
3198
|
|
|
@@ -2029,6 +3212,11 @@ FLAGS
|
|
|
2029
3212
|
--dry-run
|
|
2030
3213
|
Preview without mutating files or the platform.
|
|
2031
3214
|
|
|
3215
|
+
--env-file=<value>
|
|
3216
|
+
Read ZITADEL_* values from this file ahead of the process environment. A
|
|
3217
|
+
relative path is read from the current directory, not from --cwd. Cannot be
|
|
3218
|
+
combined with --env.
|
|
3219
|
+
|
|
2032
3220
|
--fields=<value>
|
|
2033
3221
|
Columns to show, comma-separated dot-paths (e.g. id,attributes.email).
|
|
2034
3222
|
Defaults to the resource's own columns; `--json` is unaffected.
|
|
@@ -2080,25 +3268,33 @@ Revoke a session by id.
|
|
|
2080
3268
|
```
|
|
2081
3269
|
USAGE
|
|
2082
3270
|
$ zitadel sessions revoke ID [--json] [-c <value>] [-s <value>] [-n]
|
|
2083
|
-
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-
|
|
3271
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
3272
|
+
<value>] [-f]
|
|
2084
3273
|
|
|
2085
3274
|
ARGUMENTS
|
|
2086
3275
|
ID session id
|
|
2087
3276
|
|
|
2088
3277
|
FLAGS
|
|
2089
|
-
-c, --cwd=<value>
|
|
2090
|
-
-
|
|
2091
|
-
|
|
2092
|
-
|
|
2093
|
-
|
|
2094
|
-
|
|
2095
|
-
-
|
|
2096
|
-
|
|
2097
|
-
|
|
2098
|
-
|
|
2099
|
-
--
|
|
2100
|
-
|
|
2101
|
-
|
|
3278
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
3279
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
3280
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
3281
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
3282
|
+
-f, --force Revoke the session without the confirmation prompt.
|
|
3283
|
+
Required when non-interactive.
|
|
3284
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
3285
|
+
an agent.
|
|
3286
|
+
-s, --server=<value> Override the resolved server URL.
|
|
3287
|
+
-v, --verbose Verbose logging.
|
|
3288
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
3289
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
3290
|
+
--debug Debug logging.
|
|
3291
|
+
--dry-run Preview without mutating files or the platform.
|
|
3292
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
3293
|
+
process environment. A relative path is read from the
|
|
3294
|
+
current directory, not from --cwd. Cannot be combined
|
|
3295
|
+
with --env.
|
|
3296
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
3297
|
+
--no-telemetry.
|
|
2102
3298
|
|
|
2103
3299
|
GLOBAL FLAGS
|
|
2104
3300
|
--json Format output as json.
|
|
@@ -2112,7 +3308,7 @@ EXAMPLES
|
|
|
2112
3308
|
|
|
2113
3309
|
## `zitadel setup`
|
|
2114
3310
|
|
|
2115
|
-
Create a Zitadel project and scaffold local auth.
|
|
3311
|
+
Create a Zitadel project and scaffold local auth. An interactive setup ends with a note about the Zitadel agent skills, shown once per machine; set NO_SKILLS_PROMPT=1 to hide it.
|
|
2116
3312
|
|
|
2117
3313
|
```
|
|
2118
3314
|
USAGE
|
|
@@ -2121,9 +3317,9 @@ USAGE
|
|
|
2121
3317
|
next|nuxt|tanstack-start|react|vue|solid-start|solid|sveltekit|svelte|qwik-r
|
|
2122
3318
|
outer|qwik|angular] [--renderer react] [--dev-port <value>] [--skip-install]
|
|
2123
3319
|
[--preset password-first|passkey-first] [--use-case
|
|
2124
|
-
minimal|consumer|business] [--
|
|
2125
|
-
|
|
2126
|
-
[--sso-scopes <value>]
|
|
3320
|
+
minimal|consumer|business] [--password-min-length <value>] [--sso
|
|
3321
|
+
google|custom] [--sso-client-id <value>] [--sso-slug <value>]
|
|
3322
|
+
[--sso-display-name <value>] [--sso-issuer <value>] [--sso-scopes <value>]
|
|
2127
3323
|
|
|
2128
3324
|
FLAGS
|
|
2129
3325
|
-c, --cwd=<value>
|
|
@@ -2152,7 +3348,8 @@ FLAGS
|
|
|
2152
3348
|
--dev-port=<value>
|
|
2153
3349
|
Dev-server port; also the issuer origin registered with Zitadel. Defaults to
|
|
2154
3350
|
the detected port. Use distinct ports to run several scaffolded apps side by
|
|
2155
|
-
side.
|
|
3351
|
+
side. In an app already set up, moves it to this port: the dev script,
|
|
3352
|
+
ZITADEL_ISSUER and the allowed origin.
|
|
2156
3353
|
|
|
2157
3354
|
--dry-run
|
|
2158
3355
|
Preview without mutating files or the platform.
|
|
@@ -2162,6 +3359,11 @@ FLAGS
|
|
|
2162
3359
|
<options: next|nuxt|tanstack-start|react|vue|solid-start|solid|sveltekit|sve
|
|
2163
3360
|
lte|qwik-router|qwik|angular>
|
|
2164
3361
|
|
|
3362
|
+
--password-min-length=<value>
|
|
3363
|
+
Minimum password length for the project's password policy, for example 12; 0
|
|
3364
|
+
sets none. Without it, setup sets 15, the NIST minimum for password-only
|
|
3365
|
+
sign-in; change it in .zitadel/policies/ later.
|
|
3366
|
+
|
|
2165
3367
|
--preset=<option>
|
|
2166
3368
|
Sign-in preset for the scaffolded schema and login flow (default:
|
|
2167
3369
|
password-first).
|
|
@@ -2211,7 +3413,9 @@ GLOBAL FLAGS
|
|
|
2211
3413
|
--json Format output as json.
|
|
2212
3414
|
|
|
2213
3415
|
DESCRIPTION
|
|
2214
|
-
Create a Zitadel project and scaffold local auth.
|
|
3416
|
+
Create a Zitadel project and scaffold local auth. An interactive setup ends
|
|
3417
|
+
with a note about the Zitadel agent skills, shown once per machine; set
|
|
3418
|
+
NO_SKILLS_PROMPT=1 to hide it.
|
|
2215
3419
|
|
|
2216
3420
|
EXAMPLES
|
|
2217
3421
|
$ zitadel setup --framework next
|
|
@@ -2261,20 +3465,28 @@ Summarize the local Zitadel server and project state.
|
|
|
2261
3465
|
```
|
|
2262
3466
|
USAGE
|
|
2263
3467
|
$ zitadel status [--json] [-c <value>] [-s <value>] [-n]
|
|
2264
|
-
[--dry-run] [-v] [--debug] [--color] [--telemetry]
|
|
3468
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
3469
|
+
<value>]
|
|
2265
3470
|
|
|
2266
3471
|
FLAGS
|
|
2267
|
-
-c, --cwd=<value>
|
|
2268
|
-
-
|
|
2269
|
-
|
|
2270
|
-
|
|
2271
|
-
-
|
|
2272
|
-
|
|
2273
|
-
|
|
2274
|
-
|
|
2275
|
-
--
|
|
2276
|
-
|
|
2277
|
-
|
|
3472
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
3473
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
3474
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
3475
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
3476
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
3477
|
+
an agent.
|
|
3478
|
+
-s, --server=<value> Override the resolved server URL.
|
|
3479
|
+
-v, --verbose Verbose logging.
|
|
3480
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
3481
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
3482
|
+
--debug Debug logging.
|
|
3483
|
+
--dry-run Preview without mutating files or the platform.
|
|
3484
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
3485
|
+
process environment. A relative path is read from the
|
|
3486
|
+
current directory, not from --cwd. Cannot be combined
|
|
3487
|
+
with --env.
|
|
3488
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
3489
|
+
--no-telemetry.
|
|
2278
3490
|
|
|
2279
3491
|
GLOBAL FLAGS
|
|
2280
3492
|
--json Format output as json.
|
|
@@ -2321,21 +3533,29 @@ Create a team.
|
|
|
2321
3533
|
```
|
|
2322
3534
|
USAGE
|
|
2323
3535
|
$ zitadel teams create [--json] [-c <value>] [-s <value>] [-n]
|
|
2324
|
-
[--dry-run] [-v] [--debug] [--color] [--telemetry] [
|
|
2325
|
-
<value> | --file <value>] [--set
|
|
3536
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
3537
|
+
<value>] [--name <value>] [--data <value> | --file <value>] [--set
|
|
3538
|
+
<value>...]
|
|
2326
3539
|
|
|
2327
3540
|
FLAGS
|
|
2328
|
-
-c, --cwd=<value>
|
|
2329
|
-
-
|
|
2330
|
-
|
|
2331
|
-
|
|
2332
|
-
-
|
|
2333
|
-
|
|
2334
|
-
|
|
2335
|
-
|
|
2336
|
-
--
|
|
2337
|
-
|
|
2338
|
-
|
|
3541
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
3542
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
3543
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
3544
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
3545
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
3546
|
+
an agent.
|
|
3547
|
+
-s, --server=<value> Override the resolved server URL.
|
|
3548
|
+
-v, --verbose Verbose logging.
|
|
3549
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
3550
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
3551
|
+
--debug Debug logging.
|
|
3552
|
+
--dry-run Preview without mutating files or the platform.
|
|
3553
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
3554
|
+
process environment. A relative path is read from the
|
|
3555
|
+
current directory, not from --cwd. Cannot be combined
|
|
3556
|
+
with --env.
|
|
3557
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
3558
|
+
--no-telemetry.
|
|
2339
3559
|
|
|
2340
3560
|
RAW BODY FLAGS
|
|
2341
3561
|
--data=<value> Whole body as a JSON object. Field flags and --set apply
|
|
@@ -2371,25 +3591,33 @@ Deactivate a team by id.
|
|
|
2371
3591
|
```
|
|
2372
3592
|
USAGE
|
|
2373
3593
|
$ zitadel teams deactivate ID [--json] [-c <value>] [-s <value>] [-n]
|
|
2374
|
-
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-
|
|
3594
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
3595
|
+
<value>] [-f]
|
|
2375
3596
|
|
|
2376
3597
|
ARGUMENTS
|
|
2377
3598
|
ID team id
|
|
2378
3599
|
|
|
2379
3600
|
FLAGS
|
|
2380
|
-
-c, --cwd=<value>
|
|
2381
|
-
-
|
|
2382
|
-
|
|
2383
|
-
|
|
2384
|
-
|
|
2385
|
-
|
|
2386
|
-
-
|
|
2387
|
-
|
|
2388
|
-
|
|
2389
|
-
|
|
2390
|
-
--
|
|
2391
|
-
|
|
2392
|
-
|
|
3601
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
3602
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
3603
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
3604
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
3605
|
+
-f, --force Deactivate the team without the confirmation prompt.
|
|
3606
|
+
Required when non-interactive.
|
|
3607
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
3608
|
+
an agent.
|
|
3609
|
+
-s, --server=<value> Override the resolved server URL.
|
|
3610
|
+
-v, --verbose Verbose logging.
|
|
3611
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
3612
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
3613
|
+
--debug Debug logging.
|
|
3614
|
+
--dry-run Preview without mutating files or the platform.
|
|
3615
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
3616
|
+
process environment. A relative path is read from the
|
|
3617
|
+
current directory, not from --cwd. Cannot be combined
|
|
3618
|
+
with --env.
|
|
3619
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
3620
|
+
--no-telemetry.
|
|
2393
3621
|
|
|
2394
3622
|
GLOBAL FLAGS
|
|
2395
3623
|
--json Format output as json.
|
|
@@ -2408,25 +3636,33 @@ Get one team by id.
|
|
|
2408
3636
|
```
|
|
2409
3637
|
USAGE
|
|
2410
3638
|
$ zitadel teams get ID [--json] [-c <value>] [-s <value>] [-n]
|
|
2411
|
-
[--dry-run] [-v] [--debug] [--color] [--telemetry] [
|
|
3639
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
3640
|
+
<value>] [--fields <value>]
|
|
2412
3641
|
|
|
2413
3642
|
ARGUMENTS
|
|
2414
3643
|
ID team id
|
|
2415
3644
|
|
|
2416
3645
|
FLAGS
|
|
2417
|
-
-c, --cwd=<value>
|
|
2418
|
-
-
|
|
2419
|
-
|
|
2420
|
-
|
|
2421
|
-
-
|
|
2422
|
-
|
|
2423
|
-
|
|
2424
|
-
|
|
2425
|
-
--
|
|
2426
|
-
|
|
2427
|
-
|
|
2428
|
-
--
|
|
2429
|
-
|
|
3646
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
3647
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
3648
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
3649
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
3650
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
3651
|
+
an agent.
|
|
3652
|
+
-s, --server=<value> Override the resolved server URL.
|
|
3653
|
+
-v, --verbose Verbose logging.
|
|
3654
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
3655
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
3656
|
+
--debug Debug logging.
|
|
3657
|
+
--dry-run Preview without mutating files or the platform.
|
|
3658
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
3659
|
+
process environment. A relative path is read from the
|
|
3660
|
+
current directory, not from --cwd. Cannot be combined
|
|
3661
|
+
with --env.
|
|
3662
|
+
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
3663
|
+
the resource's own; `--json` is unaffected.
|
|
3664
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
3665
|
+
--no-telemetry.
|
|
2430
3666
|
|
|
2431
3667
|
GLOBAL FLAGS
|
|
2432
3668
|
--json Format output as json.
|
|
@@ -2447,9 +3683,9 @@ List teams.
|
|
|
2447
3683
|
```
|
|
2448
3684
|
USAGE
|
|
2449
3685
|
$ zitadel teams list [--json] [-c <value>] [-s <value>] [-n]
|
|
2450
|
-
[--dry-run] [-v] [--debug] [--color] [--telemetry] [
|
|
2451
|
-
|
|
2452
|
-
[--sort <value>]
|
|
3686
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
3687
|
+
<value>] [--limit <value>] [-a | --page-token <value>] [--fields <value>]
|
|
3688
|
+
[--plain] [--filter <value>...] [--sort <value>]
|
|
2453
3689
|
|
|
2454
3690
|
FLAGS
|
|
2455
3691
|
-a, --all
|
|
@@ -2458,6 +3694,11 @@ FLAGS
|
|
|
2458
3694
|
-c, --cwd=<value>
|
|
2459
3695
|
Project directory to operate on.
|
|
2460
3696
|
|
|
3697
|
+
-e, --env=<value>
|
|
3698
|
+
Environment to run against, e.g. production. Defaults to ZITADEL_ENV, then
|
|
3699
|
+
the hosting platform's build (VERCEL_ENV, or Netlify's CONTEXT), then
|
|
3700
|
+
development.
|
|
3701
|
+
|
|
2461
3702
|
-n, --non-interactive
|
|
2462
3703
|
Disable prompts. Required when scripting or running as an agent.
|
|
2463
3704
|
|
|
@@ -2477,6 +3718,11 @@ FLAGS
|
|
|
2477
3718
|
--dry-run
|
|
2478
3719
|
Preview without mutating files or the platform.
|
|
2479
3720
|
|
|
3721
|
+
--env-file=<value>
|
|
3722
|
+
Read ZITADEL_* values from this file ahead of the process environment. A
|
|
3723
|
+
relative path is read from the current directory, not from --cwd. Cannot be
|
|
3724
|
+
combined with --env.
|
|
3725
|
+
|
|
2480
3726
|
--fields=<value>
|
|
2481
3727
|
Columns to show, comma-separated dot-paths (e.g. id,attributes.email).
|
|
2482
3728
|
Defaults to the resource's own columns; `--json` is unaffected.
|
|
@@ -2526,24 +3772,32 @@ Update a team by id.
|
|
|
2526
3772
|
```
|
|
2527
3773
|
USAGE
|
|
2528
3774
|
$ zitadel teams update ID [--json] [-c <value>] [-s <value>] [-n]
|
|
2529
|
-
[--dry-run] [-v] [--debug] [--color] [--telemetry] [
|
|
2530
|
-
<value> | --file <value>] [--set
|
|
3775
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
3776
|
+
<value>] [--name <value>] [--data <value> | --file <value>] [--set
|
|
3777
|
+
<value>...]
|
|
2531
3778
|
|
|
2532
3779
|
ARGUMENTS
|
|
2533
3780
|
ID team id
|
|
2534
3781
|
|
|
2535
3782
|
FLAGS
|
|
2536
|
-
-c, --cwd=<value>
|
|
2537
|
-
-
|
|
2538
|
-
|
|
2539
|
-
|
|
2540
|
-
-
|
|
2541
|
-
|
|
2542
|
-
|
|
2543
|
-
|
|
2544
|
-
--
|
|
2545
|
-
|
|
2546
|
-
|
|
3783
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
3784
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
3785
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
3786
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
3787
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
3788
|
+
an agent.
|
|
3789
|
+
-s, --server=<value> Override the resolved server URL.
|
|
3790
|
+
-v, --verbose Verbose logging.
|
|
3791
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
3792
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
3793
|
+
--debug Debug logging.
|
|
3794
|
+
--dry-run Preview without mutating files or the platform.
|
|
3795
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
3796
|
+
process environment. A relative path is read from the
|
|
3797
|
+
current directory, not from --cwd. Cannot be combined
|
|
3798
|
+
with --env.
|
|
3799
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
3800
|
+
--no-telemetry.
|
|
2547
3801
|
|
|
2548
3802
|
RAW BODY FLAGS
|
|
2549
3803
|
--data=<value> Whole body as a JSON object. Field flags and --set apply
|
|
@@ -2611,22 +3865,29 @@ Create a user.
|
|
|
2611
3865
|
```
|
|
2612
3866
|
USAGE
|
|
2613
3867
|
$ zitadel users create [--json] [-c <value>] [-s <value>] [-n]
|
|
2614
|
-
[--dry-run] [-v] [--debug] [--color] [--telemetry] [
|
|
2615
|
-
[--
|
|
2616
|
-
<value>...]
|
|
3868
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
3869
|
+
<value>] [--schema <value>] [--attributes <value>...] [--data <value> |
|
|
3870
|
+
--file <value>] [--set <value>...]
|
|
2617
3871
|
|
|
2618
3872
|
FLAGS
|
|
2619
|
-
-c, --cwd=<value>
|
|
2620
|
-
-
|
|
2621
|
-
|
|
2622
|
-
|
|
2623
|
-
-
|
|
2624
|
-
|
|
2625
|
-
|
|
2626
|
-
|
|
2627
|
-
--
|
|
2628
|
-
|
|
2629
|
-
|
|
3873
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
3874
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
3875
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
3876
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
3877
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
3878
|
+
an agent.
|
|
3879
|
+
-s, --server=<value> Override the resolved server URL.
|
|
3880
|
+
-v, --verbose Verbose logging.
|
|
3881
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
3882
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
3883
|
+
--debug Debug logging.
|
|
3884
|
+
--dry-run Preview without mutating files or the platform.
|
|
3885
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
3886
|
+
process environment. A relative path is read from the
|
|
3887
|
+
current directory, not from --cwd. Cannot be combined
|
|
3888
|
+
with --env.
|
|
3889
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
3890
|
+
--no-telemetry.
|
|
2630
3891
|
|
|
2631
3892
|
REQUIRED FIELD FLAGS
|
|
2632
3893
|
--attributes=<value>... (required) Repeatable attributes entry: key=value for
|
|
@@ -2666,25 +3927,33 @@ Delete a user by id.
|
|
|
2666
3927
|
```
|
|
2667
3928
|
USAGE
|
|
2668
3929
|
$ zitadel users delete ID [--json] [-c <value>] [-s <value>] [-n]
|
|
2669
|
-
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-
|
|
3930
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
3931
|
+
<value>] [-f]
|
|
2670
3932
|
|
|
2671
3933
|
ARGUMENTS
|
|
2672
3934
|
ID user id
|
|
2673
3935
|
|
|
2674
3936
|
FLAGS
|
|
2675
|
-
-c, --cwd=<value>
|
|
2676
|
-
-
|
|
2677
|
-
|
|
2678
|
-
|
|
2679
|
-
|
|
2680
|
-
|
|
2681
|
-
-
|
|
2682
|
-
|
|
2683
|
-
|
|
2684
|
-
|
|
2685
|
-
--
|
|
2686
|
-
|
|
2687
|
-
|
|
3937
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
3938
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
3939
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
3940
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
3941
|
+
-f, --force Delete the user without the confirmation prompt.
|
|
3942
|
+
Required when non-interactive.
|
|
3943
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
3944
|
+
an agent.
|
|
3945
|
+
-s, --server=<value> Override the resolved server URL.
|
|
3946
|
+
-v, --verbose Verbose logging.
|
|
3947
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
3948
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
3949
|
+
--debug Debug logging.
|
|
3950
|
+
--dry-run Preview without mutating files or the platform.
|
|
3951
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
3952
|
+
process environment. A relative path is read from the
|
|
3953
|
+
current directory, not from --cwd. Cannot be combined
|
|
3954
|
+
with --env.
|
|
3955
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
3956
|
+
--no-telemetry.
|
|
2688
3957
|
|
|
2689
3958
|
GLOBAL FLAGS
|
|
2690
3959
|
--json Format output as json.
|
|
@@ -2703,25 +3972,33 @@ Get one user by id.
|
|
|
2703
3972
|
```
|
|
2704
3973
|
USAGE
|
|
2705
3974
|
$ zitadel users get ID [--json] [-c <value>] [-s <value>] [-n]
|
|
2706
|
-
[--dry-run] [-v] [--debug] [--color] [--telemetry] [
|
|
3975
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
3976
|
+
<value>] [--fields <value>]
|
|
2707
3977
|
|
|
2708
3978
|
ARGUMENTS
|
|
2709
3979
|
ID user id
|
|
2710
3980
|
|
|
2711
3981
|
FLAGS
|
|
2712
|
-
-c, --cwd=<value>
|
|
2713
|
-
-
|
|
2714
|
-
|
|
2715
|
-
|
|
2716
|
-
-
|
|
2717
|
-
|
|
2718
|
-
|
|
2719
|
-
|
|
2720
|
-
--
|
|
2721
|
-
|
|
2722
|
-
|
|
2723
|
-
--
|
|
2724
|
-
|
|
3982
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
3983
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
3984
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
3985
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
3986
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
3987
|
+
an agent.
|
|
3988
|
+
-s, --server=<value> Override the resolved server URL.
|
|
3989
|
+
-v, --verbose Verbose logging.
|
|
3990
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
3991
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
3992
|
+
--debug Debug logging.
|
|
3993
|
+
--dry-run Preview without mutating files or the platform.
|
|
3994
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
3995
|
+
process environment. A relative path is read from the
|
|
3996
|
+
current directory, not from --cwd. Cannot be combined
|
|
3997
|
+
with --env.
|
|
3998
|
+
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
3999
|
+
the resource's own; `--json` is unaffected.
|
|
4000
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
4001
|
+
--no-telemetry.
|
|
2725
4002
|
|
|
2726
4003
|
GLOBAL FLAGS
|
|
2727
4004
|
--json Format output as json.
|
|
@@ -2742,9 +4019,9 @@ List users.
|
|
|
2742
4019
|
```
|
|
2743
4020
|
USAGE
|
|
2744
4021
|
$ zitadel users list [--json] [-c <value>] [-s <value>] [-n]
|
|
2745
|
-
[--dry-run] [-v] [--debug] [--color] [--telemetry] [
|
|
2746
|
-
|
|
2747
|
-
[--sort <value>]
|
|
4022
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
4023
|
+
<value>] [--limit <value>] [-a | --page-token <value>] [--fields <value>]
|
|
4024
|
+
[--plain] [--filter <value>...] [--sort <value>]
|
|
2748
4025
|
|
|
2749
4026
|
FLAGS
|
|
2750
4027
|
-a, --all
|
|
@@ -2753,6 +4030,11 @@ FLAGS
|
|
|
2753
4030
|
-c, --cwd=<value>
|
|
2754
4031
|
Project directory to operate on.
|
|
2755
4032
|
|
|
4033
|
+
-e, --env=<value>
|
|
4034
|
+
Environment to run against, e.g. production. Defaults to ZITADEL_ENV, then
|
|
4035
|
+
the hosting platform's build (VERCEL_ENV, or Netlify's CONTEXT), then
|
|
4036
|
+
development.
|
|
4037
|
+
|
|
2756
4038
|
-n, --non-interactive
|
|
2757
4039
|
Disable prompts. Required when scripting or running as an agent.
|
|
2758
4040
|
|
|
@@ -2772,6 +4054,11 @@ FLAGS
|
|
|
2772
4054
|
--dry-run
|
|
2773
4055
|
Preview without mutating files or the platform.
|
|
2774
4056
|
|
|
4057
|
+
--env-file=<value>
|
|
4058
|
+
Read ZITADEL_* values from this file ahead of the process environment. A
|
|
4059
|
+
relative path is read from the current directory, not from --cwd. Cannot be
|
|
4060
|
+
combined with --env.
|
|
4061
|
+
|
|
2775
4062
|
--fields=<value>
|
|
2776
4063
|
Columns to show, comma-separated dot-paths (e.g. id,attributes.email).
|
|
2777
4064
|
Defaults to the resource's own columns; `--json` is unaffected.
|
|
@@ -2782,10 +4069,11 @@ FLAGS
|
|
|
2782
4069
|
qual|greater_than|greater_than_or_equal), id (equals|not_equals|contains|not
|
|
2783
4070
|
_contains|less_than|less_than_or_equal|greater_than|greater_than_or_equal),
|
|
2784
4071
|
schema (equals|not_equals|contains|not_contains|less_than|less_than_or_equal
|
|
2785
|
-
|greater_than|greater_than_or_equal),
|
|
2786
|
-
|
|
2787
|
-
|
|
2788
|
-
|
|
4072
|
+
|greater_than|greater_than_or_equal), schema_object_type
|
|
4073
|
+
(equals|not_equals|contains), status (equals|not_equals|contains|not_contain
|
|
4074
|
+
s|less_than|less_than_or_equal|greater_than|greater_than_or_equal), team_id
|
|
4075
|
+
(equals|not_equals|contains|not_contains|less_than|less_than_or_equal|greate
|
|
4076
|
+
r_than|greater_than_or_equal), lifecycle_owner_team_id
|
|
2789
4077
|
(equals|not_equals|contains|not_contains|less_than|less_than_or_equal|greate
|
|
2790
4078
|
r_than|greater_than_or_equal).
|
|
2791
4079
|
|
|
@@ -2827,25 +4115,32 @@ Update a user by id.
|
|
|
2827
4115
|
```
|
|
2828
4116
|
USAGE
|
|
2829
4117
|
$ zitadel users update ID [--json] [-c <value>] [-s <value>] [-n]
|
|
2830
|
-
[--dry-run] [-v] [--debug] [--color] [--telemetry] [
|
|
2831
|
-
[--
|
|
2832
|
-
<value>...]
|
|
4118
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
4119
|
+
<value>] [--schema <value>] [--attributes <value>...] [--data <value> |
|
|
4120
|
+
--file <value>] [--set <value>...]
|
|
2833
4121
|
|
|
2834
4122
|
ARGUMENTS
|
|
2835
4123
|
ID user id
|
|
2836
4124
|
|
|
2837
4125
|
FLAGS
|
|
2838
|
-
-c, --cwd=<value>
|
|
2839
|
-
-
|
|
2840
|
-
|
|
2841
|
-
|
|
2842
|
-
-
|
|
2843
|
-
|
|
2844
|
-
|
|
2845
|
-
|
|
2846
|
-
--
|
|
2847
|
-
|
|
2848
|
-
|
|
4126
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
4127
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
4128
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
4129
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
4130
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
4131
|
+
an agent.
|
|
4132
|
+
-s, --server=<value> Override the resolved server URL.
|
|
4133
|
+
-v, --verbose Verbose logging.
|
|
4134
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
4135
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
4136
|
+
--debug Debug logging.
|
|
4137
|
+
--dry-run Preview without mutating files or the platform.
|
|
4138
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
4139
|
+
process environment. A relative path is read from the
|
|
4140
|
+
current directory, not from --cwd. Cannot be combined
|
|
4141
|
+
with --env.
|
|
4142
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
4143
|
+
--no-telemetry.
|
|
2849
4144
|
|
|
2850
4145
|
OPTIONAL FIELD FLAGS
|
|
2851
4146
|
--attributes=<value>... Repeatable attributes entry: key=value for a string,
|
|
@@ -2874,156 +4169,238 @@ EXAMPLES
|
|
|
2874
4169
|
$ zitadel users update <id> --file ./user.json
|
|
2875
4170
|
```
|
|
2876
4171
|
|
|
2877
|
-
## `zitadel
|
|
4172
|
+
## `zitadel variable get NAME`
|
|
2878
4173
|
|
|
2879
|
-
|
|
4174
|
+
Get one variable from the project.
|
|
2880
4175
|
|
|
2881
4176
|
```
|
|
2882
4177
|
USAGE
|
|
2883
|
-
$ zitadel
|
|
2884
|
-
[--dry-run] [-v] [--debug] [--color] [--telemetry] [
|
|
4178
|
+
$ zitadel variable get NAME [--json] [-c <value>] [-s <value>] [-n]
|
|
4179
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
4180
|
+
<value>] [--preview]
|
|
2885
4181
|
|
|
2886
4182
|
ARGUMENTS
|
|
2887
|
-
NAME Variable name to
|
|
4183
|
+
NAME Variable name to read.
|
|
2888
4184
|
|
|
2889
4185
|
FLAGS
|
|
2890
|
-
-c, --cwd=<value>
|
|
2891
|
-
-
|
|
2892
|
-
|
|
2893
|
-
|
|
2894
|
-
|
|
2895
|
-
|
|
2896
|
-
-
|
|
2897
|
-
|
|
2898
|
-
|
|
2899
|
-
|
|
2900
|
-
--
|
|
2901
|
-
--
|
|
2902
|
-
|
|
2903
|
-
|
|
2904
|
-
|
|
4186
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
4187
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
4188
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
4189
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
4190
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
4191
|
+
an agent.
|
|
4192
|
+
-s, --server=<value> Override the resolved server URL.
|
|
4193
|
+
-v, --verbose Verbose logging.
|
|
4194
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
4195
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
4196
|
+
--debug Debug logging.
|
|
4197
|
+
--dry-run Preview without mutating files or the platform.
|
|
4198
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
4199
|
+
process environment. A relative path is read from the
|
|
4200
|
+
current directory, not from --cwd. Cannot be combined
|
|
4201
|
+
with --env.
|
|
4202
|
+
--preview Read the preview value instead of the primary one.
|
|
4203
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
4204
|
+
--no-telemetry.
|
|
2905
4205
|
|
|
2906
4206
|
GLOBAL FLAGS
|
|
2907
4207
|
--json Format output as json.
|
|
2908
4208
|
|
|
2909
4209
|
DESCRIPTION
|
|
2910
|
-
|
|
4210
|
+
Get one variable from the project.
|
|
2911
4211
|
|
|
2912
4212
|
EXAMPLES
|
|
2913
|
-
$ zitadel
|
|
4213
|
+
$ zitadel variable get GOOGLE_CLIENT_ID
|
|
2914
4214
|
|
|
2915
|
-
$ zitadel
|
|
4215
|
+
$ zitadel variable get API_URL --preview
|
|
4216
|
+
|
|
4217
|
+
$ zitadel variable get GOOGLE_CLIENT_ID --json
|
|
2916
4218
|
```
|
|
2917
4219
|
|
|
2918
|
-
## `zitadel
|
|
4220
|
+
## `zitadel variable list`
|
|
2919
4221
|
|
|
2920
|
-
|
|
4222
|
+
List the variables entered on the project.
|
|
2921
4223
|
|
|
2922
4224
|
```
|
|
2923
4225
|
USAGE
|
|
2924
|
-
$ zitadel
|
|
2925
|
-
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--
|
|
4226
|
+
$ zitadel variable list [--json] [-c <value>] [-s <value>] [-n]
|
|
4227
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
4228
|
+
<value>] [--preview] [--plain]
|
|
2926
4229
|
|
|
2927
|
-
|
|
2928
|
-
|
|
4230
|
+
FLAGS
|
|
4231
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
4232
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
4233
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
4234
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
4235
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
4236
|
+
an agent.
|
|
4237
|
+
-s, --server=<value> Override the resolved server URL.
|
|
4238
|
+
-v, --verbose Verbose logging.
|
|
4239
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
4240
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
4241
|
+
--debug Debug logging.
|
|
4242
|
+
--dry-run Preview without mutating files or the platform.
|
|
4243
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
4244
|
+
process environment. A relative path is read from the
|
|
4245
|
+
current directory, not from --cwd. Cannot be combined
|
|
4246
|
+
with --env.
|
|
4247
|
+
--plain Tab-separated rows with no header, for piping. Implied
|
|
4248
|
+
when stdout is not a terminal.
|
|
4249
|
+
--preview List the preview values instead of the primary ones.
|
|
4250
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
4251
|
+
--no-telemetry.
|
|
4252
|
+
|
|
4253
|
+
GLOBAL FLAGS
|
|
4254
|
+
--json Format output as json.
|
|
4255
|
+
|
|
4256
|
+
DESCRIPTION
|
|
4257
|
+
List the variables entered on the project.
|
|
4258
|
+
|
|
4259
|
+
EXAMPLES
|
|
4260
|
+
$ zitadel variable list
|
|
4261
|
+
|
|
4262
|
+
$ zitadel variable list --preview
|
|
4263
|
+
|
|
4264
|
+
$ zitadel variable list --json
|
|
4265
|
+
```
|
|
4266
|
+
|
|
4267
|
+
## `zitadel variable resolve`
|
|
4268
|
+
|
|
4269
|
+
Show the variables the live deployment froze for a target.
|
|
4270
|
+
|
|
4271
|
+
```
|
|
4272
|
+
USAGE
|
|
4273
|
+
$ zitadel variable resolve [--json] [-c <value>] [-s <value>] [-n]
|
|
4274
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
4275
|
+
<value>] [--origin <value>] [--plain]
|
|
2929
4276
|
|
|
2930
4277
|
FLAGS
|
|
2931
|
-
-c, --cwd=<value>
|
|
2932
|
-
-
|
|
2933
|
-
|
|
2934
|
-
|
|
2935
|
-
-
|
|
2936
|
-
|
|
2937
|
-
|
|
2938
|
-
|
|
2939
|
-
--
|
|
2940
|
-
|
|
2941
|
-
|
|
2942
|
-
--
|
|
2943
|
-
|
|
4278
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
4279
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
4280
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
4281
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
4282
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
4283
|
+
an agent.
|
|
4284
|
+
-s, --server=<value> Override the resolved server URL.
|
|
4285
|
+
-v, --verbose Verbose logging.
|
|
4286
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
4287
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
4288
|
+
--debug Debug logging.
|
|
4289
|
+
--dry-run Preview without mutating files or the platform.
|
|
4290
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
4291
|
+
process environment. A relative path is read from the
|
|
4292
|
+
current directory, not from --cwd. Cannot be combined
|
|
4293
|
+
with --env.
|
|
4294
|
+
--origin=<value> The origin whose live deployment to read.
|
|
4295
|
+
--plain Tab-separated rows with no header, for piping. Implied
|
|
4296
|
+
when stdout is not a terminal.
|
|
4297
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
4298
|
+
--no-telemetry.
|
|
2944
4299
|
|
|
2945
4300
|
GLOBAL FLAGS
|
|
2946
4301
|
--json Format output as json.
|
|
2947
4302
|
|
|
2948
4303
|
DESCRIPTION
|
|
2949
|
-
|
|
4304
|
+
Show the variables the live deployment froze for a target.
|
|
2950
4305
|
|
|
2951
4306
|
EXAMPLES
|
|
2952
|
-
$ zitadel
|
|
4307
|
+
$ zitadel variable resolve
|
|
2953
4308
|
|
|
2954
|
-
$ zitadel
|
|
4309
|
+
$ zitadel variable resolve --origin https://app.acme.com
|
|
4310
|
+
|
|
4311
|
+
$ zitadel variable resolve --json
|
|
2955
4312
|
```
|
|
2956
4313
|
|
|
2957
|
-
## `zitadel
|
|
4314
|
+
## `zitadel variable rm NAME`
|
|
2958
4315
|
|
|
2959
|
-
|
|
4316
|
+
Remove one variable from the project.
|
|
2960
4317
|
|
|
2961
4318
|
```
|
|
2962
4319
|
USAGE
|
|
2963
|
-
$ zitadel
|
|
2964
|
-
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--
|
|
2965
|
-
[--
|
|
4320
|
+
$ zitadel variable rm NAME [--json] [-c <value>] [-s <value>] [-n]
|
|
4321
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
4322
|
+
<value>] [--preview] [-f]
|
|
4323
|
+
|
|
4324
|
+
ARGUMENTS
|
|
4325
|
+
NAME Variable name to remove.
|
|
2966
4326
|
|
|
2967
4327
|
FLAGS
|
|
2968
|
-
-c, --cwd=<value>
|
|
2969
|
-
-
|
|
2970
|
-
|
|
2971
|
-
|
|
2972
|
-
-
|
|
2973
|
-
|
|
2974
|
-
|
|
2975
|
-
|
|
2976
|
-
|
|
2977
|
-
|
|
2978
|
-
|
|
2979
|
-
|
|
2980
|
-
|
|
2981
|
-
--
|
|
2982
|
-
|
|
4328
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
4329
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
4330
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
4331
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
4332
|
+
-f, --force Remove the variable without the confirmation prompt.
|
|
4333
|
+
Required when non-interactive.
|
|
4334
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
4335
|
+
an agent.
|
|
4336
|
+
-s, --server=<value> Override the resolved server URL.
|
|
4337
|
+
-v, --verbose Verbose logging.
|
|
4338
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
4339
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
4340
|
+
--debug Debug logging.
|
|
4341
|
+
--dry-run Preview without mutating files or the platform.
|
|
4342
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
4343
|
+
process environment. A relative path is read from the
|
|
4344
|
+
current directory, not from --cwd. Cannot be combined
|
|
4345
|
+
with --env.
|
|
4346
|
+
--preview Remove the preview value alone, leaving the primary
|
|
4347
|
+
one standing.
|
|
4348
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
4349
|
+
--no-telemetry.
|
|
2983
4350
|
|
|
2984
4351
|
GLOBAL FLAGS
|
|
2985
4352
|
--json Format output as json.
|
|
2986
4353
|
|
|
2987
4354
|
DESCRIPTION
|
|
2988
|
-
|
|
4355
|
+
Remove one variable from the project.
|
|
2989
4356
|
|
|
2990
4357
|
EXAMPLES
|
|
2991
|
-
$ zitadel
|
|
4358
|
+
$ zitadel variable rm GOOGLE_CLIENT_ID
|
|
2992
4359
|
|
|
2993
|
-
$ zitadel
|
|
4360
|
+
$ zitadel variable rm API_URL --preview
|
|
4361
|
+
|
|
4362
|
+
$ zitadel variable rm GOOGLE_CLIENT_ID --force
|
|
2994
4363
|
```
|
|
2995
4364
|
|
|
2996
|
-
## `zitadel
|
|
4365
|
+
## `zitadel variable set NAME [VALUE]`
|
|
2997
4366
|
|
|
2998
4367
|
Set one variable on the project.
|
|
2999
4368
|
|
|
3000
4369
|
```
|
|
3001
4370
|
USAGE
|
|
3002
|
-
$ zitadel
|
|
3003
|
-
[--dry-run] [-v] [--debug] [--color] [--telemetry] [
|
|
3004
|
-
[--secret] [--as string|number|boolean]
|
|
4371
|
+
$ zitadel variable set NAME [VALUE] [--json] [-c <value>] [-s <value>]
|
|
4372
|
+
[-n] [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>]
|
|
4373
|
+
[--env-file <value>] [--secret] [--as string|number|boolean] [--preview]
|
|
3005
4374
|
|
|
3006
4375
|
ARGUMENTS
|
|
3007
|
-
NAME
|
|
4376
|
+
NAME Variable name (letters, digits and underscores).
|
|
4377
|
+
[VALUE] The value, for a plain (non-secret) variable.
|
|
3008
4378
|
|
|
3009
4379
|
FLAGS
|
|
3010
|
-
-c, --cwd=<value>
|
|
3011
|
-
-
|
|
3012
|
-
|
|
3013
|
-
|
|
3014
|
-
-
|
|
3015
|
-
|
|
3016
|
-
|
|
3017
|
-
|
|
3018
|
-
|
|
3019
|
-
|
|
3020
|
-
--
|
|
3021
|
-
|
|
3022
|
-
|
|
3023
|
-
--
|
|
3024
|
-
|
|
3025
|
-
|
|
3026
|
-
|
|
4380
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
4381
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
4382
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
4383
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
4384
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
4385
|
+
an agent.
|
|
4386
|
+
-s, --server=<value> Override the resolved server URL.
|
|
4387
|
+
-v, --verbose Verbose logging.
|
|
4388
|
+
--as=<option> [default: string] Store the value as this JSON type.
|
|
4389
|
+
<options: string|number|boolean>
|
|
4390
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
4391
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
4392
|
+
--debug Debug logging.
|
|
4393
|
+
--dry-run Preview without mutating files or the platform.
|
|
4394
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
4395
|
+
process environment. A relative path is read from the
|
|
4396
|
+
current directory, not from --cwd. Cannot be combined
|
|
4397
|
+
with --env.
|
|
4398
|
+
--preview Write the preview value alone, leaving the primary one
|
|
4399
|
+
as it is.
|
|
4400
|
+
--secret Store the value encrypted. It can be replaced later
|
|
4401
|
+
but never read back.
|
|
4402
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
4403
|
+
--no-telemetry.
|
|
3027
4404
|
|
|
3028
4405
|
GLOBAL FLAGS
|
|
3029
4406
|
--json Format output as json.
|
|
@@ -3032,11 +4409,13 @@ DESCRIPTION
|
|
|
3032
4409
|
Set one variable on the project.
|
|
3033
4410
|
|
|
3034
4411
|
EXAMPLES
|
|
3035
|
-
$ zitadel
|
|
4412
|
+
$ zitadel variable set GOOGLE_CLIENT_ID 1234.apps.googleusercontent.com
|
|
4413
|
+
|
|
4414
|
+
$ zitadel variable set GOOGLE_CLIENT_SECRET --secret < secret.txt
|
|
3036
4415
|
|
|
3037
|
-
$ zitadel
|
|
4416
|
+
$ zitadel variable set SESSION_TTL 3600 --as number
|
|
3038
4417
|
|
|
3039
|
-
$ zitadel
|
|
4418
|
+
$ zitadel variable set API_URL https://preview.acme.com --preview
|
|
3040
4419
|
```
|
|
3041
4420
|
|
|
3042
4421
|
## `zitadel version`
|