@zitadel/cli 0.1.0-alpha.17 → 0.1.0-alpha.19

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (62) hide show
  1. package/README.md +210 -124
  2. package/SKILLS.md +159 -17
  3. package/dist/branding-cygSBPkV.mjs +79 -0
  4. package/dist/branding-cygSBPkV.mjs.map +1 -0
  5. package/dist/claim-state-DlfD6Res.mjs +66 -0
  6. package/dist/claim-state-DlfD6Res.mjs.map +1 -0
  7. package/dist/commands/apply.mjs +6 -5
  8. package/dist/commands/apply.mjs.map +1 -1
  9. package/dist/commands/branding/eject.mjs +104 -0
  10. package/dist/commands/branding/eject.mjs.map +1 -0
  11. package/dist/commands/claim.mjs +402 -0
  12. package/dist/commands/claim.mjs.map +1 -0
  13. package/dist/commands/doctor.mjs +500 -37
  14. package/dist/commands/doctor.mjs.map +1 -1
  15. package/dist/commands/eject.mjs +4 -4
  16. package/dist/commands/eject.mjs.map +1 -1
  17. package/dist/commands/logs.mjs +2 -2
  18. package/dist/commands/plan.mjs +6 -5
  19. package/dist/commands/plan.mjs.map +1 -1
  20. package/dist/commands/reset.mjs +2 -2
  21. package/dist/commands/schemas/list.mjs +11 -11
  22. package/dist/commands/schemas/list.mjs.map +1 -1
  23. package/dist/commands/setup.mjs +359 -132
  24. package/dist/commands/setup.mjs.map +1 -1
  25. package/dist/commands/start.mjs +3 -3
  26. package/dist/commands/status.mjs +21 -13
  27. package/dist/commands/status.mjs.map +1 -1
  28. package/dist/commands/stop.mjs +3 -3
  29. package/dist/commands/stop.mjs.map +1 -1
  30. package/dist/designs-Ckz18Dpo.mjs +38 -0
  31. package/dist/designs-Ckz18Dpo.mjs.map +1 -0
  32. package/dist/{docker-pGcTrDIY.mjs → docker-DcRGTOJa.mjs} +4 -3
  33. package/dist/docker-DcRGTOJa.mjs.map +1 -0
  34. package/dist/{environment-BQF7LeCz.mjs → environment-rjRVkJjW.mjs} +1 -1
  35. package/dist/{environment-BQF7LeCz.mjs.map → environment-rjRVkJjW.mjs.map} +1 -1
  36. package/dist/{journey-guidance-CYVpQszz.mjs → journey-guidance-BGrOX_gT.mjs} +14 -3
  37. package/dist/{journey-guidance-CYVpQszz.mjs.map → journey-guidance-BGrOX_gT.mjs.map} +1 -1
  38. package/dist/{oclif-BRdjVNne.mjs → oclif-CanO3zdt.mjs} +247 -43
  39. package/dist/oclif-CanO3zdt.mjs.map +1 -0
  40. package/dist/{orca-Dip6DPJ2.mjs → orca-Cu0iW1mv.mjs} +894 -196
  41. package/dist/orca-Cu0iW1mv.mjs.map +1 -0
  42. package/dist/package-manager-DFdLcDx1.mjs +194 -0
  43. package/dist/package-manager-DFdLcDx1.mjs.map +1 -0
  44. package/dist/{ports-V8JfiNgT.mjs → ports-BM20XIZb.mjs} +2 -2
  45. package/dist/{ports-V8JfiNgT.mjs.map → ports-BM20XIZb.mjs.map} +1 -1
  46. package/dist/{processes-BVqYsxT8.mjs → processes-DKHPkU8O.mjs} +1 -1
  47. package/dist/{processes-BVqYsxT8.mjs.map → processes-DKHPkU8O.mjs.map} +1 -1
  48. package/dist/{project-BGgv7Bba.mjs → project-CHhot85s.mjs} +57 -4
  49. package/dist/project-CHhot85s.mjs.map +1 -0
  50. package/dist/{sync-Cd3z7Q1R.mjs → sync-Bd6vASgg.mjs} +549 -75
  51. package/dist/sync-Bd6vASgg.mjs.map +1 -0
  52. package/dist/user-schema-DTuOsdKE.mjs +91 -0
  53. package/dist/user-schema-DTuOsdKE.mjs.map +1 -0
  54. package/oclif.manifest.json +227 -5
  55. package/package.json +9 -6
  56. package/dist/docker-pGcTrDIY.mjs.map +0 -1
  57. package/dist/oclif-BRdjVNne.mjs.map +0 -1
  58. package/dist/orca-Dip6DPJ2.mjs.map +0 -1
  59. package/dist/project-BGgv7Bba.mjs.map +0 -1
  60. package/dist/sync-Cd3z7Q1R.mjs.map +0 -1
  61. package/dist/user-schema-DDz5-lX5.mjs +0 -13
  62. package/dist/user-schema-DDz5-lX5.mjs.map +0 -1
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # @zitadel/cli
2
2
 
3
- Scaffolds Zitadel auth (login, register, profile, middleware) into a Next.js, React, Vue, Angular, or Nuxt app.
3
+ Scaffolds Zitadel auth (login, register, profile, middleware/proxy) into a Next.js, Nuxt, React, Vue, Angular, Solid, Svelte, or Qwik app.
4
4
 
5
5
  ```sh
6
6
  npx @zitadel/cli@alpha start
@@ -15,9 +15,10 @@ automation when reproducibility matters.
15
15
 
16
16
  ## Requirements
17
17
 
18
- - Node 24+
18
+ - Node from the supported range in `package.json#engines` (currently ≥ 24)
19
19
  - Docker only when using the optional Docker runtime backend
20
- - A Next.js project, or an empty directory where setup can scaffold one
20
+ - An app in one of the eight supported frameworks, or an empty directory
21
+ where setup can scaffold one
21
22
 
22
23
  ## Quickstart
23
24
 
@@ -31,14 +32,20 @@ npm run dev
31
32
  ```
32
33
 
33
34
  `start` runs the `@zitadel/server` npm binary by default and stores runtime data
34
- under `.zitadel/local/`. Remote-server setup can use `--server <url>` without
35
- starting a local runtime. Use `--runtime docker`, `--image`, or
36
- `ZITADEL_LOCAL_IMAGE` for advanced Docker backend debugging.
35
+ under `.zitadel/local/` (SQLite by default). Remote-server setup can use
36
+ `--server <url>` without starting a local runtime. Use `--runtime docker`,
37
+ `--image`, or `ZITADEL_LOCAL_IMAGE` for advanced Docker backend debugging.
37
38
  `setup --server local` creates a project on that local server, asks which
38
- framework to scaffold when the directory is fresh, writes the Next.js app into
39
- the current directory, scaffolds `app/login`, `app/register`, `app/profile`, and
40
- `proxy.ts` for Next 16+ or `middleware.ts` for older Next versions. Fresh
41
- scaffolds also replace the starter `app/page.tsx` with a redirect to `/login`.
39
+ framework to scaffold when the directory is fresh (and which login design to
40
+ use), writes the app into the current directory, and scaffolds the framework's
41
+ idiomatic auth routes plus the proxy layer — for Next.js that means
42
+ `app/login`, `app/register`, `app/profile`, and `proxy.ts` for Next 16+ or
43
+ `middleware.ts` for older versions; other frameworks get their equivalents
44
+ from the same patcher system. In a pre-existing app, setup derives the
45
+ embedding posture from the app instead of assuming a fresh skeleton: the
46
+ scaffolded pages take the `variant="widget"` posture inside your app's own
47
+ shell, recorded in the scaffold manifest and verified by `doctor`. Fresh
48
+ scaffolds also replace the starter home page with a redirect to `/login`.
42
49
  Setup writes `.env.local` and `.zitadel/`, and installs
43
50
  dependencies with the detected package manager. Pass `--skip-install` to install
44
51
  them yourself. The project's default user schema and login flow are provisioned
@@ -64,12 +71,15 @@ Users who skip passkey setup can still sign in with password; users who add a
64
71
  passkey can sign in with either credential.
65
72
 
66
73
  Repo config is authoritative: edit `zitadel.json`, `.zitadel/schemas/*.json`,
67
- or `.zitadel/flows/*.json`, then re-run `zitadel plan` and `zitadel apply`.
68
- Server-provisioned defaults remain a fallback for non-CLI project creation, but
69
- CLI-created projects are authored from local files first.
70
- Templates are not supported until the server exposes template storage and APIs.
71
- Flow create, read, list, update, and delete are available; the server enforces
72
- flow lifecycle rules such as draft-only edits.
74
+ `.zitadel/flows/*.json`, or `.zitadel/branding/` (a `branding.json` descriptor
75
+ plus a `login.liquid` LiquidJS template), then re-run `zitadel plan` and
76
+ `zitadel apply`. Server-provisioned defaults remain a fallback for non-CLI
77
+ project creation, but CLI-created projects are authored from local files first.
78
+ Login templates are supported: scaffold them with the `branding eject` command
79
+ (`--design centered|split|split-right|hero|minimal`) or `setup --design <name>`;
80
+ every edit publishes a new immutable branding revision and the login serves
81
+ the newest one. Flow create, read, list, update, and delete are available; the
82
+ server enforces flow lifecycle rules such as draft-only edits.
73
83
 
74
84
  For agent scripts, pass `--non-interactive --json` and capture stdout and stderr
75
85
  separately. The CLI contract is one parseable JSON object on stdout; terminals
@@ -77,13 +87,23 @@ and agent UIs may display stderr package-manager progress together with stdout.
77
87
 
78
88
  ## Other commands
79
89
 
90
+ - `zitadel claim` — attach the project to your team (opens the claim page,
91
+ polls for completion; team attachment then shows in `setup`, `status`, and
92
+ `doctor`)
80
93
  - `zitadel doctor` — verify the local runtime and generated project files
94
+ (including scaffold drift and dependency-version alignment)
81
95
  - `zitadel status` — summarise the local runtime and project
82
96
  - `zitadel plan` — validate config and preview sync changes without mutation
83
97
  - `zitadel apply` — validate and upload repo config to Zitadel
98
+ - `zitadel branding eject` — scaffold an editable login template from a design
99
+ - `zitadel schemas list` — list the project's user schemas
84
100
  - `zitadel eject` — remove what setup wrote (alias: `zitadel uninstall`)
85
101
  - `zitadel start|stop|logs|reset` — manage the local runtime
86
102
 
103
+ The full agent-facing contract (JSON envelope, posture rules, claim flow,
104
+ doctor repair) is [`SKILLS.md`](https://github.com/zitadel/nextgen/blob/main/apps/cli/SKILLS.md),
105
+ which ships in this package.
106
+
87
107
  ## Reference
88
108
 
89
109
  <details>
@@ -92,6 +112,8 @@ and agent UIs may display stderr package-manager progress together with stdout.
92
112
  <!-- commands -->
93
113
  * [`zitadel apply`](#zitadel-apply)
94
114
  * [`zitadel autocomplete [SHELL]`](#zitadel-autocomplete-shell)
115
+ * [`zitadel branding eject`](#zitadel-branding-eject)
116
+ * [`zitadel claim`](#zitadel-claim)
95
117
  * [`zitadel commands`](#zitadel-commands)
96
118
  * [`zitadel doctor`](#zitadel-doctor)
97
119
  * [`zitadel eject`](#zitadel-eject)
@@ -115,22 +137,19 @@ Validate and upload repo config to the platform.
115
137
 
116
138
  ```
117
139
  USAGE
118
- $ zitadel apply [--json] [-c <value>] [-s <value>] [-n] [-f]
119
- [--dry-run] [--verbose] [--debug] [--telemetry] [-e
120
- development|preview|production]
140
+ $ zitadel apply [--json] [-c <value>] [-s <value>] [-n] [-f] [--dry-run] [--verbose] [--debug]
141
+ [--telemetry] [-e development|preview|production]
121
142
 
122
143
  FLAGS
123
144
  -c, --cwd=<value> Project directory to operate on.
124
145
  -e, --environment=<option> Target environment (default: development).
125
146
  <options: development|preview|production>
126
147
  -f, --force Overwrite protected files on conflict.
127
- -n, --non-interactive Disable prompts. Required when scripting or
128
- running as an agent.
148
+ -n, --non-interactive Disable prompts. Required when scripting or running as an agent.
129
149
  -s, --server=<value> Override the resolved server URL.
130
150
  --debug Debug logging.
131
151
  --dry-run Preview without mutating files or the platform.
132
- --[no-]telemetry Send anonymous usage analytics. Disable with
133
- --no-telemetry.
152
+ --[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
134
153
  --verbose Verbose logging.
135
154
 
136
155
  GLOBAL FLAGS
@@ -171,15 +190,77 @@ EXAMPLES
171
190
 
172
191
  _See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v3.2.50/src/commands/autocomplete/index.ts)_
173
192
 
193
+ ## `zitadel branding eject`
194
+
195
+ Take ownership of the login template: scaffold .zitadel/branding/ from a shipped design.
196
+
197
+ ```
198
+ USAGE
199
+ $ zitadel branding eject [--json] [-c <value>] [-s <value>] [-n] [-f] [--dry-run] [--verbose] [--debug]
200
+ [--telemetry] [--design centered|split|split-right|hero|minimal]
201
+
202
+ FLAGS
203
+ -c, --cwd=<value> Project directory to operate on.
204
+ -f, --force Overwrite protected files on conflict.
205
+ -n, --non-interactive Disable prompts. Required when scripting or running as an agent.
206
+ -s, --server=<value> Override the resolved server URL.
207
+ --debug Debug logging.
208
+ --design=<option> Design to start from (default: centered).
209
+ <options: centered|split|split-right|hero|minimal>
210
+ --dry-run Preview without mutating files or the platform.
211
+ --[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
212
+ --verbose Verbose logging.
213
+
214
+ GLOBAL FLAGS
215
+ --json Format output as json.
216
+
217
+ DESCRIPTION
218
+ Take ownership of the login template: scaffold .zitadel/branding/ from a shipped design.
219
+ ```
220
+
221
+ ## `zitadel claim`
222
+
223
+ Attach this project to a team so it becomes permanent. Opens a browser to finish signing in.
224
+
225
+ ```
226
+ USAGE
227
+ $ zitadel claim [--json] [-c <value>] [-s <value>] [-n] [-f] [--dry-run] [--verbose] [--debug]
228
+ [--telemetry] [--no-open] [--timeout <value>]
229
+
230
+ FLAGS
231
+ -c, --cwd=<value> Project directory to operate on.
232
+ -f, --force Overwrite protected files on conflict.
233
+ -n, --non-interactive Disable prompts. Required when scripting or running as an agent.
234
+ -s, --server=<value> Override the resolved server URL.
235
+ --debug Debug logging.
236
+ --dry-run Preview without mutating files or the platform.
237
+ --no-open Print the link instead of opening a browser.
238
+ --[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
239
+ --timeout=<value> Seconds to wait for the browser step. Defaults to the link's own expiry (10 minutes).
240
+ --verbose Verbose logging.
241
+
242
+ GLOBAL FLAGS
243
+ --json Format output as json.
244
+
245
+ DESCRIPTION
246
+ Attach this project to a team so it becomes permanent. Opens a browser to finish signing in.
247
+
248
+ EXAMPLES
249
+ $ zitadel claim
250
+
251
+ $ zitadel claim --no-open
252
+
253
+ $ zitadel claim --timeout 120
254
+ ```
255
+
174
256
  ## `zitadel commands`
175
257
 
176
258
  List all zitadel commands.
177
259
 
178
260
  ```
179
261
  USAGE
180
- $ zitadel commands [--json] [-c id|plugin|summary|type... | --tree]
181
- [--deprecated] [-x | ] [--hidden] [--no-truncate | ] [--sort
182
- id|plugin|summary|type | ]
262
+ $ zitadel commands [--json] [-c id|plugin|summary|type... | --tree] [--deprecated] [-x | ] [--hidden]
263
+ [--no-truncate | ] [--sort id|plugin|summary|type | ]
183
264
 
184
265
  FLAGS
185
266
  -c, --columns=<option>... Only show provided columns (comma-separated).
@@ -207,25 +288,22 @@ Verify local runtime and project state.
207
288
 
208
289
  ```
209
290
  USAGE
210
- $ zitadel doctor [--json] [-c <value>] [-s <value>] [-n] [-f]
211
- [--dry-run] [--verbose] [--debug] [--telemetry] [--fix] [--image <value>]
212
- [--port <value>] [--runtime binary|docker]
291
+ $ zitadel doctor [--json] [-c <value>] [-s <value>] [-n] [-f] [--dry-run] [--verbose] [--debug]
292
+ [--telemetry] [--fix] [--image <value>] [--port <value>] [--runtime binary|docker]
213
293
 
214
294
  FLAGS
215
295
  -c, --cwd=<value> Project directory to operate on.
216
296
  -f, --force Overwrite protected files on conflict.
217
- -n, --non-interactive Disable prompts. Required when scripting or running as
218
- an agent.
297
+ -n, --non-interactive Disable prompts. Required when scripting or running as an agent.
219
298
  -s, --server=<value> Override the resolved server URL.
220
299
  --debug Debug logging.
221
300
  --dry-run Preview without mutating files or the platform.
222
- --fix Re-apply missing managed files.
301
+ --fix Repair missing files and stale managed wiring.
223
302
  --image=<value> Container image to check.
224
303
  --port=<value> [default: 8080] Local HTTP port.
225
304
  --runtime=<option> Local runtime backend.
226
305
  <options: binary|docker>
227
- --[no-]telemetry Send anonymous usage analytics. Disable with
228
- --no-telemetry.
306
+ --[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
229
307
  --verbose Verbose logging.
230
308
 
231
309
  GLOBAL FLAGS
@@ -241,19 +319,17 @@ Remove managed files and local Zitadel state.
241
319
 
242
320
  ```
243
321
  USAGE
244
- $ zitadel eject [--json] [-c <value>] [-s <value>] [-n] [-f]
245
- [--dry-run] [--verbose] [--debug] [--telemetry]
322
+ $ zitadel eject [--json] [-c <value>] [-s <value>] [-n] [-f] [--dry-run] [--verbose] [--debug]
323
+ [--telemetry]
246
324
 
247
325
  FLAGS
248
326
  -c, --cwd=<value> Project directory to operate on.
249
327
  -f, --force Overwrite protected files on conflict.
250
- -n, --non-interactive Disable prompts. Required when scripting or running as
251
- an agent.
328
+ -n, --non-interactive Disable prompts. Required when scripting or running as an agent.
252
329
  -s, --server=<value> Override the resolved server URL.
253
330
  --debug Debug logging.
254
331
  --dry-run Preview without mutating files or the platform.
255
- --[no-]telemetry Send anonymous usage analytics. Disable with
256
- --no-telemetry.
332
+ --[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
257
333
  --verbose Verbose logging.
258
334
 
259
335
  GLOBAL FLAGS
@@ -292,21 +368,19 @@ Show local Zitadel server logs.
292
368
 
293
369
  ```
294
370
  USAGE
295
- $ zitadel logs [--json] [-c <value>] [-s <value>] [-n] [-f]
296
- [--dry-run] [--verbose] [--debug] [--telemetry] [--follow] [--tail <value>]
371
+ $ zitadel logs [--json] [-c <value>] [-s <value>] [-n] [-f] [--dry-run] [--verbose] [--debug]
372
+ [--telemetry] [--follow] [--tail <value>]
297
373
 
298
374
  FLAGS
299
375
  -c, --cwd=<value> Project directory to operate on.
300
376
  -f, --force Overwrite protected files on conflict.
301
- -n, --non-interactive Disable prompts. Required when scripting or running as
302
- an agent.
377
+ -n, --non-interactive Disable prompts. Required when scripting or running as an agent.
303
378
  -s, --server=<value> Override the resolved server URL.
304
379
  --debug Debug logging.
305
380
  --dry-run Preview without mutating files or the platform.
306
381
  --follow Follow logs.
307
382
  --tail=<value> [default: 200] Number of lines to show.
308
- --[no-]telemetry Send anonymous usage analytics. Disable with
309
- --no-telemetry.
383
+ --[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
310
384
  --verbose Verbose logging.
311
385
 
312
386
  GLOBAL FLAGS
@@ -322,22 +396,19 @@ Validate config without mutation and preview the sync diff.
322
396
 
323
397
  ```
324
398
  USAGE
325
- $ zitadel plan [--json] [-c <value>] [-s <value>] [-n] [-f]
326
- [--dry-run] [--verbose] [--debug] [--telemetry] [-e
327
- development|preview|production]
399
+ $ zitadel plan [--json] [-c <value>] [-s <value>] [-n] [-f] [--dry-run] [--verbose] [--debug]
400
+ [--telemetry] [-e development|preview|production]
328
401
 
329
402
  FLAGS
330
403
  -c, --cwd=<value> Project directory to operate on.
331
404
  -e, --environment=<option> Target environment (default: development).
332
405
  <options: development|preview|production>
333
406
  -f, --force Overwrite protected files on conflict.
334
- -n, --non-interactive Disable prompts. Required when scripting or
335
- running as an agent.
407
+ -n, --non-interactive Disable prompts. Required when scripting or running as an agent.
336
408
  -s, --server=<value> Override the resolved server URL.
337
409
  --debug Debug logging.
338
410
  --dry-run Preview without mutating files or the platform.
339
- --[no-]telemetry Send anonymous usage analytics. Disable with
340
- --no-telemetry.
411
+ --[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
341
412
  --verbose Verbose logging.
342
413
 
343
414
  GLOBAL FLAGS
@@ -353,19 +424,17 @@ Delete the local Zitadel server runtime and data.
353
424
 
354
425
  ```
355
426
  USAGE
356
- $ zitadel reset [--json] [-c <value>] [-s <value>] [-n] [-f]
357
- [--dry-run] [--verbose] [--debug] [--telemetry]
427
+ $ zitadel reset [--json] [-c <value>] [-s <value>] [-n] [-f] [--dry-run] [--verbose] [--debug]
428
+ [--telemetry]
358
429
 
359
430
  FLAGS
360
431
  -c, --cwd=<value> Project directory to operate on.
361
432
  -f, --force Overwrite protected files on conflict.
362
- -n, --non-interactive Disable prompts. Required when scripting or running as
363
- an agent.
433
+ -n, --non-interactive Disable prompts. Required when scripting or running as an agent.
364
434
  -s, --server=<value> Override the resolved server URL.
365
435
  --debug Debug logging.
366
436
  --dry-run Preview without mutating files or the platform.
367
- --[no-]telemetry Send anonymous usage analytics. Disable with
368
- --no-telemetry.
437
+ --[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
369
438
  --verbose Verbose logging.
370
439
 
371
440
  GLOBAL FLAGS
@@ -381,24 +450,20 @@ List revisions of a user-schema by objectType.
381
450
 
382
451
  ```
383
452
  USAGE
384
- $ zitadel schemas list -t <value> [--json] [-c <value>] [-s <value>]
385
- [-n] [-f] [--dry-run] [--verbose] [--debug] [--telemetry] [-e
386
- development|preview|production]
453
+ $ zitadel schemas list -t <value> [--json] [-c <value>] [-s <value>] [-n] [-f] [--dry-run] [--verbose] [--debug]
454
+ [--telemetry] [-e development|preview|production]
387
455
 
388
456
  FLAGS
389
457
  -c, --cwd=<value> Project directory to operate on.
390
458
  -e, --environment=<option> Target environment (default: development).
391
459
  <options: development|preview|production>
392
460
  -f, --force Overwrite protected files on conflict.
393
- -n, --non-interactive Disable prompts. Required when scripting or
394
- running as an agent.
461
+ -n, --non-interactive Disable prompts. Required when scripting or running as an agent.
395
462
  -s, --server=<value> Override the resolved server URL.
396
- -t, --object-type=<value> (required) Filter revisions by objectType (e.g.
397
- human-user).
463
+ -t, --object-type=<value> (required) Filter revisions by objectType (e.g. human-user).
398
464
  --debug Debug logging.
399
465
  --dry-run Preview without mutating files or the platform.
400
- --[no-]telemetry Send anonymous usage analytics. Disable with
401
- --no-telemetry.
466
+ --[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
402
467
  --verbose Verbose logging.
403
468
 
404
469
  GLOBAL FLAGS
@@ -419,8 +484,7 @@ USAGE
419
484
  DESCRIPTION
420
485
  Search for a command.
421
486
 
422
- Once you select a command, hit enter and it will show the help for that
423
- command.
487
+ Once you select a command, hit enter and it will show the help for that command.
424
488
  ```
425
489
 
426
490
  _See code: [@oclif/plugin-search](https://github.com/oclif/plugin-search/blob/v1.2.50/src/commands/search.ts)_
@@ -431,33 +495,66 @@ Create a Zitadel project and scaffold local auth.
431
495
 
432
496
  ```
433
497
  USAGE
434
- $ zitadel setup [--json] [-c <value>] [-s <value>] [-n] [-f]
435
- [--dry-run] [--verbose] [--debug] [--telemetry] [--framework
436
- next|nuxt|react|vue|solid|svelte|qwik|angular] [--renderer
437
- react|web-component] [--dev-port <value>] [--skip-install]
498
+ $ zitadel setup [--json] [-c <value>] [-s <value>] [-n] [-f] [--dry-run] [--verbose] [--debug]
499
+ [--telemetry] [--framework next|nuxt|react|vue|solid|svelte|qwik|angular] [--renderer react] [--dev-port <value>]
500
+ [--skip-install] [--preset password-first|passkey-first] [--use-case minimal|consumer|business] [--design
501
+ centered|split|split-right|hero|minimal]
438
502
 
439
503
  FLAGS
440
- -c, --cwd=<value> Project directory to operate on.
441
- -f, --force Overwrite protected files on conflict.
442
- -n, --non-interactive Disable prompts. Required when scripting or running
443
- as an agent.
444
- -s, --server=<value> Override the resolved server URL.
445
- --debug Debug logging.
446
- --dev-port=<value> Dev-server port; also the issuer origin registered
447
- with Zitadel. Defaults to the detected port. Use
448
- distinct ports to run several scaffolded apps side
449
- by side.
450
- --dry-run Preview without mutating files or the platform.
451
- --framework=<option> Framework to target.
452
- <options:
453
- next|nuxt|react|vue|solid|svelte|qwik|angular>
454
- --renderer=<option> Renderer (default: react).
455
- <options: react|web-component>
456
- --skip-install Do not install dependencies after setup updates
457
- package.json.
458
- --[no-]telemetry Send anonymous usage analytics. Disable with
459
- --no-telemetry.
460
- --verbose Verbose logging.
504
+ -c, --cwd=<value>
505
+ Project directory to operate on.
506
+
507
+ -f, --force
508
+ Overwrite protected files on conflict.
509
+
510
+ -n, --non-interactive
511
+ Disable prompts. Required when scripting or running as an agent.
512
+
513
+ -s, --server=<value>
514
+ Override the resolved server URL.
515
+
516
+ --debug
517
+ Debug logging.
518
+
519
+ --design=<option>
520
+ Login design to eject into .zitadel/branding/ and publish as branding revision 1. Skips the wizard's design
521
+ question. When omitted in non-interactive runs, the login uses the built-in template; run the `branding eject`
522
+ command later to customize. Split-family designs (split, split-right, hero) collapse their brand pane by container
523
+ width: narrow containers — including widget-posture embeds at card width — render the compact brand mark instead
524
+ (logo_url, else hero_url, from .zitadel/branding/branding.json; hero falls back to editable text).
525
+ <options: centered|split|split-right|hero|minimal>
526
+
527
+ --dev-port=<value>
528
+ Dev-server port; also the issuer origin registered with Zitadel. Defaults to the detected port. Use distinct ports
529
+ to run several scaffolded apps side by side.
530
+
531
+ --dry-run
532
+ Preview without mutating files or the platform.
533
+
534
+ --framework=<option>
535
+ Framework to target.
536
+ <options: next|nuxt|react|vue|solid|svelte|qwik|angular>
537
+
538
+ --preset=<option>
539
+ Sign-in preset for the scaffolded schema and login flow (default: password-first).
540
+ <options: password-first|passkey-first>
541
+
542
+ --renderer=<option>
543
+ Renderer (default: react). Not yet available: web-component.
544
+ <options: react>
545
+
546
+ --skip-install
547
+ Do not install dependencies after setup updates package.json.
548
+
549
+ --[no-]telemetry
550
+ Send anonymous usage analytics. Disable with --no-telemetry.
551
+
552
+ --use-case=<option>
553
+ Use case for the scaffolded schema fields: who signs in to the app (default: minimal).
554
+ <options: minimal|consumer|business>
555
+
556
+ --verbose
557
+ Verbose logging.
461
558
 
462
559
  GLOBAL FLAGS
463
560
  --json Format output as json.
@@ -477,15 +574,13 @@ Start a local Zitadel server.
477
574
 
478
575
  ```
479
576
  USAGE
480
- $ zitadel start [--json] [-c <value>] [-s <value>] [-n] [-f]
481
- [--dry-run] [--verbose] [--debug] [--telemetry] [--image <value>] [--port
482
- <value>] [--runtime binary|docker]
577
+ $ zitadel start [--json] [-c <value>] [-s <value>] [-n] [-f] [--dry-run] [--verbose] [--debug]
578
+ [--telemetry] [--image <value>] [--port <value>] [--runtime binary|docker]
483
579
 
484
580
  FLAGS
485
581
  -c, --cwd=<value> Project directory to operate on.
486
582
  -f, --force Overwrite protected files on conflict.
487
- -n, --non-interactive Disable prompts. Required when scripting or running as
488
- an agent.
583
+ -n, --non-interactive Disable prompts. Required when scripting or running as an agent.
489
584
  -s, --server=<value> Override the resolved server URL.
490
585
  --debug Debug logging.
491
586
  --dry-run Preview without mutating files or the platform.
@@ -493,8 +588,7 @@ FLAGS
493
588
  --port=<value> [default: 8080] Local HTTP port.
494
589
  --runtime=<option> Local runtime backend.
495
590
  <options: binary|docker>
496
- --[no-]telemetry Send anonymous usage analytics. Disable with
497
- --no-telemetry.
591
+ --[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
498
592
  --verbose Verbose logging.
499
593
 
500
594
  GLOBAL FLAGS
@@ -510,19 +604,17 @@ Summarize the local Zitadel server and project state.
510
604
 
511
605
  ```
512
606
  USAGE
513
- $ zitadel status [--json] [-c <value>] [-s <value>] [-n] [-f]
514
- [--dry-run] [--verbose] [--debug] [--telemetry]
607
+ $ zitadel status [--json] [-c <value>] [-s <value>] [-n] [-f] [--dry-run] [--verbose] [--debug]
608
+ [--telemetry]
515
609
 
516
610
  FLAGS
517
611
  -c, --cwd=<value> Project directory to operate on.
518
612
  -f, --force Overwrite protected files on conflict.
519
- -n, --non-interactive Disable prompts. Required when scripting or running as
520
- an agent.
613
+ -n, --non-interactive Disable prompts. Required when scripting or running as an agent.
521
614
  -s, --server=<value> Override the resolved server URL.
522
615
  --debug Debug logging.
523
616
  --dry-run Preview without mutating files or the platform.
524
- --[no-]telemetry Send anonymous usage analytics. Disable with
525
- --no-telemetry.
617
+ --[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
526
618
  --verbose Verbose logging.
527
619
 
528
620
  GLOBAL FLAGS
@@ -538,21 +630,18 @@ Stop the local Zitadel server.
538
630
 
539
631
  ```
540
632
  USAGE
541
- $ zitadel stop [--json] [-c <value>] [-s <value>] [-n] [-f]
542
- [--dry-run] [--verbose] [--debug] [--telemetry] [--all]
633
+ $ zitadel stop [--json] [-c <value>] [-s <value>] [-n] [-f] [--dry-run] [--verbose] [--debug]
634
+ [--telemetry] [--all]
543
635
 
544
636
  FLAGS
545
637
  -c, --cwd=<value> Project directory to operate on.
546
638
  -f, --force Overwrite protected files on conflict.
547
- -n, --non-interactive Disable prompts. Required when scripting or running as
548
- an agent.
639
+ -n, --non-interactive Disable prompts. Required when scripting or running as an agent.
549
640
  -s, --server=<value> Override the resolved server URL.
550
- --all Stop all discovered CLI-managed local Zitadel runtime
551
- processes.
641
+ --all Stop all discovered CLI-managed local Zitadel runtime processes.
552
642
  --debug Debug logging.
553
643
  --dry-run Preview without mutating files or the platform.
554
- --[no-]telemetry Send anonymous usage analytics. Disable with
555
- --no-telemetry.
644
+ --[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
556
645
  --verbose Verbose logging.
557
646
 
558
647
  GLOBAL FLAGS
@@ -568,19 +657,17 @@ Remove managed files and local Zitadel state.
568
657
 
569
658
  ```
570
659
  USAGE
571
- $ zitadel uninstall [--json] [-c <value>] [-s <value>] [-n] [-f]
572
- [--dry-run] [--verbose] [--debug] [--telemetry]
660
+ $ zitadel uninstall [--json] [-c <value>] [-s <value>] [-n] [-f] [--dry-run] [--verbose] [--debug]
661
+ [--telemetry]
573
662
 
574
663
  FLAGS
575
664
  -c, --cwd=<value> Project directory to operate on.
576
665
  -f, --force Overwrite protected files on conflict.
577
- -n, --non-interactive Disable prompts. Required when scripting or running as
578
- an agent.
666
+ -n, --non-interactive Disable prompts. Required when scripting or running as an agent.
579
667
  -s, --server=<value> Override the resolved server URL.
580
668
  --debug Debug logging.
581
669
  --dry-run Preview without mutating files or the platform.
582
- --[no-]telemetry Send anonymous usage analytics. Disable with
583
- --no-telemetry.
670
+ --[no-]telemetry Send anonymous usage analytics. Disable with --no-telemetry.
584
671
  --verbose Verbose logging.
585
672
 
586
673
  GLOBAL FLAGS
@@ -608,8 +695,7 @@ GLOBAL FLAGS
608
695
  FLAG DESCRIPTIONS
609
696
  --verbose Show additional information about the CLI.
610
697
 
611
- Additionally shows the architecture, node version, operating system, and
612
- versions of plugins that the CLI is using.
698
+ Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using.
613
699
  ```
614
700
 
615
701
  _See code: [@oclif/plugin-version](https://github.com/oclif/plugin-version/blob/2.2.46/src/commands/version.ts)_