@sanity/cli 6.3.1 → 6.3.2

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 (131) hide show
  1. package/README.md +295 -442
  2. package/dist/actions/build/decorateIndexWithStagingScript.js +16 -0
  3. package/dist/actions/build/decorateIndexWithStagingScript.js.map +1 -0
  4. package/dist/actions/build/writeSanityRuntime.js +3 -2
  5. package/dist/actions/build/writeSanityRuntime.js.map +1 -1
  6. package/dist/actions/dataset/create.js +4 -0
  7. package/dist/actions/dataset/create.js.map +1 -1
  8. package/dist/actions/deploy/findUserApplicationForApp.js +1 -0
  9. package/dist/actions/deploy/findUserApplicationForApp.js.map +1 -1
  10. package/dist/actions/deploy/types.js +1 -1
  11. package/dist/actions/deploy/types.js.map +1 -1
  12. package/dist/actions/init/templates/nextjs/index.js +1 -2
  13. package/dist/actions/init/templates/nextjs/index.js.map +1 -1
  14. package/dist/actions/manifest/types.js +1 -1
  15. package/dist/actions/manifest/types.js.map +1 -1
  16. package/dist/actions/schema/types.js +3 -3
  17. package/dist/actions/schema/types.js.map +1 -1
  18. package/dist/actions/users/validateEmail.js +2 -2
  19. package/dist/actions/users/validateEmail.js.map +1 -1
  20. package/dist/commands/backups/disable.js +1 -1
  21. package/dist/commands/backups/disable.js.map +1 -1
  22. package/dist/commands/backups/download.js +1 -1
  23. package/dist/commands/backups/download.js.map +1 -1
  24. package/dist/commands/backups/enable.js +1 -1
  25. package/dist/commands/backups/enable.js.map +1 -1
  26. package/dist/commands/backups/list.js +1 -1
  27. package/dist/commands/backups/list.js.map +1 -1
  28. package/dist/commands/build.js +1 -1
  29. package/dist/commands/build.js.map +1 -1
  30. package/dist/commands/cors/add.js +1 -1
  31. package/dist/commands/cors/add.js.map +1 -1
  32. package/dist/commands/cors/delete.js +1 -1
  33. package/dist/commands/cors/delete.js.map +1 -1
  34. package/dist/commands/cors/list.js +2 -2
  35. package/dist/commands/cors/list.js.map +1 -1
  36. package/dist/commands/datasets/alias/create.js +1 -1
  37. package/dist/commands/datasets/alias/create.js.map +1 -1
  38. package/dist/commands/datasets/alias/delete.js +1 -1
  39. package/dist/commands/datasets/alias/delete.js.map +1 -1
  40. package/dist/commands/datasets/alias/link.js +1 -1
  41. package/dist/commands/datasets/alias/link.js.map +1 -1
  42. package/dist/commands/datasets/alias/unlink.js +1 -1
  43. package/dist/commands/datasets/alias/unlink.js.map +1 -1
  44. package/dist/commands/datasets/copy.js +1 -1
  45. package/dist/commands/datasets/copy.js.map +1 -1
  46. package/dist/commands/datasets/create.js +1 -1
  47. package/dist/commands/datasets/create.js.map +1 -1
  48. package/dist/commands/datasets/delete.js +1 -1
  49. package/dist/commands/datasets/delete.js.map +1 -1
  50. package/dist/commands/datasets/embeddings/enable.js +11 -0
  51. package/dist/commands/datasets/embeddings/enable.js.map +1 -1
  52. package/dist/commands/datasets/export.js +2 -2
  53. package/dist/commands/datasets/export.js.map +1 -1
  54. package/dist/commands/datasets/list.js +2 -2
  55. package/dist/commands/datasets/list.js.map +1 -1
  56. package/dist/commands/debug.js +1 -1
  57. package/dist/commands/debug.js.map +1 -1
  58. package/dist/commands/deploy.js +3 -3
  59. package/dist/commands/deploy.js.map +1 -1
  60. package/dist/commands/dev.js +5 -5
  61. package/dist/commands/dev.js.map +1 -1
  62. package/dist/commands/docs/browse.js +1 -1
  63. package/dist/commands/docs/browse.js.map +1 -1
  64. package/dist/commands/documents/delete.js +1 -1
  65. package/dist/commands/documents/delete.js.map +1 -1
  66. package/dist/commands/exec.js +2 -2
  67. package/dist/commands/exec.js.map +1 -1
  68. package/dist/commands/graphql/deploy.js +2 -2
  69. package/dist/commands/graphql/deploy.js.map +1 -1
  70. package/dist/commands/graphql/list.js +2 -2
  71. package/dist/commands/graphql/list.js.map +1 -1
  72. package/dist/commands/hooks/create.js +2 -2
  73. package/dist/commands/hooks/create.js.map +1 -1
  74. package/dist/commands/hooks/delete.js +5 -5
  75. package/dist/commands/hooks/delete.js.map +1 -1
  76. package/dist/commands/hooks/list.js +3 -3
  77. package/dist/commands/hooks/list.js.map +1 -1
  78. package/dist/commands/hooks/logs.js +5 -5
  79. package/dist/commands/hooks/logs.js.map +1 -1
  80. package/dist/commands/init.js +30 -12
  81. package/dist/commands/init.js.map +1 -1
  82. package/dist/commands/install.js +1 -1
  83. package/dist/commands/install.js.map +1 -1
  84. package/dist/commands/learn.js +1 -1
  85. package/dist/commands/learn.js.map +1 -1
  86. package/dist/commands/login.js +1 -1
  87. package/dist/commands/login.js.map +1 -1
  88. package/dist/commands/logout.js +1 -1
  89. package/dist/commands/logout.js.map +1 -1
  90. package/dist/commands/manage.js +1 -1
  91. package/dist/commands/manage.js.map +1 -1
  92. package/dist/commands/manifest/extract.js +2 -2
  93. package/dist/commands/manifest/extract.js.map +1 -1
  94. package/dist/commands/media/delete-aspect.js +1 -1
  95. package/dist/commands/media/delete-aspect.js.map +1 -1
  96. package/dist/commands/media/export.js +1 -1
  97. package/dist/commands/media/export.js.map +1 -1
  98. package/dist/commands/preview.js +3 -3
  99. package/dist/commands/preview.js.map +1 -1
  100. package/dist/commands/projects/list.js +4 -2
  101. package/dist/commands/projects/list.js.map +1 -1
  102. package/dist/commands/schemas/deploy.js +3 -4
  103. package/dist/commands/schemas/deploy.js.map +1 -1
  104. package/dist/commands/schemas/extract.js +3 -3
  105. package/dist/commands/schemas/extract.js.map +1 -1
  106. package/dist/commands/schemas/list.js +4 -5
  107. package/dist/commands/schemas/list.js.map +1 -1
  108. package/dist/commands/telemetry/disable.js +2 -2
  109. package/dist/commands/telemetry/disable.js.map +1 -1
  110. package/dist/commands/telemetry/enable.js +2 -2
  111. package/dist/commands/telemetry/enable.js.map +1 -1
  112. package/dist/commands/telemetry/status.js +2 -2
  113. package/dist/commands/telemetry/status.js.map +1 -1
  114. package/dist/commands/tokens/add.js +1 -1
  115. package/dist/commands/tokens/add.js.map +1 -1
  116. package/dist/commands/tokens/delete.js +1 -1
  117. package/dist/commands/tokens/delete.js.map +1 -1
  118. package/dist/commands/tokens/list.js +2 -2
  119. package/dist/commands/tokens/list.js.map +1 -1
  120. package/dist/commands/users/list.js +1 -1
  121. package/dist/commands/users/list.js.map +1 -1
  122. package/dist/commands/versions.js +1 -1
  123. package/dist/commands/versions.js.map +1 -1
  124. package/dist/server/vite/plugin-sanity-build-entries.js +3 -2
  125. package/dist/server/vite/plugin-sanity-build-entries.js.map +1 -1
  126. package/dist/util/telemetry/createTelemetryStore.js +27 -12
  127. package/dist/util/telemetry/createTelemetryStore.js.map +1 -1
  128. package/dist/util/validateProjection.js +121 -0
  129. package/dist/util/validateProjection.js.map +1 -0
  130. package/oclif.manifest.json +158 -156
  131. package/package.json +22 -21
package/README.md CHANGED
@@ -115,7 +115,7 @@ Code for sanity cli
115
115
 
116
116
  ## `sanity backups disable [DATASET]`
117
117
 
118
- Disable backup for a dataset.
118
+ Disable backup for a dataset
119
119
 
120
120
  ```
121
121
  USAGE
@@ -128,7 +128,7 @@ OVERRIDE FLAGS
128
128
  -p, --project-id=<id> Project ID to disable backups for (overrides CLI configuration)
129
129
 
130
130
  DESCRIPTION
131
- Disable backup for a dataset.
131
+ Disable backup for a dataset
132
132
 
133
133
  EXAMPLES
134
134
  Interactively disable backup for a dataset
@@ -140,11 +140,9 @@ EXAMPLES
140
140
  $ sanity backups disable production
141
141
  ```
142
142
 
143
- _See code: [src/commands/backups/disable.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/backups/disable.ts)_
144
-
145
143
  ## `sanity backups download [DATASET]`
146
144
 
147
- Download a dataset backup to a local file.
145
+ Download a dataset backup to a local file
148
146
 
149
147
  ```
150
148
  USAGE
@@ -164,7 +162,7 @@ OVERRIDE FLAGS
164
162
  -p, --project-id=<id> Project ID to download backup from (overrides CLI configuration)
165
163
 
166
164
  DESCRIPTION
167
- Download a dataset backup to a local file.
165
+ Download a dataset backup to a local file
168
166
 
169
167
  EXAMPLES
170
168
  Interactively download a backup
@@ -184,11 +182,9 @@ EXAMPLES
184
182
  $ sanity backups download production --backup-id 2024-01-01-backup-3 --out /path/to/file --overwrite
185
183
  ```
186
184
 
187
- _See code: [src/commands/backups/download.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/backups/download.ts)_
188
-
189
185
  ## `sanity backups enable [DATASET]`
190
186
 
191
- Enable backup for a dataset.
187
+ Enable backup for a dataset
192
188
 
193
189
  ```
194
190
  USAGE
@@ -201,7 +197,7 @@ OVERRIDE FLAGS
201
197
  -p, --project-id=<id> Project ID to enable backups for (overrides CLI configuration)
202
198
 
203
199
  DESCRIPTION
204
- Enable backup for a dataset.
200
+ Enable backup for a dataset
205
201
 
206
202
  EXAMPLES
207
203
  Interactively enable backup for a dataset
@@ -213,11 +209,9 @@ EXAMPLES
213
209
  $ sanity backups enable production
214
210
  ```
215
211
 
216
- _See code: [src/commands/backups/enable.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/backups/enable.ts)_
217
-
218
212
  ## `sanity backups list [DATASET]`
219
213
 
220
- List available backups for a dataset.
214
+ List available backups for a dataset
221
215
 
222
216
  ```
223
217
  USAGE
@@ -235,7 +229,7 @@ OVERRIDE FLAGS
235
229
  -p, --project-id=<id> Project ID to list backups for (overrides CLI configuration)
236
230
 
237
231
  DESCRIPTION
238
- List available backups for a dataset.
232
+ List available backups for a dataset
239
233
 
240
234
  EXAMPLES
241
235
  List backups for a dataset interactively
@@ -255,37 +249,38 @@ EXAMPLES
255
249
  $ sanity backups list production --after 2024-01-31 --limit 10
256
250
  ```
257
251
 
258
- _See code: [src/commands/backups/list.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/backups/list.ts)_
259
-
260
252
  ## `sanity blueprints add TYPE`
261
253
 
262
254
  Add a function resource to a Blueprint
263
255
 
264
256
  ```
265
257
  USAGE
266
- $ sanity blueprints add TYPE [--example <value> | -n <value> | --fn-type
267
- document-publish|document-create|document-update|document-delete|media-library-asset-create|media-library-asset-upda
268
- te|media-library-asset-delete|scheduled-function... | --language ts|js | --javascript | --fn-helpers |
269
- --fn-installer skip|npm|pnpm|yarn] [-i | ]
258
+ $ sanity blueprints add TYPE [--json] [--validate-resources] [--example <value> | -n <value> | --fn-type
259
+ document-publish|document-create|document-delete|document-update|media-library-asset-create|media-library-asset-dele
260
+ te|media-library-asset-update|scheduled-function|sync-tag-invalidate... | --language ts|js | --javascript |
261
+ --fn-helpers | --fn-installer skip|npm|pnpm|yarn] [-i | ]
270
262
 
271
263
  ARGUMENTS
272
264
  TYPE (function) Type of resource to add (only "function" is supported)
273
265
 
274
266
  FLAGS
275
- -i, --install Shortcut for --fn-installer npm
276
- -n, --name=<value> Name of the resource to add
277
- --example=<value> Example to use for the function resource. Discover examples at
278
- https://www.sanity.io/exchange/type=recipes/by=sanity
279
- --[no-]fn-helpers Add helpers to the new function
280
- --fn-installer=<option> Which package manager to use when installing the @sanity/functions helpers
281
- <options: skip|npm|pnpm|yarn>
282
- --fn-type=<option>... Document change event(s) that should trigger the function; you can specify multiple
283
- events by specifying this flag multiple times
284
- <options: document-publish|document-create|document-update|document-delete|media-library-
285
- asset-create|media-library-asset-update|media-library-asset-delete|scheduled-function>
286
- --javascript Use JavaScript instead of TypeScript
287
- --language=<option> [default: ts] Language of the new function
288
- <options: ts|js>
267
+ -i, --install Shortcut for --fn-installer npm
268
+ -n, --name=<value> Name of the resource to add
269
+ --example=<value> Example to use for the function resource. Discover examples at
270
+ https://www.sanity.io/exchange/type=recipes/by=sanity
271
+ --[no-]fn-helpers Add helpers to the new function
272
+ --fn-installer=<option> Which package manager to use when installing the @sanity/functions helpers
273
+ <options: skip|npm|pnpm|yarn>
274
+ --fn-type=<option>... Document change event(s) that should trigger the function; you can specify multiple
275
+ events by specifying this flag multiple times
276
+ <options: document-publish|document-create|document-delete|document-update|media-librar
277
+ y-asset-create|media-library-asset-delete|media-library-asset-update|scheduled-function
278
+ |sync-tag-invalidate>
279
+ --javascript Use JavaScript instead of TypeScript
280
+ --json Format output as json
281
+ --language=<option> [default: ts] Language of the new function
282
+ <options: ts|js>
283
+ --[no-]validate-resources Validate resources
289
284
 
290
285
  DESCRIPTION
291
286
  Add a function resource to a Blueprint
@@ -307,20 +302,22 @@ EXAMPLES
307
302
  $ sanity blueprints add function --name my-function --fn-type document-create --fn-type document-update --lang js
308
303
  ```
309
304
 
310
- _See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.7.2/src/commands/blueprints/add.ts)_
311
-
312
305
  ## `sanity blueprints config`
313
306
 
314
307
  View or edit the local Blueprint configuration
315
308
 
316
309
  ```
317
310
  USAGE
318
- $ sanity blueprints config [--project-id <value> -e] [--stack <value> ]
311
+ $ sanity blueprints config [--json] [--validate-resources] [--stack <value> -e] [--project-id <value> ]
312
+ [--organization-id <value> ]
319
313
 
320
314
  FLAGS
321
- -e, --edit Modify the configuration interactively, or directly when combined with ID flags.
322
- --project-id=<value> Directly set the project ID in the configuration. Requires --edit flag
323
- --stack=<value> Stack name or ID to set in the configuration. Requires --edit flag
315
+ -e, --edit Modify the configuration interactively, or directly when combined with ID flags.
316
+ --json Format output as json
317
+ --organization-id=<value> Sanity organization ID used to scope Blueprint and Stack
318
+ --project-id=<value> Sanity project ID used to scope Blueprint and Stack
319
+ --stack=<value> Stack name or ID to set in the configuration. Requires --edit flag
320
+ --[no-]validate-resources Validate resources
324
321
 
325
322
  DESCRIPTION
326
323
  View or edit the local Blueprint configuration
@@ -342,25 +339,26 @@ EXAMPLES
342
339
  $ sanity blueprints config --edit --project-id <projectId> --stack <name-or-id>
343
340
  ```
344
341
 
345
- _See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.7.2/src/commands/blueprints/config.ts)_
346
-
347
342
  ## `sanity blueprints deploy`
348
343
 
349
344
  Deploy the local Blueprint to the remote Stack
350
345
 
351
346
  ```
352
347
  USAGE
353
- $ sanity blueprints deploy [--stack <value>] [--no-wait]
348
+ $ sanity blueprints deploy [--json] [--validate-resources] [--stack <value>] [-m <value>] [--no-wait]
354
349
 
355
350
  FLAGS
356
- --no-wait Do not wait for Stack deployment to complete
357
- --stack=<value> Stack name or ID to use instead of the locally configured Stack
351
+ -m, --message=<value> Message describing the deployment (e.g. reason for change)
352
+ --json Format output as json
353
+ --no-wait Do not wait for Stack deployment to complete
354
+ --stack=<value> Stack name or ID to use instead of the locally configured Stack
355
+ --[no-]validate-resources Validate resources
358
356
 
359
357
  DESCRIPTION
360
358
  Deploy the local Blueprint to the remote Stack
361
359
 
362
- Pushes your local Blueprint configuration to the remote Stack; provisioning, updating, or destroying resources as
363
- needed. This is the primary command for applying infrastructure changes.
360
+ Applies your local Blueprint to the remote Stack, creating, updating, or removing resources as needed. This is the
361
+ primary command for applying infrastructure changes.
364
362
 
365
363
  Before deploying, run 'blueprints plan' to preview changes. After deployment, use 'blueprints info' to verify Stack
366
364
  status or 'blueprints logs' to monitor activity.
@@ -374,29 +372,33 @@ DESCRIPTION
374
372
  EXAMPLES
375
373
  $ sanity blueprints deploy
376
374
 
375
+ $ sanity blueprints deploy --message "Enable staging dataset"
376
+
377
377
  $ sanity blueprints deploy --no-wait
378
378
 
379
379
  $ sanity blueprints deploy --fn-installer npm
380
380
  ```
381
381
 
382
- _See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.7.2/src/commands/blueprints/deploy.ts)_
383
-
384
382
  ## `sanity blueprints destroy`
385
383
 
386
- Destroy the remote Stack deployment and its resources (will not delete local files)
384
+ Destroy a remote Stack deployment and its resources
387
385
 
388
386
  ```
389
387
  USAGE
390
- $ sanity blueprints destroy [--project-id <value> --stack <value> --force] [--no-wait]
388
+ $ sanity blueprints destroy [--json] [--validate-resources] [--project-id <value> --stack <value> --force]
389
+ [--organization-id <value> ] [--no-wait]
391
390
 
392
391
  FLAGS
393
- --force Force Stack destruction (skip confirmation)
394
- --no-wait Do not wait for Stack destruction to complete
395
- --project-id=<value> Project associated with the Stack
396
- --stack=<value> Stack name or ID to destroy (defaults to the locally configured Stack)
392
+ --force Force Stack destruction (skip confirmation)
393
+ --json Format output as json
394
+ --no-wait Do not wait for Stack destruction to complete
395
+ --organization-id=<value> Sanity organization ID used to scope Blueprint and Stack
396
+ --project-id=<value> Sanity project ID used to scope Blueprint and Stack
397
+ --stack=<value> Stack name or ID to destroy (defaults to the locally configured Stack)
398
+ --[no-]validate-resources Validate resources
397
399
 
398
400
  DESCRIPTION
399
- Destroy the remote Stack deployment and its resources (will not delete local files)
401
+ Destroy a remote Stack deployment and its resources
400
402
 
401
403
  Permanently removes the remote Stack and all its provisioned resources. Your local Blueprint files remain untouched,
402
404
  allowing you to redeploy later with 'blueprints init' + 'blueprints deploy'.
@@ -411,21 +413,20 @@ EXAMPLES
411
413
  $ sanity blueprints destroy --stack <name-or-id> --project-id <projectId> --force --no-wait
412
414
  ```
413
415
 
414
- _See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.7.2/src/commands/blueprints/destroy.ts)_
415
-
416
416
  ## `sanity blueprints doctor`
417
417
 
418
418
  Diagnose potential issues with local Blueprint and remote Stack configuration
419
419
 
420
420
  ```
421
421
  USAGE
422
- $ sanity blueprints doctor [--json] [-p <value>] [--verbose] [--fix]
422
+ $ sanity blueprints doctor [--json] [-p <value>] [--validate-resources] [--verbose] [--fix]
423
423
 
424
424
  FLAGS
425
- -p, --path=<value> [env: SANITY_BLUEPRINT_PATH] Path to a Blueprint file or directory containing one
426
- --fix Interactively fix configuration issues
427
- --json Format output as json.
428
- --[no-]verbose Verbose output; defaults to true
425
+ -p, --path=<value> [env: SANITY_BLUEPRINT_PATH] Path to a Blueprint file or directory containing one
426
+ --fix Interactively fix configuration issues
427
+ --json Format output as json
428
+ --[no-]validate-resources Validate resources
429
+ --[no-]verbose Verbose output; defaults to true
429
430
 
430
431
  DESCRIPTION
431
432
  Diagnose potential issues with local Blueprint and remote Stack configuration
@@ -435,23 +436,29 @@ DESCRIPTION
435
436
 
436
437
  Run this command when encountering errors with other Blueprint commands. Use --fix to interactively resolve detected
437
438
  issues.
438
- ```
439
439
 
440
- _See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.7.2/src/commands/blueprints/doctor.ts)_
440
+ EXAMPLES
441
+ $ sanity blueprints doctor
442
+
443
+ $ sanity blueprints doctor --fix
444
+ ```
441
445
 
442
446
  ## `sanity blueprints info`
443
447
 
444
- Show information about the local Blueprint's remote Stack deployment
448
+ Display the status and resources of the remote Stack deployment
445
449
 
446
450
  ```
447
451
  USAGE
448
- $ sanity blueprints info [--stack <value>]
452
+ $ sanity blueprints info [--json] [--validate-resources] [--stack <value>] [--project-id <value>]
449
453
 
450
454
  FLAGS
451
- --stack=<value> Stack name or ID to use instead of the locally configured Stack
455
+ --json Format output as json
456
+ --project-id=<value> Sanity project ID used to scope Blueprint and Stack
457
+ --stack=<value> Stack name or ID
458
+ --[no-]validate-resources Validate resources
452
459
 
453
460
  DESCRIPTION
454
- Show information about the local Blueprint's remote Stack deployment
461
+ Display the status and resources of the remote Stack deployment
455
462
 
456
463
  Displays the current state and metadata of your remote Stack deployment, including deployed resources, status, and
457
464
  configuration.
@@ -465,18 +472,19 @@ EXAMPLES
465
472
  $ sanity blueprints info
466
473
 
467
474
  $ sanity blueprints info --stack <name-or-id>
468
- ```
469
475
 
470
- _See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.7.2/src/commands/blueprints/info.ts)_
476
+ $ sanity blueprints info --project-id <id> --stack <name-or-id>
477
+ ```
471
478
 
472
479
  ## `sanity blueprints init [DIR]`
473
480
 
474
- Initialize a local Blueprint and optionally provision a remote Stack deployment
481
+ Initialize a Blueprint and create a remote Stack
475
482
 
476
483
  ```
477
484
  USAGE
478
- $ sanity blueprints init [DIR] [--verbose] [--dir <value>] [--example <value> | --blueprint-type json|js|ts |
479
- --stack-id <value> | --stack-name <value>] [--project-id <value>]
485
+ $ sanity blueprints init [DIR] [--json] [--validate-resources] [--verbose] [--dir <value>] [--example <value> |
486
+ --blueprint-type json|js|ts | --stack-id <value> | --stack-name <value>] [--project-id <value>] [--organization-id
487
+ <value>]
480
488
 
481
489
  ARGUMENTS
482
490
  [DIR] Directory to create the local Blueprint in
@@ -486,13 +494,16 @@ FLAGS
486
494
  <options: json|js|ts>
487
495
  --dir=<value> Directory to create the local Blueprint in
488
496
  --example=<value> Example to use for the local Blueprint
489
- --project-id=<value> Sanity project ID used to scope local Blueprint and remote Stack
497
+ --json Format output as json
498
+ --organization-id=<value> Sanity organization ID used to scope Blueprint and Stack
499
+ --project-id=<value> Sanity project ID used to scope Blueprint and Stack
490
500
  --stack-id=<value> Existing Stack ID used to scope local Blueprint
491
501
  --stack-name=<value> Name to use for a new Stack provisioned during initialization
502
+ --[no-]validate-resources Validate resources
492
503
  --verbose Verbose output
493
504
 
494
505
  DESCRIPTION
495
- Initialize a local Blueprint and optionally provision a remote Stack deployment
506
+ Initialize a Blueprint and create a remote Stack
496
507
 
497
508
  A Blueprint is your local infrastructure-as-code configuration that defines Sanity resources (datasets, functions,
498
509
  etc.). A Stack is the remote deployment target where your Blueprint is applied.
@@ -517,19 +528,19 @@ EXAMPLES
517
528
  $ sanity blueprints init --blueprint-type <json|js|ts> --stack-name <stackName>
518
529
  ```
519
530
 
520
- _See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.7.2/src/commands/blueprints/init.ts)_
521
-
522
531
  ## `sanity blueprints logs`
523
532
 
524
533
  Display logs for the current Blueprint's Stack deployment
525
534
 
526
535
  ```
527
536
  USAGE
528
- $ sanity blueprints logs [--stack <value>] [-w]
537
+ $ sanity blueprints logs [--json] [--validate-resources] [--stack <value>] [-w]
529
538
 
530
539
  FLAGS
531
- -w, --watch Watch for new Stack logs (streaming mode)
532
- --stack=<value> Stack name or ID to use instead of the locally configured Stack
540
+ -w, --watch Watch for new Stack logs (streaming mode)
541
+ --json Format output as json
542
+ --stack=<value> Stack name or ID to use instead of the locally configured Stack
543
+ --[no-]validate-resources Validate resources
533
544
 
534
545
  DESCRIPTION
535
546
  Display logs for the current Blueprint's Stack deployment
@@ -546,21 +557,21 @@ EXAMPLES
546
557
  $ sanity blueprints logs --watch
547
558
  ```
548
559
 
549
- _See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.7.2/src/commands/blueprints/logs.ts)_
550
-
551
560
  ## `sanity blueprints plan`
552
561
 
553
- Enumerate resources to be deployed to the remote Stack - will not modify any resources
562
+ Preview changes that will be applied to the remote Stack
554
563
 
555
564
  ```
556
565
  USAGE
557
- $ sanity blueprints plan [--stack <value>]
566
+ $ sanity blueprints plan [--json] [--validate-resources] [--stack <value>]
558
567
 
559
568
  FLAGS
560
- --stack=<value> Stack name or ID to use instead of the locally configured Stack
569
+ --json Format output as json
570
+ --stack=<value> Stack name or ID to use instead of the locally configured Stack
571
+ --[no-]validate-resources Validate resources
561
572
 
562
573
  DESCRIPTION
563
- Enumerate resources to be deployed to the remote Stack - will not modify any resources
574
+ Preview changes that will be applied to the remote Stack
564
575
 
565
576
  Use this command to preview what changes will be applied to your remote Stack before deploying. This is a safe,
566
577
  read-only operation—no resources are created, modified, or deleted.
@@ -572,21 +583,22 @@ EXAMPLES
572
583
  $ sanity blueprints plan
573
584
  ```
574
585
 
575
- _See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.7.2/src/commands/blueprints/plan.ts)_
576
-
577
586
  ## `sanity blueprints stacks`
578
587
 
579
- List all remote Stack deployments (defaults to the current Blueprint's project scope)
588
+ List remote Stack deployments for your project or organization
580
589
 
581
590
  ```
582
591
  USAGE
583
- $ sanity blueprints stacks [--project-id <value> | ]
592
+ $ sanity blueprints stacks [--json] [--validate-resources] [--project-id <value> | --organization-id <value>]
584
593
 
585
594
  FLAGS
586
- --project-id=<value> Project ID to show Stack deployments for
595
+ --json Format output as json
596
+ --organization-id=<value> Sanity organization ID used to scope Blueprint and Stack
597
+ --project-id=<value> Sanity project ID used to scope Blueprint and Stack
598
+ --[no-]validate-resources Validate resources
587
599
 
588
600
  DESCRIPTION
589
- List all remote Stack deployments (defaults to the current Blueprint's project scope)
601
+ List remote Stack deployments for your project or organization
590
602
 
591
603
  Shows all Stacks associated with a project or organization. By default, lists Stacks scoped to the local Blueprint.
592
604
 
@@ -601,11 +613,9 @@ EXAMPLES
601
613
  $ sanity blueprints stacks --organization-id <organizationId>
602
614
  ```
603
615
 
604
- _See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.7.2/src/commands/blueprints/stacks.ts)_
605
-
606
616
  ## `sanity build [OUTPUTDIR]`
607
617
 
608
- Builds the Sanity Studio configuration into a static bundle
618
+ Build Sanity Studio into a static bundle
609
619
 
610
620
  ```
611
621
  USAGE
@@ -622,7 +632,7 @@ FLAGS
622
632
  --stats Show stats about the built bundles
623
633
 
624
634
  DESCRIPTION
625
- Builds the Sanity Studio configuration into a static bundle
635
+ Build Sanity Studio into a static bundle
626
636
 
627
637
  EXAMPLES
628
638
  $ sanity build
@@ -630,8 +640,6 @@ EXAMPLES
630
640
  $ sanity build --no-minify --source-maps
631
641
  ```
632
642
 
633
- _See code: [src/commands/build.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/build.ts)_
634
-
635
643
  ## `sanity codemod [CODEMODNAME]`
636
644
 
637
645
  Updates Sanity Studio codebase with a code modification script
@@ -661,11 +669,9 @@ EXAMPLES
661
669
  $ sanity codemod reactIconsV3 --dry
662
670
  ```
663
671
 
664
- _See code: [src/commands/codemod.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/codemod.ts)_
665
-
666
672
  ## `sanity cors add ORIGIN`
667
673
 
668
- Allow a new origin to use your project API through CORS
674
+ Add a CORS origin to the project
669
675
 
670
676
  ```
671
677
  USAGE
@@ -681,7 +687,7 @@ OVERRIDE FLAGS
681
687
  -p, --project-id=<id> Project ID to add CORS origin to (overrides CLI configuration)
682
688
 
683
689
  DESCRIPTION
684
- Allow a new origin to use your project API through CORS
690
+ Add a CORS origin to the project
685
691
 
686
692
  EXAMPLES
687
693
  Interactively add a CORS origin
@@ -701,11 +707,9 @@ EXAMPLES
701
707
  $ sanity cors add https://myapp.com --project-id abc123
702
708
  ```
703
709
 
704
- _See code: [src/commands/cors/add.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/cors/add.ts)_
705
-
706
710
  ## `sanity cors delete [ORIGIN]`
707
711
 
708
- Delete an existing CORS origin from your project
712
+ Delete a CORS origin from the project
709
713
 
710
714
  ```
711
715
  USAGE
@@ -718,7 +722,7 @@ OVERRIDE FLAGS
718
722
  -p, --project-id=<id> Project ID to delete CORS origin from (overrides CLI configuration)
719
723
 
720
724
  DESCRIPTION
721
- Delete an existing CORS origin from your project
725
+ Delete a CORS origin from the project
722
726
 
723
727
  EXAMPLES
724
728
  Interactively select and delete a CORS origin
@@ -734,11 +738,9 @@ EXAMPLES
734
738
  $ sanity cors delete --project-id abc123
735
739
  ```
736
740
 
737
- _See code: [src/commands/cors/delete.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/cors/delete.ts)_
738
-
739
741
  ## `sanity cors list`
740
742
 
741
- List all origins allowed to access the API for this project
743
+ List CORS origins for the project
742
744
 
743
745
  ```
744
746
  USAGE
@@ -748,10 +750,10 @@ OVERRIDE FLAGS
748
750
  -p, --project-id=<id> Project ID to list CORS origins for (overrides CLI configuration)
749
751
 
750
752
  DESCRIPTION
751
- List all origins allowed to access the API for this project
753
+ List CORS origins for the project
752
754
 
753
755
  EXAMPLES
754
- List CORS origins for the current project
756
+ List CORS origins for the project
755
757
 
756
758
  $ sanity cors list
757
759
 
@@ -760,11 +762,9 @@ EXAMPLES
760
762
  $ sanity cors list --project-id abc123
761
763
  ```
762
764
 
763
- _See code: [src/commands/cors/list.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/cors/list.ts)_
764
-
765
765
  ## `sanity datasets alias create [ALIASNAME] [TARGETDATASET]`
766
766
 
767
- Create a dataset alias within your project
767
+ Create a dataset alias for the project
768
768
 
769
769
  ```
770
770
  USAGE
@@ -778,7 +778,7 @@ OVERRIDE FLAGS
778
778
  -p, --project-id=<id> Project ID to create dataset alias in (overrides CLI configuration)
779
779
 
780
780
  DESCRIPTION
781
- Create a dataset alias within your project
781
+ Create a dataset alias for the project
782
782
 
783
783
  EXAMPLES
784
784
  Create alias in a specific project
@@ -798,11 +798,9 @@ EXAMPLES
798
798
  $ sanity datasets alias create conference conf-2025
799
799
  ```
800
800
 
801
- _See code: [src/commands/datasets/alias/create.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/datasets/alias/create.ts)_
802
-
803
801
  ## `sanity datasets alias delete ALIASNAME`
804
802
 
805
- Delete a dataset alias within your project
803
+ Delete a dataset alias from the project
806
804
 
807
805
  ```
808
806
  USAGE
@@ -818,7 +816,7 @@ OVERRIDE FLAGS
818
816
  -p, --project-id=<id> Project ID to delete dataset alias from (overrides CLI configuration)
819
817
 
820
818
  DESCRIPTION
821
- Delete a dataset alias within your project
819
+ Delete a dataset alias from the project
822
820
 
823
821
  EXAMPLES
824
822
  Delete alias named "conference" with confirmation prompt
@@ -830,11 +828,9 @@ EXAMPLES
830
828
  $ sanity datasets alias delete conference --force
831
829
  ```
832
830
 
833
- _See code: [src/commands/datasets/alias/delete.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/datasets/alias/delete.ts)_
834
-
835
831
  ## `sanity datasets alias link [ALIASNAME] [TARGETDATASET]`
836
832
 
837
- Link a dataset alias to a dataset within your project
833
+ Link a dataset alias to a dataset in the project
838
834
 
839
835
  ```
840
836
  USAGE
@@ -851,7 +847,7 @@ OVERRIDE FLAGS
851
847
  -p, --project-id=<id> Project ID to link dataset alias in (overrides CLI configuration)
852
848
 
853
849
  DESCRIPTION
854
- Link a dataset alias to a dataset within your project
850
+ Link a dataset alias to a dataset in the project
855
851
 
856
852
  EXAMPLES
857
853
  Link an alias with interactive prompts
@@ -871,11 +867,9 @@ EXAMPLES
871
867
  $ sanity datasets alias link conference conf-2025 --force
872
868
  ```
873
869
 
874
- _See code: [src/commands/datasets/alias/link.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/datasets/alias/link.ts)_
875
-
876
870
  ## `sanity datasets alias unlink [ALIASNAME]`
877
871
 
878
- Unlink a dataset alias from its dataset within your project
872
+ Unlink a dataset alias from its dataset in the project
879
873
 
880
874
  ```
881
875
  USAGE
@@ -891,7 +885,7 @@ OVERRIDE FLAGS
891
885
  -p, --project-id=<id> Project ID to unlink dataset alias in (overrides CLI configuration)
892
886
 
893
887
  DESCRIPTION
894
- Unlink a dataset alias from its dataset within your project
888
+ Unlink a dataset alias from its dataset in the project
895
889
 
896
890
  EXAMPLES
897
891
  Unlink an alias with interactive selection
@@ -907,11 +901,9 @@ EXAMPLES
907
901
  $ sanity datasets alias unlink conference --force
908
902
  ```
909
903
 
910
- _See code: [src/commands/datasets/alias/unlink.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/datasets/alias/unlink.ts)_
911
-
912
904
  ## `sanity datasets copy [SOURCE] [TARGET]`
913
905
 
914
- Manages dataset copying, including starting a new copy job, listing copy jobs and following the progress of a running copy job
906
+ Copy a dataset or manage copy jobs
915
907
 
916
908
  ```
917
909
  USAGE
@@ -934,8 +926,7 @@ OVERRIDE FLAGS
934
926
  -p, --project-id=<id> Project ID to copy dataset in (overrides CLI configuration)
935
927
 
936
928
  DESCRIPTION
937
- Manages dataset copying, including starting a new copy job, listing copy jobs and following the progress of a running
938
- copy job
929
+ Copy a dataset or manage copy jobs
939
930
 
940
931
  EXAMPLES
941
932
  Interactively copy a dataset
@@ -971,11 +962,9 @@ EXAMPLES
971
962
  $ sanity datasets copy --list --offset 2 --limit 10
972
963
  ```
973
964
 
974
- _See code: [src/commands/datasets/copy.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/datasets/copy.ts)_
975
-
976
965
  ## `sanity datasets create [NAME]`
977
966
 
978
- Create a new dataset within your project
967
+ Create a new dataset for the project
979
968
 
980
969
  ```
981
970
  USAGE
@@ -995,7 +984,7 @@ OVERRIDE FLAGS
995
984
  -p, --project-id=<id> Project ID to create dataset in (overrides CLI configuration)
996
985
 
997
986
  DESCRIPTION
998
- Create a new dataset within your project
987
+ Create a new dataset for the project
999
988
 
1000
989
  EXAMPLES
1001
990
  Interactively create a dataset
@@ -1011,11 +1000,9 @@ EXAMPLES
1011
1000
  $ sanity datasets create my-dataset --visibility private
1012
1001
  ```
1013
1002
 
1014
- _See code: [src/commands/datasets/create.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/datasets/create.ts)_
1015
-
1016
1003
  ## `sanity datasets delete DATASETNAME`
1017
1004
 
1018
- Delete a dataset within your project
1005
+ Delete a dataset from the project
1019
1006
 
1020
1007
  ```
1021
1008
  USAGE
@@ -1031,7 +1018,7 @@ OVERRIDE FLAGS
1031
1018
  -p, --project-id=<id> Project ID to delete dataset from (overrides CLI configuration)
1032
1019
 
1033
1020
  DESCRIPTION
1034
- Delete a dataset within your project
1021
+ Delete a dataset from the project
1035
1022
 
1036
1023
  EXAMPLES
1037
1024
  Delete a specific dataset
@@ -1043,8 +1030,6 @@ EXAMPLES
1043
1030
  $ sanity datasets delete my-dataset --force
1044
1031
  ```
1045
1032
 
1046
- _See code: [src/commands/datasets/delete.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/datasets/delete.ts)_
1047
-
1048
1033
  ## `sanity datasets embeddings disable [DATASET]`
1049
1034
 
1050
1035
  Disable embeddings for a dataset
@@ -1068,8 +1053,6 @@ EXAMPLES
1068
1053
  $ sanity datasets embeddings disable production
1069
1054
  ```
1070
1055
 
1071
- _See code: [src/commands/datasets/embeddings/disable.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/datasets/embeddings/disable.ts)_
1072
-
1073
1056
  ## `sanity datasets embeddings enable [DATASET]`
1074
1057
 
1075
1058
  Enable embeddings for a dataset
@@ -1105,8 +1088,6 @@ EXAMPLES
1105
1088
  $ sanity datasets embeddings enable production --wait
1106
1089
  ```
1107
1090
 
1108
- _See code: [src/commands/datasets/embeddings/enable.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/datasets/embeddings/enable.ts)_
1109
-
1110
1091
  ## `sanity datasets embeddings status [DATASET]`
1111
1092
 
1112
1093
  Show embeddings settings and status for a dataset
@@ -1130,11 +1111,9 @@ EXAMPLES
1130
1111
  $ sanity datasets embeddings status production
1131
1112
  ```
1132
1113
 
1133
- _See code: [src/commands/datasets/embeddings/status.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/datasets/embeddings/status.ts)_
1134
-
1135
1114
  ## `sanity datasets export [NAME] [DESTINATION]`
1136
1115
 
1137
- Export dataset to local filesystem as a gzipped tarball. Assets failing with HTTP status codes 401, 403 and 404 upon download are ignored and excluded from export.
1116
+ Export a dataset to a local gzipped tarball. Assets returning 401, 403, or 404 are excluded from the export.
1138
1117
 
1139
1118
  ```
1140
1119
  USAGE
@@ -1147,9 +1126,8 @@ ARGUMENTS
1147
1126
 
1148
1127
  FLAGS
1149
1128
  --asset-concurrency=<value> [default: 8] Concurrent number of asset downloads
1150
- --mode=<option> [default: stream] Mode to export documents with `cursor` might be more performant for
1151
- larger datasets, but might not be as accurate if the dataset is being modified during
1152
- export
1129
+ --mode=<option> [default: stream] Export mode ('cursor' is faster for large datasets but may miss
1130
+ concurrent changes)
1153
1131
  <options: stream|cursor>
1154
1132
  --no-assets Export only non-asset documents and remove references to image assets
1155
1133
  --no-compress Skips compressing tarball entries (still generates a gzip file)
@@ -1162,8 +1140,7 @@ OVERRIDE FLAGS
1162
1140
  -p, --project-id=<id> Project ID to export dataset from (overrides CLI configuration)
1163
1141
 
1164
1142
  DESCRIPTION
1165
- Export dataset to local filesystem as a gzipped tarball. Assets failing with HTTP status codes 401, 403 and 404 upon
1166
- download are ignored and excluded from export.
1143
+ Export a dataset to a local gzipped tarball. Assets returning 401, 403, or 404 are excluded from the export.
1167
1144
 
1168
1145
  EXAMPLES
1169
1146
  Export dataset "moviedb" to localPath.tar.gz
@@ -1183,8 +1160,6 @@ EXAMPLES
1183
1160
  $ sanity datasets export staging staging.tar.gz --types products,shops
1184
1161
  ```
1185
1162
 
1186
- _See code: [src/commands/datasets/export.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/datasets/export.ts)_
1187
-
1188
1163
  ## `sanity datasets import SOURCE [TARGETDATASET]`
1189
1164
 
1190
1165
  Import documents to a Sanity dataset
@@ -1236,11 +1211,9 @@ EXAMPLES
1236
1211
  $ sanity datasets import -d staging -t someSecretToken my-dataset.ndjson
1237
1212
  ```
1238
1213
 
1239
- _See code: [src/commands/datasets/import.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/datasets/import.ts)_
1240
-
1241
1214
  ## `sanity datasets list`
1242
1215
 
1243
- List datasets of your project
1216
+ List datasets for the project
1244
1217
 
1245
1218
  ```
1246
1219
  USAGE
@@ -1250,10 +1223,10 @@ OVERRIDE FLAGS
1250
1223
  -p, --project-id=<id> Project ID to list datasets for (overrides CLI configuration)
1251
1224
 
1252
1225
  DESCRIPTION
1253
- List datasets of your project
1226
+ List datasets for the project
1254
1227
 
1255
1228
  EXAMPLES
1256
- List datasets of your project
1229
+ List datasets for the project
1257
1230
 
1258
1231
  $ sanity datasets list
1259
1232
 
@@ -1262,8 +1235,6 @@ EXAMPLES
1262
1235
  $ sanity datasets list --project-id abc123
1263
1236
  ```
1264
1237
 
1265
- _See code: [src/commands/datasets/list.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/datasets/list.ts)_
1266
-
1267
1238
  ## `sanity datasets visibility get DATASET`
1268
1239
 
1269
1240
  Get the visibility of a dataset
@@ -1287,8 +1258,6 @@ EXAMPLES
1287
1258
  $ sanity datasets visibility get my-dataset
1288
1259
  ```
1289
1260
 
1290
- _See code: [src/commands/datasets/visibility/get.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/datasets/visibility/get.ts)_
1291
-
1292
1261
  ## `sanity datasets visibility set DATASET MODE`
1293
1262
 
1294
1263
  Set the visibility of a dataset
@@ -1317,11 +1286,9 @@ EXAMPLES
1317
1286
  $ sanity datasets visibility set my-dataset public
1318
1287
  ```
1319
1288
 
1320
- _See code: [src/commands/datasets/visibility/set.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/datasets/visibility/set.ts)_
1321
-
1322
1289
  ## `sanity debug`
1323
1290
 
1324
- Provides diagnostic info for Sanity Studio troubleshooting
1291
+ Print diagnostic info for troubleshooting
1325
1292
 
1326
1293
  ```
1327
1294
  USAGE
@@ -1332,7 +1299,7 @@ FLAGS
1332
1299
  --verbose Show full error details including stack traces
1333
1300
 
1334
1301
  DESCRIPTION
1335
- Provides diagnostic info for Sanity Studio troubleshooting
1302
+ Print diagnostic info for troubleshooting
1336
1303
 
1337
1304
  EXAMPLES
1338
1305
  $ sanity debug
@@ -1340,8 +1307,6 @@ EXAMPLES
1340
1307
  $ sanity debug --secrets
1341
1308
  ```
1342
1309
 
1343
- _See code: [src/commands/debug.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/debug.ts)_
1344
-
1345
1310
  ## `sanity deploy [SOURCEDIR]`
1346
1311
 
1347
1312
  Builds and deploys Sanity Studio or application to Sanity hosting
@@ -1357,10 +1322,10 @@ ARGUMENTS
1357
1322
  FLAGS
1358
1323
  -y, --yes Unattended mode, answers "yes" to any "yes/no" prompt and otherwise uses defaults
1359
1324
  --[no-]auto-updates Automatically update the studio to the latest version
1360
- --[no-]build Don't build the studio prior to deploy, instead deploying the version currently in `dist/`
1325
+ --[no-]build Build the studio before deploying (use --no-build to deploy existing `dist/` output)
1361
1326
  --external Register an externally hosted studio
1362
- --[no-]minify Skip minifying built JavaScript (speeds up build, increases size of bundle)
1363
- --schema-required Fail-fast deployment if schema store fails
1327
+ --[no-]minify Minify built JavaScript (use --no-minify to skip for faster builds)
1328
+ --schema-required Fail if schema deployment fails
1364
1329
  --source-maps Enable source maps for built bundles (increases size of bundle)
1365
1330
  --url=<value> Studio URL for deployment. For external studios, the full URL. For hosted studios, the
1366
1331
  hostname (e.g. "my-studio" or "my-studio.sanity.studio")
@@ -1387,24 +1352,22 @@ EXAMPLES
1387
1352
  $ sanity deploy --external
1388
1353
  ```
1389
1354
 
1390
- _See code: [src/commands/deploy.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/deploy.ts)_
1391
-
1392
1355
  ## `sanity dev`
1393
1356
 
1394
- Starts a local development server for Sanity Studio with live reloading
1357
+ Start a local development server with live reloading
1395
1358
 
1396
1359
  ```
1397
1360
  USAGE
1398
1361
  $ sanity dev [--auto-updates] [--host <value>] [--load-in-dashboard] [--port <value>]
1399
1362
 
1400
1363
  FLAGS
1401
- --[no-]auto-updates Automatically update Sanity Studio dependencies.
1402
- --host=<value> [default: localhost] The local network interface at which to listen.
1403
- --[no-]load-in-dashboard Load the app/studio in the Sanity dashboard.
1404
- --port=<value> [default: 3333] TCP port to start server on.
1364
+ --[no-]auto-updates Automatically update Sanity Studio dependencies
1365
+ --host=<value> Local network interface to listen on (default: localhost)
1366
+ --[no-]load-in-dashboard Load the app/studio in the Sanity dashboard
1367
+ --port=<value> TCP port to start server on (default: 3333)
1405
1368
 
1406
1369
  DESCRIPTION
1407
- Starts a local development server for Sanity Studio with live reloading
1370
+ Start a local development server with live reloading
1408
1371
 
1409
1372
  EXAMPLES
1410
1373
  $ sanity dev --host=0.0.0.0
@@ -1414,22 +1377,18 @@ EXAMPLES
1414
1377
  $ sanity dev --load-in-dashboard
1415
1378
  ```
1416
1379
 
1417
- _See code: [src/commands/dev.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/dev.ts)_
1418
-
1419
1380
  ## `sanity docs browse`
1420
1381
 
1421
- Open Sanity docs in a web browser
1382
+ Open Sanity docs in your browser
1422
1383
 
1423
1384
  ```
1424
1385
  USAGE
1425
1386
  $ sanity docs browse
1426
1387
 
1427
1388
  DESCRIPTION
1428
- Open Sanity docs in a web browser
1389
+ Open Sanity docs in your browser
1429
1390
  ```
1430
1391
 
1431
- _See code: [src/commands/docs/browse.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/docs/browse.ts)_
1432
-
1433
1392
  ## `sanity docs read PATH`
1434
1393
 
1435
1394
  Read an article in terminal
@@ -1465,8 +1424,6 @@ EXAMPLES
1465
1424
  $ sanity docs read https://www.sanity.io/docs/studio/installation -w
1466
1425
  ```
1467
1426
 
1468
- _See code: [src/commands/docs/read.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/docs/read.ts)_
1469
-
1470
1427
  ## `sanity docs search QUERY`
1471
1428
 
1472
1429
  Search Sanity docs
@@ -1498,8 +1455,6 @@ EXAMPLES
1498
1455
  $ sanity docs search "deployment" --limit=5
1499
1456
  ```
1500
1457
 
1501
- _See code: [src/commands/docs/search.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/docs/search.ts)_
1502
-
1503
1458
  ## `sanity doctor [CHECKS]`
1504
1459
 
1505
1460
  Run diagnostics on your Sanity project
@@ -1529,8 +1484,6 @@ EXAMPLES
1529
1484
  $ sanity doctor cli
1530
1485
  ```
1531
1486
 
1532
- _See code: [src/commands/doctor.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/doctor.ts)_
1533
-
1534
1487
  ## `sanity documents create [FILE]`
1535
1488
 
1536
1489
  Create one or more documents
@@ -1580,11 +1533,9 @@ EXAMPLES
1580
1533
  $ sanity documents create myDocument.json --project-id abc123
1581
1534
  ```
1582
1535
 
1583
- _See code: [src/commands/documents/create.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/documents/create.ts)_
1584
-
1585
1536
  ## `sanity documents delete ID [IDS]`
1586
1537
 
1587
- Delete one or more documents from the projects configured dataset
1538
+ Delete one or more documents from the project's configured dataset
1588
1539
 
1589
1540
  ```
1590
1541
  USAGE
@@ -1599,7 +1550,7 @@ OVERRIDE FLAGS
1599
1550
  -p, --project-id=<id> Project ID to delete from (overrides CLI configuration)
1600
1551
 
1601
1552
  DESCRIPTION
1602
- Delete one or more documents from the projects configured dataset
1553
+ Delete one or more documents from the project's configured dataset
1603
1554
 
1604
1555
  EXAMPLES
1605
1556
  Delete the document with the ID "myDocId"
@@ -1623,8 +1574,6 @@ EXAMPLES
1623
1574
  $ sanity documents delete myDocId --project-id abc123
1624
1575
  ```
1625
1576
 
1626
- _See code: [src/commands/documents/delete.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/documents/delete.ts)_
1627
-
1628
1577
  ## `sanity documents get DOCUMENTID`
1629
1578
 
1630
1579
  Get and print a document by ID
@@ -1664,8 +1613,6 @@ EXAMPLES
1664
1613
  $ sanity documents get myDocId --project-id abc123
1665
1614
  ```
1666
1615
 
1667
- _See code: [src/commands/documents/get.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/documents/get.ts)_
1668
-
1669
1616
  ## `sanity documents query QUERY`
1670
1617
 
1671
1618
  Query for documents
@@ -1707,8 +1654,6 @@ EXAMPLES
1707
1654
  $ sanity documents query '*[_type == "post"]' --project-id abc123 --dataset production
1708
1655
  ```
1709
1656
 
1710
- _See code: [src/commands/documents/query.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/documents/query.ts)_
1711
-
1712
1657
  ## `sanity documents validate`
1713
1658
 
1714
1659
  Validate documents in a dataset against the studio schema
@@ -1761,8 +1706,6 @@ EXAMPLES
1761
1706
  $ sanity documents validate --project-id abc123 --dataset production
1762
1707
  ```
1763
1708
 
1764
- _See code: [src/commands/documents/validate.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/documents/validate.ts)_
1765
-
1766
1709
  ## `sanity exec SCRIPT`
1767
1710
 
1768
1711
  Executes a script within the Sanity Studio context
@@ -1775,8 +1718,8 @@ ARGUMENTS
1775
1718
  SCRIPT... Path to the script to execute
1776
1719
 
1777
1720
  FLAGS
1778
- --mock-browser-env Mocks a browser-like environment using jsdom
1779
- --with-user-token Prime access token from CLI config into getCliClient()
1721
+ --mock-browser-env Mock a browser environment with jsdom
1722
+ --with-user-token Include your auth token in getCliClient()
1780
1723
 
1781
1724
  DESCRIPTION
1782
1725
  Executes a script within the Sanity Studio context
@@ -1802,40 +1745,42 @@ EXAMPLES
1802
1745
  $ sanity exec --mock-browser-env myscript.js -- --dry-run positional-argument
1803
1746
  ```
1804
1747
 
1805
- _See code: [src/commands/exec.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/exec.ts)_
1806
-
1807
1748
  ## `sanity functions add`
1808
1749
 
1809
1750
  Add a Function to your Blueprint
1810
1751
 
1811
1752
  ```
1812
1753
  USAGE
1813
- $ sanity functions add [--example <value> | -n <value> | | --language ts|js | --javascript | | ] [--type
1814
- document-publish|document-create|document-update|document-delete|media-library-asset-create|media-library-asset-upda
1815
- te|media-library-asset-delete|scheduled-function... ] [--helpers] [--installer skip|npm|pnpm|yarn] [-i | ]
1754
+ $ sanity functions add [--json] [--validate-resources] [--example <value> | -n <value> | | --language ts|js |
1755
+ --javascript | | ] [--type document-publish|document-create|document-delete|document-update|media-library-asset-cre
1756
+ ate|media-library-asset-delete|media-library-asset-update|scheduled-function|sync-tag-invalidate... ] [--helpers]
1757
+ [--installer skip|npm|pnpm|yarn] [-i | ]
1816
1758
 
1817
1759
  FLAGS
1818
- -i, --install Shortcut for --fn-installer npm
1819
- -n, --name=<value> Name of the Function to add
1820
- --example=<value> Example to use for the Function
1821
- --[no-]helpers Add helpers to the new Function
1822
- --installer=<option> How to install the @sanity/functions helpers
1823
- <options: skip|npm|pnpm|yarn>
1824
- --javascript Use JavaScript instead of TypeScript
1825
- --language=<option> [default: ts] Language of the new Function
1826
- <options: ts|js>
1827
- --type=<option>... Document change event(s) that should trigger the function; you can specify multiple events
1828
- by specifying this flag multiple times
1829
- <options: document-publish|document-create|document-update|document-delete|media-library-ass
1830
- et-create|media-library-asset-update|media-library-asset-delete|scheduled-function>
1760
+ -i, --install Shortcut for --fn-installer npm
1761
+ -n, --name=<value> Name of the Function to add
1762
+ --example=<value> Example to use for the Function
1763
+ --[no-]helpers Add helpers to the new Function
1764
+ --installer=<option> How to install the @sanity/functions helpers
1765
+ <options: skip|npm|pnpm|yarn>
1766
+ --javascript Use JavaScript instead of TypeScript
1767
+ --json Format output as json
1768
+ --language=<option> [default: ts] Language of the new Function
1769
+ <options: ts|js>
1770
+ --type=<option>... Document change event(s) that should trigger the function; you can specify multiple
1771
+ events by specifying this flag multiple times
1772
+ <options: document-publish|document-create|document-delete|document-update|media-librar
1773
+ y-asset-create|media-library-asset-delete|media-library-asset-update|scheduled-function
1774
+ |sync-tag-invalidate>
1775
+ --[no-]validate-resources Validate resources
1831
1776
 
1832
1777
  DESCRIPTION
1833
1778
  Add a Function to your Blueprint
1834
1779
 
1835
1780
  Scaffolds a new Function in the functions/ folder and templates a resource for your Blueprint manifest.
1836
1781
 
1837
- Functions are serverless handlers triggered by document events (create, update, delete, publish) or media library
1838
- events.
1782
+ Functions are serverless handlers triggered by document, live content or media-library events (create, update, delete,
1783
+ publish).
1839
1784
 
1840
1785
  After adding, use 'functions dev' to test locally, then 'blueprints deploy' to publish.
1841
1786
 
@@ -1851,21 +1796,21 @@ EXAMPLES
1851
1796
  $ sanity functions add --name my-function --type document-create --type document-update --lang js
1852
1797
  ```
1853
1798
 
1854
- _See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.7.2/src/commands/functions/add.ts)_
1855
-
1856
1799
  ## `sanity functions dev`
1857
1800
 
1858
1801
  Start the Sanity Function emulator
1859
1802
 
1860
1803
  ```
1861
1804
  USAGE
1862
- $ sanity functions dev [-h <value>] [-p <value>] [-t <value>]
1805
+ $ sanity functions dev [--json] [--validate-resources] [-h <value>] [-p <value>] [-t <value>]
1863
1806
 
1864
1807
  FLAGS
1865
- -h, --host=<value> The local network interface at which to listen. [default: "localhost"]
1866
- -p, --port=<value> TCP port to start emulator on. [default: 8080]
1867
- -t, --timeout=<value> Maximum execution time for all functions, in seconds. Takes precedence over function-specific
1868
- `timeout`
1808
+ -h, --host=<value> The local network interface at which to listen. [default: "localhost"]
1809
+ -p, --port=<value> TCP port to start emulator on. [default: 8080]
1810
+ -t, --timeout=<value> Maximum execution time for all functions, in seconds. Takes precedence over
1811
+ function-specific `timeout`
1812
+ --json Format output as json
1813
+ --[no-]validate-resources Validate resources
1869
1814
 
1870
1815
  DESCRIPTION
1871
1816
  Start the Sanity Function emulator
@@ -1885,21 +1830,23 @@ EXAMPLES
1885
1830
  $ sanity functions dev --timeout 60
1886
1831
  ```
1887
1832
 
1888
- _See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.7.2/src/commands/functions/dev.ts)_
1889
-
1890
1833
  ## `sanity functions env add NAME KEY VALUE`
1891
1834
 
1892
1835
  Add or set an environment variable for a deployed function
1893
1836
 
1894
1837
  ```
1895
1838
  USAGE
1896
- $ sanity functions env add NAME KEY VALUE
1839
+ $ sanity functions env add NAME KEY VALUE [--json] [--validate-resources]
1897
1840
 
1898
1841
  ARGUMENTS
1899
1842
  NAME The name of the Sanity Function
1900
1843
  KEY The name of the environment variable
1901
1844
  VALUE The value of the environment variable
1902
1845
 
1846
+ FLAGS
1847
+ --json Format output as json
1848
+ --[no-]validate-resources Validate resources
1849
+
1903
1850
  DESCRIPTION
1904
1851
  Add or set an environment variable for a deployed function
1905
1852
 
@@ -1912,19 +1859,21 @@ EXAMPLES
1912
1859
  $ sanity functions env add MyFunction API_URL https://api.example.com/
1913
1860
  ```
1914
1861
 
1915
- _See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.7.2/src/commands/functions/env/add.ts)_
1916
-
1917
1862
  ## `sanity functions env list NAME`
1918
1863
 
1919
1864
  List environment variables for a deployed function
1920
1865
 
1921
1866
  ```
1922
1867
  USAGE
1923
- $ sanity functions env list NAME
1868
+ $ sanity functions env list NAME [--json] [--validate-resources]
1924
1869
 
1925
1870
  ARGUMENTS
1926
1871
  NAME The name of the Sanity Function
1927
1872
 
1873
+ FLAGS
1874
+ --json Format output as json
1875
+ --[no-]validate-resources Validate resources
1876
+
1928
1877
  DESCRIPTION
1929
1878
  List environment variables for a deployed function
1930
1879
 
@@ -1936,20 +1885,22 @@ EXAMPLES
1936
1885
  $ sanity functions env list MyFunction
1937
1886
  ```
1938
1887
 
1939
- _See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.7.2/src/commands/functions/env/list.ts)_
1940
-
1941
1888
  ## `sanity functions env remove NAME KEY`
1942
1889
 
1943
1890
  Remove an environment variable from a deployed function
1944
1891
 
1945
1892
  ```
1946
1893
  USAGE
1947
- $ sanity functions env remove NAME KEY
1894
+ $ sanity functions env remove NAME KEY [--json] [--validate-resources]
1948
1895
 
1949
1896
  ARGUMENTS
1950
1897
  NAME The name of the Sanity Function
1951
1898
  KEY The name of the environment variable
1952
1899
 
1900
+ FLAGS
1901
+ --json Format output as json
1902
+ --[no-]validate-resources Validate resources
1903
+
1953
1904
  DESCRIPTION
1954
1905
  Remove an environment variable from a deployed function
1955
1906
 
@@ -1962,27 +1913,26 @@ EXAMPLES
1962
1913
  $ sanity functions env remove MyFunction API_URL
1963
1914
  ```
1964
1915
 
1965
- _See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.7.2/src/commands/functions/env/remove.ts)_
1966
-
1967
1916
  ## `sanity functions logs [NAME]`
1968
1917
 
1969
1918
  Retrieve or delete logs for a Sanity Function
1970
1919
 
1971
1920
  ```
1972
1921
  USAGE
1973
- $ sanity functions logs [NAME] [--stack <value>] [-u] [-f [-d | -l <value> | -j]] [-w]
1922
+ $ sanity functions logs [NAME] [--validate-resources] [--stack <value>] [-u] [-f [-d | -l <value> | --json]] [-w]
1974
1923
 
1975
1924
  ARGUMENTS
1976
1925
  [NAME] The name of the Sanity Function
1977
1926
 
1978
1927
  FLAGS
1979
- -d, --delete Delete all logs for the function
1980
- -f, --force Skip confirmation for deleting logs
1981
- -j, --json Return logs in JSON format
1982
- -l, --limit=<value> [default: 50] Total number of log entries to retrieve
1983
- -u, --utc Show dates in UTC time zone
1984
- -w, --watch Watch for new logs (streaming mode)
1985
- --stack=<value> Stack name or ID to use instead of the locally configured Stack
1928
+ -d, --delete Delete all logs for the function
1929
+ -f, --force Skip confirmation for deleting logs
1930
+ -l, --limit=<value> [default: 50] Total number of log entries to retrieve
1931
+ -u, --utc Show dates in UTC time zone
1932
+ -w, --watch Watch for new logs (streaming mode)
1933
+ --json Format output as json
1934
+ --stack=<value> Stack name or ID to use instead of the locally configured Stack
1935
+ --[no-]validate-resources Validate resources
1986
1936
 
1987
1937
  DESCRIPTION
1988
1938
  Retrieve or delete logs for a Sanity Function
@@ -2002,18 +1952,17 @@ EXAMPLES
2002
1952
  $ sanity functions logs <name> --delete
2003
1953
  ```
2004
1954
 
2005
- _See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.7.2/src/commands/functions/logs.ts)_
2006
-
2007
1955
  ## `sanity functions test [NAME]`
2008
1956
 
2009
1957
  Invoke a local Sanity Function
2010
1958
 
2011
1959
  ```
2012
1960
  USAGE
2013
- $ sanity functions test [NAME] [--data-before <value> | [-d <value> | -f <value> | --document-id <value>] | | |
2014
- --file-before <value> | --file-after <value> | --document-id-before <value> | --document-id-after <value>]
2015
- [--data-after <value> | | | | | | | ] [-e create|update|delete] [-t <value>] [-a <value>] [--with-user-token]
2016
- [--media-library-id <value> | --project-id <value> | --dataset <value>]
1961
+ $ sanity functions test [NAME] [--json] [--validate-resources] [--organization-id <value>] [--data-before <value>
1962
+ | [-d <value> | -f <value> | --document-id <value>] | | | --file-before <value> | --file-after <value> |
1963
+ --document-id-before <value> | --document-id-after <value>] [--data-after <value> | | | | | | | ] [-e
1964
+ create|update|delete] [-t <value>] [-a <value>] [--with-user-token] [--media-library-id <value> | --project-id
1965
+ <value> | --dataset <value>]
2017
1966
 
2018
1967
  ARGUMENTS
2019
1968
  [NAME] The name of the Sanity Function
@@ -2033,8 +1982,11 @@ FLAGS
2033
1982
  --document-id-before=<value> Original document
2034
1983
  --file-after=<value> Current document
2035
1984
  --file-before=<value> Original document
1985
+ --json Format output as json
2036
1986
  --media-library-id=<value> Sanity Media Library ID to use
2037
- --project-id=<value> Sanity Project ID to use
1987
+ --organization-id=<value> Sanity organization ID used to scope Blueprint and Stack
1988
+ --project-id=<value> Sanity project ID used to scope Blueprint and Stack
1989
+ --[no-]validate-resources Validate resources
2038
1990
  --with-user-token Prime access token from CLI config
2039
1991
 
2040
1992
  DESCRIPTION
@@ -2056,8 +2008,6 @@ EXAMPLES
2056
2008
  $ sanity functions test <name> --event update --data-before '{ "title": "before" }' --data-after '{ "title": "after" }'
2057
2009
  ```
2058
2010
 
2059
- _See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.7.2/src/commands/functions/test.ts)_
2060
-
2061
2011
  ## `sanity graphql deploy`
2062
2012
 
2063
2013
  Deploy a GraphQL API from the current Sanity schema
@@ -2069,7 +2019,7 @@ USAGE
2069
2019
 
2070
2020
  FLAGS
2071
2021
  -d, --dataset=<name> Deploy API for the given dataset
2072
- --api=<value>... Only deploy API with this ID. Can be specified multiple times.
2022
+ --api=<value>... Only deploy API with this ID (can be specified multiple times)
2073
2023
  --dry-run Validate defined GraphQL APIs, check for breaking changes, skip deploy
2074
2024
  --force Deploy API without confirming breaking changes
2075
2025
  --generation=<option> API generation to deploy (defaults to "gen3")
@@ -2077,8 +2027,7 @@ FLAGS
2077
2027
  --non-null-document-fields Use non-null document fields (_id, _type etc)
2078
2028
  --[no-]playground Enable GraphQL playground for easier debugging
2079
2029
  --tag=<value> Deploy API(s) to given tag (defaults to "default")
2080
- --with-union-cache Enable union cache that optimizes schema generation for schemas with many self
2081
- referencing types
2030
+ --with-union-cache Cache union types (faster for schemas with many self-references)
2082
2031
 
2083
2032
  DESCRIPTION
2084
2033
  Deploy a GraphQL API from the current Sanity schema
@@ -2101,11 +2050,9 @@ EXAMPLES
2101
2050
  $ sanity graphql deploy --playground
2102
2051
  ```
2103
2052
 
2104
- _See code: [src/commands/graphql/deploy.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/graphql/deploy.ts)_
2105
-
2106
2053
  ## `sanity graphql list`
2107
2054
 
2108
- List all GraphQL endpoints deployed for this project
2055
+ List deployed GraphQL endpoints for the project
2109
2056
 
2110
2057
  ```
2111
2058
  USAGE
@@ -2115,10 +2062,10 @@ OVERRIDE FLAGS
2115
2062
  -p, --project-id=<id> Project ID to list GraphQL endpoints for (overrides CLI configuration)
2116
2063
 
2117
2064
  DESCRIPTION
2118
- List all GraphQL endpoints deployed for this project
2065
+ List deployed GraphQL endpoints for the project
2119
2066
 
2120
2067
  EXAMPLES
2121
- List GraphQL endpoints for the current project
2068
+ List GraphQL endpoints for the project
2122
2069
 
2123
2070
  $ sanity graphql list
2124
2071
 
@@ -2127,8 +2074,6 @@ EXAMPLES
2127
2074
  $ sanity graphql list --project-id abc123
2128
2075
  ```
2129
2076
 
2130
- _See code: [src/commands/graphql/list.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/graphql/list.ts)_
2131
-
2132
2077
  ## `sanity graphql undeploy`
2133
2078
 
2134
2079
  Remove a deployed GraphQL API
@@ -2175,8 +2120,6 @@ EXAMPLES
2175
2120
  $ sanity graphql undeploy --project-id abc123 --dataset production
2176
2121
  ```
2177
2122
 
2178
- _See code: [src/commands/graphql/undeploy.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/graphql/undeploy.ts)_
2179
-
2180
2123
  ## `sanity help [COMMAND]`
2181
2124
 
2182
2125
  Display help for sanity.
@@ -2195,8 +2138,6 @@ DESCRIPTION
2195
2138
  Display help for sanity.
2196
2139
  ```
2197
2140
 
2198
- _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/6.2.40/src/commands/help.ts)_
2199
-
2200
2141
  ## `sanity hooks attempt ATTEMPTID`
2201
2142
 
2202
2143
  Print details of a given webhook delivery attempt
@@ -2224,11 +2165,9 @@ EXAMPLES
2224
2165
  $ sanity hooks attempt abc123 --project-id projectId
2225
2166
  ```
2226
2167
 
2227
- _See code: [src/commands/hooks/attempt.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/hooks/attempt.ts)_
2228
-
2229
2168
  ## `sanity hooks create`
2230
2169
 
2231
- Create a new webhook for the current project
2170
+ Create a new webhook for the project
2232
2171
 
2233
2172
  ```
2234
2173
  USAGE
@@ -2238,10 +2177,10 @@ OVERRIDE FLAGS
2238
2177
  -p, --project-id=<id> Project ID to create webhook for (overrides CLI configuration)
2239
2178
 
2240
2179
  DESCRIPTION
2241
- Create a new webhook for the current project
2180
+ Create a new webhook for the project
2242
2181
 
2243
2182
  EXAMPLES
2244
- Create a new webhook for the current project
2183
+ Create a new webhook for the project
2245
2184
 
2246
2185
  $ sanity hooks create
2247
2186
 
@@ -2250,44 +2189,40 @@ EXAMPLES
2250
2189
  $ sanity hooks create --project-id abc123
2251
2190
  ```
2252
2191
 
2253
- _See code: [src/commands/hooks/create.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/hooks/create.ts)_
2254
-
2255
2192
  ## `sanity hooks delete [NAME]`
2256
2193
 
2257
- Delete a hook within your project
2194
+ Delete a webhook from the project
2258
2195
 
2259
2196
  ```
2260
2197
  USAGE
2261
2198
  $ sanity hooks delete [NAME] [-p <id>]
2262
2199
 
2263
2200
  ARGUMENTS
2264
- [NAME] Name of hook to delete (will prompt if not provided)
2201
+ [NAME] Name of webhook to delete (will prompt if not provided)
2265
2202
 
2266
2203
  OVERRIDE FLAGS
2267
2204
  -p, --project-id=<id> Project ID to delete webhook from (overrides CLI configuration)
2268
2205
 
2269
2206
  DESCRIPTION
2270
- Delete a hook within your project
2207
+ Delete a webhook from the project
2271
2208
 
2272
2209
  EXAMPLES
2273
- Interactively select and delete a hook
2210
+ Interactively select and delete a webhook
2274
2211
 
2275
2212
  $ sanity hooks delete
2276
2213
 
2277
- Delete a specific hook by name
2214
+ Delete a specific webhook by name
2278
2215
 
2279
2216
  $ sanity hooks delete my-hook
2280
2217
 
2281
- Delete a hook from a specific project
2218
+ Delete a webhook from a specific project
2282
2219
 
2283
2220
  $ sanity hooks delete --project-id abc123
2284
2221
  ```
2285
2222
 
2286
- _See code: [src/commands/hooks/delete.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/hooks/delete.ts)_
2287
-
2288
2223
  ## `sanity hooks list`
2289
2224
 
2290
- List hooks for a given project
2225
+ List webhooks for the project
2291
2226
 
2292
2227
  ```
2293
2228
  USAGE
@@ -2297,30 +2232,28 @@ OVERRIDE FLAGS
2297
2232
  -p, --project-id=<id> Project ID to list webhooks for (overrides CLI configuration)
2298
2233
 
2299
2234
  DESCRIPTION
2300
- List hooks for a given project
2235
+ List webhooks for the project
2301
2236
 
2302
2237
  EXAMPLES
2303
- List hooks for a given project
2238
+ List webhooks for the project
2304
2239
 
2305
2240
  $ sanity hooks list
2306
2241
 
2307
- List hooks for a specific project
2242
+ List webhooks for a specific project
2308
2243
 
2309
2244
  $ sanity hooks list --project-id abc123
2310
2245
  ```
2311
2246
 
2312
- _See code: [src/commands/hooks/list.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/hooks/list.ts)_
2313
-
2314
2247
  ## `sanity hooks logs [NAME]`
2315
2248
 
2316
- List latest log entries for a given hook
2249
+ Show log entries for project webhooks
2317
2250
 
2318
2251
  ```
2319
2252
  USAGE
2320
2253
  $ sanity hooks logs [NAME] [-p <id>] [--detailed]
2321
2254
 
2322
2255
  ARGUMENTS
2323
- [NAME] Name of the hook to show logs for
2256
+ [NAME] Name of the webhook to show logs for
2324
2257
 
2325
2258
  FLAGS
2326
2259
  --detailed Include detailed payload and attempts
@@ -2329,24 +2262,22 @@ OVERRIDE FLAGS
2329
2262
  -p, --project-id=<id> Project ID to view webhook logs for (overrides CLI configuration)
2330
2263
 
2331
2264
  DESCRIPTION
2332
- List latest log entries for a given hook
2265
+ Show log entries for project webhooks
2333
2266
 
2334
2267
  EXAMPLES
2335
- List latest log entries for a given hook
2268
+ Show log entries for project webhooks
2336
2269
 
2337
2270
  $ sanity hooks logs
2338
2271
 
2339
- List latest log entries for a specific hook by name
2272
+ Show log entries for a specific webhook by name
2340
2273
 
2341
2274
  $ sanity hooks logs [NAME]
2342
2275
 
2343
- List hook logs for a specific project
2276
+ Show log entries for a specific project
2344
2277
 
2345
2278
  $ sanity hooks logs --project-id abc123
2346
2279
  ```
2347
2280
 
2348
- _See code: [src/commands/hooks/logs.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/hooks/logs.ts)_
2349
-
2350
2281
  ## `sanity init`
2351
2282
 
2352
2283
  Initialize a new Sanity Studio, project and/or app
@@ -2415,11 +2346,9 @@ EXAMPLES
2415
2346
  --output-path /Users/espenh/movies-unlimited
2416
2347
  ```
2417
2348
 
2418
- _See code: [src/commands/init.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/init.ts)_
2419
-
2420
2349
  ## `sanity install [PACKAGES]`
2421
2350
 
2422
- Installs dependencies for Sanity Studio project
2351
+ Install dependencies for the Sanity Studio project
2423
2352
 
2424
2353
  ```
2425
2354
  USAGE
@@ -2429,7 +2358,7 @@ ARGUMENTS
2429
2358
  [PACKAGES...] Packages to install
2430
2359
 
2431
2360
  DESCRIPTION
2432
- Installs dependencies for Sanity Studio project
2361
+ Install dependencies for the Sanity Studio project
2433
2362
 
2434
2363
  EXAMPLES
2435
2364
  $ sanity install
@@ -2439,25 +2368,21 @@ EXAMPLES
2439
2368
  $ sanity install some-package another-package
2440
2369
  ```
2441
2370
 
2442
- _See code: [src/commands/install.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/install.ts)_
2443
-
2444
2371
  ## `sanity learn`
2445
2372
 
2446
- Opens Sanity Learn in your web browser
2373
+ Open Sanity Learn in your browser
2447
2374
 
2448
2375
  ```
2449
2376
  USAGE
2450
2377
  $ sanity learn
2451
2378
 
2452
2379
  DESCRIPTION
2453
- Opens Sanity Learn in your web browser
2380
+ Open Sanity Learn in your browser
2454
2381
  ```
2455
2382
 
2456
- _See code: [src/commands/learn.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/learn.ts)_
2457
-
2458
2383
  ## `sanity login`
2459
2384
 
2460
- Authenticates the CLI for access to Sanity projects
2385
+ Log in to your Sanity account
2461
2386
 
2462
2387
  ```
2463
2388
  USAGE
@@ -2470,7 +2395,7 @@ FLAGS
2470
2395
  --sso-provider=<name> Select a specific SSO provider by name (use with --sso)
2471
2396
 
2472
2397
  DESCRIPTION
2473
- Authenticates the CLI for access to Sanity projects
2398
+ Log in to your Sanity account
2474
2399
 
2475
2400
  EXAMPLES
2476
2401
  Log in using default settings
@@ -2490,39 +2415,33 @@ EXAMPLES
2490
2415
  $ sanity login --sso my-organization --sso-provider "Okta SSO"
2491
2416
  ```
2492
2417
 
2493
- _See code: [src/commands/login.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/login.ts)_
2494
-
2495
2418
  ## `sanity logout`
2496
2419
 
2497
- Logs out the CLI from the current user session
2420
+ Log out of the current session
2498
2421
 
2499
2422
  ```
2500
2423
  USAGE
2501
2424
  $ sanity logout
2502
2425
 
2503
2426
  DESCRIPTION
2504
- Logs out the CLI from the current user session
2427
+ Log out of the current session
2505
2428
  ```
2506
2429
 
2507
- _See code: [src/commands/logout.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/logout.ts)_
2508
-
2509
2430
  ## `sanity manage`
2510
2431
 
2511
- Opens project management interface in your web browser
2432
+ Open project settings in your browser
2512
2433
 
2513
2434
  ```
2514
2435
  USAGE
2515
2436
  $ sanity manage
2516
2437
 
2517
2438
  DESCRIPTION
2518
- Opens project management interface in your web browser
2439
+ Open project settings in your browser
2519
2440
  ```
2520
2441
 
2521
- _See code: [src/commands/manage.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/manage.ts)_
2522
-
2523
2442
  ## `sanity manifest extract`
2524
2443
 
2525
- Extracts the studio configuration as one or more JSON manifest files.
2444
+ Extract studio configuration as JSON manifest files.
2526
2445
 
2527
2446
  ```
2528
2447
  USAGE
@@ -2532,9 +2451,9 @@ FLAGS
2532
2451
  --path=<value> [default: dist/static] Optional path to specify destination directory of the manifest files
2533
2452
 
2534
2453
  DESCRIPTION
2535
- Extracts the studio configuration as one or more JSON manifest files.
2454
+ Extract studio configuration as JSON manifest files.
2536
2455
 
2537
- **Note**: This command is experimental and subject to change. It is currently intended for use with Create only.
2456
+ Note: This command is experimental and subject to change. It is currently intended for use with Create only.
2538
2457
 
2539
2458
  EXAMPLES
2540
2459
  Extracts manifests
@@ -2546,8 +2465,6 @@ EXAMPLES
2546
2465
  $ sanity manifest extract --path /public/static
2547
2466
  ```
2548
2467
 
2549
- _See code: [src/commands/manifest/extract.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/manifest/extract.ts)_
2550
-
2551
2468
  ## `sanity mcp configure`
2552
2469
 
2553
2470
  Configure Sanity MCP server for AI editors (Claude Code, Codex CLI, Cursor, Gemini CLI, GitHub Copilot CLI, VS Code)
@@ -2565,8 +2482,6 @@ EXAMPLES
2565
2482
  $ sanity mcp configure
2566
2483
  ```
2567
2484
 
2568
- _See code: [src/commands/mcp/configure.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/mcp/configure.ts)_
2569
-
2570
2485
  ## `sanity media create-aspect`
2571
2486
 
2572
2487
  Create a new aspect definition file
@@ -2584,11 +2499,9 @@ EXAMPLES
2584
2499
  $ sanity media create-aspect
2585
2500
  ```
2586
2501
 
2587
- _See code: [src/commands/media/create-aspect.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/media/create-aspect.ts)_
2588
-
2589
2502
  ## `sanity media delete-aspect ASPECTNAME`
2590
2503
 
2591
- Undeploy an aspect
2504
+ Delete an aspect definition
2592
2505
 
2593
2506
  ```
2594
2507
  USAGE
@@ -2605,7 +2518,7 @@ OVERRIDE FLAGS
2605
2518
  -p, --project-id=<id> Project ID to delete media aspect from (overrides CLI configuration)
2606
2519
 
2607
2520
  DESCRIPTION
2608
- Undeploy an aspect
2521
+ Delete an aspect definition
2609
2522
 
2610
2523
  EXAMPLES
2611
2524
  Delete the aspect named "someAspect"
@@ -2613,8 +2526,6 @@ EXAMPLES
2613
2526
  $ sanity media delete-aspect someAspect
2614
2527
  ```
2615
2528
 
2616
- _See code: [src/commands/media/delete-aspect.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/media/delete-aspect.ts)_
2617
-
2618
2529
  ## `sanity media deploy-aspect [ASPECTNAME]`
2619
2530
 
2620
2531
  Deploy an aspect
@@ -2646,11 +2557,9 @@ EXAMPLES
2646
2557
  $ sanity media deploy-aspect --all
2647
2558
  ```
2648
2559
 
2649
- _See code: [src/commands/media/deploy-aspect.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/media/deploy-aspect.ts)_
2650
-
2651
2560
  ## `sanity media export [DESTINATION]`
2652
2561
 
2653
- Export an archive of all file and image assets including their aspect data from the target media library. Video assets are excluded from the export.
2562
+ Export file and image assets from a media library (excludes video)
2654
2563
 
2655
2564
  ```
2656
2565
  USAGE
@@ -2670,8 +2579,7 @@ OVERRIDE FLAGS
2670
2579
  -p, --project-id=<id> Project ID to export media from (overrides CLI configuration)
2671
2580
 
2672
2581
  DESCRIPTION
2673
- Export an archive of all file and image assets including their aspect data from the target media library. Video assets
2674
- are excluded from the export.
2582
+ Export file and image assets from a media library (excludes video)
2675
2583
 
2676
2584
  EXAMPLES
2677
2585
  Export media library interactively
@@ -2687,8 +2595,6 @@ EXAMPLES
2687
2595
  $ sanity media export --media-library-id my-library-id
2688
2596
  ```
2689
2597
 
2690
- _See code: [src/commands/media/export.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/media/export.ts)_
2691
-
2692
2598
  ## `sanity media import SOURCE`
2693
2599
 
2694
2600
  Import a set of assets to the target media library.
@@ -2725,8 +2631,6 @@ EXAMPLES
2725
2631
  $ sanity media import products --replace-aspects
2726
2632
  ```
2727
2633
 
2728
- _See code: [src/commands/media/import.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/media/import.ts)_
2729
-
2730
2634
  ## `sanity migrations create [TITLE]`
2731
2635
 
2732
2636
  Create a new migration within your project
@@ -2751,8 +2655,6 @@ EXAMPLES
2751
2655
  $ sanity migrations create "Rename field from location to address"
2752
2656
  ```
2753
2657
 
2754
- _See code: [@sanity/migrate](https://github.com/sanity-io/migrate/blob/v6.1.1/src/commands/migrations/create.ts)_
2755
-
2756
2658
  ## `sanity migrations list`
2757
2659
 
2758
2660
  List available migrations
@@ -2770,8 +2672,6 @@ EXAMPLES
2770
2672
  $ sanity migrations list
2771
2673
  ```
2772
2674
 
2773
- _See code: [@sanity/migrate](https://github.com/sanity-io/migrate/blob/v6.1.1/src/commands/migrations/list.ts)_
2774
-
2775
2675
  ## `sanity migrations run [ID]`
2776
2676
 
2777
2677
  Run a migration against a dataset
@@ -2814,8 +2714,6 @@ EXAMPLES
2814
2714
  $ sanity migrations run <id> --from-export=production.tar.gz --no-dry-run --project xyz --dataset staging
2815
2715
  ```
2816
2716
 
2817
- _See code: [@sanity/migrate](https://github.com/sanity-io/migrate/blob/v6.1.1/src/commands/migrations/run.ts)_
2818
-
2819
2717
  ## `sanity openapi get SLUG`
2820
2718
 
2821
2719
  Get an OpenAPI specification by slug
@@ -2853,8 +2751,6 @@ EXAMPLES
2853
2751
  $ sanity openapi get query > query-api.yaml
2854
2752
  ```
2855
2753
 
2856
- _See code: [src/commands/openapi/get.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/openapi/get.ts)_
2857
-
2858
2754
  ## `sanity openapi list`
2859
2755
 
2860
2756
  List all available OpenAPI specifications
@@ -2884,11 +2780,9 @@ EXAMPLES
2884
2780
  $ sanity openapi list --web
2885
2781
  ```
2886
2782
 
2887
- _See code: [src/commands/openapi/list.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/openapi/list.ts)_
2888
-
2889
2783
  ## `sanity preview [OUTPUTDIR]`
2890
2784
 
2891
- Starts a server to preview a production build
2785
+ Start a local server to preview a production build
2892
2786
 
2893
2787
  ```
2894
2788
  USAGE
@@ -2898,11 +2792,11 @@ ARGUMENTS
2898
2792
  [OUTPUTDIR] Output directory
2899
2793
 
2900
2794
  FLAGS
2901
- --host=<value> [default: localhost] The local network interface at which to listen.
2902
- --port=<value> [default: 3333] TCP port to start server on.
2795
+ --host=<value> Local network interface to listen on (default: localhost)
2796
+ --port=<value> TCP port to start server on (default: 3333)
2903
2797
 
2904
2798
  DESCRIPTION
2905
- Starts a server to preview a production build
2799
+ Start a local server to preview a production build
2906
2800
 
2907
2801
  EXAMPLES
2908
2802
  $ sanity preview --host=0.0.0.0
@@ -2912,8 +2806,6 @@ EXAMPLES
2912
2806
  $ sanity preview some/build-output-dir
2913
2807
  ```
2914
2808
 
2915
- _See code: [src/commands/preview.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/preview.ts)_
2916
-
2917
2809
  ## `sanity projects create [PROJECTNAME]`
2918
2810
 
2919
2811
  Create a new Sanity project
@@ -2960,37 +2852,33 @@ EXAMPLES
2960
2852
  $ sanity projects create "CI Project" --yes --json
2961
2853
  ```
2962
2854
 
2963
- _See code: [src/commands/projects/create.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/projects/create.ts)_
2964
-
2965
2855
  ## `sanity projects list`
2966
2856
 
2967
- Lists projects connected to your user
2857
+ List your projects
2968
2858
 
2969
2859
  ```
2970
2860
  USAGE
2971
2861
  $ sanity projects list [--order asc|desc] [--sort id|members|name|url|created]
2972
2862
 
2973
2863
  FLAGS
2974
- --order=<option> [default: desc]
2864
+ --order=<option> [default: desc] Sort direction
2975
2865
  <options: asc|desc>
2976
- --sort=<option> [default: created]
2866
+ --sort=<option> [default: created] Sort field
2977
2867
  <options: id|members|name|url|created>
2978
2868
 
2979
2869
  DESCRIPTION
2980
- Lists projects connected to your user
2870
+ List your projects
2981
2871
 
2982
2872
  EXAMPLES
2983
2873
  List projects
2984
2874
 
2985
2875
  $ sanity projects list
2986
2876
 
2987
- List all users of the project, but exclude pending invitations and robots
2877
+ List projects sorted by member count, ascending
2988
2878
 
2989
2879
  $ sanity projects list --sort=members --order=asc
2990
2880
  ```
2991
2881
 
2992
- _See code: [src/commands/projects/list.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/projects/list.ts)_
2993
-
2994
2882
  ## `sanity schemas delete`
2995
2883
 
2996
2884
  Delete schema documents by id
@@ -3021,8 +2909,6 @@ EXAMPLES
3021
2909
  sanity.workspace.schema.workspaceName,prefix.sanity.workspace.schema.otherWorkspace
3022
2910
  ```
3023
2911
 
3024
- _See code: [src/commands/schemas/delete.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/schemas/delete.ts)_
3025
-
3026
2912
  ## `sanity schemas deploy`
3027
2913
 
3028
2914
  Deploy schema documents into workspace datasets.
@@ -3033,7 +2919,7 @@ USAGE
3033
2919
  <name>]
3034
2920
 
3035
2921
  FLAGS
3036
- --[no-]extract-manifest Disables manifest generation - the command will fail if no manifest exists
2922
+ --[no-]extract-manifest Regenerate manifest before deploying (use --no-extract-manifest to skip)
3037
2923
  --manifest-dir=<directory> [default: ./dist/static] Directory containing manifest file
3038
2924
  --tag=<tag> Add a tag suffix to the schema id
3039
2925
  --verbose Print detailed information during deployment
@@ -3042,10 +2928,9 @@ FLAGS
3042
2928
  DESCRIPTION
3043
2929
  Deploy schema documents into workspace datasets.
3044
2930
 
3045
- **Note**: This command is experimental and subject to change.
2931
+ Note: This command is experimental and subject to change.
3046
2932
 
3047
- This operation (re-)generates a manifest file describing the sanity config workspace by default.
3048
- To re-use an existing manifest file, use --no-extract-manifest.
2933
+ Regenerates a manifest file by default. To re-use an existing manifest, use --no-extract-manifest.
3049
2934
 
3050
2935
  EXAMPLES
3051
2936
  Deploy all workspace schemas
@@ -3057,11 +2942,9 @@ EXAMPLES
3057
2942
  $ sanity schemas deploy --workspace default
3058
2943
  ```
3059
2944
 
3060
- _See code: [src/commands/schemas/deploy.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/schemas/deploy.ts)_
3061
-
3062
2945
  ## `sanity schemas extract`
3063
2946
 
3064
- Extracts a JSON representation of a Sanity schema within a Studio context.
2947
+ Extract a JSON representation of a Sanity schema within a Studio context.
3065
2948
 
3066
2949
  ```
3067
2950
  USAGE
@@ -3070,17 +2953,16 @@ USAGE
3070
2953
 
3071
2954
  FLAGS
3072
2955
  --enforce-required-fields Makes the schema generated treat fields marked as required as non-optional
3073
- --format=<format> [default: groq-type-nodes] Format the schema as GROQ type nodes. Only available format at
3074
- the moment.
2956
+ --format=<format> [default: groq-type-nodes] Output format (currently only groq-type-nodes)
3075
2957
  --path=<value> Optional path to specify destination of the schema file
3076
2958
  --watch Enable watch mode to re-extract schema on file changes
3077
2959
  --watch-patterns=<glob>... Additional glob pattern(s) to watch (can be specified multiple times)
3078
2960
  --workspace=<name> The name of the workspace to generate a schema for
3079
2961
 
3080
2962
  DESCRIPTION
3081
- Extracts a JSON representation of a Sanity schema within a Studio context.
2963
+ Extract a JSON representation of a Sanity schema within a Studio context.
3082
2964
 
3083
- **Note**: This command is experimental and subject to change.
2965
+ Note: This command is experimental and subject to change.
3084
2966
 
3085
2967
  EXAMPLES
3086
2968
  Extracts schema types in a Sanity project with more than one workspace
@@ -3096,11 +2978,9 @@ EXAMPLES
3096
2978
  $ sanity schemas extract --watch --watch-patterns "lib/**/*.ts"
3097
2979
  ```
3098
2980
 
3099
- _See code: [src/commands/schemas/extract.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/schemas/extract.ts)_
3100
-
3101
2981
  ## `sanity schemas list`
3102
2982
 
3103
- Lists all schemas in the current dataset.
2983
+ List all schemas in the current dataset.
3104
2984
 
3105
2985
  ```
3106
2986
  USAGE
@@ -3111,12 +2991,11 @@ FLAGS
3111
2991
  --json Get schema as json
3112
2992
 
3113
2993
  DESCRIPTION
3114
- Lists all schemas in the current dataset.
2994
+ List all schemas in the current dataset.
3115
2995
 
3116
- **Note**: This command is experimental and subject to change.
2996
+ Note: This command is experimental and subject to change.
3117
2997
 
3118
- This operation (re-)generates a manifest file describing the sanity config workspace by default.
3119
- To re-use an existing manifest file, use --no-extract-manifest.
2998
+ Regenerates a manifest file by default. To reuse an existing manifest, use --no-extract-manifest.
3120
2999
 
3121
3000
  EXAMPLES
3122
3001
  List all schemas found in any workspace dataset in a table
@@ -3136,8 +3015,6 @@ EXAMPLES
3136
3015
  $ sanity schemas list --json --id _.schemas.workspaceName
3137
3016
  ```
3138
3017
 
3139
- _See code: [src/commands/schemas/list.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/schemas/list.ts)_
3140
-
3141
3018
  ## `sanity schemas validate`
3142
3019
 
3143
3020
  Validates all schema types specified in a workspace
@@ -3179,68 +3056,60 @@ EXAMPLES
3179
3056
  $ sanity schemas validate --debug-metafile-path metafile.json
3180
3057
  ```
3181
3058
 
3182
- _See code: [src/commands/schemas/validate.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/schemas/validate.ts)_
3183
-
3184
3059
  ## `sanity telemetry disable`
3185
3060
 
3186
- Disable telemetry for your logged in user
3061
+ Disable telemetry for your account
3187
3062
 
3188
3063
  ```
3189
3064
  USAGE
3190
3065
  $ sanity telemetry disable
3191
3066
 
3192
3067
  DESCRIPTION
3193
- Disable telemetry for your logged in user
3068
+ Disable telemetry for your account
3194
3069
 
3195
3070
  EXAMPLES
3196
- Disable telemetry for your logged in user
3071
+ Disable telemetry for your account
3197
3072
 
3198
3073
  $ sanity telemetry telemetry disable
3199
3074
  ```
3200
3075
 
3201
- _See code: [src/commands/telemetry/disable.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/telemetry/disable.ts)_
3202
-
3203
3076
  ## `sanity telemetry enable`
3204
3077
 
3205
- Enable telemetry for your logged in user
3078
+ Enable telemetry for your account
3206
3079
 
3207
3080
  ```
3208
3081
  USAGE
3209
3082
  $ sanity telemetry enable
3210
3083
 
3211
3084
  DESCRIPTION
3212
- Enable telemetry for your logged in user
3085
+ Enable telemetry for your account
3213
3086
 
3214
3087
  EXAMPLES
3215
- Enable telemetry for your logged in user
3088
+ Enable telemetry for your account
3216
3089
 
3217
3090
  $ sanity telemetry telemetry enable
3218
3091
  ```
3219
3092
 
3220
- _See code: [src/commands/telemetry/enable.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/telemetry/enable.ts)_
3221
-
3222
3093
  ## `sanity telemetry status`
3223
3094
 
3224
- Check telemetry consent status for your logged in user
3095
+ Check telemetry status for your account
3225
3096
 
3226
3097
  ```
3227
3098
  USAGE
3228
3099
  $ sanity telemetry status
3229
3100
 
3230
3101
  DESCRIPTION
3231
- Check telemetry consent status for your logged in user
3102
+ Check telemetry status for your account
3232
3103
 
3233
3104
  EXAMPLES
3234
- Check telemetry consent status for your logged in user
3105
+ Check telemetry status for your account
3235
3106
 
3236
3107
  $ sanity telemetry telemetry status
3237
3108
  ```
3238
3109
 
3239
- _See code: [src/commands/telemetry/status.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/telemetry/status.ts)_
3240
-
3241
3110
  ## `sanity tokens add [LABEL]`
3242
3111
 
3243
- Create a new API token for this project
3112
+ Create a new API token for the project
3244
3113
 
3245
3114
  ```
3246
3115
  USAGE
@@ -3258,7 +3127,7 @@ OVERRIDE FLAGS
3258
3127
  -p, --project-id=<id> Project ID to add token to (overrides CLI configuration)
3259
3128
 
3260
3129
  DESCRIPTION
3261
- Create a new API token for this project
3130
+ Create a new API token for the project
3262
3131
 
3263
3132
  EXAMPLES
3264
3133
  Create a token with a label
@@ -3282,11 +3151,9 @@ EXAMPLES
3282
3151
  $ sanity tokens add "My Token" --project-id abc123 --role=editor
3283
3152
  ```
3284
3153
 
3285
- _See code: [src/commands/tokens/add.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/tokens/add.ts)_
3286
-
3287
3154
  ## `sanity tokens delete [TOKENID]`
3288
3155
 
3289
- Delete an API token from this project
3156
+ Delete an API token from the project
3290
3157
 
3291
3158
  ```
3292
3159
  USAGE
@@ -3302,7 +3169,7 @@ OVERRIDE FLAGS
3302
3169
  -p, --project-id=<id> Project ID to delete token from (overrides CLI configuration)
3303
3170
 
3304
3171
  DESCRIPTION
3305
- Delete an API token from this project
3172
+ Delete an API token from the project
3306
3173
 
3307
3174
  EXAMPLES
3308
3175
  Interactively select and delete a token
@@ -3322,11 +3189,9 @@ EXAMPLES
3322
3189
  $ sanity tokens delete --project-id abc123
3323
3190
  ```
3324
3191
 
3325
- _See code: [src/commands/tokens/delete.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/tokens/delete.ts)_
3326
-
3327
3192
  ## `sanity tokens list`
3328
3193
 
3329
- List API tokens for the current project
3194
+ List API tokens for the project
3330
3195
 
3331
3196
  ```
3332
3197
  USAGE
@@ -3339,10 +3204,10 @@ OVERRIDE FLAGS
3339
3204
  -p, --project-id=<id> Project ID to list tokens for (overrides CLI configuration)
3340
3205
 
3341
3206
  DESCRIPTION
3342
- List API tokens for the current project
3207
+ List API tokens for the project
3343
3208
 
3344
3209
  EXAMPLES
3345
- List tokens for the current project
3210
+ List tokens for the project
3346
3211
 
3347
3212
  $ sanity tokens list
3348
3213
 
@@ -3355,8 +3220,6 @@ EXAMPLES
3355
3220
  $ sanity tokens list --project-id abc123
3356
3221
  ```
3357
3222
 
3358
- _See code: [src/commands/tokens/list.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/tokens/list.ts)_
3359
-
3360
3223
  ## `sanity typegen generate`
3361
3224
 
3362
3225
  Sanity TypeGen
@@ -3401,8 +3264,6 @@ EXAMPLES
3401
3264
  $ sanity typegen generate
3402
3265
  ```
3403
3266
 
3404
- _See code: [@sanity/codegen](https://github.com/sanity-io/codegen/blob/v6.0.2/src/commands/typegen/generate.ts)_
3405
-
3406
3267
  ## `sanity undeploy`
3407
3268
 
3408
3269
  Removes the deployed Sanity Studio/App from Sanity hosting
@@ -3418,8 +3279,6 @@ DESCRIPTION
3418
3279
  Removes the deployed Sanity Studio/App from Sanity hosting
3419
3280
  ```
3420
3281
 
3421
- _See code: [src/commands/undeploy.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/undeploy.ts)_
3422
-
3423
3282
  ## `sanity users invite [EMAIL]`
3424
3283
 
3425
3284
  Invite a new user to the project
@@ -3458,11 +3317,9 @@ EXAMPLES
3458
3317
  $ sanity users invite pippi@sanity.io --project-id abc123
3459
3318
  ```
3460
3319
 
3461
- _See code: [src/commands/users/invite.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/users/invite.ts)_
3462
-
3463
3320
  ## `sanity users list`
3464
3321
 
3465
- List all users of the project
3322
+ List project members
3466
3323
 
3467
3324
  ```
3468
3325
  USAGE
@@ -3480,7 +3337,7 @@ OVERRIDE FLAGS
3480
3337
  -p, --project-id=<id> Project ID to list users for (overrides CLI configuration)
3481
3338
 
3482
3339
  DESCRIPTION
3483
- List all users of the project
3340
+ List project members
3484
3341
 
3485
3342
  EXAMPLES
3486
3343
  List all users of the project
@@ -3500,23 +3357,19 @@ EXAMPLES
3500
3357
  $ sanity users list --project-id abc123
3501
3358
  ```
3502
3359
 
3503
- _See code: [src/commands/users/list.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/users/list.ts)_
3504
-
3505
3360
  ## `sanity versions`
3506
3361
 
3507
- Shows installed versions of Sanity Studio and components
3362
+ Show installed package versions
3508
3363
 
3509
3364
  ```
3510
3365
  USAGE
3511
3366
  $ sanity versions
3512
3367
 
3513
3368
  DESCRIPTION
3514
- Shows installed versions of Sanity Studio and components
3369
+ Show installed package versions
3515
3370
 
3516
3371
  EXAMPLES
3517
3372
  $ sanity versions
3518
3373
  ```
3519
3374
 
3520
- _See code: [src/commands/versions.ts](https://github.com/sanity-io/cli/blob/v6.3.0/src/commands/versions.ts)_
3521
-
3522
3375
  <!-- commandsstop -->