@sanity/cli 6.0.0-alpha.15 → 6.0.0-alpha.17

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 (67) hide show
  1. package/README.md +595 -397
  2. package/dist/actions/backup/downloadAsset.js +9 -9
  3. package/dist/actions/backup/downloadAsset.js.map +1 -1
  4. package/dist/actions/backup/downloadDocument.js +8 -8
  5. package/dist/actions/backup/downloadDocument.js.map +1 -1
  6. package/dist/actions/build/buildStudio.js +50 -41
  7. package/dist/actions/build/buildStudio.js.map +1 -1
  8. package/dist/actions/build/renderDocument.js +2 -6
  9. package/dist/actions/build/renderDocument.js.map +1 -1
  10. package/dist/actions/build/renderDocumentWorker/components/BasicDocument.js +4 -4
  11. package/dist/actions/build/renderDocumentWorker/components/BasicDocument.js.map +1 -1
  12. package/dist/actions/build/renderDocumentWorker/components/DefaultDocument.js +3 -3
  13. package/dist/actions/build/renderDocumentWorker/components/DefaultDocument.js.map +1 -1
  14. package/dist/actions/build/renderDocumentWorker/getDocumentComponent.js +2 -2
  15. package/dist/actions/build/renderDocumentWorker/getDocumentComponent.js.map +1 -1
  16. package/dist/actions/build/renderDocumentWorker/renderDocumentWorker.js +1 -1
  17. package/dist/actions/build/renderDocumentWorker/renderDocumentWorker.js.map +1 -1
  18. package/dist/actions/build/shouldAutoUpdate.js +2 -0
  19. package/dist/actions/build/shouldAutoUpdate.js.map +1 -1
  20. package/dist/actions/build/writeFavicons.js +3 -5
  21. package/dist/actions/build/writeFavicons.js.map +1 -1
  22. package/dist/actions/dataset/create.js.map +1 -1
  23. package/dist/actions/dataset/determineDatasetAclMode.js.map +1 -1
  24. package/dist/actions/graphql/getGraphQLAPIs.js +9 -20
  25. package/dist/actions/graphql/getGraphQLAPIs.js.map +1 -1
  26. package/dist/actions/init/bootstrapLocalTemplate.js.map +1 -1
  27. package/dist/actions/init/bootstrapRemoteTemplate.js.map +1 -1
  28. package/dist/actions/init/bootstrapTemplate.js.map +1 -1
  29. package/dist/actions/init/createAppCliConfig.js.map +1 -1
  30. package/dist/actions/init/createCliConfig.js.map +1 -1
  31. package/dist/actions/manifest/extractManifest.js +2 -0
  32. package/dist/actions/manifest/extractManifest.js.map +1 -1
  33. package/dist/actions/manifest/extractManifest.worker.js +5 -6
  34. package/dist/actions/manifest/extractManifest.worker.js.map +1 -1
  35. package/dist/actions/mcp/detectAvailableEditors.js.map +1 -1
  36. package/dist/actions/mcp/setupMCP.js.map +1 -1
  37. package/dist/actions/media/importAspects.js +2 -11
  38. package/dist/actions/media/importAspects.js.map +1 -1
  39. package/dist/actions/schema/extractSanitySchema.worker.js +0 -5
  40. package/dist/actions/schema/extractSanitySchema.worker.js.map +1 -1
  41. package/dist/actions/schema/uniqueWorkspaces.worker.js +3 -1
  42. package/dist/actions/schema/uniqueWorkspaces.worker.js.map +1 -1
  43. package/dist/actions/schema/validateSchema.worker.js +0 -5
  44. package/dist/actions/schema/validateSchema.worker.js.map +1 -1
  45. package/dist/actions/users/getMembersForProject.js.map +1 -1
  46. package/dist/actions/users/getPendingInvitations.js +1 -1
  47. package/dist/actions/users/getPendingInvitations.js.map +1 -1
  48. package/dist/actions/users/types.js.map +1 -1
  49. package/dist/commands/users/list.js +52 -26
  50. package/dist/commands/users/list.js.map +1 -1
  51. package/dist/services/getUrlHeaders.js +7 -16
  52. package/dist/services/getUrlHeaders.js.map +1 -1
  53. package/dist/services/graphql.js +1 -1
  54. package/dist/services/graphql.js.map +1 -1
  55. package/dist/services/projects.js.map +1 -1
  56. package/dist/util/compareDependencyVersions.js +37 -24
  57. package/dist/util/compareDependencyVersions.js.map +1 -1
  58. package/dist/util/getProjectDefaults.js.map +1 -1
  59. package/dist/util/readdirRecursive.js.map +1 -1
  60. package/oclif.manifest.json +350 -350
  61. package/package.json +20 -21
  62. package/static/favicons/apple-touch-icon.png +0 -0
  63. package/static/favicons/favicon-192.png +0 -0
  64. package/static/favicons/favicon-512.png +0 -0
  65. package/static/favicons/favicon-96.png +0 -0
  66. package/static/favicons/favicon.ico +0 -0
  67. package/static/favicons/favicon.svg +12 -0
package/README.md CHANGED
@@ -134,7 +134,7 @@ EXAMPLES
134
134
  $ sanity backup disable production
135
135
  ```
136
136
 
137
- _See code: [src/commands/backup/disable.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/backup/disable.ts)_
137
+ _See code: [src/commands/backup/disable.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/backup/disable.ts)_
138
138
 
139
139
  ## `sanity backup download [DATASET]`
140
140
 
@@ -142,14 +142,16 @@ Download a dataset backup to a local file.
142
142
 
143
143
  ```
144
144
  USAGE
145
- $ sanity backup download [DATASET] [--backup-id <value>] [--concurrency <value>] [--out <value>] [--overwrite]
145
+ $ sanity backup download [DATASET] [--backup-id <value>] [--concurrency
146
+ <value>] [--out <value>] [--overwrite]
146
147
 
147
148
  ARGUMENTS
148
149
  [DATASET] Dataset name to download backup from
149
150
 
150
151
  FLAGS
151
152
  --backup-id=<value> The backup ID to download
152
- --concurrency=<value> [default: 10] Concurrent number of backup item downloads (max: 24)
153
+ --concurrency=<value> [default: 10] Concurrent number of backup item downloads
154
+ (max: 24)
153
155
  --out=<value> The file or directory path the backup should download to
154
156
  --overwrite Allows overwriting of existing backup file
155
157
 
@@ -167,14 +169,16 @@ EXAMPLES
167
169
 
168
170
  Download backup to a specific file
169
171
 
170
- $ sanity backup download production --backup-id 2024-01-01-backup-2 --out /path/to/file
172
+ $ sanity backup download production --backup-id 2024-01-01-backup-2 --out \
173
+ /path/to/file
171
174
 
172
175
  Download backup and overwrite existing file
173
176
 
174
- $ sanity backup download production --backup-id 2024-01-01-backup-3 --out /path/to/file --overwrite
177
+ $ sanity backup download production --backup-id 2024-01-01-backup-3 --out \
178
+ /path/to/file --overwrite
175
179
  ```
176
180
 
177
- _See code: [src/commands/backup/download.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/backup/download.ts)_
181
+ _See code: [src/commands/backup/download.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/backup/download.ts)_
178
182
 
179
183
  ## `sanity backup enable [DATASET]`
180
184
 
@@ -200,7 +204,7 @@ EXAMPLES
200
204
  $ sanity backup enable production
201
205
  ```
202
206
 
203
- _See code: [src/commands/backup/enable.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/backup/enable.ts)_
207
+ _See code: [src/commands/backup/enable.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/backup/enable.ts)_
204
208
 
205
209
  ## `sanity backup list [DATASET]`
206
210
 
@@ -208,15 +212,18 @@ List available backups for a dataset.
208
212
 
209
213
  ```
210
214
  USAGE
211
- $ sanity backup list [DATASET] [--after <value>] [--before <value>] [-l <value>]
215
+ $ sanity backup list [DATASET] [--after <value>] [--before <value>] [-l
216
+ <value>]
212
217
 
213
218
  ARGUMENTS
214
219
  [DATASET] Dataset name to list backups for
215
220
 
216
221
  FLAGS
217
222
  -l, --limit=<value> [default: 30] Maximum number of backups returned
218
- --after=<value> Only return backups after this date (inclusive, YYYY-MM-DD format)
219
- --before=<value> Only return backups before this date (exclusive, YYYY-MM-DD format)
223
+ --after=<value> Only return backups after this date (inclusive,
224
+ YYYY-MM-DD format)
225
+ --before=<value> Only return backups before this date (exclusive,
226
+ YYYY-MM-DD format)
220
227
 
221
228
  DESCRIPTION
222
229
  List available backups for a dataset.
@@ -239,7 +246,7 @@ EXAMPLES
239
246
  $ sanity backup list production --after 2024-01-31 --limit 10
240
247
  ```
241
248
 
242
- _See code: [src/commands/backup/list.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/backup/list.ts)_
249
+ _See code: [src/commands/backup/list.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/backup/list.ts)_
243
250
 
244
251
  ## `sanity blueprints add TYPE`
245
252
 
@@ -248,36 +255,55 @@ Add a function resource to a Blueprint
248
255
  ```
249
256
  USAGE
250
257
  $ sanity blueprints add TYPE [--example <value> | -n <value> | --fn-type
251
- document-create|document-delete|document-update|document-publish|media-library-asset-create|media-library-asset-upda
252
- te|media-library-asset-delete... | --language ts|js | --javascript | --fn-helpers | --fn-installer
258
+ document-create|document-delete|document-update|document-publish|media-librar
259
+ y-asset-create|media-library-asset-update|media-library-asset-delete... |
260
+ --language ts|js | --javascript | --fn-helpers | --fn-installer
253
261
  skip|npm|pnpm|yarn] [-i | ]
254
262
 
255
263
  ARGUMENTS
256
264
  TYPE (function) Type of resource to add (only "function" is supported)
257
265
 
258
266
  FLAGS
259
- -i, --install Shortcut for --fn-installer npm
260
- -n, --name=<value> Name of the resource to add
261
- --example=<value> Example to use for the function resource. Discover examples at
262
- https://www.sanity.io/exchange/type=recipes/by=sanity
263
- --[no-]fn-helpers Add helpers to the new function
264
- --fn-installer=<option> Which package manager to use when installing the @sanity/functions helpers
265
- <options: skip|npm|pnpm|yarn>
266
- --fn-type=<option>... Document change event(s) that should trigger the function; you can specify multiple
267
- events by specifying this flag multiple times
268
- <options: document-create|document-delete|document-update|document-publish|media-library-
269
- asset-create|media-library-asset-update|media-library-asset-delete>
270
- --javascript Use JavaScript instead of TypeScript
271
- --language=<option> [default: ts] Language of the new function
272
- <options: ts|js>
267
+ -i, --install
268
+ Shortcut for --fn-installer npm
269
+
270
+ -n, --name=<value>
271
+ Name of the resource to add
272
+
273
+ --example=<value>
274
+ Example to use for the function resource. Discover examples at
275
+ https://www.sanity.io/exchange/type=recipes/by=sanity
276
+
277
+ --[no-]fn-helpers
278
+ Add helpers to the new function
279
+
280
+ --fn-installer=<option>
281
+ Which package manager to use when installing the @sanity/functions helpers
282
+ <options: skip|npm|pnpm|yarn>
283
+
284
+ --fn-type=<option>...
285
+ Document change event(s) that should trigger the function; you can specify
286
+ multiple events by specifying this flag multiple times
287
+ <options:
288
+ document-create|document-delete|document-update|document-publish|media-librar
289
+ y-asset-create|media-library-asset-update|media-library-asset-delete>
290
+
291
+ --javascript
292
+ Use JavaScript instead of TypeScript
293
+
294
+ --language=<option>
295
+ [default: ts] Language of the new function
296
+ <options: ts|js>
273
297
 
274
298
  DESCRIPTION
275
299
  Add a function resource to a Blueprint
276
300
 
277
- Scaffolds a new Sanity Function in your Blueprint. Functions are serverless handlers triggered by document events
278
- (create, update, delete, publish) or media library events.
301
+ Scaffolds a new Sanity Function in your Blueprint. Functions are serverless
302
+ handlers triggered by document events (create, update, delete, publish) or
303
+ media library events.
279
304
 
280
- After adding a function, use 'functions dev' to test locally, then 'blueprints deploy' to publish it.
305
+ After adding a function, use 'functions dev' to test locally, then 'blueprints
306
+ deploy' to publish it.
281
307
 
282
308
  EXAMPLES
283
309
  $ sanity blueprints add function
@@ -291,7 +317,7 @@ EXAMPLES
291
317
  $ sanity blueprints add function --name my-function --fn-type document-create --fn-type document-update --lang js
292
318
  ```
293
319
 
294
- _See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v13.3.1/src/commands/blueprints/add.ts)_
320
+ _See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v13.4.0/src/commands/blueprints/add.ts)_
295
321
 
296
322
  ## `sanity blueprints config`
297
323
 
@@ -302,19 +328,25 @@ USAGE
302
328
  $ sanity blueprints config [--project-id <value> -e] [--stack-id <value> ]
303
329
 
304
330
  FLAGS
305
- -e, --edit Modify the configuration interactively, or directly when combined with ID flags.
306
- --project-id=<value> Directly set the project ID in the configuration. Requires --edit flag
307
- --stack-id=<value> Directly set the Stack ID in the configuration. Requires --edit flag
331
+ -e, --edit Modify the configuration interactively, or directly
332
+ when combined with ID flags.
333
+ --project-id=<value> Directly set the project ID in the configuration.
334
+ Requires --edit flag
335
+ --stack-id=<value> Directly set the Stack ID in the configuration.
336
+ Requires --edit flag
308
337
 
309
338
  DESCRIPTION
310
339
  View or edit the local Blueprint configuration
311
340
 
312
- Manages the local Blueprint configuration, which links your Blueprint to a Sanity project and Stack.
341
+ Manages the local Blueprint configuration, which links your Blueprint to a
342
+ Sanity project and Stack.
313
343
 
314
- Without flags, displays the current configuration. Use --edit to interactively modify settings, or combine --edit with
315
- ID flags to update values directly (useful for scripting and automation).
344
+ Without flags, displays the current configuration. Use --edit to interactively
345
+ modify settings, or combine --edit with ID flags to update values directly
346
+ (useful for scripting and automation).
316
347
 
317
- If you need to switch your Blueprint to a different Stack, use --edit --stack-id.
348
+ If you need to switch your Blueprint to a different Stack, use --edit
349
+ --stack-id.
318
350
 
319
351
  EXAMPLES
320
352
  $ sanity blueprints config
@@ -326,7 +358,7 @@ EXAMPLES
326
358
  $ sanity blueprints config --edit --project-id <projectId> --stack-id <stackId>
327
359
  ```
328
360
 
329
- _See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v13.3.1/src/commands/blueprints/config.ts)_
361
+ _See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v13.4.0/src/commands/blueprints/config.ts)_
330
362
 
331
363
  ## `sanity blueprints deploy`
332
364
 
@@ -342,13 +374,16 @@ FLAGS
342
374
  DESCRIPTION
343
375
  Deploy the local Blueprint to the remote Stack
344
376
 
345
- Pushes your local Blueprint configuration to the remote Stack; provisioning, updating, or destroying resources as
346
- needed. This is the primary command for applying infrastructure changes.
377
+ Pushes your local Blueprint configuration to the remote Stack; provisioning,
378
+ updating, or destroying resources as needed. This is the primary command for
379
+ applying infrastructure changes.
347
380
 
348
- Before deploying, run 'blueprints plan' to preview changes. After deployment, use 'blueprints info' to verify Stack
349
- status or 'blueprints logs' to monitor activity.
381
+ Before deploying, run 'blueprints plan' to preview changes. After deployment,
382
+ use 'blueprints info' to verify Stack status or 'blueprints logs' to monitor
383
+ activity.
350
384
 
351
- Use --no-wait to queue the deployment and return immediately without waiting for completion.
385
+ Use --no-wait to queue the deployment and return immediately without waiting
386
+ for completion.
352
387
 
353
388
  EXAMPLES
354
389
  $ sanity blueprints deploy
@@ -356,7 +391,7 @@ EXAMPLES
356
391
  $ sanity blueprints deploy --no-wait
357
392
  ```
358
393
 
359
- _See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v13.3.1/src/commands/blueprints/deploy.ts)_
394
+ _See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v13.4.0/src/commands/blueprints/deploy.ts)_
360
395
 
361
396
  ## `sanity blueprints destroy`
362
397
 
@@ -364,7 +399,8 @@ Destroy the remote Stack deployment and its resources (will not delete local fil
364
399
 
365
400
  ```
366
401
  USAGE
367
- $ sanity blueprints destroy [--project-id <value> --stack-id <value> --force] [--no-wait]
402
+ $ sanity blueprints destroy [--project-id <value> --stack-id <value> --force]
403
+ [--no-wait]
368
404
 
369
405
  FLAGS
370
406
  --force Force Stack destruction (skip confirmation)
@@ -373,14 +409,18 @@ FLAGS
373
409
  --stack-id=<value> Stack ID to destroy (defaults to current Stack)
374
410
 
375
411
  DESCRIPTION
376
- Destroy the remote Stack deployment and its resources (will not delete local files)
412
+ Destroy the remote Stack deployment and its resources (will not delete local
413
+ files)
377
414
 
378
- Permanently removes the remote Stack and all its provisioned resources. Your local Blueprint files remain untouched,
379
- allowing you to redeploy later with 'blueprints init' + 'blueprints deploy'.
415
+ Permanently removes the remote Stack and all its provisioned resources. Your
416
+ local Blueprint files remain untouched, allowing you to redeploy later with
417
+ 'blueprints init' + 'blueprints deploy'.
380
418
 
381
- This is a destructive operation. You will be prompted to confirm unless --force is specified.
419
+ This is a destructive operation. You will be prompted to confirm unless --force
420
+ is specified.
382
421
 
383
- Use this to clean up test environments or decommission a Stack you no longer need.
422
+ Use this to clean up test environments or decommission a Stack you no longer
423
+ need.
384
424
 
385
425
  EXAMPLES
386
426
  $ sanity blueprints destroy
@@ -388,7 +428,7 @@ EXAMPLES
388
428
  $ sanity blueprints destroy --stack-id <stackId> --project-id <projectId> --force --no-wait
389
429
  ```
390
430
 
391
- _See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v13.3.1/src/commands/blueprints/destroy.ts)_
431
+ _See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v13.4.0/src/commands/blueprints/destroy.ts)_
392
432
 
393
433
  ## `sanity blueprints doctor`
394
434
 
@@ -396,25 +436,27 @@ Diagnose potential issues with local Blueprint and remote Stack configuration
396
436
 
397
437
  ```
398
438
  USAGE
399
- $ sanity blueprints doctor [--json] [--path <value>] [--verbose] [--fix]
439
+ $ sanity blueprints doctor [--json] [-p <value>] [--verbose] [--fix]
400
440
 
401
441
  FLAGS
402
- --fix Interactively fix configuration issues
403
- --json Format output as json.
404
- --path=<value> Path to the directory containing the Blueprint
405
- --verbose Verbose output
442
+ -p, --path=<value> [env: SANITY_BLUEPRINT_PATH] Path to a Blueprint file or
443
+ directory containing one
444
+ --fix Interactively fix configuration issues
445
+ --json Format output as json.
446
+ --verbose Verbose output
406
447
 
407
448
  DESCRIPTION
408
449
  Diagnose potential issues with local Blueprint and remote Stack configuration
409
450
 
410
- Analyzes your local Blueprint and remote Stack configuration for common issues, such as missing authentication,
411
- invalid project references, or misconfigured resources.
451
+ Analyzes your local Blueprint and remote Stack configuration for common issues,
452
+ such as missing authentication, invalid project references, or misconfigured
453
+ resources.
412
454
 
413
- Run this command when encountering errors with other Blueprint commands. Use --fix to interactively resolve detected
414
- issues.
455
+ Run this command when encountering errors with other Blueprint commands. Use
456
+ --fix to interactively resolve detected issues.
415
457
  ```
416
458
 
417
- _See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v13.3.1/src/commands/blueprints/doctor.ts)_
459
+ _See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v13.4.0/src/commands/blueprints/doctor.ts)_
418
460
 
419
461
  ## `sanity blueprints info`
420
462
 
@@ -430,13 +472,14 @@ FLAGS
430
472
  DESCRIPTION
431
473
  Show information about the local Blueprint's remote Stack deployment
432
474
 
433
- Displays the current state and metadata of your remote Stack deployment, including deployed resources, status, and
434
- configuration.
475
+ Displays the current state and metadata of your remote Stack deployment,
476
+ including deployed resources, status, and configuration.
435
477
 
436
- Use this command to verify a deployment succeeded, check what resources are live, or confirm which Stack your local
437
- Blueprint is connected to.
478
+ Use this command to verify a deployment succeeded, check what resources are
479
+ live, or confirm which Stack your local Blueprint is connected to.
438
480
 
439
- Run 'blueprints stacks' to see all available Stacks in your project or organization.
481
+ Run 'blueprints stacks' to see all available Stacks in your project or
482
+ organization.
440
483
 
441
484
  EXAMPLES
442
485
  $ sanity blueprints info
@@ -444,7 +487,7 @@ EXAMPLES
444
487
  $ sanity blueprints info --id <stackId>
445
488
  ```
446
489
 
447
- _See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v13.3.1/src/commands/blueprints/info.ts)_
490
+ _See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v13.4.0/src/commands/blueprints/info.ts)_
448
491
 
449
492
  ## `sanity blueprints init [DIR]`
450
493
 
@@ -452,35 +495,42 @@ Initialize a local Blueprint and optionally provision a remote Stack deployment
452
495
 
453
496
  ```
454
497
  USAGE
455
- $ sanity blueprints init [DIR] [--verbose] [--dir <value>] [--example <value> | --blueprint-type json|js|ts |
456
- --stack-id <value> | --stack-name <value>] [--project-id <value>]
498
+ $ sanity blueprints init [DIR] [--verbose] [--dir <value>] [--example
499
+ <value> | --blueprint-type json|js|ts | --stack-id <value> | --stack-name
500
+ <value>] [--project-id <value>]
457
501
 
458
502
  ARGUMENTS
459
503
  [DIR] Directory to create the local Blueprint in
460
504
 
461
505
  FLAGS
462
- --blueprint-type=<option> Blueprint manifest type to use for the local Blueprint
506
+ --blueprint-type=<option> Blueprint manifest type to use for the local
507
+ Blueprint
463
508
  <options: json|js|ts>
464
509
  --dir=<value> Directory to create the local Blueprint in
465
510
  --example=<value> Example to use for the local Blueprint
466
- --project-id=<value> Sanity project ID used to scope local Blueprint and remote Stack
511
+ --project-id=<value> Sanity project ID used to scope local Blueprint and
512
+ remote Stack
467
513
  --stack-id=<value> Existing Stack ID used to scope local Blueprint
468
- --stack-name=<value> Name to use for a new Stack provisioned during initialization
514
+ --stack-name=<value> Name to use for a new Stack provisioned during
515
+ initialization
469
516
  --verbose Verbose output
470
517
 
471
518
  DESCRIPTION
472
519
  Initialize a local Blueprint and optionally provision a remote Stack deployment
473
520
 
474
- A Blueprint is your local infrastructure-as-code configuration that defines Sanity resources (datasets, functions,
475
- etc.). A Stack is the remote deployment target where your Blueprint is applied.
521
+ A Blueprint is your local infrastructure-as-code configuration that defines
522
+ Sanity resources (datasets, functions, etc.). A Stack is the remote deployment
523
+ target where your Blueprint is applied.
476
524
  [NOTE: Currently, accounts are limited to three (3) Stacks per project scope.]
477
525
 
478
- This is typically the first command you run in a new project. It creates a local Blueprint manifest file
479
- (sanity.blueprint.ts, .js, or .json) and provisions a new remote Stack.
480
- Additionally, a Blueprint configuration file is created in .sanity/ containing the scope and Stack IDs. This is
481
- .gitignored by default.
526
+ This is typically the first command you run in a new project. It creates a
527
+ local Blueprint manifest file (sanity.blueprint.ts, .js, or .json) and
528
+ provisions a new remote Stack.
529
+ Additionally, a Blueprint configuration file is created in .sanity/ containing
530
+ the scope and Stack IDs. This is .gitignored by default.
482
531
 
483
- After initialization, use 'blueprints plan' to preview changes, then 'blueprints deploy' to apply them.
532
+ After initialization, use 'blueprints plan' to preview changes, then
533
+ 'blueprints deploy' to apply them.
484
534
 
485
535
  EXAMPLES
486
536
  $ sanity blueprints init
@@ -494,7 +544,7 @@ EXAMPLES
494
544
  $ sanity blueprints init --blueprint-type <json|js|ts> --stack-name <stackName>
495
545
  ```
496
546
 
497
- _See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v13.3.1/src/commands/blueprints/init.ts)_
547
+ _See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v13.4.0/src/commands/blueprints/init.ts)_
498
548
 
499
549
  ## `sanity blueprints logs`
500
550
 
@@ -510,11 +560,13 @@ FLAGS
510
560
  DESCRIPTION
511
561
  Display logs for the current Blueprint's Stack deployment
512
562
 
513
- Retrieves Stack deployment logs, useful for debugging and monitoring deployment activity.
563
+ Retrieves Stack deployment logs, useful for debugging and monitoring deployment
564
+ activity.
514
565
 
515
566
  Use --watch (-w) to stream logs in real-time.
516
567
 
517
- If you're not seeing expected logs, verify your Stack is deployed with 'blueprints info'.
568
+ If you're not seeing expected logs, verify your Stack is deployed with
569
+ 'blueprints info'.
518
570
 
519
571
  EXAMPLES
520
572
  $ sanity blueprints logs
@@ -522,7 +574,7 @@ EXAMPLES
522
574
  $ sanity blueprints logs --watch
523
575
  ```
524
576
 
525
- _See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v13.3.1/src/commands/blueprints/logs.ts)_
577
+ _See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v13.4.0/src/commands/blueprints/logs.ts)_
526
578
 
527
579
  ## `sanity blueprints plan`
528
580
 
@@ -533,19 +585,21 @@ USAGE
533
585
  $ sanity blueprints plan
534
586
 
535
587
  DESCRIPTION
536
- Enumerate resources to be deployed to the remote Stack - will not modify any resources
588
+ Enumerate resources to be deployed to the remote Stack - will not modify any
589
+ resources
537
590
 
538
- Use this command to preview what changes will be applied to your remote Stack before deploying. This is a safe,
539
- read-only operation—no resources are created, modified, or deleted.
591
+ Use this command to preview what changes will be applied to your remote Stack
592
+ before deploying. This is a safe, read-only operation—no resources are created,
593
+ modified, or deleted.
540
594
 
541
- Run 'blueprints plan' after making local changes to your Blueprint manifest to verify the expected diff. When ready,
542
- run 'blueprints deploy' to apply changes.
595
+ Run 'blueprints plan' after making local changes to your Blueprint manifest to
596
+ verify the expected diff. When ready, run 'blueprints deploy' to apply changes.
543
597
 
544
598
  EXAMPLES
545
599
  $ sanity blueprints plan
546
600
  ```
547
601
 
548
- _See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v13.3.1/src/commands/blueprints/plan.ts)_
602
+ _See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v13.4.0/src/commands/blueprints/plan.ts)_
549
603
 
550
604
  ## `sanity blueprints stacks`
551
605
 
@@ -559,12 +613,14 @@ FLAGS
559
613
  --project-id=<value> Project ID to show Stack deployments for
560
614
 
561
615
  DESCRIPTION
562
- List all remote Stack deployments (defaults to the current Blueprint's project scope)
616
+ List all remote Stack deployments (defaults to the current Blueprint's project
617
+ scope)
563
618
 
564
- Shows all Stacks associated with a project or organization. By default, lists Stacks scoped to the local Blueprint.
619
+ Shows all Stacks associated with a project or organization. By default, lists
620
+ Stacks scoped to the local Blueprint.
565
621
 
566
- Use this to discover existing Stacks you can scope a local Blueprint to (using 'blueprints config --edit'), or to
567
- audit what's deployed across your project.
622
+ Use this to discover existing Stacks you can scope a local Blueprint to (using
623
+ 'blueprints config --edit'), or to audit what's deployed across your project.
568
624
 
569
625
  EXAMPLES
570
626
  $ sanity blueprints stacks
@@ -574,7 +630,7 @@ EXAMPLES
574
630
  $ sanity blueprints stacks --organization-id <organizationId>
575
631
  ```
576
632
 
577
- _See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v13.3.1/src/commands/blueprints/stacks.ts)_
633
+ _See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v13.4.0/src/commands/blueprints/stacks.ts)_
578
634
 
579
635
  ## `sanity build [OUTPUTDIR]`
580
636
 
@@ -582,16 +638,19 @@ Builds the Sanity Studio configuration into a static bundle
582
638
 
583
639
  ```
584
640
  USAGE
585
- $ sanity build [OUTPUTDIR] [--auto-updates] [--minify] [--source-maps] [--stats] [-y]
641
+ $ sanity build [OUTPUTDIR] [--auto-updates] [--minify]
642
+ [--source-maps] [--stats] [-y]
586
643
 
587
644
  ARGUMENTS
588
645
  [OUTPUTDIR] Output directory
589
646
 
590
647
  FLAGS
591
- -y, --yes Unattended mode, answers "yes" to any "yes/no" prompt and otherwise uses defaults
648
+ -y, --yes Unattended mode, answers "yes" to any "yes/no" prompt
649
+ and otherwise uses defaults
592
650
  --[no-]auto-updates Enable/disable auto updates of studio versions
593
651
  --[no-]minify Enable/disable minifying of built bundles
594
- --[no-]source-maps Enable source maps for built bundles (increases size of bundle)
652
+ --[no-]source-maps Enable source maps for built bundles (increases size
653
+ of bundle)
595
654
  --stats Show stats about the built bundles
596
655
 
597
656
  DESCRIPTION
@@ -603,7 +662,7 @@ EXAMPLES
603
662
  $ sanity build --no-minify --source-maps
604
663
  ```
605
664
 
606
- _See code: [src/commands/build.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/build.ts)_
665
+ _See code: [src/commands/build.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/build.ts)_
607
666
 
608
667
  ## `sanity codemod [CODEMODNAME]`
609
668
 
@@ -611,14 +670,16 @@ Updates Sanity Studio codebase with a code modification script
611
670
 
612
671
  ```
613
672
  USAGE
614
- $ sanity codemod [CODEMODNAME] [--dry] [--extensions <value>] [--no-verify]
673
+ $ sanity codemod [CODEMODNAME] [--dry] [--extensions <value>]
674
+ [--no-verify]
615
675
 
616
676
  ARGUMENTS
617
677
  [CODEMODNAME] Name of the codemod to run
618
678
 
619
679
  FLAGS
620
680
  --dry Dry run (no changes are made to files)
621
- --extensions=<value> [default: js,ts,tsx] Transform files with these file extensions (comma separated)
681
+ --extensions=<value> [default: js,ts,tsx] Transform files with these file
682
+ extensions (comma separated)
622
683
  --no-verify Skip verification steps before running codemod
623
684
 
624
685
  DESCRIPTION
@@ -634,7 +695,7 @@ EXAMPLES
634
695
  $ sanity codemod reactIconsV3 --dry
635
696
  ```
636
697
 
637
- _See code: [src/commands/codemod.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/codemod.ts)_
698
+ _See code: [src/commands/codemod.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/codemod.ts)_
638
699
 
639
700
  ## `sanity cors add ORIGIN`
640
701
 
@@ -648,7 +709,8 @@ ARGUMENTS
648
709
  ORIGIN Origin to allow (e.g., https://example.com)
649
710
 
650
711
  FLAGS
651
- --[no-]credentials Allow credentials (token/cookie) to be sent from this origin
712
+ --[no-]credentials Allow credentials (token/cookie) to be sent from this
713
+ origin
652
714
 
653
715
  DESCRIPTION
654
716
  Allow a new origin to use your project API through CORS
@@ -667,7 +729,7 @@ EXAMPLES
667
729
  $ sanity cors add https://myapp.com --credentials
668
730
  ```
669
731
 
670
- _See code: [src/commands/cors/add.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/cors/add.ts)_
732
+ _See code: [src/commands/cors/add.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/cors/add.ts)_
671
733
 
672
734
  ## `sanity cors delete [ORIGIN]`
673
735
 
@@ -693,7 +755,7 @@ EXAMPLES
693
755
  $ sanity cors delete https://example.com
694
756
  ```
695
757
 
696
- _See code: [src/commands/cors/delete.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/cors/delete.ts)_
758
+ _See code: [src/commands/cors/delete.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/cors/delete.ts)_
697
759
 
698
760
  ## `sanity cors list`
699
761
 
@@ -712,7 +774,7 @@ EXAMPLES
712
774
  $ sanity cors list
713
775
  ```
714
776
 
715
- _See code: [src/commands/cors/list.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/cors/list.ts)_
777
+ _See code: [src/commands/cors/list.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/cors/list.ts)_
716
778
 
717
779
  ## `sanity dataset alias create [ALIASNAME] [TARGETDATASET]`
718
780
 
@@ -747,7 +809,7 @@ EXAMPLES
747
809
  $ sanity dataset alias create ~conference conf-2025
748
810
  ```
749
811
 
750
- _See code: [src/commands/dataset/alias/create.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/dataset/alias/create.ts)_
812
+ _See code: [src/commands/dataset/alias/create.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/dataset/alias/create.ts)_
751
813
 
752
814
  ## `sanity dataset alias delete ALIASNAME`
753
815
 
@@ -780,7 +842,7 @@ EXAMPLES
780
842
  $ sanity dataset alias delete conference --force
781
843
  ```
782
844
 
783
- _See code: [src/commands/dataset/alias/delete.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/dataset/alias/delete.ts)_
845
+ _See code: [src/commands/dataset/alias/delete.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/dataset/alias/delete.ts)_
784
846
 
785
847
  ## `sanity dataset alias link [ALIASNAME] [TARGETDATASET]`
786
848
 
@@ -822,7 +884,7 @@ EXAMPLES
822
884
  $ sanity dataset alias link conference conf-2025 --force
823
885
  ```
824
886
 
825
- _See code: [src/commands/dataset/alias/link.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/dataset/alias/link.ts)_
887
+ _See code: [src/commands/dataset/alias/link.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/dataset/alias/link.ts)_
826
888
 
827
889
  ## `sanity dataset alias unlink [ALIASNAME]`
828
890
 
@@ -859,7 +921,7 @@ EXAMPLES
859
921
  $ sanity dataset alias unlink conference --force
860
922
  ```
861
923
 
862
- _See code: [src/commands/dataset/alias/unlink.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/dataset/alias/unlink.ts)_
924
+ _See code: [src/commands/dataset/alias/unlink.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/dataset/alias/unlink.ts)_
863
925
 
864
926
  ## `sanity dataset copy [SOURCE] [TARGET]`
865
927
 
@@ -867,8 +929,8 @@ Manages dataset copying, including starting a new copy job, listing copy jobs an
867
929
 
868
930
  ```
869
931
  USAGE
870
- $ sanity dataset copy [SOURCE] [TARGET] [--attach <value> | --list | --detach | --skip-history] [--limit <value>
871
- ] [--offset <value> ]
932
+ $ sanity dataset copy [SOURCE] [TARGET] [--attach <value> | --list |
933
+ --detach | --skip-history] [--limit <value> ] [--offset <value> ]
872
934
 
873
935
  ARGUMENTS
874
936
  [SOURCE] Name of the dataset to copy from
@@ -883,8 +945,8 @@ FLAGS
883
945
  --skip-history Don't preserve document history on copy
884
946
 
885
947
  DESCRIPTION
886
- Manages dataset copying, including starting a new copy job, listing copy jobs and following the progress of a running
887
- copy job
948
+ Manages dataset copying, including starting a new copy job, listing copy jobs
949
+ and following the progress of a running copy job
888
950
 
889
951
  EXAMPLES
890
952
  Interactively copy a dataset
@@ -920,7 +982,7 @@ EXAMPLES
920
982
  $ sanity dataset copy --list --offset 2 --limit 10
921
983
  ```
922
984
 
923
- _See code: [src/commands/dataset/copy.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/dataset/copy.ts)_
985
+ _See code: [src/commands/dataset/copy.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/dataset/copy.ts)_
924
986
 
925
987
  ## `sanity dataset create [NAME]`
926
988
 
@@ -954,7 +1016,7 @@ EXAMPLES
954
1016
  $ sanity dataset create my-dataset --visibility private
955
1017
  ```
956
1018
 
957
- _See code: [src/commands/dataset/create.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/dataset/create.ts)_
1019
+ _See code: [src/commands/dataset/create.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/dataset/create.ts)_
958
1020
 
959
1021
  ## `sanity dataset delete DATASETNAME`
960
1022
 
@@ -983,7 +1045,7 @@ EXAMPLES
983
1045
  $ sanity dataset delete my-dataset --force
984
1046
  ```
985
1047
 
986
- _See code: [src/commands/dataset/delete.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/dataset/delete.ts)_
1048
+ _See code: [src/commands/dataset/delete.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/dataset/delete.ts)_
987
1049
 
988
1050
  ## `sanity dataset export [NAME] [DESTINATION]`
989
1051
 
@@ -991,8 +1053,9 @@ Export dataset to local filesystem as a gzipped tarball. Assets failing with HTT
991
1053
 
992
1054
  ```
993
1055
  USAGE
994
- $ sanity dataset export [NAME] [DESTINATION] [--asset-concurrency <value>] [--mode stream|cursor] [--no-assets]
995
- [--no-compress] [--no-drafts] [--overwrite] [--raw] [--types <value>]
1056
+ $ sanity dataset export [NAME] [DESTINATION] [--asset-concurrency <value>]
1057
+ [--mode stream|cursor] [--no-assets] [--no-compress] [--no-drafts]
1058
+ [--overwrite] [--raw] [--types <value>]
996
1059
 
997
1060
  ARGUMENTS
998
1061
  [NAME] Name of the dataset to export
@@ -1000,20 +1063,26 @@ ARGUMENTS
1000
1063
 
1001
1064
  FLAGS
1002
1065
  --asset-concurrency=<value> [default: 8] Concurrent number of asset downloads
1003
- --mode=<option> [default: stream] Mode to export documents with `cursor` might be more performant for
1004
- larger datasets, but might not be as accurate if the dataset is being modified during
1005
- export
1066
+ --mode=<option> [default: stream] Mode to export documents with
1067
+ `cursor` might be more performant for larger
1068
+ datasets, but might not be as accurate if the
1069
+ dataset is being modified during export
1006
1070
  <options: stream|cursor>
1007
- --no-assets Export only non-asset documents and remove references to image assets
1008
- --no-compress Skips compressing tarball entries (still generates a gzip file)
1071
+ --no-assets Export only non-asset documents and remove
1072
+ references to image assets
1073
+ --no-compress Skips compressing tarball entries (still generates
1074
+ a gzip file)
1009
1075
  --no-drafts Export only published versions of documents
1010
1076
  --overwrite Overwrite any file with the same name
1011
- --raw Extract only documents, without rewriting asset references
1012
- --types=<value> Defines which document types to export (comma-separated)
1077
+ --raw Extract only documents, without rewriting asset
1078
+ references
1079
+ --types=<value> Defines which document types to export
1080
+ (comma-separated)
1013
1081
 
1014
1082
  DESCRIPTION
1015
- Export dataset to local filesystem as a gzipped tarball. Assets failing with HTTP status codes 401, 403 and 404 upon
1016
- download are ignored and excluded from export.
1083
+ Export dataset to local filesystem as a gzipped tarball. Assets failing with
1084
+ HTTP status codes 401, 403 and 404 upon download are ignored and excluded from
1085
+ export.
1017
1086
 
1018
1087
  EXAMPLES
1019
1088
  Export dataset "moviedb" to localPath.tar.gz
@@ -1033,7 +1102,7 @@ EXAMPLES
1033
1102
  $ sanity dataset export staging staging.tar.gz --types products,shops
1034
1103
  ```
1035
1104
 
1036
- _See code: [src/commands/dataset/export.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/dataset/export.ts)_
1105
+ _See code: [src/commands/dataset/export.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/dataset/export.ts)_
1037
1106
 
1038
1107
  ## `sanity dataset import SOURCE`
1039
1108
 
@@ -1041,9 +1110,11 @@ Import documents to a Sanity dataset
1041
1110
 
1042
1111
  ```
1043
1112
  USAGE
1044
- $ sanity dataset import SOURCE -p <value> -d <value> [-t <value>] [--replace | --missing] [--allow-failing-assets]
1045
- [--allow-assets-in-different-dataset] [--replace-assets] [--skip-cross-dataset-references]
1046
- [--allow-replacement-characters] [--allow-system-documents] [--asset-concurrency <value>]
1113
+ $ sanity dataset import SOURCE -p <value> -d <value> [-t <value>]
1114
+ [--replace | --missing] [--allow-failing-assets]
1115
+ [--allow-assets-in-different-dataset] [--replace-assets]
1116
+ [--skip-cross-dataset-references] [--allow-replacement-characters]
1117
+ [--allow-system-documents] [--asset-concurrency <value>]
1047
1118
 
1048
1119
  ARGUMENTS
1049
1120
  SOURCE Source file (use "-" for stdin)
@@ -1051,10 +1122,14 @@ ARGUMENTS
1051
1122
  FLAGS
1052
1123
  -d, --dataset=<value> (required) Dataset to import to
1053
1124
  -p, --project=<value> (required) Project ID to import to
1054
- -t, --token=<value> [env: SANITY_IMPORT_TOKEN] Token to authenticate with
1055
- --allow-assets-in-different-dataset Allow asset documents to reference different project/dataset
1056
- --allow-failing-assets Skip assets that cannot be fetched/uploaded
1057
- --allow-replacement-characters Allow unicode replacement characters in imported documents
1125
+ -t, --token=<value> [env: SANITY_IMPORT_TOKEN] Token to
1126
+ authenticate with
1127
+ --allow-assets-in-different-dataset Allow asset documents to reference
1128
+ different project/dataset
1129
+ --allow-failing-assets Skip assets that cannot be
1130
+ fetched/uploaded
1131
+ --allow-replacement-characters Allow unicode replacement characters
1132
+ in imported documents
1058
1133
  --allow-system-documents Imports system documents
1059
1134
  --asset-concurrency=<value> Number of parallel asset imports
1060
1135
  --missing Skip documents that already exist
@@ -1068,14 +1143,15 @@ DESCRIPTION
1068
1143
  EXAMPLES
1069
1144
  Import "./my-dataset.ndjson" into dataset "staging"
1070
1145
 
1071
- $ sanity dataset import -p myPrOj -d staging -t someSecretToken my-dataset.ndjson
1146
+ $ sanity dataset import -p myPrOj -d staging -t someSecretToken \
1147
+ my-dataset.ndjson
1072
1148
 
1073
1149
  Import into dataset "test" from stdin, read token from env var
1074
1150
 
1075
1151
  cat my-dataset.ndjson | sanity dataset import -p myPrOj -d test -
1076
1152
  ```
1077
1153
 
1078
- _See code: [src/commands/dataset/import.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/dataset/import.ts)_
1154
+ _See code: [src/commands/dataset/import.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/dataset/import.ts)_
1079
1155
 
1080
1156
  ## `sanity dataset list`
1081
1157
 
@@ -1094,7 +1170,7 @@ EXAMPLES
1094
1170
  $ sanity dataset list
1095
1171
  ```
1096
1172
 
1097
- _See code: [src/commands/dataset/list.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/dataset/list.ts)_
1173
+ _See code: [src/commands/dataset/list.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/dataset/list.ts)_
1098
1174
 
1099
1175
  ## `sanity dataset visibility get DATASET`
1100
1176
 
@@ -1116,7 +1192,7 @@ EXAMPLES
1116
1192
  $ sanity dataset visibility get my-dataset
1117
1193
  ```
1118
1194
 
1119
- _See code: [src/commands/dataset/visibility/get.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/dataset/visibility/get.ts)_
1195
+ _See code: [src/commands/dataset/visibility/get.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/dataset/visibility/get.ts)_
1120
1196
 
1121
1197
  ## `sanity dataset visibility set DATASET MODE`
1122
1198
 
@@ -1143,7 +1219,7 @@ EXAMPLES
1143
1219
  $ sanity dataset visibility set my-dataset public
1144
1220
  ```
1145
1221
 
1146
- _See code: [src/commands/dataset/visibility/set.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/dataset/visibility/set.ts)_
1222
+ _See code: [src/commands/dataset/visibility/set.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/dataset/visibility/set.ts)_
1147
1223
 
1148
1224
  ## `sanity debug`
1149
1225
 
@@ -1165,7 +1241,7 @@ EXAMPLES
1165
1241
  $ sanity debug --secrets
1166
1242
  ```
1167
1243
 
1168
- _See code: [src/commands/debug.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/debug.ts)_
1244
+ _See code: [src/commands/debug.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/debug.ts)_
1169
1245
 
1170
1246
  ## `sanity deploy [SOURCEDIR]`
1171
1247
 
@@ -1173,19 +1249,23 @@ Builds and deploys Sanity Studio or application to Sanity hosting
1173
1249
 
1174
1250
  ```
1175
1251
  USAGE
1176
- $ sanity deploy [SOURCEDIR] [--auto-updates] [--build] [--minify] [--schema-required] [--source-maps]
1177
- [--verbose] [-y]
1252
+ $ sanity deploy [SOURCEDIR] [--auto-updates] [--build] [--minify]
1253
+ [--schema-required] [--source-maps] [--verbose] [-y]
1178
1254
 
1179
1255
  ARGUMENTS
1180
1256
  [SOURCEDIR] Source directory
1181
1257
 
1182
1258
  FLAGS
1183
- -y, --yes Unattended mode, answers "yes" to any "yes/no" prompt and otherwise uses defaults
1259
+ -y, --yes Unattended mode, answers "yes" to any "yes/no" prompt
1260
+ and otherwise uses defaults
1184
1261
  --[no-]auto-updates Automatically update the studio to the latest version
1185
- --[no-]build Don't build the studio prior to deploy, instead deploying the version currently in `dist/`
1186
- --[no-]minify Skip minifying built JavaScript (speeds up build, increases size of bundle)
1262
+ --[no-]build Don't build the studio prior to deploy, instead
1263
+ deploying the version currently in `dist/`
1264
+ --[no-]minify Skip minifying built JavaScript (speeds up build,
1265
+ increases size of bundle)
1187
1266
  --schema-required Fail-fast deployment if schema store fails
1188
- --source-maps Enable source maps for built bundles (increases size of bundle)
1267
+ --source-maps Enable source maps for built bundles (increases size
1268
+ of bundle)
1189
1269
  --verbose Enable verbose logging
1190
1270
 
1191
1271
  DESCRIPTION
@@ -1200,12 +1280,13 @@ EXAMPLES
1200
1280
 
1201
1281
  $ sanity deploy --no-minify --source-maps
1202
1282
 
1203
- Fail fast on schema store fails - for when other services rely on the stored schema
1283
+ Fail fast on schema store fails - for when other services rely on the stored
1284
+ schema
1204
1285
 
1205
1286
  $ sanity deploy --schema-required
1206
1287
  ```
1207
1288
 
1208
- _See code: [src/commands/deploy.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/deploy.ts)_
1289
+ _See code: [src/commands/deploy.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/deploy.ts)_
1209
1290
 
1210
1291
  ## `sanity dev`
1211
1292
 
@@ -1213,11 +1294,13 @@ Starts a local development server for Sanity Studio with live reloading
1213
1294
 
1214
1295
  ```
1215
1296
  USAGE
1216
- $ sanity dev [--auto-updates] [--host <value>] [--load-in-dashboard] [--port <value>]
1297
+ $ sanity dev [--auto-updates] [--host <value>]
1298
+ [--load-in-dashboard] [--port <value>]
1217
1299
 
1218
1300
  FLAGS
1219
1301
  --[no-]auto-updates Automatically update Sanity Studio dependencies.
1220
- --host=<value> [default: localhost] The local network interface at which to listen.
1302
+ --host=<value> [default: localhost] The local network interface at
1303
+ which to listen.
1221
1304
  --[no-]load-in-dashboard Load the app/studio in the Sanity dashboard.
1222
1305
  --port=<value> [default: 3333] TCP port to start server on.
1223
1306
 
@@ -1232,7 +1315,7 @@ EXAMPLES
1232
1315
  $ sanity dev --load-in-dashboard
1233
1316
  ```
1234
1317
 
1235
- _See code: [src/commands/dev.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/dev.ts)_
1318
+ _See code: [src/commands/dev.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/dev.ts)_
1236
1319
 
1237
1320
  ## `sanity docs browse`
1238
1321
 
@@ -1246,7 +1329,7 @@ DESCRIPTION
1246
1329
  Open Sanity docs in a web browser
1247
1330
  ```
1248
1331
 
1249
- _See code: [src/commands/docs/browse.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/docs/browse.ts)_
1332
+ _See code: [src/commands/docs/browse.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/docs/browse.ts)_
1250
1333
 
1251
1334
  ## `sanity docs read PATH`
1252
1335
 
@@ -1283,7 +1366,7 @@ EXAMPLES
1283
1366
  $ sanity docs read https://www.sanity.io/docs/studio/installation -w
1284
1367
  ```
1285
1368
 
1286
- _See code: [src/commands/docs/read.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/docs/read.ts)_
1369
+ _See code: [src/commands/docs/read.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/docs/read.ts)_
1287
1370
 
1288
1371
  ## `sanity docs search QUERY`
1289
1372
 
@@ -1316,7 +1399,7 @@ EXAMPLES
1316
1399
  $ sanity docs search "deployment" --limit=5
1317
1400
  ```
1318
1401
 
1319
- _See code: [src/commands/docs/search.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/docs/search.ts)_
1402
+ _See code: [src/commands/docs/search.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/docs/search.ts)_
1320
1403
 
1321
1404
  ## `sanity documents create [FILE]`
1322
1405
 
@@ -1324,18 +1407,24 @@ Create one or more documents
1324
1407
 
1325
1408
  ```
1326
1409
  USAGE
1327
- $ sanity documents create [FILE] [-d <value>] [--id <value>] [--json5] [--missing] [--replace] [--watch]
1410
+ $ sanity documents create [FILE] [-d <value>] [--id <value>] [--json5]
1411
+ [--missing] [--replace] [--watch]
1328
1412
 
1329
1413
  ARGUMENTS
1330
1414
  [FILE] JSON file to create document(s) from
1331
1415
 
1332
1416
  FLAGS
1333
1417
  -d, --dataset=<value> Dataset to create document(s) in (overrides config)
1334
- --id=<value> Specify a document ID to use. Will fetch remote document ID and populate editor.
1335
- --json5 Use JSON5 file type to allow a "simplified" version of JSON
1336
- --missing On duplicate document IDs, don't modify the target document(s)
1337
- --replace On duplicate document IDs, replace existing document with specified document(s)
1338
- --watch Write the documents whenever the target file or buffer changes
1418
+ --id=<value> Specify a document ID to use. Will fetch remote document
1419
+ ID and populate editor.
1420
+ --json5 Use JSON5 file type to allow a "simplified" version of
1421
+ JSON
1422
+ --missing On duplicate document IDs, don't modify the target
1423
+ document(s)
1424
+ --replace On duplicate document IDs, replace existing document
1425
+ with specified document(s)
1426
+ --watch Write the documents whenever the target file or buffer
1427
+ changes
1339
1428
 
1340
1429
  DESCRIPTION
1341
1430
  Create one or more documents
@@ -1349,18 +1438,19 @@ EXAMPLES
1349
1438
 
1350
1439
  $ sanity documents create
1351
1440
 
1352
- Fetch document with the ID "myDocId" and open configured $EDITOR with the current document content (if any). Replace
1353
- document with the edited version when the editor closes
1441
+ Fetch document with the ID "myDocId" and open configured $EDITOR with the
1442
+ current document content (if any). Replace document with the edited version
1443
+ when the editor closes
1354
1444
 
1355
1445
  $ sanity documents create --id myDocId --replace
1356
1446
 
1357
- Open configured $EDITOR and replace the document with the given content on each save. Use JSON5 file extension and
1358
- parser for simplified syntax.
1447
+ Open configured $EDITOR and replace the document with the given content on
1448
+ each save. Use JSON5 file extension and parser for simplified syntax.
1359
1449
 
1360
1450
  $ sanity documents create --id myDocId --watch --replace --json5
1361
1451
  ```
1362
1452
 
1363
- _See code: [src/commands/documents/create.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/documents/create.ts)_
1453
+ _See code: [src/commands/documents/create.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/documents/create.ts)_
1364
1454
 
1365
1455
  ## `sanity documents delete ID [IDS]`
1366
1456
 
@@ -1398,7 +1488,7 @@ EXAMPLES
1398
1488
  $ sanity documents delete doc1 doc2
1399
1489
  ```
1400
1490
 
1401
- _See code: [src/commands/documents/delete.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/documents/delete.ts)_
1491
+ _See code: [src/commands/documents/delete.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/documents/delete.ts)_
1402
1492
 
1403
1493
  ## `sanity documents get DOCUMENTID`
1404
1494
 
@@ -1432,7 +1522,7 @@ EXAMPLES
1432
1522
  $ sanity documents get myDocId --dataset production
1433
1523
  ```
1434
1524
 
1435
- _See code: [src/commands/documents/get.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/documents/get.ts)_
1525
+ _See code: [src/commands/documents/get.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/documents/get.ts)_
1436
1526
 
1437
1527
  ## `sanity documents query QUERY`
1438
1528
 
@@ -1440,7 +1530,8 @@ Query for documents
1440
1530
 
1441
1531
  ```
1442
1532
  USAGE
1443
- $ sanity documents query QUERY [--anonymous] [--api-version <value>] [-d <value>] [--pretty] [-p <value>]
1533
+ $ sanity documents query QUERY [--anonymous] [--api-version <value>] [-d
1534
+ <value>] [--pretty] [-p <value>]
1444
1535
 
1445
1536
  ARGUMENTS
1446
1537
  QUERY GROQ query to run against the dataset
@@ -1449,7 +1540,8 @@ FLAGS
1449
1540
  -d, --dataset=<value> Dataset to query (overrides config)
1450
1541
  -p, --project=<value> Project ID to query (overrides config)
1451
1542
  --anonymous Send the query without any authorization token
1452
- --api-version=<value> [env: SANITY_CLI_QUERY_API_VERSION] API version to use (defaults to 2025-08-15)
1543
+ --api-version=<value> [env: SANITY_CLI_QUERY_API_VERSION] API version to
1544
+ use (defaults to 2025-08-15)
1453
1545
  --pretty Colorize JSON output
1454
1546
 
1455
1547
  DESCRIPTION
@@ -1462,14 +1554,16 @@ EXAMPLES
1462
1554
 
1463
1555
  Fetch title of the oldest movie in the dataset named "staging"
1464
1556
 
1465
- $ sanity documents query '*[_type == "movie"]|order(releaseDate asc)[0]{title}' --dataset staging
1557
+ $ sanity documents query '*[_type == "movie"]|order(releaseDate \
1558
+ asc)[0]{title}' --dataset staging
1466
1559
 
1467
1560
  Use API version v2021-06-07 and do a query
1468
1561
 
1469
- $ sanity documents query '*[_id == "header"] { "headerText": pt::text(body) }' --api-version v2021-06-07
1562
+ $ sanity documents query '*[_id == "header"] { "headerText": \
1563
+ pt::text(body) }' --api-version v2021-06-07
1470
1564
  ```
1471
1565
 
1472
- _See code: [src/commands/documents/query.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/documents/query.ts)_
1566
+ _See code: [src/commands/documents/query.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/documents/query.ts)_
1473
1567
 
1474
1568
  ## `sanity documents validate`
1475
1569
 
@@ -1477,25 +1571,35 @@ Validate documents in a dataset against the studio schema
1477
1571
 
1478
1572
  ```
1479
1573
  USAGE
1480
- $ sanity documents validate [-d <value>] [--file <value>] [--format <value>] [--level error|warning|info]
1481
- [--max-custom-validation-concurrency <value>] [--max-fetch-concurrency <value>] [--workspace <value>] [-y]
1574
+ $ sanity documents validate [-d <value>] [--file <value>] [--format <value>]
1575
+ [--level error|warning|info] [--max-custom-validation-concurrency <value>]
1576
+ [--max-fetch-concurrency <value>] [--workspace <value>] [-y]
1482
1577
 
1483
1578
  FLAGS
1484
- -d, --dataset=<value> Override the dataset used. By default, this is derived from the given
1485
- workspace
1486
- -y, --yes Skips the first confirmation prompt
1487
- --file=<value> Provide a path to either an .ndjson file or a tarball containing an
1488
- .ndjson file
1489
- --format=<value> The output format used to print the found validation markers and
1490
- report progress
1491
- --level=<option> [default: warning] The minimum level reported out. Defaults to
1492
- warning
1579
+ -d, --dataset=<value> Override the dataset used. By
1580
+ default, this is derived from
1581
+ the given workspace
1582
+ -y, --yes Skips the first confirmation
1583
+ prompt
1584
+ --file=<value> Provide a path to either an
1585
+ .ndjson file or a tarball
1586
+ containing an .ndjson file
1587
+ --format=<value> The output format used to
1588
+ print the found validation
1589
+ markers and report progress
1590
+ --level=<option> [default: warning] The minimum
1591
+ level reported out. Defaults
1592
+ to warning
1493
1593
  <options: error|warning|info>
1494
- --max-custom-validation-concurrency=<value> [default: 5] Specify how many custom validators can run concurrently
1495
- --max-fetch-concurrency=<value> [default: 25] Specify how many `client.fetch` requests are allow
1496
- concurrency at once
1497
- --workspace=<value> The name of the workspace to use when downloading and validating all
1498
- documents
1594
+ --max-custom-validation-concurrency=<value> [default: 5] Specify how many
1595
+ custom validators can run
1596
+ concurrently
1597
+ --max-fetch-concurrency=<value> [default: 25] Specify how many
1598
+ `client.fetch` requests are
1599
+ allow concurrency at once
1600
+ --workspace=<value> The name of the workspace to
1601
+ use when downloading and
1602
+ validating all documents
1499
1603
 
1500
1604
  DESCRIPTION
1501
1605
  Validate documents in a dataset against the studio schema
@@ -1518,7 +1622,7 @@ EXAMPLES
1518
1622
  $ sanity documents validate --level info
1519
1623
  ```
1520
1624
 
1521
- _See code: [src/commands/documents/validate.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/documents/validate.ts)_
1625
+ _See code: [src/commands/documents/validate.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/documents/validate.ts)_
1522
1626
 
1523
1627
  ## `sanity exec SCRIPT`
1524
1628
 
@@ -1543,8 +1647,8 @@ EXAMPLES
1543
1647
 
1544
1648
  $ sanity exec some/script.js
1545
1649
 
1546
- Run the script at migrations/fullname.ts and configure `getCliClient()` from `sanity/cli` to include the current
1547
- user's token
1650
+ Run the script at migrations/fullname.ts and configure `getCliClient()` from
1651
+ `sanity/cli` to include the current user's token
1548
1652
 
1549
1653
  $ sanity exec migrations/fullname.ts --with-user-token
1550
1654
 
@@ -1552,14 +1656,16 @@ EXAMPLES
1552
1656
 
1553
1657
  $ sanity exec scripts/browserScript.js --mock-browser-env
1554
1658
 
1555
- Pass arbitrary arguments to scripts by separating them with a `--`. Arguments are available in `process.argv` as
1556
- they would in regular node scripts (eg the following command would yield a `process.argv` of: `['/path/to/node',
1659
+ Pass arbitrary arguments to scripts by separating them with a `--`. Arguments
1660
+ are available in `process.argv` as they would in regular node scripts (eg the
1661
+ following command would yield a `process.argv` of: `['/path/to/node',
1557
1662
  '/path/to/myscript.js', '--dry-run', 'positional-argument']`)
1558
1663
 
1559
- $ sanity exec --mock-browser-env myscript.js -- --dry-run positional-argument
1664
+ $ sanity exec --mock-browser-env myscript.js -- --dry-run \
1665
+ positional-argument
1560
1666
  ```
1561
1667
 
1562
- _See code: [src/commands/exec.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/exec.ts)_
1668
+ _See code: [src/commands/exec.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/exec.ts)_
1563
1669
 
1564
1670
  ## `sanity functions add`
1565
1671
 
@@ -1567,34 +1673,54 @@ Add a Function to your Blueprint
1567
1673
 
1568
1674
  ```
1569
1675
  USAGE
1570
- $ sanity functions add [--example <value> | -n <value> | | --language ts|js | --javascript | | ] [--type
1571
- document-create|document-delete|document-update|document-publish|media-library-asset-create|media-library-asset-upda
1572
- te|media-library-asset-delete... ] [--helpers] [--installer skip|npm|pnpm|yarn] [-i | ]
1676
+ $ sanity functions add [--example <value> | -n <value> | | --language
1677
+ ts|js | --javascript | | ] [--type
1678
+ document-create|document-delete|document-update|document-publish|media-librar
1679
+ y-asset-create|media-library-asset-update|media-library-asset-delete... ]
1680
+ [--helpers] [--installer skip|npm|pnpm|yarn] [-i | ]
1573
1681
 
1574
1682
  FLAGS
1575
- -i, --install Shortcut for --fn-installer npm
1576
- -n, --name=<value> Name of the Function to add
1577
- --example=<value> Example to use for the Function
1578
- --[no-]helpers Add helpers to the new Function
1579
- --installer=<option> How to install the @sanity/functions helpers
1580
- <options: skip|npm|pnpm|yarn>
1581
- --javascript Use JavaScript instead of TypeScript
1582
- --language=<option> [default: ts] Language of the new Function
1583
- <options: ts|js>
1584
- --type=<option>... Document change event(s) that should trigger the function; you can specify multiple events
1585
- by specifying this flag multiple times
1586
- <options: document-create|document-delete|document-update|document-publish|media-library-ass
1587
- et-create|media-library-asset-update|media-library-asset-delete>
1683
+ -i, --install
1684
+ Shortcut for --fn-installer npm
1685
+
1686
+ -n, --name=<value>
1687
+ Name of the Function to add
1688
+
1689
+ --example=<value>
1690
+ Example to use for the Function
1691
+
1692
+ --[no-]helpers
1693
+ Add helpers to the new Function
1694
+
1695
+ --installer=<option>
1696
+ How to install the @sanity/functions helpers
1697
+ <options: skip|npm|pnpm|yarn>
1698
+
1699
+ --javascript
1700
+ Use JavaScript instead of TypeScript
1701
+
1702
+ --language=<option>
1703
+ [default: ts] Language of the new Function
1704
+ <options: ts|js>
1705
+
1706
+ --type=<option>...
1707
+ Document change event(s) that should trigger the function; you can specify
1708
+ multiple events by specifying this flag multiple times
1709
+ <options:
1710
+ document-create|document-delete|document-update|document-publish|media-librar
1711
+ y-asset-create|media-library-asset-update|media-library-asset-delete>
1588
1712
 
1589
1713
  DESCRIPTION
1590
1714
  Add a Function to your Blueprint
1591
1715
 
1592
- Scaffolds a new Function in the functions/ folder and templates a resource for your Blueprint manifest.
1716
+ Scaffolds a new Function in the functions/ folder and templates a resource for
1717
+ your Blueprint manifest.
1593
1718
 
1594
- Functions are serverless handlers triggered by document events (create, update, delete, publish) or media library
1595
- events.
1719
+ Functions are serverless handlers triggered by document events (create, update,
1720
+ delete, publish) or media library events.
1596
1721
 
1597
- After adding, use 'functions dev' to test locally, then 'blueprints deploy' to publish.
1722
+ After adding, use 'functions dev' to test locally, then 'blueprints deploy' to
1723
+ publish.
1598
1724
 
1599
1725
  EXAMPLES
1600
1726
  $ sanity functions add
@@ -1608,7 +1734,7 @@ EXAMPLES
1608
1734
  $ sanity functions add --name my-function --type document-create --type document-update --lang js
1609
1735
  ```
1610
1736
 
1611
- _See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v13.3.1/src/commands/functions/add.ts)_
1737
+ _See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v13.4.0/src/commands/functions/add.ts)_
1612
1738
 
1613
1739
  ## `sanity functions dev`
1614
1740
 
@@ -1619,20 +1745,23 @@ USAGE
1619
1745
  $ sanity functions dev [-h <value>] [-p <value>] [-t <value>]
1620
1746
 
1621
1747
  FLAGS
1622
- -h, --host=<value> The local network interface at which to listen. [default: "localhost"]
1748
+ -h, --host=<value> The local network interface at which to listen.
1749
+ [default: "localhost"]
1623
1750
  -p, --port=<value> TCP port to start emulator on. [default: 8080]
1624
- -t, --timeout=<value> Maximum execution time for all functions, in seconds. Takes precedence over function-specific
1625
- `timeout`
1751
+ -t, --timeout=<value> Maximum execution time for all functions, in seconds.
1752
+ Takes precedence over function-specific `timeout`
1626
1753
 
1627
1754
  DESCRIPTION
1628
1755
  Start the Sanity Function emulator
1629
1756
 
1630
- Runs a local, web-based development server to test your functions before deploying.
1757
+ Runs a local, web-based development server to test your functions before
1758
+ deploying.
1631
1759
 
1632
- Open the emulator in your browser to interactively test your functions with the payload editor.
1760
+ Open the emulator in your browser to interactively test your functions with the
1761
+ payload editor.
1633
1762
 
1634
- Optionally, set the host and port with the --host and --port flags. Function timeout can be configured with the
1635
- --timeout flag.
1763
+ Optionally, set the host and port with the --host and --port flags. Function
1764
+ timeout can be configured with the --timeout flag.
1636
1765
 
1637
1766
  To invoke a function with the CLI, use 'functions test'.
1638
1767
 
@@ -1642,7 +1771,7 @@ EXAMPLES
1642
1771
  $ sanity functions dev --timeout 60
1643
1772
  ```
1644
1773
 
1645
- _See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v13.3.1/src/commands/functions/dev.ts)_
1774
+ _See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v13.4.0/src/commands/functions/dev.ts)_
1646
1775
 
1647
1776
  ## `sanity functions env add NAME KEY VALUE`
1648
1777
 
@@ -1660,16 +1789,18 @@ ARGUMENTS
1660
1789
  DESCRIPTION
1661
1790
  Add or set an environment variable for a deployed function
1662
1791
 
1663
- Sets an environment variable in a deployed Sanity Function. If the variable already exists, its value is updated.
1792
+ Sets an environment variable in a deployed Sanity Function. If the variable
1793
+ already exists, its value is updated.
1664
1794
 
1665
- Environment variables are useful for API keys, configuration values, and other secrets that shouldn't be hardcoded.
1666
- Changes take effect on the next function invocation.
1795
+ Environment variables are useful for API keys, configuration values, and other
1796
+ secrets that shouldn't be hardcoded. Changes take effect on the next function
1797
+ invocation.
1667
1798
 
1668
1799
  EXAMPLES
1669
1800
  $ sanity functions env add MyFunction API_URL https://api.example.com/
1670
1801
  ```
1671
1802
 
1672
- _See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v13.3.1/src/commands/functions/env/add.ts)_
1803
+ _See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v13.4.0/src/commands/functions/env/add.ts)_
1673
1804
 
1674
1805
  ## `sanity functions env list NAME`
1675
1806
 
@@ -1685,15 +1816,17 @@ ARGUMENTS
1685
1816
  DESCRIPTION
1686
1817
  List environment variables for a deployed function
1687
1818
 
1688
- Displays all environment variables (keys only) configured in a deployed Sanity Function.
1819
+ Displays all environment variables (keys only) configured in a deployed Sanity
1820
+ Function.
1689
1821
 
1690
- Use 'functions env add' to set variables or 'functions env remove' to delete them.
1822
+ Use 'functions env add' to set variables or 'functions env remove' to delete
1823
+ them.
1691
1824
 
1692
1825
  EXAMPLES
1693
1826
  $ sanity functions env list MyFunction
1694
1827
  ```
1695
1828
 
1696
- _See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v13.3.1/src/commands/functions/env/list.ts)_
1829
+ _See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v13.4.0/src/commands/functions/env/list.ts)_
1697
1830
 
1698
1831
  ## `sanity functions env remove NAME KEY`
1699
1832
 
@@ -1710,8 +1843,8 @@ ARGUMENTS
1710
1843
  DESCRIPTION
1711
1844
  Remove an environment variable from a deployed function
1712
1845
 
1713
- Deletes an environment variable from a deployed Sanity Function. The change takes effect on the next function
1714
- invocation.
1846
+ Deletes an environment variable from a deployed Sanity Function. The change
1847
+ takes effect on the next function invocation.
1715
1848
 
1716
1849
  Use 'functions env list' to see current variables before removing.
1717
1850
 
@@ -1719,7 +1852,7 @@ EXAMPLES
1719
1852
  $ sanity functions env remove MyFunction API_URL
1720
1853
  ```
1721
1854
 
1722
- _See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v13.3.1/src/commands/functions/env/remove.ts)_
1855
+ _See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v13.4.0/src/commands/functions/env/remove.ts)_
1723
1856
 
1724
1857
  ## `sanity functions logs [NAME]`
1725
1858
 
@@ -1743,10 +1876,11 @@ FLAGS
1743
1876
  DESCRIPTION
1744
1877
  Retrieve or delete logs for a Sanity Function
1745
1878
 
1746
- Fetches execution logs from a deployed function, useful for debugging production issues or monitoring activity.
1879
+ Fetches execution logs from a deployed function, useful for debugging
1880
+ production issues or monitoring activity.
1747
1881
 
1748
- Use --watch (-w) to stream logs in real-time. Use --delete to clear all logs for a function (requires confirmation
1749
- unless --force is specified).
1882
+ Use --watch (-w) to stream logs in real-time. Use --delete to clear all logs
1883
+ for a function (requires confirmation unless --force is specified).
1750
1884
 
1751
1885
  EXAMPLES
1752
1886
  $ sanity functions logs <name>
@@ -1758,7 +1892,7 @@ EXAMPLES
1758
1892
  $ sanity functions logs <name> --delete
1759
1893
  ```
1760
1894
 
1761
- _See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v13.3.1/src/commands/functions/logs.ts)_
1895
+ _See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v13.4.0/src/commands/functions/logs.ts)_
1762
1896
 
1763
1897
  ## `sanity functions test [NAME]`
1764
1898
 
@@ -1766,10 +1900,12 @@ Invoke a local Sanity Function
1766
1900
 
1767
1901
  ```
1768
1902
  USAGE
1769
- $ sanity functions test [NAME] [--data-before <value> | [-d <value> | -f <value> | --document-id <value>] | | |
1770
- --file-before <value> | --file-after <value> | --document-id-before <value> | --document-id-after <value>]
1771
- [--data-after <value> | | | | | | | ] [-e create|update|delete] [-t <value>] [-a <value>] [--with-user-token]
1772
- [--media-library-id <value> | --project-id <value> | --dataset <value>]
1903
+ $ sanity functions test [NAME] [--data-before <value> | [-d <value> | -f
1904
+ <value> | --document-id <value>] | | | --file-before <value> | --file-after
1905
+ <value> | --document-id-before <value> | --document-id-after <value>]
1906
+ [--data-after <value> | | | | | | | ] [-e create|update|delete] [-t
1907
+ <value>] [-a <value>] [--with-user-token] [--media-library-id <value> |
1908
+ --project-id <value> | --dataset <value>]
1773
1909
 
1774
1910
  ARGUMENTS
1775
1911
  [NAME] The name of the Sanity Function
@@ -1796,11 +1932,12 @@ FLAGS
1796
1932
  DESCRIPTION
1797
1933
  Invoke a local Sanity Function
1798
1934
 
1799
- Executes a function locally with the provided payload, simulating how it would run when deployed. Use this to test
1800
- your function logic before deploying.
1935
+ Executes a function locally with the provided payload, simulating how it would
1936
+ run when deployed. Use this to test your function logic before deploying.
1801
1937
 
1802
- Provide test data via --data (inline JSON), --file (JSON file), or --document-id (fetch from Sanity). For update
1803
- events, use the before/after flag pairs to simulate document changes.
1938
+ Provide test data via --data (inline JSON), --file (JSON file), or
1939
+ --document-id (fetch from Sanity). For update events, use the before/after flag
1940
+ pairs to simulate document changes.
1804
1941
 
1805
1942
  EXAMPLES
1806
1943
  $ sanity functions test <name> --data '{ "id": 1 }'
@@ -1812,7 +1949,7 @@ EXAMPLES
1812
1949
  $ sanity functions test <name> --event update --data-before '{ "title": "before" }' --data-after '{ "title": "after" }'
1813
1950
  ```
1814
1951
 
1815
- _See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v13.3.1/src/commands/functions/test.ts)_
1952
+ _See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v13.4.0/src/commands/functions/test.ts)_
1816
1953
 
1817
1954
  ## `sanity graphql deploy`
1818
1955
 
@@ -1820,21 +1957,24 @@ Deploy a GraphQL API from the current Sanity schema
1820
1957
 
1821
1958
  ```
1822
1959
  USAGE
1823
- $ sanity graphql deploy [--api <value>...] [--dataset <value>] [--dry-run] [--force] [--generation gen1|gen2|gen3]
1824
- [--non-null-document-fields] [--playground] [--tag <value>] [--with-union-cache]
1960
+ $ sanity graphql deploy [--api <value>...] [--dataset <value>] [--dry-run]
1961
+ [--force] [--generation gen1|gen2|gen3] [--non-null-document-fields]
1962
+ [--playground] [--tag <value>] [--with-union-cache]
1825
1963
 
1826
1964
  FLAGS
1827
- --api=<value>... Only deploy API with this ID. Can be specified multiple times.
1965
+ --api=<value>... Only deploy API with this ID. Can be specified
1966
+ multiple times.
1828
1967
  --dataset=<value> Deploy API for the given dataset
1829
- --dry-run Validate defined GraphQL APIs, check for breaking changes, skip deploy
1968
+ --dry-run Validate defined GraphQL APIs, check for breaking
1969
+ changes, skip deploy
1830
1970
  --force Deploy API without confirming breaking changes
1831
1971
  --generation=<option> API generation to deploy (defaults to "gen3")
1832
1972
  <options: gen1|gen2|gen3>
1833
1973
  --non-null-document-fields Use non-null document fields (_id, _type etc)
1834
1974
  --[no-]playground Enable GraphQL playground for easier debugging
1835
1975
  --tag=<value> Deploy API(s) to given tag (defaults to "default")
1836
- --with-union-cache Enable union cache that optimizes schema generation for schemas with many self referencing
1837
- types
1976
+ --with-union-cache Enable union cache that optimizes schema generation
1977
+ for schemas with many self referencing types
1838
1978
 
1839
1979
  DESCRIPTION
1840
1980
  Deploy a GraphQL API from the current Sanity schema
@@ -1857,7 +1997,7 @@ EXAMPLES
1857
1997
  $ sanity graphql deploy --playground
1858
1998
  ```
1859
1999
 
1860
- _See code: [src/commands/graphql/deploy.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/graphql/deploy.ts)_
2000
+ _See code: [src/commands/graphql/deploy.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/graphql/deploy.ts)_
1861
2001
 
1862
2002
  ## `sanity graphql list`
1863
2003
 
@@ -1876,7 +2016,7 @@ EXAMPLES
1876
2016
  $ sanity graphql list
1877
2017
  ```
1878
2018
 
1879
- _See code: [src/commands/graphql/list.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/graphql/list.ts)_
2019
+ _See code: [src/commands/graphql/list.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/graphql/list.ts)_
1880
2020
 
1881
2021
  ## `sanity graphql undeploy`
1882
2022
 
@@ -1884,10 +2024,12 @@ Remove a deployed GraphQL API
1884
2024
 
1885
2025
  ```
1886
2026
  USAGE
1887
- $ sanity graphql undeploy [--api <value>] [--dataset <value>] [--force] [--project <value>] [--tag <value>]
2027
+ $ sanity graphql undeploy [--api <value>] [--dataset <value>] [--force]
2028
+ [--project <value>] [--tag <value>]
1888
2029
 
1889
2030
  FLAGS
1890
- --api=<value> Undeploy API with this ID (project, dataset and tag flags take precedence)
2031
+ --api=<value> Undeploy API with this ID (project, dataset and tag flags
2032
+ take precedence)
1891
2033
  --dataset=<value> Dataset to undeploy GraphQL API from
1892
2034
  --force Skip confirmation prompt
1893
2035
  --project=<value> Project ID to delete GraphQL API for
@@ -1918,7 +2060,7 @@ EXAMPLES
1918
2060
  $ sanity graphql undeploy --force
1919
2061
  ```
1920
2062
 
1921
- _See code: [src/commands/graphql/undeploy.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/graphql/undeploy.ts)_
2063
+ _See code: [src/commands/graphql/undeploy.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/graphql/undeploy.ts)_
1922
2064
 
1923
2065
  ## `sanity help [COMMAND]`
1924
2066
 
@@ -1960,7 +2102,7 @@ EXAMPLES
1960
2102
  $ sanity hook attempt abc123
1961
2103
  ```
1962
2104
 
1963
- _See code: [src/commands/hook/attempt.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/hook/attempt.ts)_
2105
+ _See code: [src/commands/hook/attempt.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/hook/attempt.ts)_
1964
2106
 
1965
2107
  ## `sanity hook create`
1966
2108
 
@@ -1979,7 +2121,7 @@ EXAMPLES
1979
2121
  $ sanity hook create
1980
2122
  ```
1981
2123
 
1982
- _See code: [src/commands/hook/create.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/hook/create.ts)_
2124
+ _See code: [src/commands/hook/create.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/hook/create.ts)_
1983
2125
 
1984
2126
  ## `sanity hook delete [NAME]`
1985
2127
 
@@ -2005,7 +2147,7 @@ EXAMPLES
2005
2147
  $ sanity hook delete my-hook
2006
2148
  ```
2007
2149
 
2008
- _See code: [src/commands/hook/delete.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/hook/delete.ts)_
2150
+ _See code: [src/commands/hook/delete.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/hook/delete.ts)_
2009
2151
 
2010
2152
  ## `sanity hook list`
2011
2153
 
@@ -2024,7 +2166,7 @@ EXAMPLES
2024
2166
  $ sanity hook list
2025
2167
  ```
2026
2168
 
2027
- _See code: [src/commands/hook/list.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/hook/list.ts)_
2169
+ _See code: [src/commands/hook/list.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/hook/list.ts)_
2028
2170
 
2029
2171
  ## `sanity hook logs [NAME]`
2030
2172
 
@@ -2053,7 +2195,7 @@ EXAMPLES
2053
2195
  $ sanity hook logs [NAME]
2054
2196
  ```
2055
2197
 
2056
- _See code: [src/commands/hook/logs.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/hook/logs.ts)_
2198
+ _See code: [src/commands/hook/logs.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/hook/logs.ts)_
2057
2199
 
2058
2200
  ## `sanity init`
2059
2201
 
@@ -2061,28 +2203,36 @@ Initialize a new Sanity Studio, project and/or app
2061
2203
 
2062
2204
  ```
2063
2205
  USAGE
2064
- $ sanity init [--json] [--auto-updates | --bare] [--coupon <code> | --project-plan <name>] [--dataset
2065
- <name> | --dataset-default] [--env <filename> | ] [--git <message> | ] [--mcp] [--nextjs-add-config-files]
2066
- [--nextjs-append-env] [--nextjs-embed-studio] [--organization <id>] [--output-path <path> | ] [--overwrite-files]
2067
- [--package-manager <manager> | ] [--project <id> | --create-project <name>] [--provider <provider>] [--template
2068
- <template> | ] [--typescript | ] [--visibility <mode>] [-y]
2206
+ $ sanity init [--json] [--auto-updates | --bare] [--coupon <code>
2207
+ | --project-plan <name>] [--dataset <name> | --dataset-default] [--env
2208
+ <filename> | ] [--git <message> | ] [--mcp] [--nextjs-add-config-files]
2209
+ [--nextjs-append-env] [--nextjs-embed-studio] [--organization <id>]
2210
+ [--output-path <path> | ] [--overwrite-files] [--package-manager <manager> |
2211
+ ] [--project <id> | --create-project <name>] [--provider <provider>]
2212
+ [--template <template> | ] [--typescript | ] [--visibility <mode>] [-y]
2069
2213
 
2070
2214
  FLAGS
2071
- -y, --yes Unattended mode, answers "yes" to any "yes/no" prompt and otherwise uses defaults
2215
+ -y, --yes Unattended mode, answers "yes" to any "yes/no"
2216
+ prompt and otherwise uses defaults
2072
2217
  --[no-]auto-updates Enable auto updates of studio versions
2073
- --bare Skip the Studio initialization and only print the selected project ID and dataset
2074
- name to stdout
2075
- --coupon=<code> Optionally select a coupon for a new project (cannot be used with --project-plan)
2218
+ --bare Skip the Studio initialization and only print
2219
+ the selected project ID and dataset name to
2220
+ stdout
2221
+ --coupon=<code> Optionally select a coupon for a new project
2222
+ (cannot be used with --project-plan)
2076
2223
  --create-project=<name> Create a new project with the given name
2077
2224
  --dataset=<name> Dataset name for the studio
2078
- --dataset-default Set up a project with a public dataset named "production"
2225
+ --dataset-default Set up a project with a public dataset named
2226
+ "production"
2079
2227
  --env=<filename> Write environment variables to file
2080
- --[no-]git=<message> Specify a commit message for initial commit, or disable git init
2228
+ --[no-]git=<message> Specify a commit message for initial commit,
2229
+ or disable git init
2081
2230
  --[no-]mcp Enable AI editor integration (MCP) setup
2082
2231
  --organization=<id> Organization ID to use for the project
2083
2232
  --output-path=<path> Path to write studio project to
2084
2233
  --[no-]overwrite-files Overwrite existing files
2085
- --package-manager=<manager> Specify which package manager to use [allowed: npm, yarn, pnpm]
2234
+ --package-manager=<manager> Specify which package manager to use [allowed:
2235
+ npm, yarn, pnpm]
2086
2236
  --project=<id> Project ID to use for the studio
2087
2237
  --project-plan=<name> Optionally select a plan for a new project
2088
2238
  --provider=<provider> Login provider to use
@@ -2110,19 +2260,23 @@ EXAMPLES
2110
2260
 
2111
2261
  Initialize a project with the given project ID and dataset to the given path
2112
2262
 
2113
- $ sanity init -y --project abc123 --dataset production --output-path ~/myproj
2263
+ $ sanity init -y --project abc123 --dataset production --output-path \
2264
+ ~/myproj
2114
2265
 
2115
- Initialize a project with the given project ID and dataset using the moviedb template to the given path
2266
+ Initialize a project with the given project ID and dataset using the moviedb
2267
+ template to the given path
2116
2268
 
2117
- $ sanity init -y --project abc123 --dataset staging --template moviedb --output-path .
2269
+ $ sanity init -y --project abc123 --dataset staging --template moviedb \
2270
+ --output-path .
2118
2271
 
2119
2272
  Create a brand new project with name "Movies Unlimited"
2120
2273
 
2121
- $ sanity init -y --create-project "Movies Unlimited" --dataset moviedb --visibility private --template moviedb \
2122
- --output-path /Users/espenh/movies-unlimited
2274
+ $ sanity init -y --create-project "Movies Unlimited" --dataset moviedb \
2275
+ --visibility private --template moviedb --output-path \
2276
+ /Users/espenh/movies-unlimited
2123
2277
  ```
2124
2278
 
2125
- _See code: [src/commands/init.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/init.ts)_
2279
+ _See code: [src/commands/init.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/init.ts)_
2126
2280
 
2127
2281
  ## `sanity install [PACKAGES]`
2128
2282
 
@@ -2146,7 +2300,7 @@ EXAMPLES
2146
2300
  $ sanity install some-package another-package
2147
2301
  ```
2148
2302
 
2149
- _See code: [src/commands/install.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/install.ts)_
2303
+ _See code: [src/commands/install.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/install.ts)_
2150
2304
 
2151
2305
  ## `sanity learn`
2152
2306
 
@@ -2160,7 +2314,7 @@ DESCRIPTION
2160
2314
  Opens Sanity Learn in your web browser
2161
2315
  ```
2162
2316
 
2163
- _See code: [src/commands/learn.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/learn.ts)_
2317
+ _See code: [src/commands/learn.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/learn.ts)_
2164
2318
 
2165
2319
  ## `sanity login`
2166
2320
 
@@ -2171,9 +2325,11 @@ USAGE
2171
2325
  $ sanity login [--open] [--provider <providerId>] [--sso <slug>]
2172
2326
 
2173
2327
  FLAGS
2174
- --[no-]open Open a browser window to log in (`--no-open` only prints URL)
2328
+ --[no-]open Open a browser window to log in (`--no-open` only
2329
+ prints URL)
2175
2330
  --provider=<providerId> Log in using the given provider
2176
- --sso=<slug> Log in using Single Sign-On, using the given organization slug
2331
+ --sso=<slug> Log in using Single Sign-On, using the given
2332
+ organization slug
2177
2333
 
2178
2334
  DESCRIPTION
2179
2335
  Authenticates the CLI for access to Sanity projects
@@ -2192,7 +2348,7 @@ EXAMPLES
2192
2348
  $ sanity login --provider github --no-open
2193
2349
  ```
2194
2350
 
2195
- _See code: [src/commands/login.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/login.ts)_
2351
+ _See code: [src/commands/login.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/login.ts)_
2196
2352
 
2197
2353
  ## `sanity logout`
2198
2354
 
@@ -2206,7 +2362,7 @@ DESCRIPTION
2206
2362
  Logs out the CLI from the current user session
2207
2363
  ```
2208
2364
 
2209
- _See code: [src/commands/logout.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/logout.ts)_
2365
+ _See code: [src/commands/logout.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/logout.ts)_
2210
2366
 
2211
2367
  ## `sanity manage`
2212
2368
 
@@ -2220,7 +2376,7 @@ DESCRIPTION
2220
2376
  Opens project management interface in your web browser
2221
2377
  ```
2222
2378
 
2223
- _See code: [src/commands/manage.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/manage.ts)_
2379
+ _See code: [src/commands/manage.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/manage.ts)_
2224
2380
 
2225
2381
  ## `sanity manifest extract`
2226
2382
 
@@ -2231,12 +2387,14 @@ USAGE
2231
2387
  $ sanity manifest extract [--path <value>]
2232
2388
 
2233
2389
  FLAGS
2234
- --path=<value> [default: /dist/static] Optional path to specify destination directory of the manifest files
2390
+ --path=<value> [default: /dist/static] Optional path to specify destination
2391
+ directory of the manifest files
2235
2392
 
2236
2393
  DESCRIPTION
2237
2394
  Extracts the studio configuration as one or more JSON manifest files.
2238
2395
 
2239
- **Note**: This command is experimental and subject to change. It is currently intended for use with Create only.
2396
+ **Note**: This command is experimental and subject to change. It is currently
2397
+ intended for use with Create only.
2240
2398
 
2241
2399
  EXAMPLES
2242
2400
  Extracts manifests
@@ -2248,7 +2406,7 @@ EXAMPLES
2248
2406
  $ sanity manifest extract --path /public/static
2249
2407
  ```
2250
2408
 
2251
- _See code: [src/commands/manifest/extract.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/manifest/extract.ts)_
2409
+ _See code: [src/commands/manifest/extract.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/manifest/extract.ts)_
2252
2410
 
2253
2411
  ## `sanity mcp configure`
2254
2412
 
@@ -2259,7 +2417,8 @@ USAGE
2259
2417
  $ sanity mcp configure
2260
2418
 
2261
2419
  DESCRIPTION
2262
- Configure Sanity MCP server for AI editors (Claude Code, Codex CLI, Cursor, Gemini CLI, GitHub Copilot CLI, VS Code)
2420
+ Configure Sanity MCP server for AI editors (Claude Code, Codex CLI, Cursor,
2421
+ Gemini CLI, GitHub Copilot CLI, VS Code)
2263
2422
 
2264
2423
  EXAMPLES
2265
2424
  Configure Sanity MCP server for detected AI editors
@@ -2267,7 +2426,7 @@ EXAMPLES
2267
2426
  $ sanity mcp configure
2268
2427
  ```
2269
2428
 
2270
- _See code: [src/commands/mcp/configure.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/mcp/configure.ts)_
2429
+ _See code: [src/commands/mcp/configure.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/mcp/configure.ts)_
2271
2430
 
2272
2431
  ## `sanity media create-aspect`
2273
2432
 
@@ -2286,7 +2445,7 @@ EXAMPLES
2286
2445
  $ sanity media create-aspect
2287
2446
  ```
2288
2447
 
2289
- _See code: [src/commands/media/create-aspect.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/media/create-aspect.ts)_
2448
+ _See code: [src/commands/media/create-aspect.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/media/create-aspect.ts)_
2290
2449
 
2291
2450
  ## `sanity media delete-aspect ASPECTNAME`
2292
2451
 
@@ -2312,7 +2471,7 @@ EXAMPLES
2312
2471
  $ sanity media delete-aspect someAspect
2313
2472
  ```
2314
2473
 
2315
- _See code: [src/commands/media/delete-aspect.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/media/delete-aspect.ts)_
2474
+ _See code: [src/commands/media/delete-aspect.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/media/delete-aspect.ts)_
2316
2475
 
2317
2476
  ## `sanity media deploy-aspect [ASPECTNAME]`
2318
2477
 
@@ -2342,7 +2501,7 @@ EXAMPLES
2342
2501
  $ sanity media deploy-aspect --all
2343
2502
  ```
2344
2503
 
2345
- _See code: [src/commands/media/deploy-aspect.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/media/deploy-aspect.ts)_
2504
+ _See code: [src/commands/media/deploy-aspect.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/media/deploy-aspect.ts)_
2346
2505
 
2347
2506
  ## `sanity media export [DESTINATION]`
2348
2507
 
@@ -2350,8 +2509,8 @@ Export an archive of all file and image assets including their aspect data from
2350
2509
 
2351
2510
  ```
2352
2511
  USAGE
2353
- $ sanity media export [DESTINATION] [--asset-concurrency <value>] [--media-library-id <value>] [--no-compress]
2354
- [--overwrite]
2512
+ $ sanity media export [DESTINATION] [--asset-concurrency <value>]
2513
+ [--media-library-id <value>] [--no-compress] [--overwrite]
2355
2514
 
2356
2515
  ARGUMENTS
2357
2516
  [DESTINATION] Output destination file path
@@ -2359,12 +2518,13 @@ ARGUMENTS
2359
2518
  FLAGS
2360
2519
  --asset-concurrency=<value> [default: 8] Concurrent number of asset downloads
2361
2520
  --media-library-id=<value> The id of the target media library
2362
- --no-compress Skips compressing tarball entries (still generates a gzip file)
2521
+ --no-compress Skips compressing tarball entries (still generates
2522
+ a gzip file)
2363
2523
  --overwrite Overwrite any file with the same name
2364
2524
 
2365
2525
  DESCRIPTION
2366
- Export an archive of all file and image assets including their aspect data from the target media library. Video assets
2367
- are excluded from the export.
2526
+ Export an archive of all file and image assets including their aspect data from
2527
+ the target media library. Video assets are excluded from the export.
2368
2528
 
2369
2529
  EXAMPLES
2370
2530
  Export media library interactively
@@ -2380,7 +2540,7 @@ EXAMPLES
2380
2540
  $ sanity media export --media-library-id my-library-id
2381
2541
  ```
2382
2542
 
2383
- _See code: [src/commands/media/export.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/media/export.ts)_
2543
+ _See code: [src/commands/media/export.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/media/export.ts)_
2384
2544
 
2385
2545
  ## `sanity media import SOURCE`
2386
2546
 
@@ -2388,15 +2548,16 @@ Import a set of assets to the target media library.
2388
2548
 
2389
2549
  ```
2390
2550
  USAGE
2391
- $ sanity media import SOURCE [--media-library-id <value>] [--replace-aspects]
2551
+ $ sanity media import SOURCE [--media-library-id <value>]
2552
+ [--replace-aspects]
2392
2553
 
2393
2554
  ARGUMENTS
2394
2555
  SOURCE Image file or folder to import from
2395
2556
 
2396
2557
  FLAGS
2397
2558
  --media-library-id=<value> The id of the target media library
2398
- --replace-aspects Replace existing aspect data. All versions will be replaced (e.g. published and draft
2399
- aspect data)
2559
+ --replace-aspects Replace existing aspect data. All versions will be
2560
+ replaced (e.g. published and draft aspect data)
2400
2561
 
2401
2562
  DESCRIPTION
2402
2563
  Import a set of assets to the target media library.
@@ -2415,7 +2576,7 @@ EXAMPLES
2415
2576
  $ sanity media import products --replace-aspects
2416
2577
  ```
2417
2578
 
2418
- _See code: [src/commands/media/import.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/media/import.ts)_
2579
+ _See code: [src/commands/media/import.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/media/import.ts)_
2419
2580
 
2420
2581
  ## `sanity migration create [TITLE]`
2421
2582
 
@@ -2441,7 +2602,7 @@ EXAMPLES
2441
2602
  $ sanity migration create "Rename field from location to address"
2442
2603
  ```
2443
2604
 
2444
- _See code: [@sanity/migrate](https://github.com/sanity-io/migrate/blob/v5.2.4/src/commands/migration/create.ts)_
2605
+ _See code: [@sanity/migrate](https://github.com/sanity-io/migrate/blob/v5.2.5/src/commands/migration/create.ts)_
2445
2606
 
2446
2607
  ## `sanity migration list`
2447
2608
 
@@ -2460,7 +2621,7 @@ EXAMPLES
2460
2621
  $ sanity migration list
2461
2622
  ```
2462
2623
 
2463
- _See code: [@sanity/migrate](https://github.com/sanity-io/migrate/blob/v5.2.4/src/commands/migration/list.ts)_
2624
+ _See code: [@sanity/migrate](https://github.com/sanity-io/migrate/blob/v5.2.5/src/commands/migration/list.ts)_
2464
2625
 
2465
2626
  ## `sanity migration run [ID]`
2466
2627
 
@@ -2468,24 +2629,31 @@ Run a migration against a dataset
2468
2629
 
2469
2630
  ```
2470
2631
  USAGE
2471
- $ sanity migration run [ID] [--api-version <value>] [--concurrency <value>] [--confirm] [--dataset <value>]
2472
- [--dry-run] [--from-export <value>] [--progress] [--project <value>]
2632
+ $ sanity migration run [ID] [--api-version <value>] [--concurrency
2633
+ <value>] [--confirm] [--dataset <value>] [--dry-run] [--from-export <value>]
2634
+ [--progress] [--project <value>]
2473
2635
 
2474
2636
  ARGUMENTS
2475
2637
  [ID] ID
2476
2638
 
2477
2639
  FLAGS
2478
- --api-version=<value> API version to use when migrating. Defaults to v2024-01-29.
2479
- --concurrency=<value> [default: 6] How many mutation requests to run in parallel. Must be between 1 and 10. Default:
2480
- 6.
2481
- --[no-]confirm Prompt for confirmation before running the migration (default: true). Use --no-confirm to skip.
2482
- --dataset=<value> Dataset to migrate. Defaults to the dataset configured in your Sanity CLI config.
2483
- --[no-]dry-run By default the migration runs in dry mode. Use --no-dry-run to migrate dataset.
2484
- --from-export=<value> Use a local dataset export as source for migration instead of calling the Sanity API. Note:
2485
- this is only supported for dry runs.
2486
- --[no-]progress Display progress during migration (default: true). Use --no-progress to hide output.
2487
- --project=<value> Project ID of the dataset to migrate. Defaults to the projectId configured in your Sanity CLI
2488
- config.
2640
+ --api-version=<value> API version to use when migrating. Defaults to
2641
+ v2024-01-29.
2642
+ --concurrency=<value> [default: 6] How many mutation requests to run in
2643
+ parallel. Must be between 1 and 10. Default: 6.
2644
+ --[no-]confirm Prompt for confirmation before running the migration
2645
+ (default: true). Use --no-confirm to skip.
2646
+ --dataset=<value> Dataset to migrate. Defaults to the dataset configured
2647
+ in your Sanity CLI config.
2648
+ --[no-]dry-run By default the migration runs in dry mode. Use
2649
+ --no-dry-run to migrate dataset.
2650
+ --from-export=<value> Use a local dataset export as source for migration
2651
+ instead of calling the Sanity API. Note: this is only
2652
+ supported for dry runs.
2653
+ --[no-]progress Display progress during migration (default: true). Use
2654
+ --no-progress to hide output.
2655
+ --project=<value> Project ID of the dataset to migrate. Defaults to the
2656
+ projectId configured in your Sanity CLI config.
2489
2657
 
2490
2658
  DESCRIPTION
2491
2659
  Run a migration against a dataset
@@ -2501,10 +2669,11 @@ EXAMPLES
2501
2669
 
2502
2670
  execute the migration using a dataset export as the source
2503
2671
 
2504
- $ sanity migration run <id> --from-export=production.tar.gz --no-dry-run --project xyz --dataset staging
2672
+ $ sanity migration run <id> --from-export=production.tar.gz --no-dry-run \
2673
+ --project xyz --dataset staging
2505
2674
  ```
2506
2675
 
2507
- _See code: [@sanity/migrate](https://github.com/sanity-io/migrate/blob/v5.2.4/src/commands/migration/run.ts)_
2676
+ _See code: [@sanity/migrate](https://github.com/sanity-io/migrate/blob/v5.2.5/src/commands/migration/run.ts)_
2508
2677
 
2509
2678
  ## `sanity openapi get SLUG`
2510
2679
 
@@ -2543,7 +2712,7 @@ EXAMPLES
2543
2712
  $ sanity openapi get query > query-api.yaml
2544
2713
  ```
2545
2714
 
2546
- _See code: [src/commands/openapi/get.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/openapi/get.ts)_
2715
+ _See code: [src/commands/openapi/get.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/openapi/get.ts)_
2547
2716
 
2548
2717
  ## `sanity openapi list`
2549
2718
 
@@ -2574,7 +2743,7 @@ EXAMPLES
2574
2743
  $ sanity openapi list --web
2575
2744
  ```
2576
2745
 
2577
- _See code: [src/commands/openapi/list.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/openapi/list.ts)_
2746
+ _See code: [src/commands/openapi/list.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/openapi/list.ts)_
2578
2747
 
2579
2748
  ## `sanity preview [OUTPUTDIR]`
2580
2749
 
@@ -2588,7 +2757,8 @@ ARGUMENTS
2588
2757
  [OUTPUTDIR] Output directory
2589
2758
 
2590
2759
  FLAGS
2591
- --host=<value> [default: localhost] The local network interface at which to listen.
2760
+ --host=<value> [default: localhost] The local network interface at which to
2761
+ listen.
2592
2762
  --port=<value> [default: 3333] TCP port to start server on.
2593
2763
 
2594
2764
  DESCRIPTION
@@ -2605,7 +2775,7 @@ EXAMPLES
2605
2775
  $ sanity preview some/build-output-dir
2606
2776
  ```
2607
2777
 
2608
- _See code: [src/commands/preview.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/preview.ts)_
2778
+ _See code: [src/commands/preview.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/preview.ts)_
2609
2779
 
2610
2780
  ## `sanity projects create [PROJECTNAME]`
2611
2781
 
@@ -2613,16 +2783,19 @@ Create a new Sanity project
2613
2783
 
2614
2784
  ```
2615
2785
  USAGE
2616
- $ sanity projects create [PROJECTNAME] [--dataset <value>] [--dataset-visibility private|public] [--json]
2617
- [--organization <slug|id>] [-y]
2786
+ $ sanity projects create [PROJECTNAME] [--dataset <value>]
2787
+ [--dataset-visibility private|public] [--json] [--organization <slug|id>]
2788
+ [-y]
2618
2789
 
2619
2790
  ARGUMENTS
2620
2791
  [PROJECTNAME] Name of the project to create
2621
2792
 
2622
2793
  FLAGS
2623
- -y, --yes Skip prompts and use defaults (project: "My Sanity Project", dataset: production,
2794
+ -y, --yes Skip prompts and use defaults (project: "My
2795
+ Sanity Project", dataset: production,
2624
2796
  visibility: public)
2625
- --dataset=<value> Create a dataset. Prompts for visibility unless specified or --yes used
2797
+ --dataset=<value> Create a dataset. Prompts for visibility
2798
+ unless specified or --yes used
2626
2799
  --dataset-visibility=<option> Dataset visibility: public or private
2627
2800
  <options: private|public>
2628
2801
  --json Output in JSON format
@@ -2646,14 +2819,15 @@ EXAMPLES
2646
2819
 
2647
2820
  Create a project with a private dataset named "staging"
2648
2821
 
2649
- $ sanity projects create "My Project" --dataset=staging --dataset-visibility=private
2822
+ $ sanity projects create "My Project" --dataset=staging \
2823
+ --dataset-visibility=private
2650
2824
 
2651
2825
  Create a project non-interactively with JSON output
2652
2826
 
2653
2827
  $ sanity projects create "CI Project" --yes --json
2654
2828
  ```
2655
2829
 
2656
- _See code: [src/commands/projects/create.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/projects/create.ts)_
2830
+ _See code: [src/commands/projects/create.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/projects/create.ts)_
2657
2831
 
2658
2832
  ## `sanity projects list`
2659
2833
 
@@ -2661,7 +2835,8 @@ Lists projects connected to your user
2661
2835
 
2662
2836
  ```
2663
2837
  USAGE
2664
- $ sanity projects list [--order asc|desc] [--sort id|members|name|url|created]
2838
+ $ sanity projects list [--order asc|desc] [--sort
2839
+ id|members|name|url|created]
2665
2840
 
2666
2841
  FLAGS
2667
2842
  --order=<option> [default: desc]
@@ -2682,7 +2857,7 @@ EXAMPLES
2682
2857
  $ sanity projects list --sort=members --order=asc
2683
2858
  ```
2684
2859
 
2685
- _See code: [src/commands/projects/list.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/projects/list.ts)_
2860
+ _See code: [src/commands/projects/list.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/projects/list.ts)_
2686
2861
 
2687
2862
  ## `sanity schema delete`
2688
2863
 
@@ -2707,10 +2882,11 @@ EXAMPLES
2707
2882
 
2708
2883
  Delete multiple schemas
2709
2884
 
2710
- $ sanity schema delete --ids sanity.workspace.schema.workspaceName,prefix.sanity.workspace.schema.otherWorkspace
2885
+ $ sanity schema delete --ids sanity.workspace.schema.workspaceName,prefix \
2886
+ .sanity.workspace.schema.otherWorkspace
2711
2887
  ```
2712
2888
 
2713
- _See code: [src/commands/schema/delete.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/schema/delete.ts)_
2889
+ _See code: [src/commands/schema/delete.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/schema/delete.ts)_
2714
2890
 
2715
2891
  ## `sanity schema deploy`
2716
2892
 
@@ -2718,12 +2894,14 @@ Deploy schema documents into workspace datasets.
2718
2894
 
2719
2895
  ```
2720
2896
  USAGE
2721
- $ sanity schema deploy [--extract-manifest] [--manifest-dir <directory>] [--tag <tag>] [--verbose] [--workspace
2722
- <name>]
2897
+ $ sanity schema deploy [--extract-manifest] [--manifest-dir <directory>]
2898
+ [--tag <tag>] [--verbose] [--workspace <name>]
2723
2899
 
2724
2900
  FLAGS
2725
- --[no-]extract-manifest Disables manifest generation - the command will fail if no manifest exists
2726
- --manifest-dir=<directory> [default: ./dist/static] Directory containing manifest file
2901
+ --[no-]extract-manifest Disables manifest generation - the command will
2902
+ fail if no manifest exists
2903
+ --manifest-dir=<directory> [default: ./dist/static] Directory containing
2904
+ manifest file
2727
2905
  --tag=<tag> Add a tag suffix to the schema id
2728
2906
  --verbose Print detailed information during deployment
2729
2907
  --workspace=<name> The name of the workspace to deploy a schema for
@@ -2733,7 +2911,8 @@ DESCRIPTION
2733
2911
 
2734
2912
  **Note**: This command is experimental and subject to change.
2735
2913
 
2736
- This operation (re-)generates a manifest file describing the sanity config workspace by default.
2914
+ This operation (re-)generates a manifest file describing the sanity config
2915
+ workspace by default.
2737
2916
  To re-use an existing manifest file, use --no-extract-manifest.
2738
2917
 
2739
2918
  EXAMPLES
@@ -2745,12 +2924,13 @@ EXAMPLES
2745
2924
 
2746
2925
  $ sanity schema deploy --workspace default
2747
2926
 
2748
- Runs using a pre-existing manifest file. Config changes in sanity.config will not be picked up in this case.
2927
+ Runs using a pre-existing manifest file. Config changes in sanity.config will
2928
+ not be picked up in this case.
2749
2929
 
2750
2930
  $ sanity schema deploy --no-extract-manifest
2751
2931
  ```
2752
2932
 
2753
- _See code: [src/commands/schema/deploy.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/schema/deploy.ts)_
2933
+ _See code: [src/commands/schema/deploy.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/schema/deploy.ts)_
2754
2934
 
2755
2935
  ## `sanity schema extract`
2756
2936
 
@@ -2758,16 +2938,21 @@ Extracts a JSON representation of a Sanity schema within a Studio context.
2758
2938
 
2759
2939
  ```
2760
2940
  USAGE
2761
- $ sanity schema extract [--enforce-required-fields] [--format <format>] [--path <value>] [--watch]
2762
- [--watch-patterns <glob>...] [--workspace <name>]
2941
+ $ sanity schema extract [--enforce-required-fields] [--format <format>]
2942
+ [--path <value>] [--watch] [--watch-patterns <glob>...] [--workspace <name>]
2763
2943
 
2764
2944
  FLAGS
2765
- --enforce-required-fields Makes the schema generated treat fields marked as required as non-optional
2766
- --format=<format> [default: groq-type-nodes] Format the schema as GROQ type nodes. Only available format at
2767
- the moment.
2768
- --path=<value> Optional path to specify destination of the schema file
2769
- --watch Enable watch mode to re-extract schema on file changes
2770
- --watch-patterns=<glob>... Additional glob pattern(s) to watch (can be specified multiple times)
2945
+ --enforce-required-fields Makes the schema generated treat fields marked as
2946
+ required as non-optional
2947
+ --format=<format> [default: groq-type-nodes] Format the schema as
2948
+ GROQ type nodes. Only available format at the
2949
+ moment.
2950
+ --path=<value> Optional path to specify destination of the schema
2951
+ file
2952
+ --watch Enable watch mode to re-extract schema on file
2953
+ changes
2954
+ --watch-patterns=<glob>... Additional glob pattern(s) to watch (can be
2955
+ specified multiple times)
2771
2956
  --workspace=<name> The name of the workspace to generate a schema for
2772
2957
 
2773
2958
  DESCRIPTION
@@ -2789,7 +2974,7 @@ EXAMPLES
2789
2974
  $ sanity schema extract --watch --watch-patterns "lib/**/*.ts"
2790
2975
  ```
2791
2976
 
2792
- _See code: [src/commands/schema/extract.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/schema/extract.ts)_
2977
+ _See code: [src/commands/schema/extract.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/schema/extract.ts)_
2793
2978
 
2794
2979
  ## `sanity schema list`
2795
2980
 
@@ -2808,7 +2993,8 @@ DESCRIPTION
2808
2993
 
2809
2994
  **Note**: This command is experimental and subject to change.
2810
2995
 
2811
- This operation (re-)generates a manifest file describing the sanity config workspace by default.
2996
+ This operation (re-)generates a manifest file describing the sanity config
2997
+ workspace by default.
2812
2998
  To re-use an existing manifest file, use --no-extract-manifest.
2813
2999
 
2814
3000
  EXAMPLES
@@ -2829,7 +3015,7 @@ EXAMPLES
2829
3015
  $ sanity schema list --json --id _.schemas.workspaceName
2830
3016
  ```
2831
3017
 
2832
- _See code: [src/commands/schema/list.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/schema/list.ts)_
3018
+ _See code: [src/commands/schema/list.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/schema/list.ts)_
2833
3019
 
2834
3020
  ## `sanity schema validate`
2835
3021
 
@@ -2837,19 +3023,23 @@ Validates all schema types specified in a workspace
2837
3023
 
2838
3024
  ```
2839
3025
  USAGE
2840
- $ sanity schema validate [--debug-metafile-path <value>] [--format pretty|ndjson|json] [--level error|warning]
2841
- [--workspace <value>]
3026
+ $ sanity schema validate [--debug-metafile-path <value>] [--format
3027
+ pretty|ndjson|json] [--level error|warning] [--workspace <value>]
2842
3028
 
2843
3029
  FLAGS
2844
- --format=<option> [default: pretty] The output format used to print schema errors and warnings
3030
+ --format=<option> [default: pretty] The output format used to print schema
3031
+ errors and warnings
2845
3032
  <options: pretty|ndjson|json>
2846
3033
  --level=<option> [default: warning] The minimum level reported out
2847
3034
  <options: error|warning>
2848
- --workspace=<value> The name of the workspace to use when validating all schema types
3035
+ --workspace=<value> The name of the workspace to use when validating all
3036
+ schema types
2849
3037
 
2850
3038
  DEBUG FLAGS
2851
- --debug-metafile-path=<value> Optional path where a metafile will be written for build analysis. Only written on
2852
- successful validation. Can be analyzed at https://esbuild.github.io/analyze/
3039
+ --debug-metafile-path=<value> Optional path where a metafile will be written
3040
+ for build analysis. Only written on successful
3041
+ validation. Can be analyzed at
3042
+ https://esbuild.github.io/analyze/
2853
3043
 
2854
3044
  DESCRIPTION
2855
3045
  Validates all schema types specified in a workspace
@@ -2867,12 +3057,13 @@ EXAMPLES
2867
3057
 
2868
3058
  $ sanity schema validate --level error
2869
3059
 
2870
- Generate a report which can be analyzed with https://esbuild.github.io/analyze/
3060
+ Generate a report which can be analyzed with
3061
+ https://esbuild.github.io/analyze/
2871
3062
 
2872
3063
  $ sanity schema validate --debug-metafile-path metafile.json
2873
3064
  ```
2874
3065
 
2875
- _See code: [src/commands/schema/validate.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/schema/validate.ts)_
3066
+ _See code: [src/commands/schema/validate.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/schema/validate.ts)_
2876
3067
 
2877
3068
  ## `sanity start [OUTPUTDIR]`
2878
3069
 
@@ -2886,7 +3077,8 @@ ARGUMENTS
2886
3077
  [OUTPUTDIR] Output directory
2887
3078
 
2888
3079
  FLAGS
2889
- --host=<value> [default: localhost] The local network interface at which to listen.
3080
+ --host=<value> [default: localhost] The local network interface at which to
3081
+ listen.
2890
3082
  --port=<value> [default: 3333] TCP port to start server on.
2891
3083
 
2892
3084
  DESCRIPTION
@@ -2920,7 +3112,7 @@ EXAMPLES
2920
3112
  $ sanity telemetry telemetry disable
2921
3113
  ```
2922
3114
 
2923
- _See code: [src/commands/telemetry/disable.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/telemetry/disable.ts)_
3115
+ _See code: [src/commands/telemetry/disable.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/telemetry/disable.ts)_
2924
3116
 
2925
3117
  ## `sanity telemetry enable`
2926
3118
 
@@ -2939,7 +3131,7 @@ EXAMPLES
2939
3131
  $ sanity telemetry telemetry enable
2940
3132
  ```
2941
3133
 
2942
- _See code: [src/commands/telemetry/enable.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/telemetry/enable.ts)_
3134
+ _See code: [src/commands/telemetry/enable.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/telemetry/enable.ts)_
2943
3135
 
2944
3136
  ## `sanity telemetry status`
2945
3137
 
@@ -2958,7 +3150,7 @@ EXAMPLES
2958
3150
  $ sanity telemetry telemetry status
2959
3151
  ```
2960
3152
 
2961
- _See code: [src/commands/telemetry/status.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/telemetry/status.ts)_
3153
+ _See code: [src/commands/telemetry/status.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/telemetry/status.ts)_
2962
3154
 
2963
3155
  ## `sanity tokens add [LABEL]`
2964
3156
 
@@ -2997,7 +3189,7 @@ EXAMPLES
2997
3189
  $ sanity tokens add "API Token" --json
2998
3190
  ```
2999
3191
 
3000
- _See code: [src/commands/tokens/add.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/tokens/add.ts)_
3192
+ _See code: [src/commands/tokens/add.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/tokens/add.ts)_
3001
3193
 
3002
3194
  ## `sanity tokens delete [TOKENID]`
3003
3195
 
@@ -3030,7 +3222,7 @@ EXAMPLES
3030
3222
  $ sanity tokens delete silJ2lFmK6dONB --yes
3031
3223
  ```
3032
3224
 
3033
- _See code: [src/commands/tokens/delete.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/tokens/delete.ts)_
3225
+ _See code: [src/commands/tokens/delete.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/tokens/delete.ts)_
3034
3226
 
3035
3227
  ## `sanity tokens list`
3036
3228
 
@@ -3056,56 +3248,60 @@ EXAMPLES
3056
3248
  $ sanity tokens list --json
3057
3249
  ```
3058
3250
 
3059
- _See code: [src/commands/tokens/list.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/tokens/list.ts)_
3251
+ _See code: [src/commands/tokens/list.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/tokens/list.ts)_
3060
3252
 
3061
3253
  ## `sanity typegen generate`
3062
3254
 
3063
- Sanity TypeGen (Beta)
3255
+ Sanity TypeGen
3064
3256
 
3065
3257
  ```
3066
3258
  USAGE
3067
3259
  $ sanity typegen generate [--config-path <value>] [--watch]
3068
3260
 
3069
3261
  FLAGS
3070
- --config-path=<value> [Default: sanity-typegen.json] Specifies the path to the typegen configuration file. This file
3071
- should be a JSON file that contains settings for the type generation process.
3262
+ --config-path=<value> [Default: sanity-typegen.json] Specifies the path to the
3263
+ typegen configuration file. This file should be a JSON
3264
+ file that contains settings for the type generation
3265
+ process.
3072
3266
  --watch [Default: false] Run the typegen in watch mode
3073
3267
 
3074
3268
  DESCRIPTION
3075
- Sanity TypeGen (Beta)
3076
- This command is currently in beta and may undergo significant changes. Feedback is welcome!
3269
+ Sanity TypeGen
3077
3270
 
3078
3271
  Configuration:
3079
- This command can utilize configuration settings defined in a `sanity-typegen.json` file. These settings include:
3272
+ This command can utilize configuration settings defined in a
3273
+ `sanity-typegen.json` file. These settings include:
3080
3274
 
3081
- - "path": Specifies a glob pattern to locate your TypeScript or JavaScript files.
3275
+ - "path": Specifies a glob pattern to locate your TypeScript or JavaScript
3276
+ files.
3082
3277
  Default: "./src/**/*.{ts,tsx,js,jsx}"
3083
3278
 
3084
- - "schema": Defines the path to your Sanity schema file. This file should be generated using the `sanity schema
3085
- extract` command.
3279
+ - "schema": Defines the path to your Sanity schema file. This file should be
3280
+ generated using the `sanity schema extract` command.
3086
3281
  Default: "schema.json"
3087
3282
 
3088
- - "generates": Indicates the path where the generated TypeScript type definitions will be saved.
3283
+ - "generates": Indicates the path where the generated TypeScript type
3284
+ definitions will be saved.
3089
3285
  Default: "./sanity.types.ts"
3090
3286
 
3091
- The default configuration values listed above are used if not overridden in your `sanity-typegen.json` configuration
3092
- file. To customize the behavior of the type generation, adjust these properties in the configuration file according to
3287
+ The default configuration values listed above are used if not overridden in
3288
+ your `sanity-typegen.json` configuration file. To customize the behavior of the
3289
+ type generation, adjust these properties in the configuration file according to
3093
3290
  your project's needs.
3094
3291
 
3095
3292
  Note:
3096
- - The `sanity schema extract` command is a prerequisite for extracting your Sanity Studio schema into a `schema.json`
3097
- file, which is then used by the `sanity typegen generate` command to generate type definitions.
3098
- - While this tool is in beta, we encourage you to experiment with these configurations and provide feedback to help
3099
- improve its functionality and usability.
3293
+ - The `sanity schema extract` command is a prerequisite for extracting your
3294
+ Sanity Studio schema into a `schema.json` file, which is then used by the
3295
+ `sanity typegen generate` command to generate type definitions.
3100
3296
 
3101
3297
  EXAMPLES
3102
- Generate TypeScript type definitions from a Sanity Studio schema extracted using the `sanity schema extract`
3103
- command.
3298
+ Generate TypeScript type definitions from a Sanity Studio schema extracted
3299
+ using the `sanity schema extract` command.
3104
3300
 
3105
3301
  $ sanity typegen generate
3106
3302
  ```
3107
3303
 
3108
- _See code: [@sanity/codegen](https://github.com/sanity-io/codegen/blob/v5.9.3/src/commands/typegen/generate.ts)_
3304
+ _See code: [@sanity/codegen](https://github.com/sanity-io/codegen/blob/v5.9.4/src/commands/typegen/generate.ts)_
3109
3305
 
3110
3306
  ## `sanity undeploy`
3111
3307
 
@@ -3116,13 +3312,14 @@ USAGE
3116
3312
  $ sanity undeploy [-y]
3117
3313
 
3118
3314
  FLAGS
3119
- -y, --yes Unattended mode, answers "yes" to any "yes/no" prompt and otherwise uses defaults
3315
+ -y, --yes Unattended mode, answers "yes" to any "yes/no" prompt and otherwise
3316
+ uses defaults
3120
3317
 
3121
3318
  DESCRIPTION
3122
3319
  Removes the deployed Sanity Studio/App from Sanity hosting
3123
3320
  ```
3124
3321
 
3125
- _See code: [src/commands/undeploy.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/undeploy.ts)_
3322
+ _See code: [src/commands/undeploy.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/undeploy.ts)_
3126
3323
 
3127
3324
  ## `sanity users invite [EMAIL]`
3128
3325
 
@@ -3155,7 +3352,7 @@ EXAMPLES
3155
3352
  $ sanity users invite pippi@sanity.io --role administrator
3156
3353
  ```
3157
3354
 
3158
- _See code: [src/commands/users/invite.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/users/invite.ts)_
3355
+ _See code: [src/commands/users/invite.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/users/invite.ts)_
3159
3356
 
3160
3357
  ## `sanity users list`
3161
3358
 
@@ -3163,7 +3360,8 @@ List all users of the project
3163
3360
 
3164
3361
  ```
3165
3362
  USAGE
3166
- $ sanity users list [--invitations] [--order asc|desc] [--robots] [--sort id|name|role|date]
3363
+ $ sanity users list [--invitations] [--order asc|desc] [--robots]
3364
+ [--sort id|name|role|date]
3167
3365
 
3168
3366
  FLAGS
3169
3367
  --[no-]invitations Includes or excludes pending invitations
@@ -3190,7 +3388,7 @@ EXAMPLES
3190
3388
  $ sanity users list --sort role
3191
3389
  ```
3192
3390
 
3193
- _See code: [src/commands/users/list.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/users/list.ts)_
3391
+ _See code: [src/commands/users/list.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/users/list.ts)_
3194
3392
 
3195
3393
  ## `sanity versions`
3196
3394
 
@@ -3207,6 +3405,6 @@ EXAMPLES
3207
3405
  $ sanity versions
3208
3406
  ```
3209
3407
 
3210
- _See code: [src/commands/versions.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.12/src/commands/versions.ts)_
3408
+ _See code: [src/commands/versions.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.16/src/commands/versions.ts)_
3211
3409
 
3212
3410
  <!-- commandsstop -->