@zitadel/cli 0.1.0-alpha.8 → 0.1.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.
Files changed (45) hide show
  1. package/README.md +2758 -210
  2. package/bin/run.js +8 -0
  3. package/dist/index.mjs +25199 -0
  4. package/dist/index.mjs.map +1 -0
  5. package/dist/lib/oclif/help.mjs +71 -0
  6. package/dist/lib/oclif/help.mjs.map +1 -0
  7. package/dist/skills-hint-BSspFzhr.mjs +173 -0
  8. package/dist/skills-hint-BSspFzhr.mjs.map +1 -0
  9. package/oclif.manifest.json +5846 -250
  10. package/package.json +73 -13
  11. package/skills/zitadel-cli/SKILL.md +442 -0
  12. package/skills/zitadel-cli/references/driving-login-ui.md +89 -0
  13. package/SKILLS.md +0 -152
  14. package/dist/commands/apply.mjs +0 -62
  15. package/dist/commands/apply.mjs.map +0 -1
  16. package/dist/commands/doctor.mjs +0 -490
  17. package/dist/commands/doctor.mjs.map +0 -1
  18. package/dist/commands/eject.mjs +0 -145
  19. package/dist/commands/eject.mjs.map +0 -1
  20. package/dist/commands/logs.mjs +0 -58
  21. package/dist/commands/logs.mjs.map +0 -1
  22. package/dist/commands/plan.mjs +0 -52
  23. package/dist/commands/plan.mjs.map +0 -1
  24. package/dist/commands/reset.mjs +0 -71
  25. package/dist/commands/reset.mjs.map +0 -1
  26. package/dist/commands/setup.mjs +0 -916
  27. package/dist/commands/setup.mjs.map +0 -1
  28. package/dist/commands/start.mjs +0 -221
  29. package/dist/commands/start.mjs.map +0 -1
  30. package/dist/commands/status.mjs +0 -112
  31. package/dist/commands/status.mjs.map +0 -1
  32. package/dist/commands/stop.mjs +0 -52
  33. package/dist/commands/stop.mjs.map +0 -1
  34. package/dist/docker-BA78SdC2.mjs +0 -383
  35. package/dist/docker-BA78SdC2.mjs.map +0 -1
  36. package/dist/docker-guidance-BvfpmsDj.mjs +0 -21
  37. package/dist/docker-guidance-BvfpmsDj.mjs.map +0 -1
  38. package/dist/oclif-VkCTGIEk.mjs +0 -818
  39. package/dist/oclif-VkCTGIEk.mjs.map +0 -1
  40. package/dist/orca-CfKDQRop.mjs +0 -2556
  41. package/dist/orca-CfKDQRop.mjs.map +0 -1
  42. package/dist/project-CKAHtHML.mjs +0 -87
  43. package/dist/project-CKAHtHML.mjs.map +0 -1
  44. package/dist/sync-B5lqgQO3.mjs +0 -733
  45. package/dist/sync-B5lqgQO3.mjs.map +0 -1
package/README.md CHANGED
@@ -1,58 +1,76 @@
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, SvelteKit, SolidStart, Qwik Router, TanStack Start, React, Vue, Angular, Solid, Svelte, or Qwik app.
4
4
 
5
5
  ```sh
6
- npx @zitadel/cli@alpha start
7
- npx @zitadel/cli@alpha setup --server local
6
+ npx @zitadel/cli@latest start
7
+ npx @zitadel/cli@latest setup --server local
8
8
  ```
9
9
 
10
- During the public alpha, bare `npx @zitadel/cli` resolves to the same tested
11
- alpha CLI. Use `@alpha` or an exact `0.1.0-alpha.N` selector in bug reports and
12
- automation when reproducibility matters.
10
+ Use an exact version (`npx @zitadel/cli@0.1.0`) in bug reports and automation
11
+ when reproducibility matters.
13
12
 
14
- > **Beta.** This is the **next-generation Zitadel**, a ground-up rewrite of the platform. It is distinct from the established Zitadel at [github.com/zitadel/zitadel](https://github.com/zitadel/zitadel). APIs and CLI flags will change.
13
+ > **Preview.** This is the **next-generation Zitadel**, a ground-up rewrite of the platform. It is distinct from the established Zitadel at [github.com/zitadel/zitadel](https://github.com/zitadel/zitadel). APIs and CLI flags will change: until 1.0.0, a breaking change ships in a minor version, and its release note marks it **Breaking:**.
15
14
 
16
15
  ## Requirements
17
16
 
18
- - Node 24+
17
+ - Node from the supported range in `package.json#engines` (currently ≥ 24)
19
18
  - Docker only when using the optional Docker runtime backend
20
- - A Next.js project, or an empty directory where setup can scaffold one
19
+ - An app in one of the eight supported frameworks, or an empty directory
20
+ where setup can scaffold one
21
21
 
22
22
  ## Quickstart
23
23
 
24
24
  ```sh
25
25
  mkdir my-app
26
26
  cd my-app
27
- npx @zitadel/cli@alpha doctor
28
- npx @zitadel/cli@alpha start
29
- npx @zitadel/cli@alpha setup --server local
27
+ npx @zitadel/cli@latest doctor
28
+ npx @zitadel/cli@latest start
29
+ npx @zitadel/cli@latest setup --server local
30
30
  npm run dev
31
31
  ```
32
32
 
33
33
  `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.
34
+ under `.zitadel/local/` (SQLite by default). Remote-server setup can use
35
+ `--server <url>` without starting a local runtime. Use `--runtime docker`,
36
+ `--image`, or `ZITADEL_LOCAL_IMAGE` for advanced Docker backend debugging.
37
+ `start` also creates a local admin, `admin@zitadel.localhost`, and ends by
38
+ printing a one-time sign-in link for the management console.
37
39
  `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 links to sign in, create
42
- an account, and profile. Setup writes `.env.local` and `.zitadel/`, and installs
40
+ framework to scaffold when the directory is fresh, writes the app into the
41
+ current directory, and scaffolds the framework's
42
+ idiomatic auth routes plus the proxy layer — for Next.js that means
43
+ `app/login`, `app/register`, `app/profile`, and `proxy.ts` for Next 16+ or
44
+ `middleware.ts` for older versions; other frameworks get their equivalents
45
+ from the same patcher system. In a pre-existing app, setup derives the
46
+ embedding posture from the app instead of assuming a fresh skeleton: the
47
+ scaffolded pages take the `variant="widget"` posture inside your app's own
48
+ shell, recorded in the scaffold manifest and verified by `doctor`. Fresh
49
+ scaffolds also replace the starter home page with a redirect to `/login`.
50
+ Against a local server started with the default platform bootstrap, setup also
51
+ attaches the new project to the local admin's team, so the project is owned
52
+ from the start and `zitadel claim` reports it as already owned. If you opted
53
+ out with `NEXTGEN_PLATFORM_BOOTSTRAP_PROJECT=false`, there is no local admin
54
+ and the project has no owning team; that server cannot claim projects.
55
+ Setup writes `.env.local` and `.zitadel/`, and installs
43
56
  dependencies with the detected package manager. Pass `--skip-install` to install
44
57
  them yourself. The project's default user schema and login flow are provisioned
45
- server-side at creation time, so the CLI does not scaffold or upload them. Open
46
- the dev server URL printed by your framework, register a user, log out, log back
47
- in, and end on the signed-in profile page.
48
-
49
- For a reproducible tester report, use the exact alpha train from the GitHub
58
+ from versioned local defaults; setup writes editable copies into
59
+ `.zitadel/schemas/default-human-user.json` and
60
+ `.zitadel/flows/default-login.json`, uploads them through the schema and flow
61
+ APIs, then seeds `.zitadel/state.json` so `zitadel plan` is immediately empty.
62
+ Open the dev server URL printed by your framework, register a user, log out,
63
+ log back in, and end on the signed-in profile page. That user is an end user
64
+ of your app. The management console is a separate sign-in: run
65
+ `zitadel console` for a fresh one-time link as the local admin.
66
+
67
+ For a reproducible tester report, use the exact version from the GitHub
50
68
  Release:
51
69
 
52
70
  ```sh
53
- npx @zitadel/cli@0.1.0-alpha.N doctor
54
- npx @zitadel/cli@0.1.0-alpha.N start
55
- npx @zitadel/cli@0.1.0-alpha.N setup --server local
71
+ npx @zitadel/cli@0.1.0 doctor
72
+ npx @zitadel/cli@0.1.0 start
73
+ npx @zitadel/cli@0.1.0 setup --server local
56
74
  ```
57
75
 
58
76
  The default project flow supports password registration/login, passkey
@@ -60,14 +78,46 @@ registration/login, and optional passkey setup after password registration.
60
78
  Users who skip passkey setup can still sign in with password; users who add a
61
79
  passkey can sign in with either credential.
62
80
 
81
+ Repo config is authoritative: edit `zitadel.json`, `.zitadel/schemas/*.json`,
82
+ `.zitadel/flows/*.json`, or `.zitadel/branding/` (a `branding.json` descriptor
83
+ plus a `login.liquid` LiquidJS template), then re-run `zitadel plan` and
84
+ `zitadel apply`. Server-provisioned defaults remain a fallback for non-CLI
85
+ project creation, but CLI-created projects are authored from local files first.
86
+ Login templates are supported: scaffold them with the `branding eject` command
87
+ (`--design centered|minimal`); setup never does;
88
+ every edit publishes a new immutable branding revision and the login serves
89
+ the newest one. Flows work the same way: every edit publishes a new immutable
90
+ flow revision. A page that pins `flow-name` gets that flow's newest revision. A
91
+ page without a pin gets the project's newest active unscoped flow, whatever its
92
+ name, so revising a flow can make it the default.
93
+
94
+ For agent scripts, pass `--non-interactive --json` and capture stdout and stderr
95
+ separately. The CLI contract is one parseable JSON object on stdout; terminals
96
+ and agent UIs may display stderr package-manager progress together with stdout.
97
+
63
98
  ## Other commands
64
99
 
65
- - `zitadel doctor` — verify the local runtime and generated project files
66
- - `zitadel status` — summarise the local runtime and project
67
- - `zitadel plan` — validate config and preview sync changes without mutation
68
- - `zitadel apply` — validate and upload repo config to Zitadel
69
- - `zitadel eject` — remove what setup wrote (alias: `zitadel uninstall`)
70
- - `zitadel start|stop|logs|reset` — manage the local runtime
100
+ - `zitadel claim`: claim the project to make it permanent (opens the claim
101
+ page, polls for completion; the claim then shows in `setup`, `status`, and
102
+ `doctor`)
103
+ - `zitadel console`: print a fresh one-time sign-in link for the local
104
+ console as `admin@zitadel.localhost` and open it in a browser
105
+ (`--no-open` prints the link only)
106
+ - `zitadel doctor`: verify the local runtime and generated project files
107
+ (including scaffold drift and dependency-version alignment)
108
+ - `zitadel status`: summarise the local runtime and project
109
+ - `zitadel plan`: validate config and preview sync changes without mutation
110
+ - `zitadel apply`: validate and upload repo config to Zitadel
111
+ - `zitadel branding eject`: scaffold an editable login template from a design
112
+ - `zitadel schemas list`: list the project's user schemas
113
+ - `zitadel variables list|get|set|delete`: manage the project's variables and
114
+ secrets (`--project-level`)
115
+ - `zitadel eject`: remove what setup wrote (alias: `zitadel uninstall`)
116
+ - `zitadel start|stop|logs|reset`: manage the local runtime
117
+
118
+ The full agent-facing contract (JSON envelope, posture rules, claim flow,
119
+ doctor repair) is [`SKILL.md`](https://github.com/zitadel/nextgen/blob/main/apps/cli/skills/zitadel-cli/SKILL.md),
120
+ which ships in this package.
71
121
 
72
122
  ## Reference
73
123
 
@@ -76,20 +126,67 @@ passkey can sign in with either credential.
76
126
 
77
127
  <!-- commands -->
78
128
  * [`zitadel apply`](#zitadel-apply)
129
+ * [`zitadel auth-method passkey disable`](#zitadel-auth-method-passkey-disable)
130
+ * [`zitadel auth-method passkey enable`](#zitadel-auth-method-passkey-enable)
131
+ * [`zitadel auth-method password disable`](#zitadel-auth-method-password-disable)
132
+ * [`zitadel auth-method password enable`](#zitadel-auth-method-password-enable)
133
+ * [`zitadel auth-method sso disable`](#zitadel-auth-method-sso-disable)
134
+ * [`zitadel auth-method sso enable`](#zitadel-auth-method-sso-enable)
79
135
  * [`zitadel autocomplete [SHELL]`](#zitadel-autocomplete-shell)
136
+ * [`zitadel branding eject`](#zitadel-branding-eject)
137
+ * [`zitadel branding get ID`](#zitadel-branding-get-id)
138
+ * [`zitadel branding list`](#zitadel-branding-list)
139
+ * [`zitadel claim`](#zitadel-claim)
80
140
  * [`zitadel commands`](#zitadel-commands)
141
+ * [`zitadel console`](#zitadel-console)
81
142
  * [`zitadel doctor`](#zitadel-doctor)
82
143
  * [`zitadel eject`](#zitadel-eject)
144
+ * [`zitadel events get ID`](#zitadel-events-get-id)
145
+ * [`zitadel events list`](#zitadel-events-list)
146
+ * [`zitadel flow-definitions get FLOW`](#zitadel-flow-definitions-get-flow)
147
+ * [`zitadel flow-definitions list`](#zitadel-flow-definitions-list)
148
+ * [`zitadel grants create`](#zitadel-grants-create)
149
+ * [`zitadel grants delete ID`](#zitadel-grants-delete-id)
150
+ * [`zitadel grants get ID`](#zitadel-grants-get-id)
151
+ * [`zitadel grants list`](#zitadel-grants-list)
83
152
  * [`zitadel help [COMMAND]`](#zitadel-help-command)
153
+ * [`zitadel idps create`](#zitadel-idps-create)
154
+ * [`zitadel idps get ID`](#zitadel-idps-get-id)
155
+ * [`zitadel idps list`](#zitadel-idps-list)
84
156
  * [`zitadel logs`](#zitadel-logs)
85
157
  * [`zitadel plan`](#zitadel-plan)
158
+ * [`zitadel projects get ID`](#zitadel-projects-get-id)
159
+ * [`zitadel projects list`](#zitadel-projects-list)
160
+ * [`zitadel projects update ID`](#zitadel-projects-update-id)
161
+ * [`zitadel releases get ID`](#zitadel-releases-get-id)
162
+ * [`zitadel releases list`](#zitadel-releases-list)
86
163
  * [`zitadel reset`](#zitadel-reset)
164
+ * [`zitadel resources`](#zitadel-resources)
165
+ * [`zitadel schemas get SCHEMA`](#zitadel-schemas-get-schema)
166
+ * [`zitadel schemas list`](#zitadel-schemas-list)
87
167
  * [`zitadel search`](#zitadel-search)
168
+ * [`zitadel sessions get ID`](#zitadel-sessions-get-id)
169
+ * [`zitadel sessions list`](#zitadel-sessions-list)
170
+ * [`zitadel sessions revoke ID`](#zitadel-sessions-revoke-id)
88
171
  * [`zitadel setup`](#zitadel-setup)
89
172
  * [`zitadel start`](#zitadel-start)
90
173
  * [`zitadel status`](#zitadel-status)
91
174
  * [`zitadel stop`](#zitadel-stop)
175
+ * [`zitadel teams create`](#zitadel-teams-create)
176
+ * [`zitadel teams deactivate ID`](#zitadel-teams-deactivate-id)
177
+ * [`zitadel teams get ID`](#zitadel-teams-get-id)
178
+ * [`zitadel teams list`](#zitadel-teams-list)
179
+ * [`zitadel teams update ID`](#zitadel-teams-update-id)
92
180
  * [`zitadel uninstall`](#zitadel-uninstall)
181
+ * [`zitadel users create`](#zitadel-users-create)
182
+ * [`zitadel users delete ID`](#zitadel-users-delete-id)
183
+ * [`zitadel users get ID`](#zitadel-users-get-id)
184
+ * [`zitadel users list`](#zitadel-users-list)
185
+ * [`zitadel users update ID`](#zitadel-users-update-id)
186
+ * [`zitadel variables delete NAME`](#zitadel-variables-delete-name)
187
+ * [`zitadel variables get NAME`](#zitadel-variables-get-name)
188
+ * [`zitadel variables list`](#zitadel-variables-list)
189
+ * [`zitadel variables set NAME`](#zitadel-variables-set-name)
93
190
  * [`zitadel version`](#zitadel-version)
94
191
  * [`zitadel which`](#zitadel-which)
95
192
 
@@ -99,19 +196,21 @@ Validate and upload repo config to the platform.
99
196
 
100
197
  ```
101
198
  USAGE
102
- $ zitadel apply [--json] [-c <value>] [-s <value>] [-n] [-f] [--dry-run] [--verbose] [--debug] [-e
103
- development|preview|production]
199
+ $ zitadel apply [--json] [-c <value>] [-s <value>] [-n]
200
+ [--dry-run] [-v] [--debug] [--color] [--telemetry]
104
201
 
105
202
  FLAGS
106
- -c, --cwd=<value> Project directory to operate on.
107
- -e, --environment=<option> Target environment (default: development).
108
- <options: development|preview|production>
109
- -f, --force Overwrite protected files on conflict.
110
- -n, --non-interactive Disable prompts. Required when scripting or running as an agent.
111
- -s, --server=<value> Override the resolved server URL.
112
- --debug Debug logging.
113
- --dry-run Preview without mutating files or the platform.
114
- --verbose Verbose logging.
203
+ -c, --cwd=<value> Project directory to operate on.
204
+ -n, --non-interactive Disable prompts. Required when scripting or running as
205
+ an agent.
206
+ -s, --server=<value> Override the resolved server URL.
207
+ -v, --verbose Verbose logging.
208
+ --[no-]color Colorize human output. Disable with --no-color;
209
+ NO_COLOR and FORCE_COLOR are honored too.
210
+ --debug Debug logging.
211
+ --dry-run Preview without mutating files or the platform.
212
+ --[no-]telemetry Send anonymous usage analytics. Disable with
213
+ --no-telemetry.
115
214
 
116
215
  GLOBAL FLAGS
117
216
  --json Format output as json.
@@ -120,376 +219,2824 @@ DESCRIPTION
120
219
  Validate and upload repo config to the platform.
121
220
  ```
122
221
 
123
- ## `zitadel autocomplete [SHELL]`
222
+ ## `zitadel auth-method passkey disable`
124
223
 
125
- Display autocomplete installation instructions.
224
+ Disable passkey sign-in for a user schema.
126
225
 
127
226
  ```
128
227
  USAGE
129
- $ zitadel autocomplete [SHELL] [-r]
130
-
131
- ARGUMENTS
132
- [SHELL] (zsh|bash|powershell) Shell type
228
+ $ zitadel auth-method passkey disable [--json] [-c <value>] [-s <value>] [-n]
229
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--schema <value>] [-f]
133
230
 
134
231
  FLAGS
135
- -r, --refresh-cache Refresh cache (ignores displaying instructions)
232
+ -c, --cwd=<value> Project directory to operate on.
233
+ -f, --force Disable the schema's last way to sign in. Its users can
234
+ then only be managed through the API.
235
+ -n, --non-interactive Disable prompts. Required when scripting or running as
236
+ an agent.
237
+ -s, --server=<value> Override the resolved server URL.
238
+ -v, --verbose Verbose logging.
239
+ --[no-]color Colorize human output. Disable with --no-color;
240
+ NO_COLOR and FORCE_COLOR are honored too.
241
+ --debug Debug logging.
242
+ --dry-run Preview without mutating files or the platform.
243
+ --schema=<value> User schema to change. Required when the Project has
244
+ more than one.
245
+ --[no-]telemetry Send anonymous usage analytics. Disable with
246
+ --no-telemetry.
247
+
248
+ GLOBAL FLAGS
249
+ --json Format output as json.
136
250
 
137
251
  DESCRIPTION
138
- Display autocomplete installation instructions.
252
+ Disable passkey sign-in for a user schema.
139
253
 
140
254
  EXAMPLES
141
- $ zitadel autocomplete
142
-
143
- $ zitadel autocomplete bash
144
-
145
- $ zitadel autocomplete zsh
146
-
147
- $ zitadel autocomplete powershell
255
+ $ zitadel auth-method passkey disable
148
256
 
149
- $ zitadel autocomplete --refresh-cache
257
+ $ zitadel auth-method passkey disable --schema customers
150
258
  ```
151
259
 
152
- _See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v3.2.50/src/commands/autocomplete/index.ts)_
153
-
154
- ## `zitadel commands`
260
+ ## `zitadel auth-method passkey enable`
155
261
 
156
- List all zitadel commands.
262
+ Enable passkey sign-in for a user schema.
157
263
 
158
264
  ```
159
265
  USAGE
160
- $ zitadel commands [--json] [-c id|plugin|summary|type... | --tree] [--deprecated] [-x | ] [--hidden]
161
- [--no-truncate | ] [--sort id|plugin|summary|type | ]
266
+ $ zitadel auth-method passkey enable [--json] [-c <value>] [-s <value>] [-n]
267
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--schema <value>]
162
268
 
163
269
  FLAGS
164
- -c, --columns=<option>... Only show provided columns (comma-separated).
165
- <options: id|plugin|summary|type>
166
- -x, --extended Show extra columns.
167
- --deprecated Show deprecated commands.
168
- --hidden Show hidden commands.
169
- --no-truncate Do not truncate output.
170
- --sort=<option> [default: id] Property to sort by.
171
- <options: id|plugin|summary|type>
172
- --tree Show tree of commands.
270
+ -c, --cwd=<value> Project directory to operate on.
271
+ -n, --non-interactive Disable prompts. Required when scripting or running as
272
+ an agent.
273
+ -s, --server=<value> Override the resolved server URL.
274
+ -v, --verbose Verbose logging.
275
+ --[no-]color Colorize human output. Disable with --no-color;
276
+ NO_COLOR and FORCE_COLOR are honored too.
277
+ --debug Debug logging.
278
+ --dry-run Preview without mutating files or the platform.
279
+ --schema=<value> User schema to change. Required when the Project has
280
+ more than one.
281
+ --[no-]telemetry Send anonymous usage analytics. Disable with
282
+ --no-telemetry.
173
283
 
174
284
  GLOBAL FLAGS
175
285
  --json Format output as json.
176
286
 
177
287
  DESCRIPTION
178
- List all zitadel commands.
179
- ```
288
+ Enable passkey sign-in for a user schema.
180
289
 
181
- _See code: [@oclif/plugin-commands](https://github.com/oclif/plugin-commands/blob/4.1.55/src/commands/commands.ts)_
290
+ EXAMPLES
291
+ $ zitadel auth-method passkey enable
182
292
 
183
- ## `zitadel doctor`
293
+ $ zitadel auth-method passkey enable --schema customers
294
+ ```
184
295
 
185
- Verify local runtime and project state.
296
+ ## `zitadel auth-method password disable`
297
+
298
+ Disable password sign-in for a user schema.
186
299
 
187
300
  ```
188
301
  USAGE
189
- $ zitadel doctor [--json] [-c <value>] [-s <value>] [-n] [-f] [--dry-run] [--verbose] [--debug] [--fix]
190
- [--image <value>] [--port <value>] [--runtime binary|docker]
302
+ $ zitadel auth-method password disable [--json] [-c <value>] [-s <value>] [-n]
303
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--schema <value>] [-f]
191
304
 
192
305
  FLAGS
193
306
  -c, --cwd=<value> Project directory to operate on.
194
- -f, --force Overwrite protected files on conflict.
195
- -n, --non-interactive Disable prompts. Required when scripting or running as an agent.
307
+ -f, --force Disable the schema's last way to sign in. Its users can
308
+ then only be managed through the API.
309
+ -n, --non-interactive Disable prompts. Required when scripting or running as
310
+ an agent.
196
311
  -s, --server=<value> Override the resolved server URL.
312
+ -v, --verbose Verbose logging.
313
+ --[no-]color Colorize human output. Disable with --no-color;
314
+ NO_COLOR and FORCE_COLOR are honored too.
197
315
  --debug Debug logging.
198
316
  --dry-run Preview without mutating files or the platform.
199
- --fix Re-apply missing managed files.
200
- --image=<value> Container image to check.
201
- --port=<value> [default: 8080] Local HTTP port.
202
- --runtime=<option> Local runtime backend.
203
- <options: binary|docker>
204
- --verbose Verbose logging.
317
+ --schema=<value> User schema to change. Required when the Project has
318
+ more than one.
319
+ --[no-]telemetry Send anonymous usage analytics. Disable with
320
+ --no-telemetry.
205
321
 
206
322
  GLOBAL FLAGS
207
323
  --json Format output as json.
208
324
 
209
325
  DESCRIPTION
210
- Verify local runtime and project state.
326
+ Disable password sign-in for a user schema.
327
+
328
+ EXAMPLES
329
+ $ zitadel auth-method password disable
330
+
331
+ $ zitadel auth-method password disable --schema customers
211
332
  ```
212
333
 
213
- ## `zitadel eject`
334
+ ## `zitadel auth-method password enable`
214
335
 
215
- Remove managed files and local Zitadel state.
336
+ Enable password sign-in for a user schema.
216
337
 
217
338
  ```
218
339
  USAGE
219
- $ zitadel eject [--json] [-c <value>] [-s <value>] [-n] [-f] [--dry-run] [--verbose] [--debug]
340
+ $ zitadel auth-method password enable [--json] [-c <value>] [-s <value>] [-n]
341
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--schema <value>]
220
342
 
221
343
  FLAGS
222
344
  -c, --cwd=<value> Project directory to operate on.
223
- -f, --force Overwrite protected files on conflict.
224
- -n, --non-interactive Disable prompts. Required when scripting or running as an agent.
345
+ -n, --non-interactive Disable prompts. Required when scripting or running as
346
+ an agent.
225
347
  -s, --server=<value> Override the resolved server URL.
348
+ -v, --verbose Verbose logging.
349
+ --[no-]color Colorize human output. Disable with --no-color;
350
+ NO_COLOR and FORCE_COLOR are honored too.
226
351
  --debug Debug logging.
227
352
  --dry-run Preview without mutating files or the platform.
228
- --verbose Verbose logging.
353
+ --schema=<value> User schema to change. Required when the Project has
354
+ more than one.
355
+ --[no-]telemetry Send anonymous usage analytics. Disable with
356
+ --no-telemetry.
229
357
 
230
358
  GLOBAL FLAGS
231
359
  --json Format output as json.
232
360
 
233
361
  DESCRIPTION
234
- Remove managed files and local Zitadel state.
362
+ Enable password sign-in for a user schema.
235
363
 
236
- ALIASES
237
- $ zitadel uninstall
364
+ EXAMPLES
365
+ $ zitadel auth-method password enable
366
+
367
+ $ zitadel auth-method password enable --schema customers
238
368
  ```
239
369
 
240
- ## `zitadel help [COMMAND]`
370
+ ## `zitadel auth-method sso disable`
241
371
 
242
- Display help for zitadel.
372
+ Remove an identity provider from a user schema.
243
373
 
244
374
  ```
245
375
  USAGE
246
- $ zitadel help [COMMAND...] [-n]
376
+ $ zitadel auth-method sso disable [--json] [-c <value>] [-s <value>] [-n]
377
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--schema <value>]
378
+ [--provider <value>] [-f]
379
+
380
+ FLAGS
381
+ -c, --cwd=<value> Project directory to operate on.
382
+ -f, --force Disable the schema's last way to sign in. Its users
383
+ can then only be managed through the API.
384
+ -n, --non-interactive Disable prompts. Required when scripting or running as
385
+ an agent.
386
+ -s, --server=<value> Override the resolved server URL.
387
+ -v, --verbose Verbose logging.
388
+ --[no-]color Colorize human output. Disable with --no-color;
389
+ NO_COLOR and FORCE_COLOR are honored too.
390
+ --debug Debug logging.
391
+ --dry-run Preview without mutating files or the platform.
392
+ --provider=<value> Identity provider to remove.
393
+ --schema=<value> User schema to change. Required when the Project has
394
+ more than one.
395
+ --[no-]telemetry Send anonymous usage analytics. Disable with
396
+ --no-telemetry.
397
+
398
+ GLOBAL FLAGS
399
+ --json Format output as json.
400
+
401
+ DESCRIPTION
402
+ Remove an identity provider from a user schema.
403
+
404
+ EXAMPLES
405
+ $ zitadel auth-method sso disable --provider google
406
+
407
+ $ zitadel auth-method sso disable --provider google --schema customers
408
+ ```
409
+
410
+ ## `zitadel auth-method sso enable`
411
+
412
+ Add an identity provider to a user schema.
413
+
414
+ ```
415
+ USAGE
416
+ $ zitadel auth-method sso enable [--json] [-c <value>] [-s <value>] [-n]
417
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--schema <value>]
418
+ [--provider google|custom] [--slug <value>] [--display-name <value>]
419
+ [--issuer <value>] [--scopes <value>] [--client-id <value>]
420
+
421
+ FLAGS
422
+ -c, --cwd=<value> Project directory to operate on.
423
+ -n, --non-interactive Disable prompts. Required when scripting or
424
+ running as an agent.
425
+ -s, --server=<value> Override the resolved server URL.
426
+ -v, --verbose Verbose logging.
427
+ --client-id=<value> Client id of the application registered with the
428
+ provider.
429
+ --[no-]color Colorize human output. Disable with --no-color;
430
+ NO_COLOR and FORCE_COLOR are honored too.
431
+ --debug Debug logging.
432
+ --display-name=<value> Name shown on the custom connection's sign-in
433
+ button.
434
+ --dry-run Preview without mutating files or the platform.
435
+ --issuer=<value> Issuer URL of the custom provider. Its endpoints
436
+ are found by OIDC discovery.
437
+ --provider=<option> Identity provider to enable, or "custom" for any
438
+ other OpenID Connect provider.
439
+ <options: google|custom>
440
+ --schema=<value> User schema to change. Required when the Project
441
+ has more than one.
442
+ --scopes=<value> Scopes the custom connection requests, separated
443
+ by spaces or commas. Must include openid. Default:
444
+ openid profile email.
445
+ --slug=<value> Name of the custom connection. Schemas and flows
446
+ refer to it by this.
447
+ --[no-]telemetry Send anonymous usage analytics. Disable with
448
+ --no-telemetry.
449
+
450
+ GLOBAL FLAGS
451
+ --json Format output as json.
452
+
453
+ DESCRIPTION
454
+ Add an identity provider to a user schema.
455
+
456
+ EXAMPLES
457
+ $ zitadel auth-method sso enable --provider google
458
+
459
+ $ zitadel auth-method sso enable --provider google --schema customers
460
+
461
+ $ zitadel auth-method sso enable --provider google --client-id 1234-abc.apps.googleusercontent.com --non-interactive < secret.txt
462
+
463
+ $ zitadel auth-method sso enable --provider custom --slug acme-sso --display-name 'Acme SSO' --issuer https://sso.acme.example
464
+
465
+ $ zitadel auth-method sso enable --provider custom --slug acme-sso --display-name 'Acme SSO' --issuer https://sso.acme.example --scopes 'openid profile email groups' --client-id abc123 --non-interactive < secret.txt
466
+ ```
467
+
468
+ ## `zitadel autocomplete [SHELL]`
469
+
470
+ Display autocomplete installation instructions.
471
+
472
+ ```
473
+ USAGE
474
+ $ zitadel autocomplete [SHELL] [-r]
247
475
 
248
476
  ARGUMENTS
249
- [COMMAND...] Command to show help for.
477
+ [SHELL] (zsh|bash|powershell) Shell type
250
478
 
251
479
  FLAGS
252
- -n, --nested-commands Include all nested commands in the output.
480
+ -r, --refresh-cache Refresh cache (ignores displaying instructions)
253
481
 
254
482
  DESCRIPTION
255
- Display help for zitadel.
483
+ Display autocomplete installation instructions.
484
+
485
+ EXAMPLES
486
+ $ zitadel autocomplete
487
+
488
+ $ zitadel autocomplete bash
489
+
490
+ $ zitadel autocomplete zsh
491
+
492
+ $ zitadel autocomplete powershell
493
+
494
+ $ zitadel autocomplete --refresh-cache
256
495
  ```
257
496
 
258
- _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/6.2.49/src/commands/help.ts)_
497
+ _See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v3.2.50/src/commands/autocomplete/index.ts)_
259
498
 
260
- ## `zitadel logs`
499
+ ## `zitadel branding eject`
261
500
 
262
- Show local Zitadel server logs.
501
+ Take ownership of the login template: scaffold .zitadel/branding/ from a shipped design.
263
502
 
264
503
  ```
265
504
  USAGE
266
- $ zitadel logs [--json] [-c <value>] [-s <value>] [-n] [-f] [--dry-run] [--verbose] [--debug] [--follow]
267
- [--tail <value>]
505
+ $ zitadel branding eject [--json] [-c <value>] [-s <value>] [-n]
506
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-f] [--design <value>]
268
507
 
269
508
  FLAGS
270
509
  -c, --cwd=<value> Project directory to operate on.
271
- -f, --force Overwrite protected files on conflict.
272
- -n, --non-interactive Disable prompts. Required when scripting or running as an agent.
510
+ -f, --force Overwrite an existing branding file.
511
+ -n, --non-interactive Disable prompts. Required when scripting or running as
512
+ an agent.
273
513
  -s, --server=<value> Override the resolved server URL.
514
+ -v, --verbose Verbose logging.
515
+ --[no-]color Colorize human output. Disable with --no-color;
516
+ NO_COLOR and FORCE_COLOR are honored too.
274
517
  --debug Debug logging.
518
+ --design=<value> Design to start from: centered or minimal (default:
519
+ centered).
275
520
  --dry-run Preview without mutating files or the platform.
276
- --follow Follow logs.
277
- --tail=<value> [default: 200] Number of lines to show.
278
- --verbose Verbose logging.
521
+ --[no-]telemetry Send anonymous usage analytics. Disable with
522
+ --no-telemetry.
279
523
 
280
524
  GLOBAL FLAGS
281
525
  --json Format output as json.
282
526
 
283
527
  DESCRIPTION
284
- Show local Zitadel server logs.
528
+ Take ownership of the login template: scaffold .zitadel/branding/ from a
529
+ shipped design.
285
530
  ```
286
531
 
287
- ## `zitadel plan`
532
+ ## `zitadel branding get ID`
288
533
 
289
- Validate config without mutation and preview the sync diff.
534
+ Get one branding revision by id.
290
535
 
291
536
  ```
292
537
  USAGE
293
- $ zitadel plan [--json] [-c <value>] [-s <value>] [-n] [-f] [--dry-run] [--verbose] [--debug] [-e
294
- development|preview|production]
538
+ $ zitadel branding get ID [--json] [-c <value>] [-s <value>] [-n]
539
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
540
+
541
+ ARGUMENTS
542
+ ID branding revision id
295
543
 
296
544
  FLAGS
297
- -c, --cwd=<value> Project directory to operate on.
298
- -e, --environment=<option> Target environment (default: development).
299
- <options: development|preview|production>
300
- -f, --force Overwrite protected files on conflict.
301
- -n, --non-interactive Disable prompts. Required when scripting or running as an agent.
302
- -s, --server=<value> Override the resolved server URL.
303
- --debug Debug logging.
304
- --dry-run Preview without mutating files or the platform.
305
- --verbose Verbose logging.
545
+ -c, --cwd=<value> Project directory to operate on.
546
+ -n, --non-interactive Disable prompts. Required when scripting or running as
547
+ an agent.
548
+ -s, --server=<value> Override the resolved server URL.
549
+ -v, --verbose Verbose logging.
550
+ --[no-]color Colorize human output. Disable with --no-color;
551
+ NO_COLOR and FORCE_COLOR are honored too.
552
+ --debug Debug logging.
553
+ --dry-run Preview without mutating files or the platform.
554
+ --fields=<value> Fields to show, comma-separated dot-paths. Defaults to
555
+ the resource's own; `--json` is unaffected.
556
+ --[no-]telemetry Send anonymous usage analytics. Disable with
557
+ --no-telemetry.
306
558
 
307
559
  GLOBAL FLAGS
308
560
  --json Format output as json.
309
561
 
310
562
  DESCRIPTION
311
- Validate config without mutation and preview the sync diff.
563
+ Get one branding revision by id.
564
+
565
+ EXAMPLES
566
+ $ zitadel branding get <id>
567
+
568
+ $ zitadel branding get <id> --json
312
569
  ```
313
570
 
314
- ## `zitadel reset`
571
+ ## `zitadel branding list`
315
572
 
316
- Delete the local Zitadel server runtime and data.
573
+ List branding.
317
574
 
318
575
  ```
319
576
  USAGE
320
- $ zitadel reset [--json] [-c <value>] [-s <value>] [-n] [-f] [--dry-run] [--verbose] [--debug]
577
+ $ zitadel branding list [--json] [-c <value>] [-s <value>] [-n]
578
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
579
+ [--plain]
321
580
 
322
581
  FLAGS
323
582
  -c, --cwd=<value> Project directory to operate on.
324
- -f, --force Overwrite protected files on conflict.
325
- -n, --non-interactive Disable prompts. Required when scripting or running as an agent.
583
+ -n, --non-interactive Disable prompts. Required when scripting or running as
584
+ an agent.
326
585
  -s, --server=<value> Override the resolved server URL.
586
+ -v, --verbose Verbose logging.
587
+ --[no-]color Colorize human output. Disable with --no-color;
588
+ NO_COLOR and FORCE_COLOR are honored too.
327
589
  --debug Debug logging.
328
590
  --dry-run Preview without mutating files or the platform.
329
- --verbose Verbose logging.
591
+ --fields=<value> Columns to show, comma-separated dot-paths (e.g.
592
+ id,attributes.email). Defaults to the resource's own
593
+ columns; `--json` is unaffected.
594
+ --plain Tab-separated rows with no header, for piping. Implied
595
+ when stdout is not a terminal.
596
+ --[no-]telemetry Send anonymous usage analytics. Disable with
597
+ --no-telemetry.
330
598
 
331
599
  GLOBAL FLAGS
332
600
  --json Format output as json.
333
601
 
334
602
  DESCRIPTION
335
- Delete the local Zitadel server runtime and data.
603
+ List branding.
604
+
605
+ EXAMPLES
606
+ $ zitadel branding list --json
336
607
  ```
337
608
 
338
- ## `zitadel search`
609
+ ## `zitadel claim`
339
610
 
340
- Search for a command.
611
+ Claim this project to make it permanent. Opens a browser to create an account or sign in.
341
612
 
342
613
  ```
343
614
  USAGE
344
- $ zitadel search
615
+ $ zitadel claim [--json] [-c <value>] [-s <value>] [-n]
616
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--no-open] [--timeout
617
+ <value>]
618
+
619
+ FLAGS
620
+ -c, --cwd=<value> Project directory to operate on.
621
+ -n, --non-interactive Disable prompts. Required when scripting or running as
622
+ an agent.
623
+ -s, --server=<value> Override the resolved server URL.
624
+ -v, --verbose Verbose logging.
625
+ --[no-]color Colorize human output. Disable with --no-color;
626
+ NO_COLOR and FORCE_COLOR are honored too.
627
+ --debug Debug logging.
628
+ --dry-run Preview without mutating files or the platform.
629
+ --no-open Print the link instead of opening a browser.
630
+ --[no-]telemetry Send anonymous usage analytics. Disable with
631
+ --no-telemetry.
632
+ --timeout=<value> Seconds to wait for the browser step. Defaults to the
633
+ link's own expiry (10 minutes).
634
+
635
+ GLOBAL FLAGS
636
+ --json Format output as json.
345
637
 
346
638
  DESCRIPTION
347
- Search for a command.
639
+ Claim this project to make it permanent. Opens a browser to create an account
640
+ or sign in.
348
641
 
349
- Once you select a command, hit enter and it will show the help for that command.
350
- ```
642
+ EXAMPLES
643
+ $ zitadel claim
351
644
 
352
- _See code: [@oclif/plugin-search](https://github.com/oclif/plugin-search/blob/v1.2.50/src/commands/search.ts)_
645
+ $ zitadel claim --no-open
353
646
 
354
- ## `zitadel setup`
647
+ $ zitadel claim --timeout 120
648
+ ```
355
649
 
356
- Create a Zitadel project and scaffold local auth.
650
+ ## `zitadel commands`
651
+
652
+ List all zitadel commands.
357
653
 
358
654
  ```
359
655
  USAGE
360
- $ zitadel setup [--json] [-c <value>] [-s <value>] [-n] [-f] [--dry-run] [--verbose] [--debug]
361
- [--framework next|nuxt|react|vue|angular] [--renderer react|web-component] [--dev-port <value>] [--skip-install]
656
+ $ zitadel commands [--json] [-c id|plugin|summary|type... | --tree]
657
+ [--deprecated] [-x | ] [--hidden] [--no-truncate | ] [--sort
658
+ id|plugin|summary|type | ]
362
659
 
363
660
  FLAGS
364
- -c, --cwd=<value> Project directory to operate on.
365
- -f, --force Overwrite protected files on conflict.
366
- -n, --non-interactive Disable prompts. Required when scripting or running as an agent.
367
- -s, --server=<value> Override the resolved server URL.
368
- --debug Debug logging.
369
- --dev-port=<value> Dev-server port; also the issuer origin registered with Zitadel. Defaults to the detected
370
- port. Use distinct ports to run several scaffolded apps side by side.
371
- --dry-run Preview without mutating files or the platform.
372
- --framework=<option> Framework to target.
373
- <options: next|nuxt|react|vue|angular>
374
- --renderer=<option> Renderer (default: react).
375
- <options: react|web-component>
376
- --skip-install Do not install dependencies after setup updates package.json.
377
- --verbose Verbose logging.
661
+ -c, --columns=<option>... Only show provided columns (comma-separated).
662
+ <options: id|plugin|summary|type>
663
+ -x, --extended Show extra columns.
664
+ --deprecated Show deprecated commands.
665
+ --hidden Show hidden commands.
666
+ --no-truncate Do not truncate output.
667
+ --sort=<option> [default: id] Property to sort by.
668
+ <options: id|plugin|summary|type>
669
+ --tree Show tree of commands.
378
670
 
379
671
  GLOBAL FLAGS
380
672
  --json Format output as json.
381
673
 
382
674
  DESCRIPTION
383
- Create a Zitadel project and scaffold local auth.
384
-
385
- EXAMPLES
386
- $ zitadel setup --framework next
387
-
388
- $ zitadel setup --framework react --dev-port 3000
675
+ List all zitadel commands.
389
676
  ```
390
677
 
391
- ## `zitadel start`
678
+ _See code: [@oclif/plugin-commands](https://github.com/oclif/plugin-commands/blob/4.1.55/src/commands/commands.ts)_
392
679
 
393
- Start a local Zitadel server.
680
+ ## `zitadel console`
681
+
682
+ Open the local console, signed in as the local admin created by `zitadel start`.
394
683
 
395
684
  ```
396
685
  USAGE
397
- $ zitadel start [--json] [-c <value>] [-s <value>] [-n] [-f] [--dry-run] [--verbose] [--debug] [--image
398
- <value>] [--port <value>] [--runtime binary|docker]
686
+ $ zitadel console [--json] [-c <value>] [-s <value>] [-n]
687
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--no-open]
399
688
 
400
689
  FLAGS
401
690
  -c, --cwd=<value> Project directory to operate on.
402
- -f, --force Overwrite protected files on conflict.
403
- -n, --non-interactive Disable prompts. Required when scripting or running as an agent.
691
+ -n, --non-interactive Disable prompts. Required when scripting or running as
692
+ an agent.
404
693
  -s, --server=<value> Override the resolved server URL.
694
+ -v, --verbose Verbose logging.
695
+ --[no-]color Colorize human output. Disable with --no-color;
696
+ NO_COLOR and FORCE_COLOR are honored too.
405
697
  --debug Debug logging.
406
698
  --dry-run Preview without mutating files or the platform.
407
- --image=<value> Container image to run.
408
- --port=<value> [default: 8080] Local HTTP port.
409
- --runtime=<option> Local runtime backend.
410
- <options: binary|docker>
411
- --verbose Verbose logging.
699
+ --no-open Print the sign-in link instead of opening a browser.
700
+ --[no-]telemetry Send anonymous usage analytics. Disable with
701
+ --no-telemetry.
412
702
 
413
703
  GLOBAL FLAGS
414
704
  --json Format output as json.
415
705
 
416
706
  DESCRIPTION
417
- Start a local Zitadel server.
707
+ Open the local console, signed in as the local admin created by `zitadel
708
+ start`.
709
+
710
+ Run it in the directory `zitadel start` ran in, or one inside it: the local
711
+ admin is read from the nearest `.zitadel/local/` on the way up.
712
+
713
+ EXAMPLES
714
+ $ zitadel console
715
+
716
+ $ zitadel console --no-open
418
717
  ```
419
718
 
420
- ## `zitadel status`
719
+ ## `zitadel doctor`
421
720
 
422
- Summarize the local Zitadel server and project state.
721
+ Verify local runtime and project state.
423
722
 
424
723
  ```
425
724
  USAGE
426
- $ zitadel status [--json] [-c <value>] [-s <value>] [-n] [-f] [--dry-run] [--verbose] [--debug]
725
+ $ zitadel doctor [--json] [-c <value>] [-s <value>] [-n]
726
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--fix] [--image <value>]
727
+ [--port <value>] [--runtime binary|docker]
427
728
 
428
729
  FLAGS
429
- -c, --cwd=<value> Project directory to operate on.
430
- -f, --force Overwrite protected files on conflict.
431
- -n, --non-interactive Disable prompts. Required when scripting or running as an agent.
432
- -s, --server=<value> Override the resolved server URL.
433
- --debug Debug logging.
434
- --dry-run Preview without mutating files or the platform.
435
- --verbose Verbose logging.
730
+ -c, --cwd=<value> Project directory to operate on.
731
+ -n, --non-interactive Disable prompts. Required when scripting or running as
732
+ an agent.
733
+ -s, --server=<value> Override the resolved server URL.
734
+ -v, --verbose Verbose logging.
735
+ --[no-]color Colorize human output. Disable with --no-color;
736
+ NO_COLOR and FORCE_COLOR are honored too.
737
+ --debug Debug logging.
738
+ --dry-run Preview without mutating files or the platform.
739
+ --fix Repair missing files and stale managed wiring.
740
+ --image=<value> Container image to check.
741
+ --port=<value> Local HTTP port to check. Defaults to the port this
742
+ directory's server uses.
743
+ --runtime=<option> Local runtime backend.
744
+ <options: binary|docker>
745
+ --[no-]telemetry Send anonymous usage analytics. Disable with
746
+ --no-telemetry.
436
747
 
437
748
  GLOBAL FLAGS
438
749
  --json Format output as json.
439
750
 
440
751
  DESCRIPTION
441
- Summarize the local Zitadel server and project state.
752
+ Verify local runtime and project state.
442
753
  ```
443
754
 
444
- ## `zitadel stop`
755
+ ## `zitadel eject`
445
756
 
446
- Stop the local Zitadel server.
757
+ Remove managed files and local Zitadel state.
447
758
 
448
759
  ```
449
760
  USAGE
450
- $ zitadel stop [--json] [-c <value>] [-s <value>] [-n] [-f] [--dry-run] [--verbose] [--debug]
761
+ $ zitadel eject [--json] [-c <value>] [-s <value>] [-n]
762
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-f]
451
763
 
452
764
  FLAGS
453
765
  -c, --cwd=<value> Project directory to operate on.
454
- -f, --force Overwrite protected files on conflict.
455
- -n, --non-interactive Disable prompts. Required when scripting or running as an agent.
766
+ -f, --force Remove the managed files without the confirmation
767
+ prompt.
768
+ -n, --non-interactive Disable prompts. Required when scripting or running as
769
+ an agent.
456
770
  -s, --server=<value> Override the resolved server URL.
771
+ -v, --verbose Verbose logging.
772
+ --[no-]color Colorize human output. Disable with --no-color;
773
+ NO_COLOR and FORCE_COLOR are honored too.
457
774
  --debug Debug logging.
458
775
  --dry-run Preview without mutating files or the platform.
459
- --verbose Verbose logging.
776
+ --[no-]telemetry Send anonymous usage analytics. Disable with
777
+ --no-telemetry.
460
778
 
461
779
  GLOBAL FLAGS
462
780
  --json Format output as json.
463
781
 
464
782
  DESCRIPTION
465
- Stop the local Zitadel server.
783
+ Remove managed files and local Zitadel state.
784
+
785
+ ALIASES
786
+ $ zitadel uninstall
466
787
  ```
467
788
 
468
- ## `zitadel uninstall`
789
+ ## `zitadel events get ID`
469
790
 
470
- Remove managed files and local Zitadel state.
791
+ Get one event by id.
471
792
 
472
793
  ```
473
794
  USAGE
474
- $ zitadel uninstall [--json] [-c <value>] [-s <value>] [-n] [-f] [--dry-run] [--verbose] [--debug]
795
+ $ zitadel events get ID [--json] [-c <value>] [-s <value>] [-n]
796
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
797
+
798
+ ARGUMENTS
799
+ ID event id
475
800
 
476
801
  FLAGS
477
802
  -c, --cwd=<value> Project directory to operate on.
478
- -f, --force Overwrite protected files on conflict.
479
- -n, --non-interactive Disable prompts. Required when scripting or running as an agent.
803
+ -n, --non-interactive Disable prompts. Required when scripting or running as
804
+ an agent.
480
805
  -s, --server=<value> Override the resolved server URL.
806
+ -v, --verbose Verbose logging.
807
+ --[no-]color Colorize human output. Disable with --no-color;
808
+ NO_COLOR and FORCE_COLOR are honored too.
481
809
  --debug Debug logging.
482
810
  --dry-run Preview without mutating files or the platform.
483
- --verbose Verbose logging.
811
+ --fields=<value> Fields to show, comma-separated dot-paths. Defaults to
812
+ the resource's own; `--json` is unaffected.
813
+ --[no-]telemetry Send anonymous usage analytics. Disable with
814
+ --no-telemetry.
484
815
 
485
816
  GLOBAL FLAGS
486
817
  --json Format output as json.
487
818
 
488
819
  DESCRIPTION
489
- Remove managed files and local Zitadel state.
820
+ Get one event by id.
490
821
 
491
- ALIASES
492
- $ zitadel uninstall
822
+ EXAMPLES
823
+ $ zitadel events get <id>
824
+
825
+ $ zitadel events get <id> --json
826
+ ```
827
+
828
+ ## `zitadel events list`
829
+
830
+ List events.
831
+
832
+ ```
833
+ USAGE
834
+ $ zitadel events list [--json] [-c <value>] [-s <value>] [-n]
835
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
836
+ --page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
837
+ [--sort <value>]
838
+
839
+ FLAGS
840
+ -a, --all
841
+ Fetch every page instead of one.
842
+
843
+ -c, --cwd=<value>
844
+ Project directory to operate on.
845
+
846
+ -n, --non-interactive
847
+ Disable prompts. Required when scripting or running as an agent.
848
+
849
+ -s, --server=<value>
850
+ Override the resolved server URL.
851
+
852
+ -v, --verbose
853
+ Verbose logging.
854
+
855
+ --[no-]color
856
+ Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are
857
+ honored too.
858
+
859
+ --debug
860
+ Debug logging.
861
+
862
+ --dry-run
863
+ Preview without mutating files or the platform.
864
+
865
+ --fields=<value>
866
+ Columns to show, comma-separated dot-paths (e.g. id,attributes.email).
867
+ Defaults to the resource's own columns; `--json` is unaffected.
868
+
869
+ --filter=<value>...
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).
876
+
877
+ --limit=<value>
878
+ Page size (server default 20, max 100).
879
+
880
+ --page-token=<value>
881
+ Continue from a previous page's next_page_token.
882
+
883
+ --plain
884
+ Tab-separated rows with no header, for piping. Implied when stdout is not a
885
+ terminal.
886
+
887
+ --sort=<value>
888
+ Sort as field:direction (asc|desc). Fields: occurred_at.
889
+
890
+ --[no-]telemetry
891
+ Send anonymous usage analytics. Disable with --no-telemetry.
892
+
893
+ GLOBAL FLAGS
894
+ --json Format output as json.
895
+
896
+ DESCRIPTION
897
+ List events.
898
+
899
+ EXAMPLES
900
+ $ zitadel events list --json
901
+
902
+ $ zitadel events list --all --json
903
+
904
+ $ zitadel events list --filter category=equals:<value> --sort occurred_at:desc
905
+ ```
906
+
907
+ ## `zitadel flow-definitions get FLOW`
908
+
909
+ Get one flow definition by id.
910
+
911
+ ```
912
+ USAGE
913
+ $ zitadel flow-definitions get FLOW [--json] [-c <value>] [-s <value>] [-n]
914
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
915
+
916
+ ARGUMENTS
917
+ FLOW flow name (newest revision) or revision id
918
+
919
+ FLAGS
920
+ -c, --cwd=<value> Project directory to operate on.
921
+ -n, --non-interactive Disable prompts. Required when scripting or running as
922
+ an agent.
923
+ -s, --server=<value> Override the resolved server URL.
924
+ -v, --verbose Verbose logging.
925
+ --[no-]color Colorize human output. Disable with --no-color;
926
+ NO_COLOR and FORCE_COLOR are honored too.
927
+ --debug Debug logging.
928
+ --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
+ --[no-]telemetry Send anonymous usage analytics. Disable with
932
+ --no-telemetry.
933
+
934
+ GLOBAL FLAGS
935
+ --json Format output as json.
936
+
937
+ DESCRIPTION
938
+ Get one flow definition by id.
939
+
940
+ EXAMPLES
941
+ $ zitadel flow-definitions get <id>
942
+
943
+ $ zitadel flow-definitions get <id> --json
944
+ ```
945
+
946
+ ## `zitadel flow-definitions list`
947
+
948
+ List flow-definitions.
949
+
950
+ ```
951
+ USAGE
952
+ $ zitadel flow-definitions list [--json] [-c <value>] [-s <value>] [-n]
953
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
954
+ --page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
955
+
956
+ FLAGS
957
+ -a, --all Fetch every page instead of one.
958
+ -c, --cwd=<value> Project directory to operate on.
959
+ -n, --non-interactive Disable prompts. Required when scripting or running
960
+ as an agent.
961
+ -s, --server=<value> Override the resolved server URL.
962
+ -v, --verbose Verbose logging.
963
+ --[no-]color Colorize human output. Disable with --no-color;
964
+ NO_COLOR and FORCE_COLOR are honored too.
965
+ --debug Debug logging.
966
+ --dry-run Preview without mutating files or the platform.
967
+ --fields=<value> Columns to show, comma-separated dot-paths (e.g.
968
+ id,attributes.email). Defaults to the resource's own
969
+ columns; `--json` is unaffected.
970
+ --filter=<value>... Filter as field=operation:value (operation defaults
971
+ to equals). Fields: name (equals), purpose (equals),
972
+ revisions (equals; values all|latest).
973
+ --limit=<value> Page size (server default 20, max 100).
974
+ --page-token=<value> Continue from a previous page's next_page_token.
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.
979
+
980
+ GLOBAL FLAGS
981
+ --json Format output as json.
982
+
983
+ DESCRIPTION
984
+ List flow-definitions.
985
+
986
+ EXAMPLES
987
+ $ zitadel flow-definitions list --json
988
+
989
+ $ zitadel flow-definitions list --all --json
990
+
991
+ $ zitadel flow-definitions list --filter name=equals:<value>
992
+ ```
993
+
994
+ ## `zitadel grants create`
995
+
996
+ Create a grant.
997
+
998
+ ```
999
+ USAGE
1000
+ $ zitadel grants create [--json] [-c <value>] [-s <value>] [-n]
1001
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--relation
1002
+ viewer|editor|admin] [--expires-at <value>] [--user-user-id <value>]
1003
+ [--user-identifier <value>] [--team-team-id <value>] [--team-name <value>]
1004
+ [--data <value> | --file <value>] [--set <value>...]
1005
+
1006
+ FLAGS
1007
+ -c, --cwd=<value> Project directory to operate on.
1008
+ -n, --non-interactive Disable prompts. Required when scripting or running as
1009
+ an agent.
1010
+ -s, --server=<value> Override the resolved server URL.
1011
+ -v, --verbose Verbose logging.
1012
+ --[no-]color Colorize human output. Disable with --no-color;
1013
+ NO_COLOR and FORCE_COLOR are honored too.
1014
+ --debug Debug logging.
1015
+ --dry-run Preview without mutating files or the platform.
1016
+ --[no-]telemetry Send anonymous usage analytics. Disable with
1017
+ --no-telemetry.
1018
+
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
+ GLOBAL FLAGS
1033
+ --json Format output as json.
1034
+
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
+ DESCRIPTION
1050
+ Create a grant.
1051
+
1052
+ EXAMPLES
1053
+ $ zitadel grants create --relation viewer --user-identifier alice@acme.com --json
1054
+
1055
+ $ zitadel grants create --data '{...}' --json
1056
+
1057
+ $ zitadel grants create --file ./grant.json
1058
+ ```
1059
+
1060
+ ## `zitadel grants delete ID`
1061
+
1062
+ Delete a grant by id.
1063
+
1064
+ ```
1065
+ USAGE
1066
+ $ zitadel grants delete ID [--json] [-c <value>] [-s <value>] [-n]
1067
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-f]
1068
+
1069
+ ARGUMENTS
1070
+ ID grant id
1071
+
1072
+ FLAGS
1073
+ -c, --cwd=<value> Project directory to operate on.
1074
+ -f, --force Delete the grant without the confirmation prompt.
1075
+ Required when non-interactive.
1076
+ -n, --non-interactive Disable prompts. Required when scripting or running as
1077
+ an agent.
1078
+ -s, --server=<value> Override the resolved server URL.
1079
+ -v, --verbose Verbose logging.
1080
+ --[no-]color Colorize human output. Disable with --no-color;
1081
+ NO_COLOR and FORCE_COLOR are honored too.
1082
+ --debug Debug logging.
1083
+ --dry-run Preview without mutating files or the platform.
1084
+ --[no-]telemetry Send anonymous usage analytics. Disable with
1085
+ --no-telemetry.
1086
+
1087
+ GLOBAL FLAGS
1088
+ --json Format output as json.
1089
+
1090
+ DESCRIPTION
1091
+ Delete a grant by id.
1092
+
1093
+ EXAMPLES
1094
+ $ zitadel grants delete <id> --force --json
1095
+ ```
1096
+
1097
+ ## `zitadel grants get ID`
1098
+
1099
+ Get one grant by id.
1100
+
1101
+ ```
1102
+ USAGE
1103
+ $ zitadel grants get ID [--json] [-c <value>] [-s <value>] [-n]
1104
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
1105
+
1106
+ ARGUMENTS
1107
+ ID grant id
1108
+
1109
+ FLAGS
1110
+ -c, --cwd=<value> Project directory to operate on.
1111
+ -n, --non-interactive Disable prompts. Required when scripting or running as
1112
+ an agent.
1113
+ -s, --server=<value> Override the resolved server URL.
1114
+ -v, --verbose Verbose logging.
1115
+ --[no-]color Colorize human output. Disable with --no-color;
1116
+ NO_COLOR and FORCE_COLOR are honored too.
1117
+ --debug Debug logging.
1118
+ --dry-run Preview without mutating files or the platform.
1119
+ --fields=<value> Fields to show, comma-separated dot-paths. Defaults to
1120
+ the resource's own; `--json` is unaffected.
1121
+ --[no-]telemetry Send anonymous usage analytics. Disable with
1122
+ --no-telemetry.
1123
+
1124
+ GLOBAL FLAGS
1125
+ --json Format output as json.
1126
+
1127
+ DESCRIPTION
1128
+ Get one grant by id.
1129
+
1130
+ EXAMPLES
1131
+ $ zitadel grants get <id>
1132
+
1133
+ $ zitadel grants get <id> --json
1134
+ ```
1135
+
1136
+ ## `zitadel grants list`
1137
+
1138
+ List grants.
1139
+
1140
+ ```
1141
+ USAGE
1142
+ $ zitadel grants list [--json] [-c <value>] [-s <value>] [-n]
1143
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
1144
+ --page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
1145
+ [--sort <value>]
1146
+
1147
+ FLAGS
1148
+ -a, --all
1149
+ Fetch every page instead of one.
1150
+
1151
+ -c, --cwd=<value>
1152
+ Project directory to operate on.
1153
+
1154
+ -n, --non-interactive
1155
+ Disable prompts. Required when scripting or running as an agent.
1156
+
1157
+ -s, --server=<value>
1158
+ Override the resolved server URL.
1159
+
1160
+ -v, --verbose
1161
+ Verbose logging.
1162
+
1163
+ --[no-]color
1164
+ Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are
1165
+ honored too.
1166
+
1167
+ --debug
1168
+ Debug logging.
1169
+
1170
+ --dry-run
1171
+ Preview without mutating files or the platform.
1172
+
1173
+ --fields=<value>
1174
+ Columns to show, comma-separated dot-paths (e.g. id,attributes.email).
1175
+ Defaults to the resource's own columns; `--json` is unaffected.
1176
+
1177
+ --filter=<value>...
1178
+ Filter as field=operation:value (operation defaults to equals). Fields:
1179
+ created_at (equals|not_equals|contains|not_contains|less_than|less_than_or_e
1180
+ qual|greater_than|greater_than_or_equal), user_id
1181
+ (equals|not_equals|contains|not_contains|less_than|less_than_or_equal|greate
1182
+ r_than|greater_than_or_equal), team_id (equals|not_equals|contains|not_conta
1183
+ ins|less_than|less_than_or_equal|greater_than|greater_than_or_equal),
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).
1188
+
1189
+ --limit=<value>
1190
+ Page size (server default 20, max 100).
1191
+
1192
+ --page-token=<value>
1193
+ Continue from a previous page's next_page_token.
1194
+
1195
+ --plain
1196
+ Tab-separated rows with no header, for piping. Implied when stdout is not a
1197
+ terminal.
1198
+
1199
+ --sort=<value>
1200
+ Sort as field:direction (asc|desc). Fields: created_at, expires_at, id.
1201
+
1202
+ --[no-]telemetry
1203
+ Send anonymous usage analytics. Disable with --no-telemetry.
1204
+
1205
+ GLOBAL FLAGS
1206
+ --json Format output as json.
1207
+
1208
+ DESCRIPTION
1209
+ List grants.
1210
+
1211
+ EXAMPLES
1212
+ $ zitadel grants list --json
1213
+
1214
+ $ zitadel grants list --all --json
1215
+
1216
+ $ zitadel grants list --filter created_at=equals:<value> --sort created_at:desc
1217
+ ```
1218
+
1219
+ ## `zitadel help [COMMAND]`
1220
+
1221
+ Display help for zitadel.
1222
+
1223
+ ```
1224
+ USAGE
1225
+ $ zitadel help [COMMAND...] [-n]
1226
+
1227
+ ARGUMENTS
1228
+ [COMMAND...] Command to show help for.
1229
+
1230
+ FLAGS
1231
+ -n, --nested-commands Include all nested commands in the output.
1232
+
1233
+ DESCRIPTION
1234
+ Display help for zitadel.
1235
+ ```
1236
+
1237
+ _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/6.2.49/src/commands/help.ts)_
1238
+
1239
+ ## `zitadel idps create`
1240
+
1241
+ Create an identity provider connection.
1242
+
1243
+ ```
1244
+ USAGE
1245
+ $ zitadel idps create [--json] [-c <value>] [-s <value>] [-n]
1246
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--slug <value>]
1247
+ [--protocol oidc] [--template <value>] [--display-name <value>]
1248
+ [--subject-claim <value>] [--claim-mapping <value>...] [--verified-claims
1249
+ <value>...] [--provisioning-creation disabled|auto] [--oidc-issuer <value>]
1250
+ [--oidc-jwks-uri <value>] [--oidc-id-token-mapping]
1251
+ [--oidc-authorization-endpoint <value>] [--oidc-token-endpoint <value>]
1252
+ [--oidc-userinfo-endpoint <value>] [--oidc-client-id <value>]
1253
+ [--oidc-client-secret <value>] [--oidc-token-endpoint-auth-method
1254
+ client_secret_basic|client_secret_post] [--oidc-scopes <value>...]
1255
+ [--oidc-pkce-enabled] [--oidc-static-authorize-parameters <value>...]
1256
+ [--data <value> | --file <value>] [--set <value>...]
1257
+
1258
+ FLAGS
1259
+ -c, --cwd=<value> Project directory to operate on.
1260
+ -n, --non-interactive Disable prompts. Required when scripting or running as
1261
+ an agent.
1262
+ -s, --server=<value> Override the resolved server URL.
1263
+ -v, --verbose Verbose logging.
1264
+ --[no-]color Colorize human output. Disable with --no-color;
1265
+ NO_COLOR and FORCE_COLOR are honored too.
1266
+ --debug Debug logging.
1267
+ --dry-run Preview without mutating files or the platform.
1268
+ --[no-]telemetry Send anonymous usage analytics. Disable with
1269
+ --no-telemetry.
1270
+
1271
+ OPTIONAL FIELD FLAGS
1272
+ --claim-mapping=<value>... Repeatable claim_mapping entry: key=value for a
1273
+ string, key:=value for JSON. Maps user-schema
1274
+ property names (keys) to provider claim names
1275
+ (values).
1276
+ --subject-claim=<value> Claim carrying the provider's stable subject
1277
+ identifier.
1278
+ --template=<value> Template hint for rendering the provider (logo,
1279
+ colors).
1280
+ --verified-claims=<value>... Repeatable verified_claims entry: key=value for
1281
+ a string, key:=value for JSON. Maps a verifiable
1282
+ user-schema property to its verification source:
1283
+ a claim name (read the claim) or the…
1284
+
1285
+ RAW BODY FLAGS
1286
+ --data=<value> Whole body as a JSON object. Field flags and --set apply
1287
+ over it.
1288
+ --file=<value> Read the body from a JSON file; `-` reads stdin. Field flags
1289
+ and --set apply over it.
1290
+ --set=<value>... Set one field by its dot path: path=value, or path:=json for
1291
+ JSON. Repeatable; applied after the field flags, in order. A
1292
+ key that contains a dot is set through its parent: --set
1293
+ 'parent:={"a.b":"x"}'.
1294
+
1295
+ REQUIRED FIELD FLAGS
1296
+ --display-name=<value> (required) Shown to the user on the sign-in button.
1297
+ --protocol=<option> (required) The protocol used by the identity provider.
1298
+ <options: oidc>
1299
+ --slug=<value> (required) Stable identifier, referenced by user
1300
+ schemas (x-auth-methods.sso.providers) and flow steps
1301
+ (sso_providers).
1302
+
1303
+ GLOBAL FLAGS
1304
+ --json Format output as json.
1305
+
1306
+ OIDC FIELD FLAGS
1307
+ --oidc-authorization-endpoint=<value>
1308
+ For a provider that exposes no .well-known document.
1309
+
1310
+ --oidc-client-id=<value>
1311
+ (required with oidc.*) Either a literal in case the same client is used in
1312
+ all environments, or a `${{ NAME }}` reference to a…
1313
+
1314
+ --oidc-client-secret=<value>
1315
+ (required with oidc.*) A reference to the variable holding the client
1316
+ secret, never the secret itself.
1317
+
1318
+ --[no-]oidc-id-token-mapping
1319
+ Read user claims from the id_token instead of the userinfo endpoint, for
1320
+ providers that populate only the…
1321
+
1322
+ --oidc-issuer=<value>
1323
+ (required with oidc.*) Discovery base.
1324
+
1325
+ --oidc-jwks-uri=<value>
1326
+ JWKS endpoint, for a provider that exposes no .well-known document.
1327
+
1328
+ --[no-]oidc-pkce-enabled
1329
+ Send PKCE (code_challenge/code_verifier).
1330
+
1331
+ --oidc-scopes=<value>...
1332
+ Repeatable, one value each. Must contain `openid` - without it the provider
1333
+ returns no id_token and the connection is not OIDC.
1334
+
1335
+ --oidc-static-authorize-parameters=<value>...
1336
+ Repeatable oidc.static_authorize_parameters entry: key=value for a string,
1337
+ key:=value for JSON. Extra provider-specific authorize parameters (for
1338
+ example `prompt`).
1339
+
1340
+ --oidc-token-endpoint=<value>
1341
+ For a provider that exposes no .well-known document.
1342
+
1343
+ --oidc-token-endpoint-auth-method=<option>
1344
+ How the client authenticates at the token endpoint.
1345
+ <options: client_secret_basic|client_secret_post>
1346
+
1347
+ --oidc-userinfo-endpoint=<value>
1348
+ For a provider that exposes no .well-known document.
1349
+
1350
+ PROVISIONING FIELD FLAGS
1351
+ --provisioning-creation=<option> <options: disabled|auto>
1352
+
1353
+ DESCRIPTION
1354
+ Create an identity provider connection.
1355
+
1356
+ EXAMPLES
1357
+ $ zitadel idps create --slug acme-sso --protocol oidc --display-name 'Acme SSO' --oidc-issuer https://sso.acme.example --oidc-client-id <client_id> --oidc-client-secret '${{ ACME_SSO_CLIENT_SECRET }}' --oidc-scopes openid --oidc-scopes profile --oidc-scopes email --json
1358
+
1359
+ $ zitadel idps create --data '{...}' --json
1360
+
1361
+ $ zitadel idps create --file ./identity-provider-connection.json
1362
+ ```
1363
+
1364
+ ## `zitadel idps get ID`
1365
+
1366
+ Get one identity provider connection by id.
1367
+
1368
+ ```
1369
+ USAGE
1370
+ $ zitadel idps get ID [--json] [-c <value>] [-s <value>] [-n]
1371
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
1372
+
1373
+ ARGUMENTS
1374
+ ID identity provider connection id
1375
+
1376
+ FLAGS
1377
+ -c, --cwd=<value> Project directory to operate on.
1378
+ -n, --non-interactive Disable prompts. Required when scripting or running as
1379
+ an agent.
1380
+ -s, --server=<value> Override the resolved server URL.
1381
+ -v, --verbose Verbose logging.
1382
+ --[no-]color Colorize human output. Disable with --no-color;
1383
+ NO_COLOR and FORCE_COLOR are honored too.
1384
+ --debug Debug logging.
1385
+ --dry-run Preview without mutating files or the platform.
1386
+ --fields=<value> Fields to show, comma-separated dot-paths. Defaults to
1387
+ the resource's own; `--json` is unaffected.
1388
+ --[no-]telemetry Send anonymous usage analytics. Disable with
1389
+ --no-telemetry.
1390
+
1391
+ GLOBAL FLAGS
1392
+ --json Format output as json.
1393
+
1394
+ DESCRIPTION
1395
+ Get one identity provider connection by id.
1396
+
1397
+ EXAMPLES
1398
+ $ zitadel idps get <id>
1399
+
1400
+ $ zitadel idps get <id> --json
1401
+ ```
1402
+
1403
+ ## `zitadel idps list`
1404
+
1405
+ List idps.
1406
+
1407
+ ```
1408
+ USAGE
1409
+ $ zitadel idps list [--json] [-c <value>] [-s <value>] [-n]
1410
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
1411
+ --page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
1412
+ [--sort <value>]
1413
+
1414
+ FLAGS
1415
+ -a, --all
1416
+ Fetch every page instead of one.
1417
+
1418
+ -c, --cwd=<value>
1419
+ Project directory to operate on.
1420
+
1421
+ -n, --non-interactive
1422
+ Disable prompts. Required when scripting or running as an agent.
1423
+
1424
+ -s, --server=<value>
1425
+ Override the resolved server URL.
1426
+
1427
+ -v, --verbose
1428
+ Verbose logging.
1429
+
1430
+ --[no-]color
1431
+ Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are
1432
+ honored too.
1433
+
1434
+ --debug
1435
+ Debug logging.
1436
+
1437
+ --dry-run
1438
+ Preview without mutating files or the platform.
1439
+
1440
+ --fields=<value>
1441
+ Columns to show, comma-separated dot-paths (e.g. id,attributes.email).
1442
+ Defaults to the resource's own columns; `--json` is unaffected.
1443
+
1444
+ --filter=<value>...
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).
1449
+
1450
+ --limit=<value>
1451
+ Page size (server default 20, max 100).
1452
+
1453
+ --page-token=<value>
1454
+ Continue from a previous page's next_page_token.
1455
+
1456
+ --plain
1457
+ Tab-separated rows with no header, for piping. Implied when stdout is not a
1458
+ terminal.
1459
+
1460
+ --sort=<value>
1461
+ Sort as field:direction (asc|desc). Fields: slug, created_at.
1462
+
1463
+ --[no-]telemetry
1464
+ Send anonymous usage analytics. Disable with --no-telemetry.
1465
+
1466
+ GLOBAL FLAGS
1467
+ --json Format output as json.
1468
+
1469
+ DESCRIPTION
1470
+ List idps.
1471
+
1472
+ EXAMPLES
1473
+ $ zitadel idps list --json
1474
+
1475
+ $ zitadel idps list --all --json
1476
+
1477
+ $ zitadel idps list --filter slug=equals:<value> --sort slug:desc
1478
+ ```
1479
+
1480
+ ## `zitadel logs`
1481
+
1482
+ Show local Zitadel server logs.
1483
+
1484
+ ```
1485
+ USAGE
1486
+ $ zitadel logs [--json] [-c <value>] [-s <value>] [-n]
1487
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--follow] [--tail
1488
+ <value>]
1489
+
1490
+ FLAGS
1491
+ -c, --cwd=<value> Project directory to operate on.
1492
+ -n, --non-interactive Disable prompts. Required when scripting or running as
1493
+ an agent.
1494
+ -s, --server=<value> Override the resolved server URL.
1495
+ -v, --verbose Verbose logging.
1496
+ --[no-]color Colorize human output. Disable with --no-color;
1497
+ NO_COLOR and FORCE_COLOR are honored too.
1498
+ --debug Debug logging.
1499
+ --dry-run Preview without mutating files or the platform.
1500
+ --follow Follow logs.
1501
+ --tail=<value> [default: 200] Number of lines to show.
1502
+ --[no-]telemetry Send anonymous usage analytics. Disable with
1503
+ --no-telemetry.
1504
+
1505
+ GLOBAL FLAGS
1506
+ --json Format output as json.
1507
+
1508
+ DESCRIPTION
1509
+ Show local Zitadel server logs.
1510
+ ```
1511
+
1512
+ ## `zitadel plan`
1513
+
1514
+ Validate config without mutation and preview the sync diff.
1515
+
1516
+ ```
1517
+ USAGE
1518
+ $ zitadel plan [--json] [-c <value>] [-s <value>] [-n]
1519
+ [--dry-run] [-v] [--debug] [--color] [--telemetry]
1520
+
1521
+ FLAGS
1522
+ -c, --cwd=<value> Project directory to operate on.
1523
+ -n, --non-interactive Disable prompts. Required when scripting or running as
1524
+ an agent.
1525
+ -s, --server=<value> Override the resolved server URL.
1526
+ -v, --verbose Verbose logging.
1527
+ --[no-]color Colorize human output. Disable with --no-color;
1528
+ NO_COLOR and FORCE_COLOR are honored too.
1529
+ --debug Debug logging.
1530
+ --dry-run Preview without mutating files or the platform.
1531
+ --[no-]telemetry Send anonymous usage analytics. Disable with
1532
+ --no-telemetry.
1533
+
1534
+ GLOBAL FLAGS
1535
+ --json Format output as json.
1536
+
1537
+ DESCRIPTION
1538
+ Validate config without mutation and preview the sync diff.
1539
+ ```
1540
+
1541
+ ## `zitadel projects get ID`
1542
+
1543
+ Get one project by id.
1544
+
1545
+ ```
1546
+ USAGE
1547
+ $ zitadel projects get ID [--json] [-c <value>] [-s <value>] [-n]
1548
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
1549
+
1550
+ ARGUMENTS
1551
+ ID project id
1552
+
1553
+ FLAGS
1554
+ -c, --cwd=<value> Project directory to operate on.
1555
+ -n, --non-interactive Disable prompts. Required when scripting or running as
1556
+ an agent.
1557
+ -s, --server=<value> Override the resolved server URL.
1558
+ -v, --verbose Verbose logging.
1559
+ --[no-]color Colorize human output. Disable with --no-color;
1560
+ NO_COLOR and FORCE_COLOR are honored too.
1561
+ --debug Debug logging.
1562
+ --dry-run Preview without mutating files or the platform.
1563
+ --fields=<value> Fields to show, comma-separated dot-paths. Defaults to
1564
+ the resource's own; `--json` is unaffected.
1565
+ --[no-]telemetry Send anonymous usage analytics. Disable with
1566
+ --no-telemetry.
1567
+
1568
+ GLOBAL FLAGS
1569
+ --json Format output as json.
1570
+
1571
+ DESCRIPTION
1572
+ Get one project by id.
1573
+
1574
+ EXAMPLES
1575
+ $ zitadel projects get <id>
1576
+
1577
+ $ zitadel projects get <id> --json
1578
+ ```
1579
+
1580
+ ## `zitadel projects list`
1581
+
1582
+ List projects.
1583
+
1584
+ ```
1585
+ USAGE
1586
+ $ zitadel projects list [--json] [-c <value>] [-s <value>] [-n]
1587
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
1588
+ --page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
1589
+ [--sort <value>]
1590
+
1591
+ FLAGS
1592
+ -a, --all Fetch every page instead of one.
1593
+ -c, --cwd=<value> Project directory to operate on.
1594
+ -n, --non-interactive Disable prompts. Required when scripting or running
1595
+ as an agent.
1596
+ -s, --server=<value> Override the resolved server URL.
1597
+ -v, --verbose Verbose logging.
1598
+ --[no-]color Colorize human output. Disable with --no-color;
1599
+ NO_COLOR and FORCE_COLOR are honored too.
1600
+ --debug Debug logging.
1601
+ --dry-run Preview without mutating files or the platform.
1602
+ --fields=<value> Columns to show, comma-separated dot-paths (e.g.
1603
+ id,attributes.email). Defaults to the resource's own
1604
+ columns; `--json` is unaffected.
1605
+ --filter=<value>... Filter as field=operation:value (operation defaults
1606
+ to equals). Fields: created_at (equals|not_equals|co
1607
+ ntains|not_contains|less_than|less_than_or_equal|gre
1608
+ ater_than|greater_than_or_equal).
1609
+ --limit=<value> Page size (server default 20, max 100).
1610
+ --page-token=<value> Continue from a previous page's next_page_token.
1611
+ --plain Tab-separated rows with no header, for piping.
1612
+ Implied when stdout is not a terminal.
1613
+ --sort=<value> Sort as field:direction (asc|desc). Fields:
1614
+ created_at.
1615
+ --[no-]telemetry Send anonymous usage analytics. Disable with
1616
+ --no-telemetry.
1617
+
1618
+ GLOBAL FLAGS
1619
+ --json Format output as json.
1620
+
1621
+ DESCRIPTION
1622
+ List projects.
1623
+
1624
+ EXAMPLES
1625
+ $ zitadel projects list --json
1626
+
1627
+ $ zitadel projects list --all --json
1628
+
1629
+ $ zitadel projects list --filter created_at=equals:<value> --sort created_at:desc
1630
+ ```
1631
+
1632
+ ## `zitadel projects update ID`
1633
+
1634
+ Update a project by id.
1635
+
1636
+ ```
1637
+ USAGE
1638
+ $ zitadel projects update ID [--json] [-c <value>] [-s <value>] [-n]
1639
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--name <value>]
1640
+ [--password-hash-algorithm argon2i|argon2id|bcrypt|scrypt|pbkdf2|sha2]
1641
+ [--password-hash-params-time <value>] [--password-hash-params-memory
1642
+ <value>] [--password-hash-params-threads <value>]
1643
+ [--password-hash-params-cost <value>] [--password-hash-params-rounds
1644
+ <value>] [--password-hash-params-hash sha1|sha224|sha256|sha384|sha512]
1645
+ [--data <value> | --file <value>] [--set <value>...]
1646
+
1647
+ ARGUMENTS
1648
+ ID project id
1649
+
1650
+ FLAGS
1651
+ -c, --cwd=<value> Project directory to operate on.
1652
+ -n, --non-interactive Disable prompts. Required when scripting or running as
1653
+ an agent.
1654
+ -s, --server=<value> Override the resolved server URL.
1655
+ -v, --verbose Verbose logging.
1656
+ --[no-]color Colorize human output. Disable with --no-color;
1657
+ NO_COLOR and FORCE_COLOR are honored too.
1658
+ --debug Debug logging.
1659
+ --dry-run Preview without mutating files or the platform.
1660
+ --[no-]telemetry Send anonymous usage analytics. Disable with
1661
+ --no-telemetry.
1662
+
1663
+ RAW BODY FLAGS
1664
+ --data=<value> Whole body as a JSON object. Field flags and --set apply
1665
+ over it.
1666
+ --file=<value> Read the body from a JSON file; `-` reads stdin. Field flags
1667
+ and --set apply over it.
1668
+ --set=<value>... Set one field by its dot path: path=value, or path:=json for
1669
+ JSON. Repeatable; applied after the field flags, in order. A
1670
+ key that contains a dot is set through its parent: --set
1671
+ 'parent:={"a.b":"x"}'.
1672
+
1673
+ GLOBAL FLAGS
1674
+ --json Format output as json.
1675
+
1676
+ OPTIONAL FIELD FLAGS
1677
+ --name=<value> The name of the project.
1678
+
1679
+ PASSWORD HASH FIELD FLAGS
1680
+ --password-hash-algorithm=<option> (required with password_hash.*) The
1681
+ hashing algorithm.
1682
+ <options: argon2i|argon2id|bcrypt|scry
1683
+ pt|pbkdf2|sha2>
1684
+ --password-hash-params-cost=<value> bcrypt cost, or scrypt's log2 of the
1685
+ CPU/memory cost.
1686
+ --password-hash-params-hash=<option> The underlying hash.
1687
+ <options:
1688
+ sha1|sha224|sha256|sha384|sha512>
1689
+ --password-hash-params-memory=<value> argon2 memory in KiB.
1690
+ --password-hash-params-rounds=<value> pbkdf2 or sha2 iteration count.
1691
+ --password-hash-params-threads=<value> argon2 lanes.
1692
+ --password-hash-params-time=<value> argon2 passes over memory.
1693
+
1694
+ DESCRIPTION
1695
+ Update a project by id.
1696
+
1697
+ EXAMPLES
1698
+ $ zitadel projects update <id> --data '{...}' --json
1699
+
1700
+ $ zitadel projects update <id> --file ./project.json
1701
+ ```
1702
+
1703
+ ## `zitadel releases get ID`
1704
+
1705
+ Get one release by id.
1706
+
1707
+ ```
1708
+ USAGE
1709
+ $ zitadel releases get ID [--json] [-c <value>] [-s <value>] [-n]
1710
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
1711
+
1712
+ ARGUMENTS
1713
+ ID release id
1714
+
1715
+ FLAGS
1716
+ -c, --cwd=<value> Project directory to operate on.
1717
+ -n, --non-interactive Disable prompts. Required when scripting or running as
1718
+ an agent.
1719
+ -s, --server=<value> Override the resolved server URL.
1720
+ -v, --verbose Verbose logging.
1721
+ --[no-]color Colorize human output. Disable with --no-color;
1722
+ NO_COLOR and FORCE_COLOR are honored too.
1723
+ --debug Debug logging.
1724
+ --dry-run Preview without mutating files or the platform.
1725
+ --fields=<value> Fields to show, comma-separated dot-paths. Defaults to
1726
+ the resource's own; `--json` is unaffected.
1727
+ --[no-]telemetry Send anonymous usage analytics. Disable with
1728
+ --no-telemetry.
1729
+
1730
+ GLOBAL FLAGS
1731
+ --json Format output as json.
1732
+
1733
+ DESCRIPTION
1734
+ Get one release by id.
1735
+
1736
+ EXAMPLES
1737
+ $ zitadel releases get <id>
1738
+
1739
+ $ zitadel releases get <id> --json
1740
+ ```
1741
+
1742
+ ## `zitadel releases list`
1743
+
1744
+ List releases.
1745
+
1746
+ ```
1747
+ USAGE
1748
+ $ zitadel releases list [--json] [-c <value>] [-s <value>] [-n]
1749
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
1750
+ --page-token <value>] [--fields <value>] [--plain]
1751
+
1752
+ FLAGS
1753
+ -a, --all Fetch every page instead of one.
1754
+ -c, --cwd=<value> Project directory to operate on.
1755
+ -n, --non-interactive Disable prompts. Required when scripting or running
1756
+ as an agent.
1757
+ -s, --server=<value> Override the resolved server URL.
1758
+ -v, --verbose Verbose logging.
1759
+ --[no-]color Colorize human output. Disable with --no-color;
1760
+ NO_COLOR and FORCE_COLOR are honored too.
1761
+ --debug Debug logging.
1762
+ --dry-run Preview without mutating files or the platform.
1763
+ --fields=<value> Columns to show, comma-separated dot-paths (e.g.
1764
+ id,attributes.email). Defaults to the resource's own
1765
+ columns; `--json` is unaffected.
1766
+ --limit=<value> Page size (server default 20, max 100).
1767
+ --page-token=<value> Continue from a previous page's next_page_token.
1768
+ --plain Tab-separated rows with no header, for piping.
1769
+ Implied when stdout is not a terminal.
1770
+ --[no-]telemetry Send anonymous usage analytics. Disable with
1771
+ --no-telemetry.
1772
+
1773
+ GLOBAL FLAGS
1774
+ --json Format output as json.
1775
+
1776
+ DESCRIPTION
1777
+ List releases.
1778
+
1779
+ EXAMPLES
1780
+ $ zitadel releases list --json
1781
+
1782
+ $ zitadel releases list --all --json
1783
+ ```
1784
+
1785
+ ## `zitadel reset`
1786
+
1787
+ Delete the local Zitadel server runtime and data.
1788
+
1789
+ ```
1790
+ USAGE
1791
+ $ zitadel reset [--json] [-c <value>] [-s <value>] [-n]
1792
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-f]
1793
+
1794
+ FLAGS
1795
+ -c, --cwd=<value> Project directory to operate on.
1796
+ -f, --force Delete the local runtime and its data without the
1797
+ confirmation prompt.
1798
+ -n, --non-interactive Disable prompts. Required when scripting or running as
1799
+ an agent.
1800
+ -s, --server=<value> Override the resolved server URL.
1801
+ -v, --verbose Verbose logging.
1802
+ --[no-]color Colorize human output. Disable with --no-color;
1803
+ NO_COLOR and FORCE_COLOR are honored too.
1804
+ --debug Debug logging.
1805
+ --dry-run Preview without mutating files or the platform.
1806
+ --[no-]telemetry Send anonymous usage analytics. Disable with
1807
+ --no-telemetry.
1808
+
1809
+ GLOBAL FLAGS
1810
+ --json Format output as json.
1811
+
1812
+ DESCRIPTION
1813
+ Delete the local Zitadel server runtime and data.
1814
+ ```
1815
+
1816
+ ## `zitadel resources`
1817
+
1818
+ List the resources this CLI manages and what can be done to each.
1819
+
1820
+ ```
1821
+ USAGE
1822
+ $ zitadel resources [--json] [-c <value>] [-s <value>] [-n]
1823
+ [--dry-run] [-v] [--debug] [--color] [--telemetry]
1824
+
1825
+ FLAGS
1826
+ -c, --cwd=<value> Project directory to operate on.
1827
+ -n, --non-interactive Disable prompts. Required when scripting or running as
1828
+ an agent.
1829
+ -s, --server=<value> Override the resolved server URL.
1830
+ -v, --verbose Verbose logging.
1831
+ --[no-]color Colorize human output. Disable with --no-color;
1832
+ NO_COLOR and FORCE_COLOR are honored too.
1833
+ --debug Debug logging.
1834
+ --dry-run Preview without mutating files or the platform.
1835
+ --[no-]telemetry Send anonymous usage analytics. Disable with
1836
+ --no-telemetry.
1837
+
1838
+ GLOBAL FLAGS
1839
+ --json Format output as json.
1840
+
1841
+ DESCRIPTION
1842
+ List the resources this CLI manages and what can be done to each.
1843
+
1844
+ EXAMPLES
1845
+ $ zitadel resources
1846
+
1847
+ $ zitadel resources --json
1848
+
1849
+ $ zitadel resources --json | jq -r '.data.resources[] | "\(.topic): \(.verbs | join(", "))"'
1850
+ ```
1851
+
1852
+ ## `zitadel schemas get SCHEMA`
1853
+
1854
+ Get one schema by id.
1855
+
1856
+ ```
1857
+ USAGE
1858
+ $ zitadel schemas get SCHEMA [--json] [-c <value>] [-s <value>] [-n]
1859
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
1860
+
1861
+ ARGUMENTS
1862
+ SCHEMA object type (current revision) or revision id
1863
+
1864
+ FLAGS
1865
+ -c, --cwd=<value> Project directory to operate on.
1866
+ -n, --non-interactive Disable prompts. Required when scripting or running as
1867
+ an agent.
1868
+ -s, --server=<value> Override the resolved server URL.
1869
+ -v, --verbose Verbose logging.
1870
+ --[no-]color Colorize human output. Disable with --no-color;
1871
+ NO_COLOR and FORCE_COLOR are honored too.
1872
+ --debug Debug logging.
1873
+ --dry-run Preview without mutating files or the platform.
1874
+ --fields=<value> Fields to show, comma-separated dot-paths. Defaults to
1875
+ the resource's own; `--json` is unaffected.
1876
+ --[no-]telemetry Send anonymous usage analytics. Disable with
1877
+ --no-telemetry.
1878
+
1879
+ GLOBAL FLAGS
1880
+ --json Format output as json.
1881
+
1882
+ DESCRIPTION
1883
+ Get one schema by id.
1884
+
1885
+ EXAMPLES
1886
+ $ zitadel schemas get <id>
1887
+
1888
+ $ zitadel schemas get <id> --json
1889
+ ```
1890
+
1891
+ ## `zitadel schemas list`
1892
+
1893
+ List schemas.
1894
+
1895
+ ```
1896
+ USAGE
1897
+ $ zitadel schemas list [--json] [-c <value>] [-s <value>] [-n]
1898
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
1899
+ --page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
1900
+
1901
+ FLAGS
1902
+ -a, --all Fetch every page instead of one.
1903
+ -c, --cwd=<value> Project directory to operate on.
1904
+ -n, --non-interactive Disable prompts. Required when scripting or running
1905
+ as an agent.
1906
+ -s, --server=<value> Override the resolved server URL.
1907
+ -v, --verbose Verbose logging.
1908
+ --[no-]color Colorize human output. Disable with --no-color;
1909
+ NO_COLOR and FORCE_COLOR are honored too.
1910
+ --debug Debug logging.
1911
+ --dry-run Preview without mutating files or the platform.
1912
+ --fields=<value> Columns to show, comma-separated dot-paths (e.g.
1913
+ id,attributes.email). Defaults to the resource's own
1914
+ columns; `--json` is unaffected.
1915
+ --filter=<value>... Filter as field=operation:value (operation defaults
1916
+ to equals). Fields: object_type (equals), kind
1917
+ (equals), revisions (equals; values all|latest).
1918
+ --limit=<value> Page size (server default 20, max 100).
1919
+ --page-token=<value> Continue from a previous page's next_page_token.
1920
+ --plain Tab-separated rows with no header, for piping.
1921
+ Implied when stdout is not a terminal.
1922
+ --[no-]telemetry Send anonymous usage analytics. Disable with
1923
+ --no-telemetry.
1924
+
1925
+ GLOBAL FLAGS
1926
+ --json Format output as json.
1927
+
1928
+ DESCRIPTION
1929
+ List schemas.
1930
+
1931
+ EXAMPLES
1932
+ $ zitadel schemas list --json
1933
+
1934
+ $ zitadel schemas list --all --json
1935
+
1936
+ $ zitadel schemas list --filter object_type=equals:<value>
1937
+ ```
1938
+
1939
+ ## `zitadel search`
1940
+
1941
+ Search for a command.
1942
+
1943
+ ```
1944
+ USAGE
1945
+ $ zitadel search
1946
+
1947
+ DESCRIPTION
1948
+ Search for a command.
1949
+
1950
+ Once you select a command, hit enter and it will show the help for that
1951
+ command.
1952
+ ```
1953
+
1954
+ _See code: [@oclif/plugin-search](https://github.com/oclif/plugin-search/blob/v1.2.50/src/commands/search.ts)_
1955
+
1956
+ ## `zitadel sessions get ID`
1957
+
1958
+ Get one session by id.
1959
+
1960
+ ```
1961
+ USAGE
1962
+ $ zitadel sessions get ID [--json] [-c <value>] [-s <value>] [-n]
1963
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
1964
+
1965
+ ARGUMENTS
1966
+ ID session id
1967
+
1968
+ FLAGS
1969
+ -c, --cwd=<value> Project directory to operate on.
1970
+ -n, --non-interactive Disable prompts. Required when scripting or running as
1971
+ an agent.
1972
+ -s, --server=<value> Override the resolved server URL.
1973
+ -v, --verbose Verbose logging.
1974
+ --[no-]color Colorize human output. Disable with --no-color;
1975
+ NO_COLOR and FORCE_COLOR are honored too.
1976
+ --debug Debug logging.
1977
+ --dry-run Preview without mutating files or the platform.
1978
+ --fields=<value> Fields to show, comma-separated dot-paths. Defaults to
1979
+ the resource's own; `--json` is unaffected.
1980
+ --[no-]telemetry Send anonymous usage analytics. Disable with
1981
+ --no-telemetry.
1982
+
1983
+ GLOBAL FLAGS
1984
+ --json Format output as json.
1985
+
1986
+ DESCRIPTION
1987
+ Get one session by id.
1988
+
1989
+ EXAMPLES
1990
+ $ zitadel sessions get <id>
1991
+
1992
+ $ zitadel sessions get <id> --json
1993
+ ```
1994
+
1995
+ ## `zitadel sessions list`
1996
+
1997
+ List sessions.
1998
+
1999
+ ```
2000
+ USAGE
2001
+ $ zitadel sessions list [--json] [-c <value>] [-s <value>] [-n]
2002
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
2003
+ --page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
2004
+ [--sort <value>]
2005
+
2006
+ FLAGS
2007
+ -a, --all
2008
+ Fetch every page instead of one.
2009
+
2010
+ -c, --cwd=<value>
2011
+ Project directory to operate on.
2012
+
2013
+ -n, --non-interactive
2014
+ Disable prompts. Required when scripting or running as an agent.
2015
+
2016
+ -s, --server=<value>
2017
+ Override the resolved server URL.
2018
+
2019
+ -v, --verbose
2020
+ Verbose logging.
2021
+
2022
+ --[no-]color
2023
+ Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are
2024
+ honored too.
2025
+
2026
+ --debug
2027
+ Debug logging.
2028
+
2029
+ --dry-run
2030
+ Preview without mutating files or the platform.
2031
+
2032
+ --fields=<value>
2033
+ Columns to show, comma-separated dot-paths (e.g. id,attributes.email).
2034
+ Defaults to the resource's own columns; `--json` is unaffected.
2035
+
2036
+ --filter=<value>...
2037
+ Filter as field=operation:value (operation defaults to equals). Fields:
2038
+ created_at (equals|not_equals|contains|not_contains|less_than|less_than_or_e
2039
+ qual|greater_than|greater_than_or_equal), user_id
2040
+ (equals|not_equals|contains|not_contains|less_than|less_than_or_equal|greate
2041
+ r_than|greater_than_or_equal), state (equals|not_equals|contains|not_contain
2042
+ s|less_than|less_than_or_equal|greater_than|greater_than_or_equal),
2043
+ lifecycle_owner_team_id (equals|not_equals|contains|not_contains|less_than|l
2044
+ ess_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: created_at, user_id.
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 sessions.
2067
+
2068
+ EXAMPLES
2069
+ $ zitadel sessions list --json
2070
+
2071
+ $ zitadel sessions list --all --json
2072
+
2073
+ $ zitadel sessions list --filter created_at=equals:<value> --sort created_at:desc
2074
+ ```
2075
+
2076
+ ## `zitadel sessions revoke ID`
2077
+
2078
+ Revoke a session by id.
2079
+
2080
+ ```
2081
+ USAGE
2082
+ $ zitadel sessions revoke ID [--json] [-c <value>] [-s <value>] [-n]
2083
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-f]
2084
+
2085
+ ARGUMENTS
2086
+ ID session id
2087
+
2088
+ FLAGS
2089
+ -c, --cwd=<value> Project directory to operate on.
2090
+ -f, --force Revoke the session without the confirmation prompt.
2091
+ Required when non-interactive.
2092
+ -n, --non-interactive Disable prompts. Required when scripting or running as
2093
+ an agent.
2094
+ -s, --server=<value> Override the resolved server URL.
2095
+ -v, --verbose Verbose logging.
2096
+ --[no-]color Colorize human output. Disable with --no-color;
2097
+ NO_COLOR and FORCE_COLOR are honored too.
2098
+ --debug Debug logging.
2099
+ --dry-run Preview without mutating files or the platform.
2100
+ --[no-]telemetry Send anonymous usage analytics. Disable with
2101
+ --no-telemetry.
2102
+
2103
+ GLOBAL FLAGS
2104
+ --json Format output as json.
2105
+
2106
+ DESCRIPTION
2107
+ Revoke a session by id.
2108
+
2109
+ EXAMPLES
2110
+ $ zitadel sessions revoke <id> --force --json
2111
+ ```
2112
+
2113
+ ## `zitadel setup`
2114
+
2115
+ Create a Zitadel project and scaffold local auth.
2116
+
2117
+ ```
2118
+ USAGE
2119
+ $ zitadel setup [--json] [-c <value>] [-s <value>] [-n]
2120
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-f] [--framework
2121
+ next|nuxt|tanstack-start|react|vue|solid-start|solid|sveltekit|svelte|qwik-r
2122
+ outer|qwik|angular] [--renderer react] [--dev-port <value>] [--skip-install]
2123
+ [--preset password-first|passkey-first] [--use-case
2124
+ minimal|consumer|business] [--sso google|custom] [--sso-client-id <value>]
2125
+ [--sso-slug <value>] [--sso-display-name <value>] [--sso-issuer <value>]
2126
+ [--sso-scopes <value>]
2127
+
2128
+ FLAGS
2129
+ -c, --cwd=<value>
2130
+ Project directory to operate on.
2131
+
2132
+ -f, --force
2133
+ Overwrite managed files that already exist, and scaffold into a non-empty
2134
+ directory.
2135
+
2136
+ -n, --non-interactive
2137
+ Disable prompts. Required when scripting or running as an agent.
2138
+
2139
+ -s, --server=<value>
2140
+ Override the resolved server URL.
2141
+
2142
+ -v, --verbose
2143
+ Verbose logging.
2144
+
2145
+ --[no-]color
2146
+ Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are
2147
+ honored too.
2148
+
2149
+ --debug
2150
+ Debug logging.
2151
+
2152
+ --dev-port=<value>
2153
+ Dev-server port; also the issuer origin registered with Zitadel. Defaults to
2154
+ the detected port. Use distinct ports to run several scaffolded apps side by
2155
+ side.
2156
+
2157
+ --dry-run
2158
+ Preview without mutating files or the platform.
2159
+
2160
+ --framework=<option>
2161
+ Framework to target.
2162
+ <options: next|nuxt|tanstack-start|react|vue|solid-start|solid|sveltekit|sve
2163
+ lte|qwik-router|qwik|angular>
2164
+
2165
+ --preset=<option>
2166
+ Sign-in preset for the scaffolded schema and login flow (default:
2167
+ password-first).
2168
+ <options: password-first|passkey-first>
2169
+
2170
+ --renderer=<option>
2171
+ Renderer (default: react). Not yet available: web-component.
2172
+ <options: react>
2173
+
2174
+ --skip-install
2175
+ Do not install dependencies after setup updates package.json.
2176
+
2177
+ --sso=<option>
2178
+ Social sign-in provider to enable while scaffolding, e.g. google. Skips the
2179
+ wizard's provider question; needs --sso-client-id, and the OAuth application
2180
+ must already be registered with the provider. Pipe the client secret in on
2181
+ stdin; never pass it as a flag.
2182
+ <options: google|custom>
2183
+
2184
+ --sso-client-id=<value>
2185
+ Client id of the OAuth application registered with the --sso provider.
2186
+
2187
+ --sso-display-name=<value>
2188
+ With --sso custom: the name shown on the sign-in button.
2189
+
2190
+ --sso-issuer=<value>
2191
+ With --sso custom: the provider's issuer URL. Its endpoints come from OIDC
2192
+ discovery.
2193
+
2194
+ --sso-scopes=<value>
2195
+ With --sso custom: the scopes to request, separated by spaces or commas.
2196
+ Must include openid. Default: openid profile email.
2197
+
2198
+ --sso-slug=<value>
2199
+ With --sso custom: the name of the connection. Schemas and flows refer to
2200
+ it.
2201
+
2202
+ --[no-]telemetry
2203
+ Send anonymous usage analytics. Disable with --no-telemetry.
2204
+
2205
+ --use-case=<option>
2206
+ Use case for the scaffolded schema fields: who signs in to the app (default:
2207
+ minimal).
2208
+ <options: minimal|consumer|business>
2209
+
2210
+ GLOBAL FLAGS
2211
+ --json Format output as json.
2212
+
2213
+ DESCRIPTION
2214
+ Create a Zitadel project and scaffold local auth.
2215
+
2216
+ EXAMPLES
2217
+ $ zitadel setup --framework next
2218
+
2219
+ $ zitadel setup --framework react --dev-port 3000
2220
+ ```
2221
+
2222
+ ## `zitadel start`
2223
+
2224
+ Start a local Zitadel server.
2225
+
2226
+ ```
2227
+ USAGE
2228
+ $ zitadel start [--json] [-c <value>] [-s <value>] [-n]
2229
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--image <value>] [--port
2230
+ <value>] [--runtime binary|docker]
2231
+
2232
+ FLAGS
2233
+ -c, --cwd=<value> Project directory to operate on.
2234
+ -n, --non-interactive Disable prompts. Required when scripting or running as
2235
+ an agent.
2236
+ -s, --server=<value> Override the resolved server URL.
2237
+ -v, --verbose Verbose logging.
2238
+ --[no-]color Colorize human output. Disable with --no-color;
2239
+ NO_COLOR and FORCE_COLOR are honored too.
2240
+ --debug Debug logging.
2241
+ --dry-run Preview without mutating files or the platform.
2242
+ --image=<value> Container image to run.
2243
+ --port=<value> Local HTTP port. By default this directory keeps the
2244
+ port it had, or takes the first free one from 8080.
2245
+ --runtime=<option> Local runtime backend.
2246
+ <options: binary|docker>
2247
+ --[no-]telemetry Send anonymous usage analytics. Disable with
2248
+ --no-telemetry.
2249
+
2250
+ GLOBAL FLAGS
2251
+ --json Format output as json.
2252
+
2253
+ DESCRIPTION
2254
+ Start a local Zitadel server.
2255
+ ```
2256
+
2257
+ ## `zitadel status`
2258
+
2259
+ Summarize the local Zitadel server and project state.
2260
+
2261
+ ```
2262
+ USAGE
2263
+ $ zitadel status [--json] [-c <value>] [-s <value>] [-n]
2264
+ [--dry-run] [-v] [--debug] [--color] [--telemetry]
2265
+
2266
+ FLAGS
2267
+ -c, --cwd=<value> Project directory to operate on.
2268
+ -n, --non-interactive Disable prompts. Required when scripting or running as
2269
+ an agent.
2270
+ -s, --server=<value> Override the resolved server URL.
2271
+ -v, --verbose Verbose logging.
2272
+ --[no-]color Colorize human output. Disable with --no-color;
2273
+ NO_COLOR and FORCE_COLOR are honored too.
2274
+ --debug Debug logging.
2275
+ --dry-run Preview without mutating files or the platform.
2276
+ --[no-]telemetry Send anonymous usage analytics. Disable with
2277
+ --no-telemetry.
2278
+
2279
+ GLOBAL FLAGS
2280
+ --json Format output as json.
2281
+
2282
+ DESCRIPTION
2283
+ Summarize the local Zitadel server and project state.
2284
+ ```
2285
+
2286
+ ## `zitadel stop`
2287
+
2288
+ Stop the local Zitadel server.
2289
+
2290
+ ```
2291
+ USAGE
2292
+ $ zitadel stop [--json] [-c <value>] [-s <value>] [-n]
2293
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--all]
2294
+
2295
+ FLAGS
2296
+ -c, --cwd=<value> Project directory to operate on.
2297
+ -n, --non-interactive Disable prompts. Required when scripting or running as
2298
+ an agent.
2299
+ -s, --server=<value> Override the resolved server URL.
2300
+ -v, --verbose Verbose logging.
2301
+ --all Stop all discovered CLI-managed local Zitadel runtime
2302
+ processes.
2303
+ --[no-]color Colorize human output. Disable with --no-color;
2304
+ NO_COLOR and FORCE_COLOR are honored too.
2305
+ --debug Debug logging.
2306
+ --dry-run Preview without mutating files or the platform.
2307
+ --[no-]telemetry Send anonymous usage analytics. Disable with
2308
+ --no-telemetry.
2309
+
2310
+ GLOBAL FLAGS
2311
+ --json Format output as json.
2312
+
2313
+ DESCRIPTION
2314
+ Stop the local Zitadel server.
2315
+ ```
2316
+
2317
+ ## `zitadel teams create`
2318
+
2319
+ Create a team.
2320
+
2321
+ ```
2322
+ USAGE
2323
+ $ zitadel teams create [--json] [-c <value>] [-s <value>] [-n]
2324
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--name <value>] [--data
2325
+ <value> | --file <value>] [--set <value>...]
2326
+
2327
+ FLAGS
2328
+ -c, --cwd=<value> Project directory to operate on.
2329
+ -n, --non-interactive Disable prompts. Required when scripting or running as
2330
+ an agent.
2331
+ -s, --server=<value> Override the resolved server URL.
2332
+ -v, --verbose Verbose logging.
2333
+ --[no-]color Colorize human output. Disable with --no-color;
2334
+ NO_COLOR and FORCE_COLOR are honored too.
2335
+ --debug Debug logging.
2336
+ --dry-run Preview without mutating files or the platform.
2337
+ --[no-]telemetry Send anonymous usage analytics. Disable with
2338
+ --no-telemetry.
2339
+
2340
+ RAW BODY FLAGS
2341
+ --data=<value> Whole body as a JSON object. Field flags and --set apply
2342
+ over it.
2343
+ --file=<value> Read the body from a JSON file; `-` reads stdin. Field flags
2344
+ and --set apply over it.
2345
+ --set=<value>... Set one field by its dot path: path=value, or path:=json for
2346
+ JSON. Repeatable; applied after the field flags, in order. A
2347
+ key that contains a dot is set through its parent: --set
2348
+ 'parent:={"a.b":"x"}'.
2349
+
2350
+ GLOBAL FLAGS
2351
+ --json Format output as json.
2352
+
2353
+ REQUIRED FIELD FLAGS
2354
+ --name=<value> (required) The name of the team.
2355
+
2356
+ DESCRIPTION
2357
+ Create a team.
2358
+
2359
+ EXAMPLES
2360
+ $ zitadel teams create --name <name> --json
2361
+
2362
+ $ zitadel teams create --data '{...}' --json
2363
+
2364
+ $ zitadel teams create --file ./team.json
2365
+ ```
2366
+
2367
+ ## `zitadel teams deactivate ID`
2368
+
2369
+ Deactivate a team by id.
2370
+
2371
+ ```
2372
+ USAGE
2373
+ $ zitadel teams deactivate ID [--json] [-c <value>] [-s <value>] [-n]
2374
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-f]
2375
+
2376
+ ARGUMENTS
2377
+ ID team id
2378
+
2379
+ FLAGS
2380
+ -c, --cwd=<value> Project directory to operate on.
2381
+ -f, --force Deactivate the team without the confirmation prompt.
2382
+ Required when non-interactive.
2383
+ -n, --non-interactive Disable prompts. Required when scripting or running as
2384
+ an agent.
2385
+ -s, --server=<value> Override the resolved server URL.
2386
+ -v, --verbose Verbose logging.
2387
+ --[no-]color Colorize human output. Disable with --no-color;
2388
+ NO_COLOR and FORCE_COLOR are honored too.
2389
+ --debug Debug logging.
2390
+ --dry-run Preview without mutating files or the platform.
2391
+ --[no-]telemetry Send anonymous usage analytics. Disable with
2392
+ --no-telemetry.
2393
+
2394
+ GLOBAL FLAGS
2395
+ --json Format output as json.
2396
+
2397
+ DESCRIPTION
2398
+ Deactivate a team by id.
2399
+
2400
+ EXAMPLES
2401
+ $ zitadel teams deactivate <id> --force --json
2402
+ ```
2403
+
2404
+ ## `zitadel teams get ID`
2405
+
2406
+ Get one team by id.
2407
+
2408
+ ```
2409
+ USAGE
2410
+ $ zitadel teams get ID [--json] [-c <value>] [-s <value>] [-n]
2411
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
2412
+
2413
+ ARGUMENTS
2414
+ ID team id
2415
+
2416
+ FLAGS
2417
+ -c, --cwd=<value> Project directory to operate on.
2418
+ -n, --non-interactive Disable prompts. Required when scripting or running as
2419
+ an agent.
2420
+ -s, --server=<value> Override the resolved server URL.
2421
+ -v, --verbose Verbose logging.
2422
+ --[no-]color Colorize human output. Disable with --no-color;
2423
+ NO_COLOR and FORCE_COLOR are honored too.
2424
+ --debug Debug logging.
2425
+ --dry-run Preview without mutating files or the platform.
2426
+ --fields=<value> Fields to show, comma-separated dot-paths. Defaults to
2427
+ the resource's own; `--json` is unaffected.
2428
+ --[no-]telemetry Send anonymous usage analytics. Disable with
2429
+ --no-telemetry.
2430
+
2431
+ GLOBAL FLAGS
2432
+ --json Format output as json.
2433
+
2434
+ DESCRIPTION
2435
+ Get one team by id.
2436
+
2437
+ EXAMPLES
2438
+ $ zitadel teams get <id>
2439
+
2440
+ $ zitadel teams get <id> --json
2441
+ ```
2442
+
2443
+ ## `zitadel teams list`
2444
+
2445
+ List teams.
2446
+
2447
+ ```
2448
+ USAGE
2449
+ $ zitadel teams list [--json] [-c <value>] [-s <value>] [-n]
2450
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
2451
+ --page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
2452
+ [--sort <value>]
2453
+
2454
+ FLAGS
2455
+ -a, --all
2456
+ Fetch every page instead of one.
2457
+
2458
+ -c, --cwd=<value>
2459
+ Project directory to operate on.
2460
+
2461
+ -n, --non-interactive
2462
+ Disable prompts. Required when scripting or running as an agent.
2463
+
2464
+ -s, --server=<value>
2465
+ Override the resolved server URL.
2466
+
2467
+ -v, --verbose
2468
+ Verbose logging.
2469
+
2470
+ --[no-]color
2471
+ Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are
2472
+ honored too.
2473
+
2474
+ --debug
2475
+ Debug logging.
2476
+
2477
+ --dry-run
2478
+ Preview without mutating files or the platform.
2479
+
2480
+ --fields=<value>
2481
+ Columns to show, comma-separated dot-paths (e.g. id,attributes.email).
2482
+ Defaults to the resource's own columns; `--json` is unaffected.
2483
+
2484
+ --filter=<value>...
2485
+ Filter as field=operation:value (operation defaults to equals). Fields:
2486
+ created_at (equals|not_equals|contains|not_contains|less_than|less_than_or_e
2487
+ qual|greater_than|greater_than_or_equal), name
2488
+ (equals|not_equals|contains|not_contains|less_than|less_than_or_equal|greate
2489
+ r_than|greater_than_or_equal), status (equals|not_equals|contains|not_contai
2490
+ ns|less_than|less_than_or_equal|greater_than|greater_than_or_equal).
2491
+
2492
+ --limit=<value>
2493
+ Page size (server default 20, max 100).
2494
+
2495
+ --page-token=<value>
2496
+ Continue from a previous page's next_page_token.
2497
+
2498
+ --plain
2499
+ Tab-separated rows with no header, for piping. Implied when stdout is not a
2500
+ terminal.
2501
+
2502
+ --sort=<value>
2503
+ Sort as field:direction (asc|desc). Fields: created_at, name, status.
2504
+
2505
+ --[no-]telemetry
2506
+ Send anonymous usage analytics. Disable with --no-telemetry.
2507
+
2508
+ GLOBAL FLAGS
2509
+ --json Format output as json.
2510
+
2511
+ DESCRIPTION
2512
+ List teams.
2513
+
2514
+ EXAMPLES
2515
+ $ zitadel teams list --json
2516
+
2517
+ $ zitadel teams list --all --json
2518
+
2519
+ $ zitadel teams list --filter created_at=equals:<value> --sort created_at:desc
2520
+ ```
2521
+
2522
+ ## `zitadel teams update ID`
2523
+
2524
+ Update a team by id.
2525
+
2526
+ ```
2527
+ USAGE
2528
+ $ zitadel teams update ID [--json] [-c <value>] [-s <value>] [-n]
2529
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--name <value>] [--data
2530
+ <value> | --file <value>] [--set <value>...]
2531
+
2532
+ ARGUMENTS
2533
+ ID team id
2534
+
2535
+ FLAGS
2536
+ -c, --cwd=<value> Project directory to operate on.
2537
+ -n, --non-interactive Disable prompts. Required when scripting or running as
2538
+ an agent.
2539
+ -s, --server=<value> Override the resolved server URL.
2540
+ -v, --verbose Verbose logging.
2541
+ --[no-]color Colorize human output. Disable with --no-color;
2542
+ NO_COLOR and FORCE_COLOR are honored too.
2543
+ --debug Debug logging.
2544
+ --dry-run Preview without mutating files or the platform.
2545
+ --[no-]telemetry Send anonymous usage analytics. Disable with
2546
+ --no-telemetry.
2547
+
2548
+ RAW BODY FLAGS
2549
+ --data=<value> Whole body as a JSON object. Field flags and --set apply
2550
+ over it.
2551
+ --file=<value> Read the body from a JSON file; `-` reads stdin. Field flags
2552
+ and --set apply over it.
2553
+ --set=<value>... Set one field by its dot path: path=value, or path:=json for
2554
+ JSON. Repeatable; applied after the field flags, in order. A
2555
+ key that contains a dot is set through its parent: --set
2556
+ 'parent:={"a.b":"x"}'.
2557
+
2558
+ GLOBAL FLAGS
2559
+ --json Format output as json.
2560
+
2561
+ OPTIONAL FIELD FLAGS
2562
+ --name=<value> The name of the team.
2563
+
2564
+ DESCRIPTION
2565
+ Update a team by id.
2566
+
2567
+ EXAMPLES
2568
+ $ zitadel teams update <id> --data '{...}' --json
2569
+
2570
+ $ zitadel teams update <id> --file ./team.json
2571
+ ```
2572
+
2573
+ ## `zitadel uninstall`
2574
+
2575
+ Remove managed files and local Zitadel state.
2576
+
2577
+ ```
2578
+ USAGE
2579
+ $ zitadel uninstall [--json] [-c <value>] [-s <value>] [-n]
2580
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-f]
2581
+
2582
+ FLAGS
2583
+ -c, --cwd=<value> Project directory to operate on.
2584
+ -f, --force Remove the managed files without the confirmation
2585
+ prompt.
2586
+ -n, --non-interactive Disable prompts. Required when scripting or running as
2587
+ an agent.
2588
+ -s, --server=<value> Override the resolved server URL.
2589
+ -v, --verbose Verbose logging.
2590
+ --[no-]color Colorize human output. Disable with --no-color;
2591
+ NO_COLOR and FORCE_COLOR are honored too.
2592
+ --debug Debug logging.
2593
+ --dry-run Preview without mutating files or the platform.
2594
+ --[no-]telemetry Send anonymous usage analytics. Disable with
2595
+ --no-telemetry.
2596
+
2597
+ GLOBAL FLAGS
2598
+ --json Format output as json.
2599
+
2600
+ DESCRIPTION
2601
+ Remove managed files and local Zitadel state.
2602
+
2603
+ ALIASES
2604
+ $ zitadel uninstall
2605
+ ```
2606
+
2607
+ ## `zitadel users create`
2608
+
2609
+ Create a user.
2610
+
2611
+ ```
2612
+ USAGE
2613
+ $ zitadel users create [--json] [-c <value>] [-s <value>] [-n]
2614
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--schema <value>]
2615
+ [--attributes <value>...] [--data <value> | --file <value>] [--set
2616
+ <value>...]
2617
+
2618
+ FLAGS
2619
+ -c, --cwd=<value> Project directory to operate on.
2620
+ -n, --non-interactive Disable prompts. Required when scripting or running as
2621
+ an agent.
2622
+ -s, --server=<value> Override the resolved server URL.
2623
+ -v, --verbose Verbose logging.
2624
+ --[no-]color Colorize human output. Disable with --no-color;
2625
+ NO_COLOR and FORCE_COLOR are honored too.
2626
+ --debug Debug logging.
2627
+ --dry-run Preview without mutating files or the platform.
2628
+ --[no-]telemetry Send anonymous usage analytics. Disable with
2629
+ --no-telemetry.
2630
+
2631
+ REQUIRED FIELD FLAGS
2632
+ --attributes=<value>... (required) Repeatable attributes entry: key=value for
2633
+ a string, key:=value for JSON. The user's
2634
+ schema-defined content.
2635
+ --schema=<value> (required) The schema that defines the content of
2636
+ `attributes`.
2637
+
2638
+ RAW BODY FLAGS
2639
+ --data=<value> Whole body as a JSON object. Field flags and --set apply
2640
+ over it.
2641
+ --file=<value> Read the body from a JSON file; `-` reads stdin. Field flags
2642
+ and --set apply over it.
2643
+ --set=<value>... Set one field by its dot path: path=value, or path:=json for
2644
+ JSON. Repeatable; applied after the field flags, in order. A
2645
+ key that contains a dot is set through its parent: --set
2646
+ 'parent:={"a.b":"x"}'.
2647
+
2648
+ GLOBAL FLAGS
2649
+ --json Format output as json.
2650
+
2651
+ DESCRIPTION
2652
+ Create a user.
2653
+
2654
+ EXAMPLES
2655
+ $ zitadel users create --schema <schema> --attributes <key>=<value> --json
2656
+
2657
+ $ zitadel users create --data '{...}' --json
2658
+
2659
+ $ zitadel users create --file ./user.json
2660
+ ```
2661
+
2662
+ ## `zitadel users delete ID`
2663
+
2664
+ Delete a user by id.
2665
+
2666
+ ```
2667
+ USAGE
2668
+ $ zitadel users delete ID [--json] [-c <value>] [-s <value>] [-n]
2669
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [-f]
2670
+
2671
+ ARGUMENTS
2672
+ ID user id
2673
+
2674
+ FLAGS
2675
+ -c, --cwd=<value> Project directory to operate on.
2676
+ -f, --force Delete the user without the confirmation prompt.
2677
+ Required when non-interactive.
2678
+ -n, --non-interactive Disable prompts. Required when scripting or running as
2679
+ an agent.
2680
+ -s, --server=<value> Override the resolved server URL.
2681
+ -v, --verbose Verbose logging.
2682
+ --[no-]color Colorize human output. Disable with --no-color;
2683
+ NO_COLOR and FORCE_COLOR are honored too.
2684
+ --debug Debug logging.
2685
+ --dry-run Preview without mutating files or the platform.
2686
+ --[no-]telemetry Send anonymous usage analytics. Disable with
2687
+ --no-telemetry.
2688
+
2689
+ GLOBAL FLAGS
2690
+ --json Format output as json.
2691
+
2692
+ DESCRIPTION
2693
+ Delete a user by id.
2694
+
2695
+ EXAMPLES
2696
+ $ zitadel users delete <id> --force --json
2697
+ ```
2698
+
2699
+ ## `zitadel users get ID`
2700
+
2701
+ Get one user by id.
2702
+
2703
+ ```
2704
+ USAGE
2705
+ $ zitadel users get ID [--json] [-c <value>] [-s <value>] [-n]
2706
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--fields <value>]
2707
+
2708
+ ARGUMENTS
2709
+ ID user id
2710
+
2711
+ FLAGS
2712
+ -c, --cwd=<value> Project directory to operate on.
2713
+ -n, --non-interactive Disable prompts. Required when scripting or running as
2714
+ an agent.
2715
+ -s, --server=<value> Override the resolved server URL.
2716
+ -v, --verbose Verbose logging.
2717
+ --[no-]color Colorize human output. Disable with --no-color;
2718
+ NO_COLOR and FORCE_COLOR are honored too.
2719
+ --debug Debug logging.
2720
+ --dry-run Preview without mutating files or the platform.
2721
+ --fields=<value> Fields to show, comma-separated dot-paths. Defaults to
2722
+ the resource's own; `--json` is unaffected.
2723
+ --[no-]telemetry Send anonymous usage analytics. Disable with
2724
+ --no-telemetry.
2725
+
2726
+ GLOBAL FLAGS
2727
+ --json Format output as json.
2728
+
2729
+ DESCRIPTION
2730
+ Get one user by id.
2731
+
2732
+ EXAMPLES
2733
+ $ zitadel users get <id>
2734
+
2735
+ $ zitadel users get <id> --json
2736
+ ```
2737
+
2738
+ ## `zitadel users list`
2739
+
2740
+ List users.
2741
+
2742
+ ```
2743
+ USAGE
2744
+ $ zitadel users list [--json] [-c <value>] [-s <value>] [-n]
2745
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--limit <value>] [-a |
2746
+ --page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
2747
+ [--sort <value>]
2748
+
2749
+ FLAGS
2750
+ -a, --all
2751
+ Fetch every page instead of one.
2752
+
2753
+ -c, --cwd=<value>
2754
+ Project directory to operate on.
2755
+
2756
+ -n, --non-interactive
2757
+ Disable prompts. Required when scripting or running as an agent.
2758
+
2759
+ -s, --server=<value>
2760
+ Override the resolved server URL.
2761
+
2762
+ -v, --verbose
2763
+ Verbose logging.
2764
+
2765
+ --[no-]color
2766
+ Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are
2767
+ honored too.
2768
+
2769
+ --debug
2770
+ Debug logging.
2771
+
2772
+ --dry-run
2773
+ Preview without mutating files or the platform.
2774
+
2775
+ --fields=<value>
2776
+ Columns to show, comma-separated dot-paths (e.g. id,attributes.email).
2777
+ Defaults to the resource's own columns; `--json` is unaffected.
2778
+
2779
+ --filter=<value>...
2780
+ Filter as field=operation:value (operation defaults to equals). Fields:
2781
+ created_at (equals|not_equals|contains|not_contains|less_than|less_than_or_e
2782
+ qual|greater_than|greater_than_or_equal), id (equals|not_equals|contains|not
2783
+ _contains|less_than|less_than_or_equal|greater_than|greater_than_or_equal),
2784
+ schema (equals|not_equals|contains|not_contains|less_than|less_than_or_equal
2785
+ |greater_than|greater_than_or_equal), status (equals|not_equals|contains|not
2786
+ _contains|less_than|less_than_or_equal|greater_than|greater_than_or_equal),
2787
+ team_id (equals|not_equals|contains|not_contains|less_than|less_than_or_equa
2788
+ l|greater_than|greater_than_or_equal), lifecycle_owner_team_id
2789
+ (equals|not_equals|contains|not_contains|less_than|less_than_or_equal|greate
2790
+ r_than|greater_than_or_equal).
2791
+
2792
+ --limit=<value>
2793
+ Page size (server default 20, max 100).
2794
+
2795
+ --page-token=<value>
2796
+ Continue from a previous page's next_page_token.
2797
+
2798
+ --plain
2799
+ Tab-separated rows with no header, for piping. Implied when stdout is not a
2800
+ terminal.
2801
+
2802
+ --sort=<value>
2803
+ Sort as field:direction (asc|desc). Fields: created_at, id, schema, status,
2804
+ lifecycle_owner_team_id.
2805
+
2806
+ --[no-]telemetry
2807
+ Send anonymous usage analytics. Disable with --no-telemetry.
2808
+
2809
+ GLOBAL FLAGS
2810
+ --json Format output as json.
2811
+
2812
+ DESCRIPTION
2813
+ List users.
2814
+
2815
+ EXAMPLES
2816
+ $ zitadel users list --json
2817
+
2818
+ $ zitadel users list --all --json
2819
+
2820
+ $ zitadel users list --filter created_at=equals:<value> --sort created_at:desc
2821
+ ```
2822
+
2823
+ ## `zitadel users update ID`
2824
+
2825
+ Update a user by id.
2826
+
2827
+ ```
2828
+ USAGE
2829
+ $ zitadel users update ID [--json] [-c <value>] [-s <value>] [-n]
2830
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--schema <value>]
2831
+ [--attributes <value>...] [--data <value> | --file <value>] [--set
2832
+ <value>...]
2833
+
2834
+ ARGUMENTS
2835
+ ID user id
2836
+
2837
+ FLAGS
2838
+ -c, --cwd=<value> Project directory to operate on.
2839
+ -n, --non-interactive Disable prompts. Required when scripting or running as
2840
+ an agent.
2841
+ -s, --server=<value> Override the resolved server URL.
2842
+ -v, --verbose Verbose logging.
2843
+ --[no-]color Colorize human output. Disable with --no-color;
2844
+ NO_COLOR and FORCE_COLOR are honored too.
2845
+ --debug Debug logging.
2846
+ --dry-run Preview without mutating files or the platform.
2847
+ --[no-]telemetry Send anonymous usage analytics. Disable with
2848
+ --no-telemetry.
2849
+
2850
+ OPTIONAL FIELD FLAGS
2851
+ --attributes=<value>... Repeatable attributes entry: key=value for a string,
2852
+ key:=value for JSON. The changed attributes only.
2853
+ --schema=<value> The schema the user follows after this patch.
2854
+
2855
+ RAW BODY FLAGS
2856
+ --data=<value> Whole body as a JSON object. Field flags and --set apply
2857
+ over it.
2858
+ --file=<value> Read the body from a JSON file; `-` reads stdin. Field flags
2859
+ and --set apply over it.
2860
+ --set=<value>... Set one field by its dot path: path=value, or path:=json for
2861
+ JSON. Repeatable; applied after the field flags, in order. A
2862
+ key that contains a dot is set through its parent: --set
2863
+ 'parent:={"a.b":"x"}'.
2864
+
2865
+ GLOBAL FLAGS
2866
+ --json Format output as json.
2867
+
2868
+ DESCRIPTION
2869
+ Update a user by id.
2870
+
2871
+ EXAMPLES
2872
+ $ zitadel users update <id> --data '{...}' --json
2873
+
2874
+ $ zitadel users update <id> --file ./user.json
2875
+ ```
2876
+
2877
+ ## `zitadel variables delete NAME`
2878
+
2879
+ Delete one variable from the project.
2880
+
2881
+ ```
2882
+ USAGE
2883
+ $ zitadel variables delete NAME [--json] [-c <value>] [-s <value>] [-n]
2884
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--project-level] [-f]
2885
+
2886
+ ARGUMENTS
2887
+ NAME Variable name to delete.
2888
+
2889
+ FLAGS
2890
+ -c, --cwd=<value> Project directory to operate on.
2891
+ -f, --force Delete the variable without the confirmation prompt.
2892
+ Required when non-interactive.
2893
+ -n, --non-interactive Disable prompts. Required when scripting or running as
2894
+ an agent.
2895
+ -s, --server=<value> Override the resolved server URL.
2896
+ -v, --verbose Verbose logging.
2897
+ --[no-]color Colorize human output. Disable with --no-color;
2898
+ NO_COLOR and FORCE_COLOR are honored too.
2899
+ --debug Debug logging.
2900
+ --dry-run Preview without mutating files or the platform.
2901
+ --project-level Address the project level. Required: it is the only
2902
+ owner the CLI can address today.
2903
+ --[no-]telemetry Send anonymous usage analytics. Disable with
2904
+ --no-telemetry.
2905
+
2906
+ GLOBAL FLAGS
2907
+ --json Format output as json.
2908
+
2909
+ DESCRIPTION
2910
+ Delete one variable from the project.
2911
+
2912
+ EXAMPLES
2913
+ $ zitadel variables delete GOOGLE_CLIENT_ID --project-level
2914
+
2915
+ $ zitadel variables delete GOOGLE_CLIENT_ID --project-level --force
2916
+ ```
2917
+
2918
+ ## `zitadel variables get NAME`
2919
+
2920
+ Get one variable from the project.
2921
+
2922
+ ```
2923
+ USAGE
2924
+ $ zitadel variables get NAME [--json] [-c <value>] [-s <value>] [-n]
2925
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--project-level]
2926
+
2927
+ ARGUMENTS
2928
+ NAME Variable name to read.
2929
+
2930
+ FLAGS
2931
+ -c, --cwd=<value> Project directory to operate on.
2932
+ -n, --non-interactive Disable prompts. Required when scripting or running as
2933
+ an agent.
2934
+ -s, --server=<value> Override the resolved server URL.
2935
+ -v, --verbose Verbose logging.
2936
+ --[no-]color Colorize human output. Disable with --no-color;
2937
+ NO_COLOR and FORCE_COLOR are honored too.
2938
+ --debug Debug logging.
2939
+ --dry-run Preview without mutating files or the platform.
2940
+ --project-level Address the project level. Required: it is the only
2941
+ owner the CLI can address today.
2942
+ --[no-]telemetry Send anonymous usage analytics. Disable with
2943
+ --no-telemetry.
2944
+
2945
+ GLOBAL FLAGS
2946
+ --json Format output as json.
2947
+
2948
+ DESCRIPTION
2949
+ Get one variable from the project.
2950
+
2951
+ EXAMPLES
2952
+ $ zitadel variables get GOOGLE_CLIENT_ID --project-level
2953
+
2954
+ $ zitadel variables get GOOGLE_CLIENT_ID --project-level --json
2955
+ ```
2956
+
2957
+ ## `zitadel variables list`
2958
+
2959
+ List the variables entered on the project.
2960
+
2961
+ ```
2962
+ USAGE
2963
+ $ zitadel variables list [--json] [-c <value>] [-s <value>] [-n]
2964
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--project-level]
2965
+ [--plain]
2966
+
2967
+ FLAGS
2968
+ -c, --cwd=<value> Project directory to operate on.
2969
+ -n, --non-interactive Disable prompts. Required when scripting or running as
2970
+ an agent.
2971
+ -s, --server=<value> Override the resolved server URL.
2972
+ -v, --verbose Verbose logging.
2973
+ --[no-]color Colorize human output. Disable with --no-color;
2974
+ NO_COLOR and FORCE_COLOR are honored too.
2975
+ --debug Debug logging.
2976
+ --dry-run Preview without mutating files or the platform.
2977
+ --plain Tab-separated rows with no header, for piping. Implied
2978
+ when stdout is not a terminal.
2979
+ --project-level Address the project level. Required: it is the only
2980
+ owner the CLI can address today.
2981
+ --[no-]telemetry Send anonymous usage analytics. Disable with
2982
+ --no-telemetry.
2983
+
2984
+ GLOBAL FLAGS
2985
+ --json Format output as json.
2986
+
2987
+ DESCRIPTION
2988
+ List the variables entered on the project.
2989
+
2990
+ EXAMPLES
2991
+ $ zitadel variables list --project-level
2992
+
2993
+ $ zitadel variables list --project-level --json
2994
+ ```
2995
+
2996
+ ## `zitadel variables set NAME`
2997
+
2998
+ Set one variable on the project.
2999
+
3000
+ ```
3001
+ USAGE
3002
+ $ zitadel variables set NAME [--json] [-c <value>] [-s <value>] [-n]
3003
+ [--dry-run] [-v] [--debug] [--color] [--telemetry] [--project-level]
3004
+ [--secret] [--as string|number|boolean]
3005
+
3006
+ ARGUMENTS
3007
+ NAME Variable name (letters, digits and underscores).
3008
+
3009
+ FLAGS
3010
+ -c, --cwd=<value> Project directory to operate on.
3011
+ -n, --non-interactive Disable prompts. Required when scripting or running as
3012
+ an agent.
3013
+ -s, --server=<value> Override the resolved server URL.
3014
+ -v, --verbose Verbose logging.
3015
+ --as=<option> [default: string] Store the value as this JSON type.
3016
+ <options: string|number|boolean>
3017
+ --[no-]color Colorize human output. Disable with --no-color;
3018
+ NO_COLOR and FORCE_COLOR are honored too.
3019
+ --debug Debug logging.
3020
+ --dry-run Preview without mutating files or the platform.
3021
+ --project-level Address the project level. Required: it is the only
3022
+ owner the CLI can address today.
3023
+ --secret Store the value encrypted. It can be replaced later but
3024
+ never read back.
3025
+ --[no-]telemetry Send anonymous usage analytics. Disable with
3026
+ --no-telemetry.
3027
+
3028
+ GLOBAL FLAGS
3029
+ --json Format output as json.
3030
+
3031
+ DESCRIPTION
3032
+ Set one variable on the project.
3033
+
3034
+ EXAMPLES
3035
+ $ zitadel variables set GOOGLE_CLIENT_ID --project-level
3036
+
3037
+ $ zitadel variables set GOOGLE_CLIENT_SECRET --project-level --secret < secret.txt
3038
+
3039
+ $ zitadel variables set SESSION_TTL --project-level --as number
493
3040
  ```
494
3041
 
495
3042
  ## `zitadel version`
@@ -507,7 +3054,8 @@ GLOBAL FLAGS
507
3054
  FLAG DESCRIPTIONS
508
3055
  --verbose Show additional information about the CLI.
509
3056
 
510
- Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using.
3057
+ Additionally shows the architecture, node version, operating system, and
3058
+ versions of plugins that the CLI is using.
511
3059
  ```
512
3060
 
513
3061
  _See code: [@oclif/plugin-version](https://github.com/oclif/plugin-version/blob/2.2.46/src/commands/version.ts)_