@sanity/runtime-cli 17.13.0-next.g2501ffa → 17.13.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +19 -19
  2. package/oclif.manifest.json +989 -989
  3. package/package.json +1 -1
package/oclif.manifest.json CHANGED
@@ -1,15 +1,27 @@
1
1
  {
2
2
  "commands": {
3
- "functions:add": {
3
+ "blueprints:add": {
4
4
  "aliases": [],
5
- "args": {},
6
- "description": "Scaffolds a new Function in the functions/ folder and templates a resource for your Blueprint manifest.\n\nFunctions are serverless handlers triggered by document, live content or media-library events (create, update, delete, publish).\n\nAfter adding, use 'functions dev' to test locally, then 'blueprints deploy' to publish.",
5
+ "args": {
6
+ "type": {
7
+ "description": "Type of resource to add (only \"function\" is supported)",
8
+ "name": "type",
9
+ "options": [
10
+ "function"
11
+ ],
12
+ "required": true
13
+ }
14
+ },
15
+ "deprecationOptions": {
16
+ "to": "functions add"
17
+ },
18
+ "description": "This command is deprecated. Use \"functions add\" instead.\n\nEquivalent usage:\n $ <%= config.bin %> functions add\n $ <%= config.bin %> functions add --name my-function --type document-create",
7
19
  "examples": [
8
- "<%= config.bin %> <%= command.id %>",
9
- "<%= config.bin %> <%= command.id %> --helpers",
10
- "<%= config.bin %> <%= command.id %> --name my-function",
11
- "<%= config.bin %> <%= command.id %> --name my-function --type document-create",
12
- "<%= config.bin %> <%= command.id %> --name my-function --type document-create --type document-update --lang js"
20
+ "<%= config.bin %> <%= command.id %> function",
21
+ "<%= config.bin %> <%= command.id %> function --helpers",
22
+ "<%= config.bin %> <%= command.id %> function --name my-function",
23
+ "<%= config.bin %> <%= command.id %> function --name my-function --fn-type document-create",
24
+ "<%= config.bin %> <%= command.id %> function --name my-function --fn-type document-create --fn-type document-update --lang js"
13
25
  ],
14
26
  "flags": {
15
27
  "json": {
@@ -95,15 +107,14 @@
95
107
  "aliases": [
96
108
  "recipe"
97
109
  ],
98
- "description": "Example to use for the Function",
110
+ "description": "Example to use for the function resource. Discover examples at https://www.sanity.io/exchange/type=recipes/by=sanity",
99
111
  "exclusive": [
100
112
  "name",
101
- "type",
113
+ "fn-type",
102
114
  "language",
103
115
  "javascript",
104
- "helpers",
105
- "installer",
106
- "install"
116
+ "fn-helpers",
117
+ "fn-installer"
107
118
  ],
108
119
  "name": "example",
109
120
  "hasDynamicHelp": false,
@@ -112,18 +123,21 @@
112
123
  },
113
124
  "name": {
114
125
  "char": "n",
115
- "description": "Name of the Function to add",
126
+ "description": "Name of the resource to add",
116
127
  "name": "name",
117
128
  "hasDynamicHelp": false,
118
129
  "multiple": false,
119
130
  "type": "option"
120
131
  },
121
- "type": {
132
+ "fn-type": {
133
+ "aliases": [
134
+ "function-type"
135
+ ],
122
136
  "dependsOn": [
123
137
  "name"
124
138
  ],
125
139
  "description": "Document change event(s) that should trigger the function; you can specify multiple events by specifying this flag multiple times",
126
- "name": "type",
140
+ "name": "fn-type",
127
141
  "hasDynamicHelp": false,
128
142
  "multiple": true,
129
143
  "options": [
@@ -142,9 +156,11 @@
142
156
  },
143
157
  "language": {
144
158
  "aliases": [
159
+ "function-language",
160
+ "fn-language",
145
161
  "lang"
146
162
  ],
147
- "description": "Language of the new Function",
163
+ "description": "Language of the new function",
148
164
  "name": "language",
149
165
  "default": "ts",
150
166
  "hasDynamicHelp": false,
@@ -167,15 +183,23 @@
167
183
  "allowNo": false,
168
184
  "type": "boolean"
169
185
  },
170
- "helpers": {
171
- "description": "Add helpers to the new Function",
172
- "name": "helpers",
186
+ "fn-helpers": {
187
+ "aliases": [
188
+ "function-helpers",
189
+ "helpers"
190
+ ],
191
+ "description": "Add helpers to the new function",
192
+ "name": "fn-helpers",
173
193
  "allowNo": true,
174
194
  "type": "boolean"
175
195
  },
176
- "installer": {
177
- "description": "How to install the @sanity/functions helpers",
178
- "name": "installer",
196
+ "fn-installer": {
197
+ "aliases": [
198
+ "function-installer",
199
+ "installer"
200
+ ],
201
+ "description": "Which package manager to use when installing the @sanity/functions helpers",
202
+ "name": "fn-installer",
179
203
  "hasDynamicHelp": false,
180
204
  "multiple": false,
181
205
  "options": [
@@ -188,9 +212,9 @@
188
212
  },
189
213
  "install": {
190
214
  "char": "i",
191
- "description": "Shortcut for --installer npm",
215
+ "description": "Shortcut for --fn-installer npm",
192
216
  "exclusive": [
193
- "installer"
217
+ "fn-installer"
194
218
  ],
195
219
  "name": "install",
196
220
  "allowNo": false,
@@ -199,12 +223,13 @@
199
223
  },
200
224
  "hasDynamicHelp": false,
201
225
  "hiddenAliases": [],
202
- "id": "functions:add",
226
+ "id": "blueprints:add",
203
227
  "pluginAlias": "@sanity/runtime-cli",
204
228
  "pluginName": "@sanity/runtime-cli",
205
229
  "pluginType": "core",
230
+ "state": "deprecated",
206
231
  "strict": true,
207
- "summary": "Add a Function to your Blueprint",
232
+ "summary": "[deprecated] Use \"functions add\" instead",
208
233
  "enableJsonFlag": true,
209
234
  "needs": [
210
235
  "blueprint"
@@ -213,19 +238,20 @@
213
238
  "relativePath": [
214
239
  "dist",
215
240
  "commands",
216
- "functions",
241
+ "blueprints",
217
242
  "add.js"
218
243
  ]
219
244
  },
220
- "functions:build": {
245
+ "blueprints:config": {
221
246
  "aliases": [],
222
- "args": {
223
- "name": {
224
- "description": "The name of the Sanity Function",
225
- "name": "name",
226
- "required": false
227
- }
228
- },
247
+ "args": {},
248
+ "description": "Manages the local Blueprint configuration, which links your Blueprint to a Sanity project and Stack.\n\nWithout flags, displays the current configuration. Use --edit to interactively modify settings, or combine --edit with ID flags to update values directly (useful for scripting and automation).\n\nIf you need to switch your Blueprint to a different Stack, use --edit --stack.",
249
+ "examples": [
250
+ "<%= config.bin %> <%= command.id %>",
251
+ "<%= config.bin %> <%= command.id %> --edit",
252
+ "<%= config.bin %> <%= command.id %> --edit --project-id <projectId>",
253
+ "<%= config.bin %> <%= command.id %> --edit --project-id <projectId> --stack <name-or-id>"
254
+ ],
229
255
  "flags": {
230
256
  "json": {
231
257
  "description": "Format output as json",
@@ -268,8 +294,14 @@
268
294
  "type": "boolean"
269
295
  },
270
296
  "stack": {
271
- "description": "Stack name or ID to use instead of the locally configured Stack",
272
- "hidden": true,
297
+ "aliases": [
298
+ "stack-id",
299
+ "stackId"
300
+ ],
301
+ "dependsOn": [
302
+ "edit"
303
+ ],
304
+ "description": "Stack name or ID to set in the configuration. Requires --edit flag",
273
305
  "name": "stack",
274
306
  "hasDynamicHelp": false,
275
307
  "multiple": false,
@@ -280,11 +312,13 @@
280
312
  "project",
281
313
  "projectId"
282
314
  ],
315
+ "dependsOn": [
316
+ "edit"
317
+ ],
283
318
  "description": "Sanity project ID used to scope Blueprint and Stack",
284
319
  "exclusive": [
285
320
  "organization-id"
286
321
  ],
287
- "hidden": true,
288
322
  "name": "project-id",
289
323
  "hasDynamicHelp": false,
290
324
  "multiple": false,
@@ -296,70 +330,59 @@
296
330
  "organizationId",
297
331
  "org"
298
332
  ],
333
+ "dependsOn": [
334
+ "edit"
335
+ ],
299
336
  "description": "Sanity organization ID used to scope Blueprint and Stack",
300
337
  "exclusive": [
301
338
  "project-id"
302
339
  ],
303
- "hidden": true,
304
340
  "name": "organization-id",
305
341
  "hasDynamicHelp": false,
306
342
  "multiple": false,
307
343
  "type": "option"
308
344
  },
309
- "fn-installer": {
310
- "aliases": [
311
- "function-installer",
312
- "installer"
313
- ],
314
- "description": "Which package manager to use when building Functions",
315
- "hidden": true,
316
- "name": "fn-installer",
317
- "hasDynamicHelp": false,
318
- "multiple": false,
319
- "options": [
320
- "npm",
321
- "pnpm",
322
- "yarn"
323
- ],
324
- "type": "option"
325
- },
326
- "out-dir": {
327
- "char": "o",
328
- "description": "Output directory for zip files",
329
- "name": "out-dir",
330
- "hasDynamicHelp": false,
331
- "multiple": false,
332
- "type": "option"
345
+ "edit": {
346
+ "char": "e",
347
+ "description": "Modify the configuration interactively, or directly when combined with ID flags.",
348
+ "name": "edit",
349
+ "allowNo": false,
350
+ "type": "boolean"
333
351
  }
334
352
  },
335
353
  "hasDynamicHelp": false,
336
- "hidden": true,
337
354
  "hiddenAliases": [],
338
- "id": "functions:build",
355
+ "id": "blueprints:config",
339
356
  "pluginAlias": "@sanity/runtime-cli",
340
357
  "pluginName": "@sanity/runtime-cli",
341
358
  "pluginType": "core",
342
359
  "strict": true,
343
- "summary": "Build Sanity Function(s) to zip archives",
360
+ "summary": "View or edit the local Blueprint configuration",
344
361
  "enableJsonFlag": true,
345
362
  "needs": [
363
+ "token",
346
364
  "blueprint"
347
365
  ],
348
366
  "isESM": true,
349
367
  "relativePath": [
350
368
  "dist",
351
369
  "commands",
352
- "functions",
353
- "build.js"
370
+ "blueprints",
371
+ "config.js"
354
372
  ]
355
373
  },
356
- "functions:dev": {
374
+ "blueprints:deploy": {
357
375
  "aliases": [],
358
376
  "args": {},
359
- "description": "Runs a local, web-based development server to test your functions before deploying.\n\nOpen the emulator in your browser to interactively test your functions with the payload editor.\n\nOptionally, set the host and port with the --host and --port flags. Port 8974 is reserved for the emulator's live-reload WebSocket server. Function timeout can be configured with the --timeout flag.\n\nTo invoke a function with the CLI, use 'functions test'.",
377
+ "description": "Applies your local Blueprint to the remote Stack, creating, updating, or removing resources as needed. This is the primary command for applying infrastructure changes.\n\nBefore deploying, run 'blueprints plan' to preview changes. After deployment, use 'blueprints info' to verify Stack status or 'blueprints logs' to monitor activity.\n\nUse --no-wait to queue the deployment and return immediately without waiting for completion.\n\nUse --fn-installer to force which package manager to use when deploying functions.\n\nSet SANITY_ASSET_TIMEOUT (seconds) to override the 180-second timeout for processing resource assets.\n\nSet SANITY_ASSET_CONCURRENCY to override how many resource assets are processed at once (default 4).\n\nExit codes: 0 deployed, 2 deployment failed, 75 deployment accepted but completion could not be confirmed (rerun 'blueprints info' to check).",
360
378
  "examples": [
361
- "<%= config.bin %> <%= command.id %> --host 127.0.0.1 --port 3333",
362
- "<%= config.bin %> <%= command.id %> --timeout 60"
379
+ "<%= config.bin %> <%= command.id %>",
380
+ "<%= config.bin %> <%= command.id %> --message \"Enable staging dataset\"",
381
+ "<%= config.bin %> <%= command.id %> --no-wait",
382
+ "<%= config.bin %> <%= command.id %> --fn-installer npm",
383
+ "<%= config.bin %> <%= command.id %> --stack <name-or-id>",
384
+ "<%= config.bin %> <%= command.id %> --organization-id <orgId> --stack <name-or-id>",
385
+ "<%= config.bin %> <%= command.id %> --new-stack-name <new-name>"
363
386
  ],
364
387
  "flags": {
365
388
  "json": {
@@ -404,7 +427,6 @@
404
427
  },
405
428
  "stack": {
406
429
  "description": "Stack name or ID to use instead of the locally configured Stack",
407
- "hidden": true,
408
430
  "name": "stack",
409
431
  "hasDynamicHelp": false,
410
432
  "multiple": false,
@@ -419,7 +441,6 @@
419
441
  "exclusive": [
420
442
  "organization-id"
421
443
  ],
422
- "hidden": true,
423
444
  "name": "project-id",
424
445
  "hasDynamicHelp": false,
425
446
  "multiple": false,
@@ -435,35 +456,56 @@
435
456
  "exclusive": [
436
457
  "project-id"
437
458
  ],
438
- "hidden": true,
439
459
  "name": "organization-id",
440
460
  "hasDynamicHelp": false,
441
461
  "multiple": false,
442
462
  "type": "option"
443
463
  },
444
- "host": {
445
- "char": "h",
446
- "description": "The local network interface at which to listen. [default: \"localhost\"]",
447
- "name": "host",
448
- "required": false,
464
+ "message": {
465
+ "char": "m",
466
+ "description": "Message describing the deployment (e.g. reason for change)",
467
+ "name": "message",
449
468
  "hasDynamicHelp": false,
450
469
  "multiple": false,
451
470
  "type": "option"
452
471
  },
453
- "port": {
454
- "char": "p",
455
- "description": "TCP port to start emulator on. [default: 8080]",
456
- "name": "port",
457
- "required": false,
472
+ "fn-installer": {
473
+ "aliases": [
474
+ "function-installer",
475
+ "installer"
476
+ ],
477
+ "description": "Which package manager to use when installing Function dependencies",
478
+ "hidden": true,
479
+ "name": "fn-installer",
458
480
  "hasDynamicHelp": false,
459
481
  "multiple": false,
482
+ "options": [
483
+ "npm",
484
+ "pnpm",
485
+ "yarn"
486
+ ],
460
487
  "type": "option"
461
488
  },
462
- "timeout": {
463
- "char": "t",
464
- "description": "Maximum execution time for all functions, in seconds. Takes precedence over function-specific `timeout`",
465
- "name": "timeout",
466
- "required": false,
489
+ "no-wait": {
490
+ "description": "Do not wait for Stack deployment to complete",
491
+ "name": "no-wait",
492
+ "allowNo": false,
493
+ "type": "boolean"
494
+ },
495
+ "configure": {
496
+ "aliases": [
497
+ "config",
498
+ "init"
499
+ ],
500
+ "description": "Configure the local Blueprint interactively before deploying",
501
+ "hidden": true,
502
+ "name": "configure",
503
+ "allowNo": false,
504
+ "type": "boolean"
505
+ },
506
+ "new-stack-name": {
507
+ "description": "Set a new name for the Stack",
508
+ "name": "new-stack-name",
467
509
  "hasDynamicHelp": false,
468
510
  "multiple": false,
469
511
  "type": "option"
@@ -471,34 +513,32 @@
471
513
  },
472
514
  "hasDynamicHelp": false,
473
515
  "hiddenAliases": [],
474
- "id": "functions:dev",
516
+ "id": "blueprints:deploy",
475
517
  "pluginAlias": "@sanity/runtime-cli",
476
518
  "pluginName": "@sanity/runtime-cli",
477
519
  "pluginType": "core",
478
520
  "strict": true,
479
- "summary": "Start the Sanity Function emulator",
521
+ "summary": "Deploy the local Blueprint to the remote Stack",
480
522
  "enableJsonFlag": true,
481
523
  "needs": [
524
+ "deployedStack",
482
525
  "blueprint"
483
526
  ],
484
527
  "isESM": true,
485
528
  "relativePath": [
486
529
  "dist",
487
530
  "commands",
488
- "functions",
489
- "dev.js"
531
+ "blueprints",
532
+ "deploy.js"
490
533
  ]
491
534
  },
492
- "functions:list": {
535
+ "blueprints:destroy": {
493
536
  "aliases": [],
494
537
  "args": {},
495
- "description": "Lists functions deployed directly in the selected project or organization scope. The local Blueprint config supplies the scope by default.\n\nUse --project-id or --organization-id to select a scope without a local Blueprint. Organization results include organization-scoped functions only.",
538
+ "description": "Permanently removes the remote Stack and all its provisioned resources. Your Blueprint manifest and resource files remain intact; \"stackId\" is unset in your local config.\n\nThis is a destructive operation. You will be prompted to confirm unless --force is specified.\n\nUse this to clean up test environments or decommission a Stack you no longer need.\n\nExit codes: 0 destroyed, 2 destruction failed, 75 destruction accepted but completion could not be confirmed (rerun 'blueprints info' to check).",
496
539
  "examples": [
497
540
  "<%= config.bin %> <%= command.id %>",
498
- "<%= config.bin %> <%= command.id %> --verbose",
499
- "<%= config.bin %> <%= command.id %> --project-id <projectId>",
500
- "<%= config.bin %> <%= command.id %> --organization-id <organizationId>",
501
- "<%= config.bin %> <%= command.id %> --project-id <projectId> --json"
541
+ "<%= config.bin %> <%= command.id %> --stack <name-or-id> --project-id <projectId> --force --no-wait"
502
542
  ],
503
543
  "flags": {
504
544
  "json": {
@@ -535,15 +575,18 @@
535
575
  "type": "boolean"
536
576
  },
537
577
  "verbose": {
538
- "char": "v",
539
- "description": "Show function configuration details",
578
+ "description": "Verbose output",
579
+ "hidden": true,
540
580
  "name": "verbose",
541
581
  "allowNo": false,
542
582
  "type": "boolean"
543
583
  },
544
584
  "stack": {
545
- "description": "Stack name or ID to use instead of the locally configured Stack",
546
- "hidden": true,
585
+ "aliases": [
586
+ "stack-id",
587
+ "stackId"
588
+ ],
589
+ "description": "Stack name or ID to destroy (defaults to the locally configured Stack)",
547
590
  "name": "stack",
548
591
  "hasDynamicHelp": false,
549
592
  "multiple": false,
@@ -554,9 +597,13 @@
554
597
  "project",
555
598
  "projectId"
556
599
  ],
557
- "description": "Sanity project ID used to scope Blueprint and Stack",
558
- "exclusive": [
559
- "organization-id"
600
+ "dependsOn": [
601
+ "stack",
602
+ "force"
603
+ ],
604
+ "description": "Sanity project ID used to scope Blueprint and Stack",
605
+ "exclusive": [
606
+ "organization-id"
560
607
  ],
561
608
  "name": "project-id",
562
609
  "hasDynamicHelp": false,
@@ -569,6 +616,10 @@
569
616
  "organizationId",
570
617
  "org"
571
618
  ],
619
+ "dependsOn": [
620
+ "stack",
621
+ "force"
622
+ ],
572
623
  "description": "Sanity organization ID used to scope Blueprint and Stack",
573
624
  "exclusive": [
574
625
  "project-id"
@@ -577,17 +628,29 @@
577
628
  "hasDynamicHelp": false,
578
629
  "multiple": false,
579
630
  "type": "option"
631
+ },
632
+ "force": {
633
+ "char": "f",
634
+ "description": "Force Stack destruction (skip confirmation)",
635
+ "name": "force",
636
+ "allowNo": false,
637
+ "type": "boolean"
638
+ },
639
+ "no-wait": {
640
+ "description": "Do not wait for Stack destruction to complete",
641
+ "name": "no-wait",
642
+ "allowNo": false,
643
+ "type": "boolean"
580
644
  }
581
645
  },
582
646
  "hasDynamicHelp": false,
583
- "hidden": true,
584
647
  "hiddenAliases": [],
585
- "id": "functions:list",
648
+ "id": "blueprints:destroy",
586
649
  "pluginAlias": "@sanity/runtime-cli",
587
650
  "pluginName": "@sanity/runtime-cli",
588
651
  "pluginType": "core",
589
652
  "strict": true,
590
- "summary": "List deployed Sanity Functions",
653
+ "summary": "Destroy a remote Stack deployment and its resources",
591
654
  "enableJsonFlag": true,
592
655
  "needs": [
593
656
  "scope"
@@ -596,25 +659,91 @@
596
659
  "relativePath": [
597
660
  "dist",
598
661
  "commands",
599
- "functions",
600
- "list.js"
662
+ "blueprints",
663
+ "destroy.js"
601
664
  ]
602
665
  },
603
- "functions:logs": {
666
+ "blueprints:doctor": {
604
667
  "aliases": [],
605
- "args": {
606
- "name": {
607
- "description": "The name of the Sanity Function",
608
- "name": "name",
609
- "required": false
668
+ "args": {},
669
+ "description": "Analyzes your local Blueprint and remote Stack configuration for common issues, such as missing authentication, invalid project references, or misconfigured resources.\n\nRun this command when encountering errors with other Blueprint commands. Use --fix to interactively resolve detected issues.\n\nSupports --json for programmatic consumption of diagnostic results.",
670
+ "examples": [
671
+ "<%= config.bin %> <%= command.id %>",
672
+ "<%= config.bin %> <%= command.id %> --fix"
673
+ ],
674
+ "flags": {
675
+ "json": {
676
+ "description": "Format output as json",
677
+ "name": "json",
678
+ "allowNo": false,
679
+ "type": "boolean"
680
+ },
681
+ "path": {
682
+ "aliases": [
683
+ "blueprint-path"
684
+ ],
685
+ "char": "p",
686
+ "description": "Path to a Blueprint file or directory containing one",
687
+ "env": "SANITY_BLUEPRINT_PATH",
688
+ "name": "path",
689
+ "hasDynamicHelp": false,
690
+ "multiple": false,
691
+ "type": "option"
692
+ },
693
+ "trace": {
694
+ "description": "Trace output",
695
+ "hidden": true,
696
+ "name": "trace",
697
+ "allowNo": false,
698
+ "type": "boolean"
699
+ },
700
+ "validate-resources": {
701
+ "description": "Validate resources",
702
+ "hidden": true,
703
+ "name": "validate-resources",
704
+ "allowNo": true,
705
+ "type": "boolean"
706
+ },
707
+ "verbose": {
708
+ "description": "Verbose output",
709
+ "hidden": true,
710
+ "name": "verbose",
711
+ "allowNo": false,
712
+ "type": "boolean"
713
+ },
714
+ "fix": {
715
+ "description": "Interactively fix configuration issues",
716
+ "name": "fix",
717
+ "allowNo": false,
718
+ "type": "boolean"
610
719
  }
611
720
  },
612
- "description": "Fetches execution logs from a deployed function, useful for debugging production issues or monitoring activity.\n\nUse --watch (-w) to stream logs in real-time. Use --delete to clear all logs for a function (requires confirmation unless --force is specified).",
721
+ "hasDynamicHelp": false,
722
+ "hiddenAliases": [],
723
+ "id": "blueprints:doctor",
724
+ "pluginAlias": "@sanity/runtime-cli",
725
+ "pluginName": "@sanity/runtime-cli",
726
+ "pluginType": "core",
727
+ "strict": true,
728
+ "summary": "Diagnose potential issues with local Blueprint and remote Stack configuration",
729
+ "enableJsonFlag": true,
730
+ "isESM": true,
731
+ "relativePath": [
732
+ "dist",
733
+ "commands",
734
+ "blueprints",
735
+ "doctor.js"
736
+ ]
737
+ },
738
+ "blueprints:info": {
739
+ "aliases": [],
740
+ "args": {},
741
+ "description": "Displays the current state and metadata of your remote Stack deployment, including deployed resources, status, and configuration.\n\nUse this command to verify a deployment succeeded, check what resources are live, or confirm which Stack your local Blueprint is connected to.\n\nRun 'blueprints stacks' to see all available Stacks in your project or organization.",
613
742
  "examples": [
614
- "<%= config.bin %> <%= command.id %> <name>",
615
- "<%= config.bin %> <%= command.id %> <name> --json",
616
- "<%= config.bin %> <%= command.id %> <name> --limit 100",
617
- "<%= config.bin %> <%= command.id %> <name> --delete"
743
+ "<%= config.bin %> <%= command.id %>",
744
+ "<%= config.bin %> <%= command.id %> --stack <name-or-id>",
745
+ "<%= config.bin %> <%= command.id %> --project-id <id> --stack <name-or-id>",
746
+ "<%= config.bin %> <%= command.id %> --organization-id <orgId> --stack <name-or-id>"
618
747
  ],
619
748
  "flags": {
620
749
  "json": {
@@ -651,14 +780,17 @@
651
780
  "type": "boolean"
652
781
  },
653
782
  "verbose": {
654
- "description": "Verbose output",
655
- "hidden": true,
783
+ "char": "v",
784
+ "description": "Show resource and external IDs",
656
785
  "name": "verbose",
657
786
  "allowNo": false,
658
787
  "type": "boolean"
659
788
  },
660
789
  "stack": {
661
- "description": "Stack name or ID to use instead of the locally configured Stack",
790
+ "aliases": [
791
+ "id"
792
+ ],
793
+ "description": "Stack name or ID",
662
794
  "name": "stack",
663
795
  "hasDynamicHelp": false,
664
796
  "multiple": false,
@@ -673,7 +805,6 @@
673
805
  "exclusive": [
674
806
  "organization-id"
675
807
  ],
676
- "hidden": true,
677
808
  "name": "project-id",
678
809
  "hasDynamicHelp": false,
679
810
  "multiple": false,
@@ -689,103 +820,52 @@
689
820
  "exclusive": [
690
821
  "project-id"
691
822
  ],
692
- "hidden": true,
693
823
  "name": "organization-id",
694
824
  "hasDynamicHelp": false,
695
825
  "multiple": false,
696
826
  "type": "option"
697
- },
698
- "limit": {
699
- "char": "l",
700
- "description": "Total number of log entries to retrieve",
701
- "name": "limit",
702
- "required": false,
703
- "default": 50,
704
- "hasDynamicHelp": false,
705
- "multiple": false,
706
- "type": "option"
707
- },
708
- "utc": {
709
- "char": "u",
710
- "description": "Show dates in UTC time zone",
711
- "name": "utc",
712
- "required": false,
713
- "allowNo": false,
714
- "type": "boolean"
715
- },
716
- "delete": {
717
- "char": "d",
718
- "description": "Delete all logs for the function",
719
- "exclusive": [
720
- "limit",
721
- "json"
722
- ],
723
- "name": "delete",
724
- "required": false,
725
- "allowNo": false,
726
- "type": "boolean"
727
- },
728
- "force": {
729
- "char": "f",
730
- "dependsOn": [
731
- "delete"
732
- ],
733
- "description": "Skip confirmation for deleting logs",
734
- "name": "force",
735
- "required": false,
736
- "allowNo": false,
737
- "type": "boolean"
738
- },
739
- "watch": {
740
- "aliases": [
741
- "follow"
742
- ],
743
- "char": "w",
744
- "description": "Watch for new logs (streaming mode)",
745
- "exclusive": [
746
- "json"
747
- ],
748
- "name": "watch",
749
- "allowNo": false,
750
- "type": "boolean"
751
827
  }
752
828
  },
753
829
  "hasDynamicHelp": false,
754
830
  "hiddenAliases": [],
755
- "id": "functions:logs",
831
+ "id": "blueprints:info",
756
832
  "pluginAlias": "@sanity/runtime-cli",
757
833
  "pluginName": "@sanity/runtime-cli",
758
834
  "pluginType": "core",
759
835
  "strict": true,
760
- "summary": "Retrieve or delete logs for a Sanity Function",
836
+ "summary": "Display the status and resources of the remote Stack deployment",
761
837
  "enableJsonFlag": true,
762
838
  "needs": [
763
- "deployedStack",
764
- "blueprint"
839
+ "deployedStack"
765
840
  ],
766
841
  "isESM": true,
767
842
  "relativePath": [
768
843
  "dist",
769
844
  "commands",
770
- "functions",
771
- "logs.js"
845
+ "blueprints",
846
+ "info.js"
772
847
  ]
773
848
  },
774
- "functions:test": {
849
+ "blueprints:init": {
775
850
  "aliases": [],
776
851
  "args": {
777
- "name": {
778
- "description": "The name of the Sanity Function",
779
- "name": "name",
780
- "required": false
852
+ "dir": {
853
+ "description": "Directory to create the local Blueprint in (defaults to the current directory)",
854
+ "name": "dir"
781
855
  }
782
856
  },
783
- "description": "Executes a function locally with the provided payload, simulating how it would run when deployed. Use this to test your function logic before deploying.\n\nProvide test data via --data (inline JSON), --file (JSON file), or --document-id (fetch from Sanity). For update events, use the before/after flag pairs to simulate document changes.",
857
+ "description": "A Blueprint is your local infrastructure-as-code configuration that defines Sanity resources (datasets, functions, etc.). A Stack is the remote deployment target where your Blueprint is applied.\n\nThis is typically the first command you run in a new project. It creates a local Blueprint manifest file (sanity.blueprint.ts, .js, or .json) and provisions a new remote Stack.\nAdditionally, a Blueprint configuration file is created in .sanity/ containing the scope and Stack IDs. A .gitignore covering node_modules, .env, and Function build output is created or updated; the .sanity/ config itself is not ignored.\n\nAfter initialization, use 'blueprints plan' to preview changes, then 'blueprints deploy' to apply them.\n\nRunning without a directory prompts to confirm the current directory. Run 'blueprints init .' to initialize in the current directory without a prompt.",
784
858
  "examples": [
785
- "<%= config.bin %> <%= command.id %> <name> --data '{ \"id\": 1 }'",
786
- "<%= config.bin %> <%= command.id %> <name> --file 'payload.json'",
787
- "<%= config.bin %> <%= command.id %> <name> --data '{ \"id\": 1 }' --timeout 60",
788
- "<%= config.bin %> <%= command.id %> <name> --event update --data-before '{ \"title\": \"before\" }' --data-after '{ \"title\": \"after\" }'"
859
+ "<%= config.bin %> <%= command.id %>",
860
+ "<%= config.bin %> <%= command.id %> .",
861
+ "<%= config.bin %> <%= command.id %> [directory]",
862
+ "<%= config.bin %> <%= command.id %> --blueprint-type <json|js|ts>",
863
+ "<%= config.bin %> <%= command.id %> --organization-id <organizationId>",
864
+ "<%= config.bin %> <%= command.id %> --project-id <projectId>",
865
+ "<%= config.bin %> <%= command.id %> --stack-name <newStackName>",
866
+ "<%= config.bin %> <%= command.id %> --stack-id <existingStackId>",
867
+ "<%= config.bin %> <%= command.id %> new-stack --type <json|js|ts> --org <organizationId> --name <newStackName>",
868
+ "<%= config.bin %> <%= command.id %> old-stack --type <json|js|ts> --project-id <projectId> --stack-id <existingStackId>"
789
869
  ],
790
870
  "flags": {
791
871
  "json": {
@@ -828,346 +908,41 @@
828
908
  "allowNo": false,
829
909
  "type": "boolean"
830
910
  },
831
- "stack": {
832
- "description": "Stack name or ID to use instead of the locally configured Stack",
833
- "hidden": true,
834
- "name": "stack",
911
+ "dir": {
912
+ "description": "Directory to create the local Blueprint in",
913
+ "name": "dir",
835
914
  "hasDynamicHelp": false,
836
915
  "multiple": false,
837
916
  "type": "option"
838
917
  },
839
- "project-id": {
918
+ "example": {
840
919
  "aliases": [
841
- "project",
842
- "projectId"
920
+ "recipe"
843
921
  ],
844
- "description": "Sanity project ID used to scope Blueprint and Stack",
922
+ "description": "Example to use for the local Blueprint",
845
923
  "exclusive": [
846
- "organization-id"
924
+ "blueprint-type",
925
+ "stack-id",
926
+ "stack-name"
847
927
  ],
848
- "name": "project-id",
928
+ "name": "example",
849
929
  "hasDynamicHelp": false,
850
930
  "multiple": false,
851
931
  "type": "option"
852
932
  },
853
- "organization-id": {
933
+ "blueprint-type": {
854
934
  "aliases": [
855
- "organization",
856
- "organizationId",
857
- "org"
858
- ],
859
- "description": "Sanity organization ID used to scope Blueprint and Stack",
860
- "exclusive": [
861
- "project-id"
935
+ "type"
862
936
  ],
863
- "name": "organization-id",
937
+ "description": "Blueprint manifest type to use for the local Blueprint",
938
+ "name": "blueprint-type",
864
939
  "hasDynamicHelp": false,
865
940
  "multiple": false,
866
- "type": "option"
867
- },
868
- "data": {
869
- "char": "d",
870
- "description": "Data to send to the function",
871
- "exclusive": [
872
- "file",
873
- "document-id"
874
- ],
875
- "name": "data",
876
- "required": false,
877
- "hasDynamicHelp": false,
878
- "multiple": false,
879
- "type": "option"
880
- },
881
- "data-before": {
882
- "description": "Original document",
883
- "exclusive": [
884
- "data",
885
- "file",
886
- "document-id",
887
- "file-before",
888
- "file-after",
889
- "document-id-before",
890
- "document-id-after"
891
- ],
892
- "name": "data-before",
893
- "required": false,
894
- "hasDynamicHelp": false,
895
- "multiple": false,
896
- "type": "option"
897
- },
898
- "data-after": {
899
- "description": "Current document",
900
- "exclusive": [
901
- "data",
902
- "file",
903
- "document-id",
904
- "file-before",
905
- "file-after",
906
- "document-id-before",
907
- "document-id-after"
908
- ],
909
- "name": "data-after",
910
- "required": false,
911
- "hasDynamicHelp": false,
912
- "multiple": false,
913
- "type": "option"
914
- },
915
- "event": {
916
- "char": "e",
917
- "description": "Type of event (create, update, delete)",
918
- "name": "event",
919
- "required": false,
920
- "hasDynamicHelp": false,
921
- "multiple": false,
922
- "options": [
923
- "create",
924
- "update",
925
- "delete"
926
- ],
927
- "type": "option"
928
- },
929
- "file": {
930
- "char": "f",
931
- "description": "Read data from file and send to the function",
932
- "exclusive": [
933
- "data",
934
- "document-id"
935
- ],
936
- "name": "file",
937
- "required": false,
938
- "hasDynamicHelp": false,
939
- "multiple": false,
940
- "type": "option"
941
- },
942
- "file-before": {
943
- "description": "Original document",
944
- "exclusive": [
945
- "data",
946
- "file",
947
- "document-id",
948
- "data-before",
949
- "data-after",
950
- "document-id-before",
951
- "document-id-after"
952
- ],
953
- "name": "file-before",
954
- "required": false,
955
- "hasDynamicHelp": false,
956
- "multiple": false,
957
- "type": "option"
958
- },
959
- "file-after": {
960
- "description": "Current document",
961
- "exclusive": [
962
- "data",
963
- "file",
964
- "document-id",
965
- "data-before",
966
- "data-after",
967
- "document-id-before",
968
- "document-id-after"
969
- ],
970
- "name": "file-after",
971
- "required": false,
972
- "hasDynamicHelp": false,
973
- "multiple": false,
974
- "type": "option"
975
- },
976
- "timeout": {
977
- "char": "t",
978
- "description": "Execution timeout value in seconds",
979
- "name": "timeout",
980
- "required": false,
981
- "hasDynamicHelp": false,
982
- "multiple": false,
983
- "type": "option"
984
- },
985
- "api": {
986
- "char": "a",
987
- "description": "Sanity API Version to use",
988
- "name": "api",
989
- "required": false,
990
- "hasDynamicHelp": false,
991
- "multiple": false,
992
- "type": "option"
993
- },
994
- "dataset": {
995
- "description": "The Sanity dataset to use",
996
- "name": "dataset",
997
- "required": false,
998
- "hasDynamicHelp": false,
999
- "multiple": false,
1000
- "type": "option"
1001
- },
1002
- "document-id": {
1003
- "aliases": [
1004
- "doc",
1005
- "documentId"
1006
- ],
1007
- "description": "Document to fetch and send to function",
1008
- "exclusive": [
1009
- "data",
1010
- "file"
1011
- ],
1012
- "name": "document-id",
1013
- "required": false,
1014
- "hasDynamicHelp": false,
1015
- "multiple": false,
1016
- "type": "option"
1017
- },
1018
- "document-id-before": {
1019
- "description": "Original document",
1020
- "exclusive": [
1021
- "data",
1022
- "file",
1023
- "document-id",
1024
- "data-before",
1025
- "data-after",
1026
- "file-before",
1027
- "file-after"
1028
- ],
1029
- "name": "document-id-before",
1030
- "required": false,
1031
- "hasDynamicHelp": false,
1032
- "multiple": false,
1033
- "type": "option"
1034
- },
1035
- "document-id-after": {
1036
- "description": "Current document",
1037
- "exclusive": [
1038
- "data",
1039
- "file",
1040
- "document-id",
1041
- "data-before",
1042
- "data-after",
1043
- "file-before",
1044
- "file-after"
1045
- ],
1046
- "name": "document-id-after",
1047
- "required": false,
1048
- "hasDynamicHelp": false,
1049
- "multiple": false,
1050
- "type": "option"
1051
- },
1052
- "with-user-token": {
1053
- "description": "Prime access token from CLI config",
1054
- "name": "with-user-token",
1055
- "allowNo": false,
1056
- "type": "boolean"
1057
- },
1058
- "media-library-id": {
1059
- "aliases": [
1060
- "media"
1061
- ],
1062
- "description": "Sanity Media Library ID to use",
1063
- "exclusive": [
1064
- "project-id",
1065
- "dataset"
1066
- ],
1067
- "name": "media-library-id",
1068
- "required": false,
1069
- "hasDynamicHelp": false,
1070
- "multiple": false,
1071
- "type": "option"
1072
- },
1073
- "no-wait": {
1074
- "description": "Skip durable wait delays instead of sleeping",
1075
- "name": "no-wait",
1076
- "required": false,
1077
- "allowNo": false,
1078
- "type": "boolean"
1079
- }
1080
- },
1081
- "hasDynamicHelp": false,
1082
- "hiddenAliases": [],
1083
- "id": "functions:test",
1084
- "pluginAlias": "@sanity/runtime-cli",
1085
- "pluginName": "@sanity/runtime-cli",
1086
- "pluginType": "core",
1087
- "strict": true,
1088
- "summary": "Invoke a local Sanity Function",
1089
- "enableJsonFlag": true,
1090
- "needs": [
1091
- "blueprint"
1092
- ],
1093
- "isESM": true,
1094
- "relativePath": [
1095
- "dist",
1096
- "commands",
1097
- "functions",
1098
- "test.js"
1099
- ]
1100
- },
1101
- "blueprints:add": {
1102
- "aliases": [],
1103
- "args": {
1104
- "type": {
1105
- "description": "Type of resource to add (only \"function\" is supported)",
1106
- "name": "type",
1107
941
  "options": [
1108
- "function"
1109
- ],
1110
- "required": true
1111
- }
1112
- },
1113
- "deprecationOptions": {
1114
- "to": "functions add"
1115
- },
1116
- "description": "This command is deprecated. Use \"functions add\" instead.\n\nEquivalent usage:\n $ <%= config.bin %> functions add\n $ <%= config.bin %> functions add --name my-function --type document-create",
1117
- "examples": [
1118
- "<%= config.bin %> <%= command.id %> function",
1119
- "<%= config.bin %> <%= command.id %> function --helpers",
1120
- "<%= config.bin %> <%= command.id %> function --name my-function",
1121
- "<%= config.bin %> <%= command.id %> function --name my-function --fn-type document-create",
1122
- "<%= config.bin %> <%= command.id %> function --name my-function --fn-type document-create --fn-type document-update --lang js"
1123
- ],
1124
- "flags": {
1125
- "json": {
1126
- "description": "Format output as json",
1127
- "name": "json",
1128
- "allowNo": false,
1129
- "type": "boolean"
1130
- },
1131
- "path": {
1132
- "aliases": [
1133
- "blueprint-path"
942
+ "json",
943
+ "js",
944
+ "ts"
1134
945
  ],
1135
- "char": "p",
1136
- "description": "Path to a Blueprint file or directory containing one",
1137
- "env": "SANITY_BLUEPRINT_PATH",
1138
- "hidden": true,
1139
- "name": "path",
1140
- "hasDynamicHelp": false,
1141
- "multiple": false,
1142
- "type": "option"
1143
- },
1144
- "trace": {
1145
- "description": "Trace output",
1146
- "hidden": true,
1147
- "name": "trace",
1148
- "allowNo": false,
1149
- "type": "boolean"
1150
- },
1151
- "validate-resources": {
1152
- "description": "Validate resources",
1153
- "hidden": true,
1154
- "name": "validate-resources",
1155
- "allowNo": true,
1156
- "type": "boolean"
1157
- },
1158
- "verbose": {
1159
- "description": "Verbose output",
1160
- "hidden": true,
1161
- "name": "verbose",
1162
- "allowNo": false,
1163
- "type": "boolean"
1164
- },
1165
- "stack": {
1166
- "description": "Stack name or ID to use instead of the locally configured Stack",
1167
- "hidden": true,
1168
- "name": "stack",
1169
- "hasDynamicHelp": false,
1170
- "multiple": false,
1171
946
  "type": "option"
1172
947
  },
1173
948
  "project-id": {
@@ -1179,7 +954,6 @@
1179
954
  "exclusive": [
1180
955
  "organization-id"
1181
956
  ],
1182
- "hidden": true,
1183
957
  "name": "project-id",
1184
958
  "hasDynamicHelp": false,
1185
959
  "multiple": false,
@@ -1195,160 +969,84 @@
1195
969
  "exclusive": [
1196
970
  "project-id"
1197
971
  ],
1198
- "hidden": true,
1199
972
  "name": "organization-id",
1200
973
  "hasDynamicHelp": false,
1201
974
  "multiple": false,
1202
975
  "type": "option"
1203
976
  },
1204
- "example": {
977
+ "stack-id": {
1205
978
  "aliases": [
1206
- "recipe"
979
+ "stackId"
1207
980
  ],
1208
- "description": "Example to use for the function resource. Discover examples at https://www.sanity.io/exchange/type=recipes/by=sanity",
981
+ "description": "Existing Stack ID used to scope local Blueprint",
1209
982
  "exclusive": [
1210
- "name",
1211
- "fn-type",
1212
- "language",
1213
- "javascript",
1214
- "fn-helpers",
1215
- "fn-installer"
1216
- ],
1217
- "name": "example",
1218
- "hasDynamicHelp": false,
1219
- "multiple": false,
1220
- "type": "option"
1221
- },
1222
- "name": {
1223
- "char": "n",
1224
- "description": "Name of the resource to add",
1225
- "name": "name",
1226
- "hasDynamicHelp": false,
1227
- "multiple": false,
1228
- "type": "option"
1229
- },
1230
- "fn-type": {
1231
- "aliases": [
1232
- "function-type"
1233
- ],
1234
- "dependsOn": [
1235
- "name"
1236
- ],
1237
- "description": "Document change event(s) that should trigger the function; you can specify multiple events by specifying this flag multiple times",
1238
- "name": "fn-type",
1239
- "hasDynamicHelp": false,
1240
- "multiple": true,
1241
- "options": [
1242
- "document-publish",
1243
- "document-create",
1244
- "document-delete",
1245
- "document-update",
1246
- "media-library-asset-create",
1247
- "media-library-asset-delete",
1248
- "media-library-asset-update",
1249
- "pub-sub",
1250
- "scheduled-function",
1251
- "sync-tag-invalidate"
983
+ "stack-name"
1252
984
  ],
1253
- "type": "option"
1254
- },
1255
- "language": {
1256
- "aliases": [
1257
- "function-language",
1258
- "fn-language",
1259
- "lang"
985
+ "name": "stack-id",
986
+ "relationships": [
987
+ {
988
+ "type": "some",
989
+ "flags": [
990
+ "project-id",
991
+ "organization-id"
992
+ ]
993
+ }
1260
994
  ],
1261
- "description": "Language of the new function",
1262
- "name": "language",
1263
- "default": "ts",
1264
995
  "hasDynamicHelp": false,
1265
996
  "multiple": false,
1266
- "options": [
1267
- "ts",
1268
- "js"
1269
- ],
1270
997
  "type": "option"
1271
998
  },
1272
- "javascript": {
999
+ "stack-name": {
1273
1000
  "aliases": [
1274
- "js"
1001
+ "name"
1275
1002
  ],
1276
- "description": "Use JavaScript instead of TypeScript",
1003
+ "description": "Name to use for a new Stack provisioned during initialization",
1277
1004
  "exclusive": [
1278
- "language"
1279
- ],
1280
- "name": "javascript",
1281
- "allowNo": false,
1282
- "type": "boolean"
1283
- },
1284
- "fn-helpers": {
1285
- "aliases": [
1286
- "function-helpers",
1287
- "helpers"
1005
+ "stack-id"
1288
1006
  ],
1289
- "description": "Add helpers to the new function",
1290
- "name": "fn-helpers",
1291
- "allowNo": true,
1292
- "type": "boolean"
1293
- },
1294
- "fn-installer": {
1295
- "aliases": [
1296
- "function-installer",
1297
- "installer"
1007
+ "name": "stack-name",
1008
+ "relationships": [
1009
+ {
1010
+ "type": "some",
1011
+ "flags": [
1012
+ "project-id",
1013
+ "organization-id"
1014
+ ]
1015
+ }
1298
1016
  ],
1299
- "description": "Which package manager to use when installing the @sanity/functions helpers",
1300
- "name": "fn-installer",
1301
1017
  "hasDynamicHelp": false,
1302
1018
  "multiple": false,
1303
- "options": [
1304
- "skip",
1305
- "npm",
1306
- "pnpm",
1307
- "yarn"
1308
- ],
1309
1019
  "type": "option"
1310
- },
1311
- "install": {
1312
- "char": "i",
1313
- "description": "Shortcut for --fn-installer npm",
1314
- "exclusive": [
1315
- "fn-installer"
1316
- ],
1317
- "name": "install",
1318
- "allowNo": false,
1319
- "type": "boolean"
1320
1020
  }
1321
1021
  },
1322
1022
  "hasDynamicHelp": false,
1323
1023
  "hiddenAliases": [],
1324
- "id": "blueprints:add",
1024
+ "id": "blueprints:init",
1325
1025
  "pluginAlias": "@sanity/runtime-cli",
1326
1026
  "pluginName": "@sanity/runtime-cli",
1327
1027
  "pluginType": "core",
1328
- "state": "deprecated",
1329
1028
  "strict": true,
1330
- "summary": "[deprecated] Use \"functions add\" instead",
1029
+ "summary": "Initialize a Blueprint and create a remote Stack",
1331
1030
  "enableJsonFlag": true,
1332
- "needs": [
1333
- "blueprint"
1334
- ],
1335
1031
  "isESM": true,
1336
1032
  "relativePath": [
1337
1033
  "dist",
1338
1034
  "commands",
1339
1035
  "blueprints",
1340
- "add.js"
1036
+ "init.js"
1341
1037
  ]
1342
1038
  },
1343
- "blueprints:config": {
1039
+ "blueprints:logs": {
1344
1040
  "aliases": [],
1345
1041
  "args": {},
1346
- "description": "Manages the local Blueprint configuration, which links your Blueprint to a Sanity project and Stack.\n\nWithout flags, displays the current configuration. Use --edit to interactively modify settings, or combine --edit with ID flags to update values directly (useful for scripting and automation).\n\nIf you need to switch your Blueprint to a different Stack, use --edit --stack.",
1042
+ "description": "Retrieves Stack deployment logs, useful for debugging and monitoring deployment activity.\n\nUse --watch (-w) to tail logs in real-time.\n\nUse --limit, --since, or --before to narrow the result set when not watching.\n\nIf you're not seeing expected logs, verify your Stack is deployed with 'blueprints info'.",
1347
1043
  "examples": [
1348
1044
  "<%= config.bin %> <%= command.id %>",
1349
- "<%= config.bin %> <%= command.id %> --edit",
1350
- "<%= config.bin %> <%= command.id %> --edit --project-id <projectId>",
1351
- "<%= config.bin %> <%= command.id %> --edit --project-id <projectId> --stack <name-or-id>"
1045
+ "<%= config.bin %> <%= command.id %> --watch",
1046
+ "<%= config.bin %> <%= command.id %> --stack <name-or-id>",
1047
+ "<%= config.bin %> <%= command.id %> --limit 500",
1048
+ "<%= config.bin %> <%= command.id %> --since 2026-05-01T00:00:00Z",
1049
+ "<%= config.bin %> <%= command.id %> --before 2026-05-01T00:00:00Z"
1352
1050
  ],
1353
1051
  "flags": {
1354
1052
  "json": {
@@ -1392,14 +1090,7 @@
1392
1090
  "type": "boolean"
1393
1091
  },
1394
1092
  "stack": {
1395
- "aliases": [
1396
- "stack-id",
1397
- "stackId"
1398
- ],
1399
- "dependsOn": [
1400
- "edit"
1401
- ],
1402
- "description": "Stack name or ID to set in the configuration. Requires --edit flag",
1093
+ "description": "Stack name or ID to use instead of the locally configured Stack",
1403
1094
  "name": "stack",
1404
1095
  "hasDynamicHelp": false,
1405
1096
  "multiple": false,
@@ -1410,9 +1101,6 @@
1410
1101
  "project",
1411
1102
  "projectId"
1412
1103
  ],
1413
- "dependsOn": [
1414
- "edit"
1415
- ],
1416
1104
  "description": "Sanity project ID used to scope Blueprint and Stack",
1417
1105
  "exclusive": [
1418
1106
  "organization-id"
@@ -1428,9 +1116,6 @@
1428
1116
  "organizationId",
1429
1117
  "org"
1430
1118
  ],
1431
- "dependsOn": [
1432
- "edit"
1433
- ],
1434
1119
  "description": "Sanity organization ID used to scope Blueprint and Stack",
1435
1120
  "exclusive": [
1436
1121
  "project-id"
@@ -1440,47 +1125,83 @@
1440
1125
  "multiple": false,
1441
1126
  "type": "option"
1442
1127
  },
1443
- "edit": {
1444
- "char": "e",
1445
- "description": "Modify the configuration interactively, or directly when combined with ID flags.",
1446
- "name": "edit",
1128
+ "watch": {
1129
+ "aliases": [
1130
+ "follow"
1131
+ ],
1132
+ "char": "w",
1133
+ "description": "Watch for new Stack logs",
1134
+ "exclusive": [
1135
+ "json"
1136
+ ],
1137
+ "name": "watch",
1447
1138
  "allowNo": false,
1448
1139
  "type": "boolean"
1140
+ },
1141
+ "limit": {
1142
+ "char": "l",
1143
+ "description": "Maximum number of log entries to retrieve (1-500)",
1144
+ "exclusive": [
1145
+ "watch"
1146
+ ],
1147
+ "name": "limit",
1148
+ "hasDynamicHelp": false,
1149
+ "multiple": false,
1150
+ "type": "option"
1151
+ },
1152
+ "since": {
1153
+ "description": "Only show logs after this ISO 8601 timestamp",
1154
+ "exclusive": [
1155
+ "watch"
1156
+ ],
1157
+ "name": "since",
1158
+ "hasDynamicHelp": false,
1159
+ "multiple": false,
1160
+ "type": "option"
1161
+ },
1162
+ "before": {
1163
+ "description": "Only show logs before this ISO 8601 timestamp",
1164
+ "exclusive": [
1165
+ "watch"
1166
+ ],
1167
+ "name": "before",
1168
+ "hasDynamicHelp": false,
1169
+ "multiple": false,
1170
+ "type": "option"
1449
1171
  }
1450
1172
  },
1451
1173
  "hasDynamicHelp": false,
1452
1174
  "hiddenAliases": [],
1453
- "id": "blueprints:config",
1175
+ "id": "blueprints:logs",
1454
1176
  "pluginAlias": "@sanity/runtime-cli",
1455
1177
  "pluginName": "@sanity/runtime-cli",
1456
1178
  "pluginType": "core",
1457
1179
  "strict": true,
1458
- "summary": "View or edit the local Blueprint configuration",
1180
+ "summary": "Display logs for the current Blueprint's Stack deployment",
1459
1181
  "enableJsonFlag": true,
1460
1182
  "needs": [
1461
- "token",
1462
- "blueprint"
1183
+ "deployedStack"
1463
1184
  ],
1464
1185
  "isESM": true,
1465
1186
  "relativePath": [
1466
1187
  "dist",
1467
1188
  "commands",
1468
1189
  "blueprints",
1469
- "config.js"
1190
+ "logs.js"
1470
1191
  ]
1471
1192
  },
1472
- "blueprints:deploy": {
1193
+ "blueprints:mint-deploy-token": {
1473
1194
  "aliases": [],
1474
1195
  "args": {},
1475
- "description": "Applies your local Blueprint to the remote Stack, creating, updating, or removing resources as needed. This is the primary command for applying infrastructure changes.\n\nBefore deploying, run 'blueprints plan' to preview changes. After deployment, use 'blueprints info' to verify Stack status or 'blueprints logs' to monitor activity.\n\nUse --no-wait to queue the deployment and return immediately without waiting for completion.\n\nUse --fn-installer to force which package manager to use when deploying functions.\n\nSet SANITY_ASSET_TIMEOUT (seconds) to override the 180-second timeout for processing resource assets.\n\nSet SANITY_ASSET_CONCURRENCY to override how many resource assets are processed at once (default 4).\n\nExit codes: 0 deployed, 2 deployment failed, 75 deployment accepted but completion could not be confirmed (rerun 'blueprints info' to check).",
1196
+ "description": "Mints a long-lived robot token with the role required to plan, deploy, and destroy Blueprints in this project or organization.\n\nBy default the command runs interactively and asks how you want to receive the token (clipboard, print, or exit). Use --print to emit only the raw token for shell pipelines, or --json for full API output.\n\nThe minted token is also visible in your Sanity Manage UI under Robots, where it can be revoked.",
1476
1197
  "examples": [
1477
1198
  "<%= config.bin %> <%= command.id %>",
1478
- "<%= config.bin %> <%= command.id %> --message \"Enable staging dataset\"",
1479
- "<%= config.bin %> <%= command.id %> --no-wait",
1480
- "<%= config.bin %> <%= command.id %> --fn-installer npm",
1481
- "<%= config.bin %> <%= command.id %> --stack <name-or-id>",
1482
- "<%= config.bin %> <%= command.id %> --organization-id <orgId> --stack <name-or-id>",
1483
- "<%= config.bin %> <%= command.id %> --new-stack-name <new-name>"
1199
+ "<%= config.bin %> <%= command.id %> --label \"ci-deploy\"",
1200
+ "<%= config.bin %> <%= command.id %> --print",
1201
+ "export SANITY_AUTH_TOKEN=$(<%= config.bin %> <%= command.id %> --print)",
1202
+ "<%= config.bin %> <%= command.id %> --json",
1203
+ "<%= config.bin %> <%= command.id %> --project-id <projectId>",
1204
+ "<%= config.bin %> <%= command.id %> --organization-id <orgId>"
1484
1205
  ],
1485
1206
  "flags": {
1486
1207
  "json": {
@@ -1525,6 +1246,7 @@
1525
1246
  },
1526
1247
  "stack": {
1527
1248
  "description": "Stack name or ID to use instead of the locally configured Stack",
1249
+ "hidden": true,
1528
1250
  "name": "stack",
1529
1251
  "hasDynamicHelp": false,
1530
1252
  "multiple": false,
@@ -1559,84 +1281,52 @@
1559
1281
  "multiple": false,
1560
1282
  "type": "option"
1561
1283
  },
1562
- "message": {
1563
- "char": "m",
1564
- "description": "Message describing the deployment (e.g. reason for change)",
1565
- "name": "message",
1566
- "hasDynamicHelp": false,
1567
- "multiple": false,
1568
- "type": "option"
1569
- },
1570
- "fn-installer": {
1571
- "aliases": [
1572
- "function-installer",
1573
- "installer"
1574
- ],
1575
- "description": "Which package manager to use when installing Function dependencies",
1576
- "hidden": true,
1577
- "name": "fn-installer",
1284
+ "label": {
1285
+ "description": "Human-readable label for the robot. Defaults to a generated value.",
1286
+ "name": "label",
1578
1287
  "hasDynamicHelp": false,
1579
1288
  "multiple": false,
1580
- "options": [
1581
- "npm",
1582
- "pnpm",
1583
- "yarn"
1584
- ],
1585
1289
  "type": "option"
1586
1290
  },
1587
- "no-wait": {
1588
- "description": "Do not wait for Stack deployment to complete",
1589
- "name": "no-wait",
1590
- "allowNo": false,
1591
- "type": "boolean"
1592
- },
1593
- "configure": {
1594
- "aliases": [
1595
- "config",
1596
- "init"
1291
+ "print": {
1292
+ "char": "P",
1293
+ "description": "Print only the raw token to stdout (suitable for shell substitution)",
1294
+ "exclusive": [
1295
+ "json"
1597
1296
  ],
1598
- "description": "Configure the local Blueprint interactively before deploying",
1599
- "hidden": true,
1600
- "name": "configure",
1297
+ "name": "print",
1601
1298
  "allowNo": false,
1602
1299
  "type": "boolean"
1603
- },
1604
- "new-stack-name": {
1605
- "description": "Set a new name for the Stack",
1606
- "name": "new-stack-name",
1607
- "hasDynamicHelp": false,
1608
- "multiple": false,
1609
- "type": "option"
1610
1300
  }
1611
1301
  },
1612
1302
  "hasDynamicHelp": false,
1613
1303
  "hiddenAliases": [],
1614
- "id": "blueprints:deploy",
1304
+ "id": "blueprints:mint-deploy-token",
1615
1305
  "pluginAlias": "@sanity/runtime-cli",
1616
1306
  "pluginName": "@sanity/runtime-cli",
1617
1307
  "pluginType": "core",
1618
1308
  "strict": true,
1619
- "summary": "Deploy the local Blueprint to the remote Stack",
1309
+ "summary": "Create a robot API token for deploying Blueprints from CI/CD",
1620
1310
  "enableJsonFlag": true,
1621
1311
  "needs": [
1622
- "deployedStack",
1623
- "blueprint"
1312
+ "scope"
1624
1313
  ],
1625
1314
  "isESM": true,
1626
1315
  "relativePath": [
1627
1316
  "dist",
1628
1317
  "commands",
1629
1318
  "blueprints",
1630
- "deploy.js"
1319
+ "mint-deploy-token.js"
1631
1320
  ]
1632
1321
  },
1633
- "blueprints:destroy": {
1322
+ "blueprints:plan": {
1634
1323
  "aliases": [],
1635
1324
  "args": {},
1636
- "description": "Permanently removes the remote Stack and all its provisioned resources. Your Blueprint manifest and resource files remain intact; \"stackId\" is unset in your local config.\n\nThis is a destructive operation. You will be prompted to confirm unless --force is specified.\n\nUse this to clean up test environments or decommission a Stack you no longer need.\n\nExit codes: 0 destroyed, 2 destruction failed, 75 destruction accepted but completion could not be confirmed (rerun 'blueprints info' to check).",
1325
+ "description": "Use this command to preview what changes will be applied to your remote Stack before deploying. This is a safe, read-only operation—no resources are created, modified, or deleted.\n\nRun 'blueprints plan' after making local changes to your Blueprint manifest to verify the expected diff. When ready, run 'blueprints deploy' to apply changes.",
1637
1326
  "examples": [
1638
1327
  "<%= config.bin %> <%= command.id %>",
1639
- "<%= config.bin %> <%= command.id %> --stack <name-or-id> --project-id <projectId> --force --no-wait"
1328
+ "<%= config.bin %> <%= command.id %> --stack <name-or-id>",
1329
+ "<%= config.bin %> <%= command.id %> --organization-id <orgId> --stack <name-or-id>"
1640
1330
  ],
1641
1331
  "flags": {
1642
1332
  "json": {
@@ -1680,11 +1370,7 @@
1680
1370
  "type": "boolean"
1681
1371
  },
1682
1372
  "stack": {
1683
- "aliases": [
1684
- "stack-id",
1685
- "stackId"
1686
- ],
1687
- "description": "Stack name or ID to destroy (defaults to the locally configured Stack)",
1373
+ "description": "Stack name or ID to use instead of the locally configured Stack",
1688
1374
  "name": "stack",
1689
1375
  "hasDynamicHelp": false,
1690
1376
  "multiple": false,
@@ -1695,10 +1381,6 @@
1695
1381
  "project",
1696
1382
  "projectId"
1697
1383
  ],
1698
- "dependsOn": [
1699
- "stack",
1700
- "force"
1701
- ],
1702
1384
  "description": "Sanity project ID used to scope Blueprint and Stack",
1703
1385
  "exclusive": [
1704
1386
  "organization-id"
@@ -1714,10 +1396,6 @@
1714
1396
  "organizationId",
1715
1397
  "org"
1716
1398
  ],
1717
- "dependsOn": [
1718
- "stack",
1719
- "force"
1720
- ],
1721
1399
  "description": "Sanity organization ID used to scope Blueprint and Stack",
1722
1400
  "exclusive": [
1723
1401
  "project-id"
@@ -1726,48 +1404,38 @@
1726
1404
  "hasDynamicHelp": false,
1727
1405
  "multiple": false,
1728
1406
  "type": "option"
1729
- },
1730
- "force": {
1731
- "char": "f",
1732
- "description": "Force Stack destruction (skip confirmation)",
1733
- "name": "force",
1734
- "allowNo": false,
1735
- "type": "boolean"
1736
- },
1737
- "no-wait": {
1738
- "description": "Do not wait for Stack destruction to complete",
1739
- "name": "no-wait",
1740
- "allowNo": false,
1741
- "type": "boolean"
1742
1407
  }
1743
1408
  },
1744
1409
  "hasDynamicHelp": false,
1745
1410
  "hiddenAliases": [],
1746
- "id": "blueprints:destroy",
1411
+ "id": "blueprints:plan",
1747
1412
  "pluginAlias": "@sanity/runtime-cli",
1748
1413
  "pluginName": "@sanity/runtime-cli",
1749
1414
  "pluginType": "core",
1750
1415
  "strict": true,
1751
- "summary": "Destroy a remote Stack deployment and its resources",
1416
+ "summary": "Preview changes that will be applied to the remote Stack",
1752
1417
  "enableJsonFlag": true,
1753
1418
  "needs": [
1754
- "scope"
1419
+ "token",
1420
+ "blueprint"
1755
1421
  ],
1756
1422
  "isESM": true,
1757
1423
  "relativePath": [
1758
1424
  "dist",
1759
1425
  "commands",
1760
1426
  "blueprints",
1761
- "destroy.js"
1427
+ "plan.js"
1762
1428
  ]
1763
1429
  },
1764
- "blueprints:doctor": {
1430
+ "blueprints:promote": {
1765
1431
  "aliases": [],
1766
1432
  "args": {},
1767
- "description": "Analyzes your local Blueprint and remote Stack configuration for common issues, such as missing authentication, invalid project references, or misconfigured resources.\n\nRun this command when encountering errors with other Blueprint commands. Use --fix to interactively resolve detected issues.\n\nSupports --json for programmatic consumption of diagnostic results.",
1433
+ "description": "Promotes a deployed Stack to organization scope, enabling management of org-level resources. Promotion cannot be reversed.\n\nYour local Blueprint configuration will be updated to reflect the new scope.",
1768
1434
  "examples": [
1769
1435
  "<%= config.bin %> <%= command.id %>",
1770
- "<%= config.bin %> <%= command.id %> --fix"
1436
+ "<%= config.bin %> <%= command.id %> --stack <name-or-id>",
1437
+ "<%= config.bin %> <%= command.id %> --project-id <projectId> --stack <name-or-id>",
1438
+ "<%= config.bin %> <%= command.id %> --new-stack-name <new-name>"
1771
1439
  ],
1772
1440
  "flags": {
1773
1441
  "json": {
@@ -1783,6 +1451,7 @@
1783
1451
  "char": "p",
1784
1452
  "description": "Path to a Blueprint file or directory containing one",
1785
1453
  "env": "SANITY_BLUEPRINT_PATH",
1454
+ "hidden": true,
1786
1455
  "name": "path",
1787
1456
  "hasDynamicHelp": false,
1788
1457
  "multiple": false,
@@ -1809,39 +1478,91 @@
1809
1478
  "allowNo": false,
1810
1479
  "type": "boolean"
1811
1480
  },
1812
- "fix": {
1813
- "description": "Interactively fix configuration issues",
1814
- "name": "fix",
1481
+ "stack": {
1482
+ "aliases": [
1483
+ "id"
1484
+ ],
1485
+ "description": "Stack name or ID to promote",
1486
+ "name": "stack",
1487
+ "hasDynamicHelp": false,
1488
+ "multiple": false,
1489
+ "type": "option"
1490
+ },
1491
+ "project-id": {
1492
+ "aliases": [
1493
+ "project",
1494
+ "projectId"
1495
+ ],
1496
+ "description": "Sanity project ID used to scope Blueprint and Stack",
1497
+ "exclusive": [
1498
+ "organization-id"
1499
+ ],
1500
+ "name": "project-id",
1501
+ "hasDynamicHelp": false,
1502
+ "multiple": false,
1503
+ "type": "option"
1504
+ },
1505
+ "organization-id": {
1506
+ "aliases": [
1507
+ "organization",
1508
+ "organizationId",
1509
+ "org"
1510
+ ],
1511
+ "description": "Sanity organization ID used to scope Blueprint and Stack",
1512
+ "exclusive": [
1513
+ "project-id"
1514
+ ],
1515
+ "hidden": true,
1516
+ "name": "organization-id",
1517
+ "hasDynamicHelp": false,
1518
+ "multiple": false,
1519
+ "type": "option"
1520
+ },
1521
+ "force": {
1522
+ "description": "Skip confirmation prompt",
1523
+ "name": "force",
1815
1524
  "allowNo": false,
1816
1525
  "type": "boolean"
1526
+ },
1527
+ "new-stack-name": {
1528
+ "description": "Set a new name for the Stack while promoting",
1529
+ "name": "new-stack-name",
1530
+ "hasDynamicHelp": false,
1531
+ "multiple": false,
1532
+ "type": "option"
1817
1533
  }
1818
1534
  },
1819
1535
  "hasDynamicHelp": false,
1820
1536
  "hiddenAliases": [],
1821
- "id": "blueprints:doctor",
1537
+ "id": "blueprints:promote",
1822
1538
  "pluginAlias": "@sanity/runtime-cli",
1823
1539
  "pluginName": "@sanity/runtime-cli",
1824
1540
  "pluginType": "core",
1825
1541
  "strict": true,
1826
- "summary": "Diagnose potential issues with local Blueprint and remote Stack configuration",
1542
+ "summary": "Promote a Stack from project scope to organization scope",
1827
1543
  "enableJsonFlag": true,
1544
+ "needs": [
1545
+ "deployedStack",
1546
+ "blueprint"
1547
+ ],
1828
1548
  "isESM": true,
1829
1549
  "relativePath": [
1830
1550
  "dist",
1831
1551
  "commands",
1832
1552
  "blueprints",
1833
- "doctor.js"
1553
+ "promote.js"
1834
1554
  ]
1835
1555
  },
1836
- "blueprints:info": {
1556
+ "blueprints:stacks": {
1837
1557
  "aliases": [],
1838
1558
  "args": {},
1839
- "description": "Displays the current state and metadata of your remote Stack deployment, including deployed resources, status, and configuration.\n\nUse this command to verify a deployment succeeded, check what resources are live, or confirm which Stack your local Blueprint is connected to.\n\nRun 'blueprints stacks' to see all available Stacks in your project or organization.",
1559
+ "description": "Shows all Stacks associated with a project or organization. By default, lists Stacks scoped to the local Blueprint.\n\nUse this to discover existing Stacks you can scope a local Blueprint to (using 'blueprints config --edit'), or to audit what's deployed across your project.\n\nWithout a scope, prompts for an organization or project. Use --all to list Stacks across every organization and project you can access, or --include-projects with --organization-id for one organization and its projects.",
1840
1560
  "examples": [
1841
1561
  "<%= config.bin %> <%= command.id %>",
1842
- "<%= config.bin %> <%= command.id %> --stack <name-or-id>",
1843
- "<%= config.bin %> <%= command.id %> --project-id <id> --stack <name-or-id>",
1844
- "<%= config.bin %> <%= command.id %> --organization-id <orgId> --stack <name-or-id>"
1562
+ "<%= config.bin %> <%= command.id %> --all",
1563
+ "<%= config.bin %> <%= command.id %> --project-id <projectId>",
1564
+ "<%= config.bin %> <%= command.id %> --organization-id <organizationId>",
1565
+ "<%= config.bin %> <%= command.id %> --organization-id <organizationId> --include-projects"
1845
1566
  ],
1846
1567
  "flags": {
1847
1568
  "json": {
@@ -1878,17 +1599,15 @@
1878
1599
  "type": "boolean"
1879
1600
  },
1880
1601
  "verbose": {
1881
- "char": "v",
1882
- "description": "Show resource and external IDs",
1602
+ "description": "Verbose output",
1603
+ "hidden": true,
1883
1604
  "name": "verbose",
1884
1605
  "allowNo": false,
1885
1606
  "type": "boolean"
1886
1607
  },
1887
1608
  "stack": {
1888
- "aliases": [
1889
- "id"
1890
- ],
1891
- "description": "Stack name or ID",
1609
+ "description": "Stack name or ID to use instead of the locally configured Stack",
1610
+ "hidden": true,
1892
1611
  "name": "stack",
1893
1612
  "hasDynamicHelp": false,
1894
1613
  "multiple": false,
@@ -1901,7 +1620,9 @@
1901
1620
  ],
1902
1621
  "description": "Sanity project ID used to scope Blueprint and Stack",
1903
1622
  "exclusive": [
1904
- "organization-id"
1623
+ "organization-id",
1624
+ "include-projects",
1625
+ "all"
1905
1626
  ],
1906
1627
  "name": "project-id",
1907
1628
  "hasDynamicHelp": false,
@@ -1916,54 +1637,65 @@
1916
1637
  ],
1917
1638
  "description": "Sanity organization ID used to scope Blueprint and Stack",
1918
1639
  "exclusive": [
1919
- "project-id"
1640
+ "project-id",
1641
+ "all"
1920
1642
  ],
1921
1643
  "name": "organization-id",
1922
1644
  "hasDynamicHelp": false,
1923
1645
  "multiple": false,
1924
1646
  "type": "option"
1647
+ },
1648
+ "include-projects": {
1649
+ "dependsOn": [
1650
+ "organization-id"
1651
+ ],
1652
+ "description": "Include Stacks from all projects within the organization. Requires --organization-id.",
1653
+ "name": "include-projects",
1654
+ "allowNo": false,
1655
+ "type": "boolean"
1656
+ },
1657
+ "all": {
1658
+ "description": "List Stacks from every organization and project you have access to",
1659
+ "exclusive": [
1660
+ "project-id",
1661
+ "organization-id",
1662
+ "include-projects"
1663
+ ],
1664
+ "name": "all",
1665
+ "allowNo": false,
1666
+ "type": "boolean"
1925
1667
  }
1926
1668
  },
1927
1669
  "hasDynamicHelp": false,
1928
1670
  "hiddenAliases": [],
1929
- "id": "blueprints:info",
1671
+ "id": "blueprints:stacks",
1930
1672
  "pluginAlias": "@sanity/runtime-cli",
1931
1673
  "pluginName": "@sanity/runtime-cli",
1932
1674
  "pluginType": "core",
1933
1675
  "strict": true,
1934
- "summary": "Display the status and resources of the remote Stack deployment",
1676
+ "summary": "List remote Stack deployments for your project or organization",
1935
1677
  "enableJsonFlag": true,
1936
1678
  "needs": [
1937
- "deployedStack"
1679
+ "token"
1938
1680
  ],
1939
1681
  "isESM": true,
1940
1682
  "relativePath": [
1941
1683
  "dist",
1942
1684
  "commands",
1943
1685
  "blueprints",
1944
- "info.js"
1686
+ "stacks.js"
1945
1687
  ]
1946
1688
  },
1947
- "blueprints:init": {
1689
+ "functions:add": {
1948
1690
  "aliases": [],
1949
- "args": {
1950
- "dir": {
1951
- "description": "Directory to create the local Blueprint in (defaults to the current directory)",
1952
- "name": "dir"
1953
- }
1954
- },
1955
- "description": "A Blueprint is your local infrastructure-as-code configuration that defines Sanity resources (datasets, functions, etc.). A Stack is the remote deployment target where your Blueprint is applied.\n\nThis is typically the first command you run in a new project. It creates a local Blueprint manifest file (sanity.blueprint.ts, .js, or .json) and provisions a new remote Stack.\nAdditionally, a Blueprint configuration file is created in .sanity/ containing the scope and Stack IDs. A .gitignore covering node_modules, .env, and Function build output is created or updated; the .sanity/ config itself is not ignored.\n\nAfter initialization, use 'blueprints plan' to preview changes, then 'blueprints deploy' to apply them.\n\nRunning without a directory prompts to confirm the current directory. Run 'blueprints init .' to initialize in the current directory without a prompt.",
1691
+ "args": {},
1692
+ "description": "Scaffolds a new Function in the functions/ folder and templates a resource for your Blueprint manifest.\n\nFunctions are serverless handlers triggered by document, live content or media-library events (create, update, delete, publish).\n\nAfter adding, use 'functions dev' to test locally, then 'blueprints deploy' to publish.",
1956
1693
  "examples": [
1957
1694
  "<%= config.bin %> <%= command.id %>",
1958
- "<%= config.bin %> <%= command.id %> .",
1959
- "<%= config.bin %> <%= command.id %> [directory]",
1960
- "<%= config.bin %> <%= command.id %> --blueprint-type <json|js|ts>",
1961
- "<%= config.bin %> <%= command.id %> --organization-id <organizationId>",
1962
- "<%= config.bin %> <%= command.id %> --project-id <projectId>",
1963
- "<%= config.bin %> <%= command.id %> --stack-name <newStackName>",
1964
- "<%= config.bin %> <%= command.id %> --stack-id <existingStackId>",
1965
- "<%= config.bin %> <%= command.id %> new-stack --type <json|js|ts> --org <organizationId> --name <newStackName>",
1966
- "<%= config.bin %> <%= command.id %> old-stack --type <json|js|ts> --project-id <projectId> --stack-id <existingStackId>"
1695
+ "<%= config.bin %> <%= command.id %> --helpers",
1696
+ "<%= config.bin %> <%= command.id %> --name my-function",
1697
+ "<%= config.bin %> <%= command.id %> --name my-function --type document-create",
1698
+ "<%= config.bin %> <%= command.id %> --name my-function --type document-create --type document-update --lang js"
1967
1699
  ],
1968
1700
  "flags": {
1969
1701
  "json": {
@@ -2006,41 +1738,12 @@
2006
1738
  "allowNo": false,
2007
1739
  "type": "boolean"
2008
1740
  },
2009
- "dir": {
2010
- "description": "Directory to create the local Blueprint in",
2011
- "name": "dir",
2012
- "hasDynamicHelp": false,
2013
- "multiple": false,
2014
- "type": "option"
2015
- },
2016
- "example": {
2017
- "aliases": [
2018
- "recipe"
2019
- ],
2020
- "description": "Example to use for the local Blueprint",
2021
- "exclusive": [
2022
- "blueprint-type",
2023
- "stack-id",
2024
- "stack-name"
2025
- ],
2026
- "name": "example",
2027
- "hasDynamicHelp": false,
2028
- "multiple": false,
2029
- "type": "option"
2030
- },
2031
- "blueprint-type": {
2032
- "aliases": [
2033
- "type"
2034
- ],
2035
- "description": "Blueprint manifest type to use for the local Blueprint",
2036
- "name": "blueprint-type",
1741
+ "stack": {
1742
+ "description": "Stack name or ID to use instead of the locally configured Stack",
1743
+ "hidden": true,
1744
+ "name": "stack",
2037
1745
  "hasDynamicHelp": false,
2038
1746
  "multiple": false,
2039
- "options": [
2040
- "json",
2041
- "js",
2042
- "ts"
2043
- ],
2044
1747
  "type": "option"
2045
1748
  },
2046
1749
  "project-id": {
@@ -2052,6 +1755,7 @@
2052
1755
  "exclusive": [
2053
1756
  "organization-id"
2054
1757
  ],
1758
+ "hidden": true,
2055
1759
  "name": "project-id",
2056
1760
  "hasDynamicHelp": false,
2057
1761
  "multiple": false,
@@ -2067,85 +1771,147 @@
2067
1771
  "exclusive": [
2068
1772
  "project-id"
2069
1773
  ],
1774
+ "hidden": true,
2070
1775
  "name": "organization-id",
2071
1776
  "hasDynamicHelp": false,
2072
1777
  "multiple": false,
2073
1778
  "type": "option"
2074
1779
  },
2075
- "stack-id": {
1780
+ "example": {
2076
1781
  "aliases": [
2077
- "stackId"
1782
+ "recipe"
2078
1783
  ],
2079
- "description": "Existing Stack ID used to scope local Blueprint",
1784
+ "description": "Example to use for the Function",
2080
1785
  "exclusive": [
2081
- "stack-name"
1786
+ "name",
1787
+ "type",
1788
+ "language",
1789
+ "javascript",
1790
+ "helpers",
1791
+ "installer",
1792
+ "install"
2082
1793
  ],
2083
- "name": "stack-id",
2084
- "relationships": [
2085
- {
2086
- "type": "some",
2087
- "flags": [
2088
- "project-id",
2089
- "organization-id"
2090
- ]
2091
- }
1794
+ "name": "example",
1795
+ "hasDynamicHelp": false,
1796
+ "multiple": false,
1797
+ "type": "option"
1798
+ },
1799
+ "name": {
1800
+ "char": "n",
1801
+ "description": "Name of the Function to add",
1802
+ "name": "name",
1803
+ "hasDynamicHelp": false,
1804
+ "multiple": false,
1805
+ "type": "option"
1806
+ },
1807
+ "type": {
1808
+ "dependsOn": [
1809
+ "name"
1810
+ ],
1811
+ "description": "Document change event(s) that should trigger the function; you can specify multiple events by specifying this flag multiple times",
1812
+ "name": "type",
1813
+ "hasDynamicHelp": false,
1814
+ "multiple": true,
1815
+ "options": [
1816
+ "document-publish",
1817
+ "document-create",
1818
+ "document-delete",
1819
+ "document-update",
1820
+ "media-library-asset-create",
1821
+ "media-library-asset-delete",
1822
+ "media-library-asset-update",
1823
+ "pub-sub",
1824
+ "scheduled-function",
1825
+ "sync-tag-invalidate"
2092
1826
  ],
1827
+ "type": "option"
1828
+ },
1829
+ "language": {
1830
+ "aliases": [
1831
+ "lang"
1832
+ ],
1833
+ "description": "Language of the new Function",
1834
+ "name": "language",
1835
+ "default": "ts",
2093
1836
  "hasDynamicHelp": false,
2094
1837
  "multiple": false,
1838
+ "options": [
1839
+ "ts",
1840
+ "js"
1841
+ ],
2095
1842
  "type": "option"
2096
1843
  },
2097
- "stack-name": {
1844
+ "javascript": {
2098
1845
  "aliases": [
2099
- "name"
1846
+ "js"
2100
1847
  ],
2101
- "description": "Name to use for a new Stack provisioned during initialization",
1848
+ "description": "Use JavaScript instead of TypeScript",
2102
1849
  "exclusive": [
2103
- "stack-id"
2104
- ],
2105
- "name": "stack-name",
2106
- "relationships": [
2107
- {
2108
- "type": "some",
2109
- "flags": [
2110
- "project-id",
2111
- "organization-id"
2112
- ]
2113
- }
1850
+ "language"
2114
1851
  ],
1852
+ "name": "javascript",
1853
+ "allowNo": false,
1854
+ "type": "boolean"
1855
+ },
1856
+ "helpers": {
1857
+ "description": "Add helpers to the new Function",
1858
+ "name": "helpers",
1859
+ "allowNo": true,
1860
+ "type": "boolean"
1861
+ },
1862
+ "installer": {
1863
+ "description": "How to install the @sanity/functions helpers",
1864
+ "name": "installer",
2115
1865
  "hasDynamicHelp": false,
2116
1866
  "multiple": false,
1867
+ "options": [
1868
+ "skip",
1869
+ "npm",
1870
+ "pnpm",
1871
+ "yarn"
1872
+ ],
2117
1873
  "type": "option"
1874
+ },
1875
+ "install": {
1876
+ "char": "i",
1877
+ "description": "Shortcut for --installer npm",
1878
+ "exclusive": [
1879
+ "installer"
1880
+ ],
1881
+ "name": "install",
1882
+ "allowNo": false,
1883
+ "type": "boolean"
2118
1884
  }
2119
1885
  },
2120
1886
  "hasDynamicHelp": false,
2121
1887
  "hiddenAliases": [],
2122
- "id": "blueprints:init",
1888
+ "id": "functions:add",
2123
1889
  "pluginAlias": "@sanity/runtime-cli",
2124
1890
  "pluginName": "@sanity/runtime-cli",
2125
1891
  "pluginType": "core",
2126
1892
  "strict": true,
2127
- "summary": "Initialize a Blueprint and create a remote Stack",
1893
+ "summary": "Add a Function to your Blueprint",
2128
1894
  "enableJsonFlag": true,
1895
+ "needs": [
1896
+ "blueprint"
1897
+ ],
2129
1898
  "isESM": true,
2130
1899
  "relativePath": [
2131
1900
  "dist",
2132
1901
  "commands",
2133
- "blueprints",
2134
- "init.js"
1902
+ "functions",
1903
+ "add.js"
2135
1904
  ]
2136
1905
  },
2137
- "blueprints:logs": {
1906
+ "functions:build": {
2138
1907
  "aliases": [],
2139
- "args": {},
2140
- "description": "Retrieves Stack deployment logs, useful for debugging and monitoring deployment activity.\n\nUse --watch (-w) to tail logs in real-time.\n\nUse --limit, --since, or --before to narrow the result set when not watching.\n\nIf you're not seeing expected logs, verify your Stack is deployed with 'blueprints info'.",
2141
- "examples": [
2142
- "<%= config.bin %> <%= command.id %>",
2143
- "<%= config.bin %> <%= command.id %> --watch",
2144
- "<%= config.bin %> <%= command.id %> --stack <name-or-id>",
2145
- "<%= config.bin %> <%= command.id %> --limit 500",
2146
- "<%= config.bin %> <%= command.id %> --since 2026-05-01T00:00:00Z",
2147
- "<%= config.bin %> <%= command.id %> --before 2026-05-01T00:00:00Z"
2148
- ],
1908
+ "args": {
1909
+ "name": {
1910
+ "description": "The name of the Sanity Function",
1911
+ "name": "name",
1912
+ "required": false
1913
+ }
1914
+ },
2149
1915
  "flags": {
2150
1916
  "json": {
2151
1917
  "description": "Format output as json",
@@ -2189,6 +1955,7 @@
2189
1955
  },
2190
1956
  "stack": {
2191
1957
  "description": "Stack name or ID to use instead of the locally configured Stack",
1958
+ "hidden": true,
2192
1959
  "name": "stack",
2193
1960
  "hasDynamicHelp": false,
2194
1961
  "multiple": false,
@@ -2203,6 +1970,7 @@
2203
1970
  "exclusive": [
2204
1971
  "organization-id"
2205
1972
  ],
1973
+ "hidden": true,
2206
1974
  "name": "project-id",
2207
1975
  "hasDynamicHelp": false,
2208
1976
  "multiple": false,
@@ -2218,88 +1986,66 @@
2218
1986
  "exclusive": [
2219
1987
  "project-id"
2220
1988
  ],
1989
+ "hidden": true,
2221
1990
  "name": "organization-id",
2222
1991
  "hasDynamicHelp": false,
2223
1992
  "multiple": false,
2224
1993
  "type": "option"
2225
1994
  },
2226
- "watch": {
1995
+ "fn-installer": {
2227
1996
  "aliases": [
2228
- "follow"
2229
- ],
2230
- "char": "w",
2231
- "description": "Watch for new Stack logs",
2232
- "exclusive": [
2233
- "json"
2234
- ],
2235
- "name": "watch",
2236
- "allowNo": false,
2237
- "type": "boolean"
2238
- },
2239
- "limit": {
2240
- "char": "l",
2241
- "description": "Maximum number of log entries to retrieve (1-500)",
2242
- "exclusive": [
2243
- "watch"
1997
+ "function-installer",
1998
+ "installer"
2244
1999
  ],
2245
- "name": "limit",
2000
+ "description": "Which package manager to use when building Functions",
2001
+ "hidden": true,
2002
+ "name": "fn-installer",
2246
2003
  "hasDynamicHelp": false,
2247
2004
  "multiple": false,
2248
- "type": "option"
2249
- },
2250
- "since": {
2251
- "description": "Only show logs after this ISO 8601 timestamp",
2252
- "exclusive": [
2253
- "watch"
2005
+ "options": [
2006
+ "npm",
2007
+ "pnpm",
2008
+ "yarn"
2254
2009
  ],
2255
- "name": "since",
2256
- "hasDynamicHelp": false,
2257
- "multiple": false,
2258
2010
  "type": "option"
2259
2011
  },
2260
- "before": {
2261
- "description": "Only show logs before this ISO 8601 timestamp",
2262
- "exclusive": [
2263
- "watch"
2264
- ],
2265
- "name": "before",
2012
+ "out-dir": {
2013
+ "char": "o",
2014
+ "description": "Output directory for zip files",
2015
+ "name": "out-dir",
2266
2016
  "hasDynamicHelp": false,
2267
2017
  "multiple": false,
2268
2018
  "type": "option"
2269
2019
  }
2270
2020
  },
2271
2021
  "hasDynamicHelp": false,
2022
+ "hidden": true,
2272
2023
  "hiddenAliases": [],
2273
- "id": "blueprints:logs",
2024
+ "id": "functions:build",
2274
2025
  "pluginAlias": "@sanity/runtime-cli",
2275
2026
  "pluginName": "@sanity/runtime-cli",
2276
2027
  "pluginType": "core",
2277
2028
  "strict": true,
2278
- "summary": "Display logs for the current Blueprint's Stack deployment",
2029
+ "summary": "Build Sanity Function(s) to zip archives",
2279
2030
  "enableJsonFlag": true,
2280
2031
  "needs": [
2281
- "deployedStack"
2032
+ "blueprint"
2282
2033
  ],
2283
2034
  "isESM": true,
2284
2035
  "relativePath": [
2285
2036
  "dist",
2286
2037
  "commands",
2287
- "blueprints",
2288
- "logs.js"
2038
+ "functions",
2039
+ "build.js"
2289
2040
  ]
2290
2041
  },
2291
- "blueprints:mint-deploy-token": {
2042
+ "functions:dev": {
2292
2043
  "aliases": [],
2293
2044
  "args": {},
2294
- "description": "Mints a long-lived robot token with the role required to plan, deploy, and destroy Blueprints in this project or organization.\n\nBy default the command runs interactively and asks how you want to receive the token (clipboard, print, or exit). Use --print to emit only the raw token for shell pipelines, or --json for full API output.\n\nThe minted token is also visible in your Sanity Manage UI under Robots, where it can be revoked.",
2045
+ "description": "Runs a local, web-based development server to test your functions before deploying.\n\nOpen the emulator in your browser to interactively test your functions with the payload editor.\n\nOptionally, set the host and port with the --host and --port flags. Port 8974 is reserved for the emulator's live-reload WebSocket server. Function timeout can be configured with the --timeout flag.\n\nTo invoke a function with the CLI, use 'functions test'.",
2295
2046
  "examples": [
2296
- "<%= config.bin %> <%= command.id %>",
2297
- "<%= config.bin %> <%= command.id %> --label \"ci-deploy\"",
2298
- "<%= config.bin %> <%= command.id %> --print",
2299
- "export SANITY_AUTH_TOKEN=$(<%= config.bin %> <%= command.id %> --print)",
2300
- "<%= config.bin %> <%= command.id %> --json",
2301
- "<%= config.bin %> <%= command.id %> --project-id <projectId>",
2302
- "<%= config.bin %> <%= command.id %> --organization-id <orgId>"
2047
+ "<%= config.bin %> <%= command.id %> --host 127.0.0.1 --port 3333",
2048
+ "<%= config.bin %> <%= command.id %> --timeout 60"
2303
2049
  ],
2304
2050
  "flags": {
2305
2051
  "json": {
@@ -2359,6 +2105,7 @@
2359
2105
  "exclusive": [
2360
2106
  "organization-id"
2361
2107
  ],
2108
+ "hidden": true,
2362
2109
  "name": "project-id",
2363
2110
  "hasDynamicHelp": false,
2364
2111
  "multiple": false,
@@ -2374,57 +2121,70 @@
2374
2121
  "exclusive": [
2375
2122
  "project-id"
2376
2123
  ],
2124
+ "hidden": true,
2377
2125
  "name": "organization-id",
2378
2126
  "hasDynamicHelp": false,
2379
2127
  "multiple": false,
2380
2128
  "type": "option"
2381
2129
  },
2382
- "label": {
2383
- "description": "Human-readable label for the robot. Defaults to a generated value.",
2384
- "name": "label",
2130
+ "host": {
2131
+ "char": "h",
2132
+ "description": "The local network interface at which to listen. [default: \"localhost\"]",
2133
+ "name": "host",
2134
+ "required": false,
2385
2135
  "hasDynamicHelp": false,
2386
2136
  "multiple": false,
2387
2137
  "type": "option"
2388
2138
  },
2389
- "print": {
2390
- "char": "P",
2391
- "description": "Print only the raw token to stdout (suitable for shell substitution)",
2392
- "exclusive": [
2393
- "json"
2394
- ],
2395
- "name": "print",
2396
- "allowNo": false,
2397
- "type": "boolean"
2139
+ "port": {
2140
+ "char": "p",
2141
+ "description": "TCP port to start emulator on. [default: 8080]",
2142
+ "name": "port",
2143
+ "required": false,
2144
+ "hasDynamicHelp": false,
2145
+ "multiple": false,
2146
+ "type": "option"
2147
+ },
2148
+ "timeout": {
2149
+ "char": "t",
2150
+ "description": "Maximum execution time for all functions, in seconds. Takes precedence over function-specific `timeout`",
2151
+ "name": "timeout",
2152
+ "required": false,
2153
+ "hasDynamicHelp": false,
2154
+ "multiple": false,
2155
+ "type": "option"
2398
2156
  }
2399
2157
  },
2400
2158
  "hasDynamicHelp": false,
2401
2159
  "hiddenAliases": [],
2402
- "id": "blueprints:mint-deploy-token",
2160
+ "id": "functions:dev",
2403
2161
  "pluginAlias": "@sanity/runtime-cli",
2404
2162
  "pluginName": "@sanity/runtime-cli",
2405
2163
  "pluginType": "core",
2406
2164
  "strict": true,
2407
- "summary": "Create a robot API token for deploying Blueprints from CI/CD",
2165
+ "summary": "Start the Sanity Function emulator",
2408
2166
  "enableJsonFlag": true,
2409
2167
  "needs": [
2410
- "scope"
2168
+ "blueprint"
2411
2169
  ],
2412
2170
  "isESM": true,
2413
2171
  "relativePath": [
2414
2172
  "dist",
2415
2173
  "commands",
2416
- "blueprints",
2417
- "mint-deploy-token.js"
2174
+ "functions",
2175
+ "dev.js"
2418
2176
  ]
2419
2177
  },
2420
- "blueprints:plan": {
2178
+ "functions:list": {
2421
2179
  "aliases": [],
2422
2180
  "args": {},
2423
- "description": "Use this command to preview what changes will be applied to your remote Stack before deploying. This is a safe, read-only operation—no resources are created, modified, or deleted.\n\nRun 'blueprints plan' after making local changes to your Blueprint manifest to verify the expected diff. When ready, run 'blueprints deploy' to apply changes.",
2181
+ "description": "Lists functions deployed directly in the selected project or organization scope. The local Blueprint config supplies the scope by default.\n\nUse --project-id or --organization-id to select a scope without a local Blueprint. Organization results include organization-scoped functions only.",
2424
2182
  "examples": [
2425
2183
  "<%= config.bin %> <%= command.id %>",
2426
- "<%= config.bin %> <%= command.id %> --stack <name-or-id>",
2427
- "<%= config.bin %> <%= command.id %> --organization-id <orgId> --stack <name-or-id>"
2184
+ "<%= config.bin %> <%= command.id %> --verbose",
2185
+ "<%= config.bin %> <%= command.id %> --project-id <projectId>",
2186
+ "<%= config.bin %> <%= command.id %> --organization-id <organizationId>",
2187
+ "<%= config.bin %> <%= command.id %> --project-id <projectId> --json"
2428
2188
  ],
2429
2189
  "flags": {
2430
2190
  "json": {
@@ -2461,14 +2221,15 @@
2461
2221
  "type": "boolean"
2462
2222
  },
2463
2223
  "verbose": {
2464
- "description": "Verbose output",
2465
- "hidden": true,
2224
+ "char": "v",
2225
+ "description": "Show function configuration details",
2466
2226
  "name": "verbose",
2467
2227
  "allowNo": false,
2468
2228
  "type": "boolean"
2469
2229
  },
2470
2230
  "stack": {
2471
2231
  "description": "Stack name or ID to use instead of the locally configured Stack",
2232
+ "hidden": true,
2472
2233
  "name": "stack",
2473
2234
  "hasDynamicHelp": false,
2474
2235
  "multiple": false,
@@ -2505,35 +2266,41 @@
2505
2266
  }
2506
2267
  },
2507
2268
  "hasDynamicHelp": false,
2269
+ "hidden": true,
2508
2270
  "hiddenAliases": [],
2509
- "id": "blueprints:plan",
2271
+ "id": "functions:list",
2510
2272
  "pluginAlias": "@sanity/runtime-cli",
2511
2273
  "pluginName": "@sanity/runtime-cli",
2512
2274
  "pluginType": "core",
2513
2275
  "strict": true,
2514
- "summary": "Preview changes that will be applied to the remote Stack",
2276
+ "summary": "List deployed Sanity Functions",
2515
2277
  "enableJsonFlag": true,
2516
2278
  "needs": [
2517
- "token",
2518
- "blueprint"
2279
+ "scope"
2519
2280
  ],
2520
2281
  "isESM": true,
2521
2282
  "relativePath": [
2522
2283
  "dist",
2523
2284
  "commands",
2524
- "blueprints",
2525
- "plan.js"
2285
+ "functions",
2286
+ "list.js"
2526
2287
  ]
2527
2288
  },
2528
- "blueprints:promote": {
2289
+ "functions:logs": {
2529
2290
  "aliases": [],
2530
- "args": {},
2531
- "description": "Promotes a deployed Stack to organization scope, enabling management of org-level resources. Promotion cannot be reversed.\n\nYour local Blueprint configuration will be updated to reflect the new scope.",
2291
+ "args": {
2292
+ "name": {
2293
+ "description": "The name of the Sanity Function",
2294
+ "name": "name",
2295
+ "required": false
2296
+ }
2297
+ },
2298
+ "description": "Fetches execution logs from a deployed function, useful for debugging production issues or monitoring activity.\n\nUse --watch (-w) to stream logs in real-time. Use --delete to clear all logs for a function (requires confirmation unless --force is specified).",
2532
2299
  "examples": [
2533
- "<%= config.bin %> <%= command.id %>",
2534
- "<%= config.bin %> <%= command.id %> --stack <name-or-id>",
2535
- "<%= config.bin %> <%= command.id %> --project-id <projectId> --stack <name-or-id>",
2536
- "<%= config.bin %> <%= command.id %> --new-stack-name <new-name>"
2300
+ "<%= config.bin %> <%= command.id %> <name>",
2301
+ "<%= config.bin %> <%= command.id %> <name> --json",
2302
+ "<%= config.bin %> <%= command.id %> <name> --limit 100",
2303
+ "<%= config.bin %> <%= command.id %> <name> --delete"
2537
2304
  ],
2538
2305
  "flags": {
2539
2306
  "json": {
@@ -2577,10 +2344,7 @@
2577
2344
  "type": "boolean"
2578
2345
  },
2579
2346
  "stack": {
2580
- "aliases": [
2581
- "id"
2582
- ],
2583
- "description": "Stack name or ID to promote",
2347
+ "description": "Stack name or ID to use instead of the locally configured Stack",
2584
2348
  "name": "stack",
2585
2349
  "hasDynamicHelp": false,
2586
2350
  "multiple": false,
@@ -2595,6 +2359,7 @@
2595
2359
  "exclusive": [
2596
2360
  "organization-id"
2597
2361
  ],
2362
+ "hidden": true,
2598
2363
  "name": "project-id",
2599
2364
  "hasDynamicHelp": false,
2600
2365
  "multiple": false,
@@ -2616,28 +2381,69 @@
2616
2381
  "multiple": false,
2617
2382
  "type": "option"
2618
2383
  },
2384
+ "limit": {
2385
+ "char": "l",
2386
+ "description": "Total number of log entries to retrieve",
2387
+ "name": "limit",
2388
+ "required": false,
2389
+ "default": 50,
2390
+ "hasDynamicHelp": false,
2391
+ "multiple": false,
2392
+ "type": "option"
2393
+ },
2394
+ "utc": {
2395
+ "char": "u",
2396
+ "description": "Show dates in UTC time zone",
2397
+ "name": "utc",
2398
+ "required": false,
2399
+ "allowNo": false,
2400
+ "type": "boolean"
2401
+ },
2402
+ "delete": {
2403
+ "char": "d",
2404
+ "description": "Delete all logs for the function",
2405
+ "exclusive": [
2406
+ "limit",
2407
+ "json"
2408
+ ],
2409
+ "name": "delete",
2410
+ "required": false,
2411
+ "allowNo": false,
2412
+ "type": "boolean"
2413
+ },
2619
2414
  "force": {
2620
- "description": "Skip confirmation prompt",
2415
+ "char": "f",
2416
+ "dependsOn": [
2417
+ "delete"
2418
+ ],
2419
+ "description": "Skip confirmation for deleting logs",
2621
2420
  "name": "force",
2421
+ "required": false,
2622
2422
  "allowNo": false,
2623
2423
  "type": "boolean"
2624
2424
  },
2625
- "new-stack-name": {
2626
- "description": "Set a new name for the Stack while promoting",
2627
- "name": "new-stack-name",
2628
- "hasDynamicHelp": false,
2629
- "multiple": false,
2630
- "type": "option"
2425
+ "watch": {
2426
+ "aliases": [
2427
+ "follow"
2428
+ ],
2429
+ "char": "w",
2430
+ "description": "Watch for new logs (streaming mode)",
2431
+ "exclusive": [
2432
+ "json"
2433
+ ],
2434
+ "name": "watch",
2435
+ "allowNo": false,
2436
+ "type": "boolean"
2631
2437
  }
2632
2438
  },
2633
2439
  "hasDynamicHelp": false,
2634
2440
  "hiddenAliases": [],
2635
- "id": "blueprints:promote",
2441
+ "id": "functions:logs",
2636
2442
  "pluginAlias": "@sanity/runtime-cli",
2637
2443
  "pluginName": "@sanity/runtime-cli",
2638
2444
  "pluginType": "core",
2639
2445
  "strict": true,
2640
- "summary": "Promote a Stack from project scope to organization scope",
2446
+ "summary": "Retrieve or delete logs for a Sanity Function",
2641
2447
  "enableJsonFlag": true,
2642
2448
  "needs": [
2643
2449
  "deployedStack",
@@ -2647,20 +2453,25 @@
2647
2453
  "relativePath": [
2648
2454
  "dist",
2649
2455
  "commands",
2650
- "blueprints",
2651
- "promote.js"
2456
+ "functions",
2457
+ "logs.js"
2652
2458
  ]
2653
2459
  },
2654
- "blueprints:stacks": {
2460
+ "functions:test": {
2655
2461
  "aliases": [],
2656
- "args": {},
2657
- "description": "Shows all Stacks associated with a project or organization. By default, lists Stacks scoped to the local Blueprint.\n\nUse this to discover existing Stacks you can scope a local Blueprint to (using 'blueprints config --edit'), or to audit what's deployed across your project.\n\nWithout a scope, prompts for an organization or project. Use --all to list Stacks across every organization and project you can access, or --include-projects with --organization-id for one organization and its projects.",
2462
+ "args": {
2463
+ "name": {
2464
+ "description": "The name of the Sanity Function",
2465
+ "name": "name",
2466
+ "required": false
2467
+ }
2468
+ },
2469
+ "description": "Executes a function locally with the provided payload, simulating how it would run when deployed. Use this to test your function logic before deploying.\n\nProvide test data via --data (inline JSON), --file (JSON file), or --document-id (fetch from Sanity). For update events, use the before/after flag pairs to simulate document changes.",
2658
2470
  "examples": [
2659
- "<%= config.bin %> <%= command.id %>",
2660
- "<%= config.bin %> <%= command.id %> --all",
2661
- "<%= config.bin %> <%= command.id %> --project-id <projectId>",
2662
- "<%= config.bin %> <%= command.id %> --organization-id <organizationId>",
2663
- "<%= config.bin %> <%= command.id %> --organization-id <organizationId> --include-projects"
2471
+ "<%= config.bin %> <%= command.id %> <name> --data '{ \"id\": 1 }'",
2472
+ "<%= config.bin %> <%= command.id %> <name> --file 'payload.json'",
2473
+ "<%= config.bin %> <%= command.id %> <name> --data '{ \"id\": 1 }' --timeout 60",
2474
+ "<%= config.bin %> <%= command.id %> <name> --event update --data-before '{ \"title\": \"before\" }' --data-after '{ \"title\": \"after\" }'"
2664
2475
  ],
2665
2476
  "flags": {
2666
2477
  "json": {
@@ -2718,9 +2529,7 @@
2718
2529
  ],
2719
2530
  "description": "Sanity project ID used to scope Blueprint and Stack",
2720
2531
  "exclusive": [
2721
- "organization-id",
2722
- "include-projects",
2723
- "all"
2532
+ "organization-id"
2724
2533
  ],
2725
2534
  "name": "project-id",
2726
2535
  "hasDynamicHelp": false,
@@ -2735,53 +2544,244 @@
2735
2544
  ],
2736
2545
  "description": "Sanity organization ID used to scope Blueprint and Stack",
2737
2546
  "exclusive": [
2738
- "project-id",
2739
- "all"
2547
+ "project-id"
2740
2548
  ],
2741
2549
  "name": "organization-id",
2742
2550
  "hasDynamicHelp": false,
2743
2551
  "multiple": false,
2744
2552
  "type": "option"
2745
2553
  },
2746
- "include-projects": {
2747
- "dependsOn": [
2748
- "organization-id"
2554
+ "data": {
2555
+ "char": "d",
2556
+ "description": "Data to send to the function",
2557
+ "exclusive": [
2558
+ "file",
2559
+ "document-id"
2749
2560
  ],
2750
- "description": "Include Stacks from all projects within the organization. Requires --organization-id.",
2751
- "name": "include-projects",
2561
+ "name": "data",
2562
+ "required": false,
2563
+ "hasDynamicHelp": false,
2564
+ "multiple": false,
2565
+ "type": "option"
2566
+ },
2567
+ "data-before": {
2568
+ "description": "Original document",
2569
+ "exclusive": [
2570
+ "data",
2571
+ "file",
2572
+ "document-id",
2573
+ "file-before",
2574
+ "file-after",
2575
+ "document-id-before",
2576
+ "document-id-after"
2577
+ ],
2578
+ "name": "data-before",
2579
+ "required": false,
2580
+ "hasDynamicHelp": false,
2581
+ "multiple": false,
2582
+ "type": "option"
2583
+ },
2584
+ "data-after": {
2585
+ "description": "Current document",
2586
+ "exclusive": [
2587
+ "data",
2588
+ "file",
2589
+ "document-id",
2590
+ "file-before",
2591
+ "file-after",
2592
+ "document-id-before",
2593
+ "document-id-after"
2594
+ ],
2595
+ "name": "data-after",
2596
+ "required": false,
2597
+ "hasDynamicHelp": false,
2598
+ "multiple": false,
2599
+ "type": "option"
2600
+ },
2601
+ "event": {
2602
+ "char": "e",
2603
+ "description": "Type of event (create, update, delete)",
2604
+ "name": "event",
2605
+ "required": false,
2606
+ "hasDynamicHelp": false,
2607
+ "multiple": false,
2608
+ "options": [
2609
+ "create",
2610
+ "update",
2611
+ "delete"
2612
+ ],
2613
+ "type": "option"
2614
+ },
2615
+ "file": {
2616
+ "char": "f",
2617
+ "description": "Read data from file and send to the function",
2618
+ "exclusive": [
2619
+ "data",
2620
+ "document-id"
2621
+ ],
2622
+ "name": "file",
2623
+ "required": false,
2624
+ "hasDynamicHelp": false,
2625
+ "multiple": false,
2626
+ "type": "option"
2627
+ },
2628
+ "file-before": {
2629
+ "description": "Original document",
2630
+ "exclusive": [
2631
+ "data",
2632
+ "file",
2633
+ "document-id",
2634
+ "data-before",
2635
+ "data-after",
2636
+ "document-id-before",
2637
+ "document-id-after"
2638
+ ],
2639
+ "name": "file-before",
2640
+ "required": false,
2641
+ "hasDynamicHelp": false,
2642
+ "multiple": false,
2643
+ "type": "option"
2644
+ },
2645
+ "file-after": {
2646
+ "description": "Current document",
2647
+ "exclusive": [
2648
+ "data",
2649
+ "file",
2650
+ "document-id",
2651
+ "data-before",
2652
+ "data-after",
2653
+ "document-id-before",
2654
+ "document-id-after"
2655
+ ],
2656
+ "name": "file-after",
2657
+ "required": false,
2658
+ "hasDynamicHelp": false,
2659
+ "multiple": false,
2660
+ "type": "option"
2661
+ },
2662
+ "timeout": {
2663
+ "char": "t",
2664
+ "description": "Execution timeout value in seconds",
2665
+ "name": "timeout",
2666
+ "required": false,
2667
+ "hasDynamicHelp": false,
2668
+ "multiple": false,
2669
+ "type": "option"
2670
+ },
2671
+ "api": {
2672
+ "char": "a",
2673
+ "description": "Sanity API Version to use",
2674
+ "name": "api",
2675
+ "required": false,
2676
+ "hasDynamicHelp": false,
2677
+ "multiple": false,
2678
+ "type": "option"
2679
+ },
2680
+ "dataset": {
2681
+ "description": "The Sanity dataset to use",
2682
+ "name": "dataset",
2683
+ "required": false,
2684
+ "hasDynamicHelp": false,
2685
+ "multiple": false,
2686
+ "type": "option"
2687
+ },
2688
+ "document-id": {
2689
+ "aliases": [
2690
+ "doc",
2691
+ "documentId"
2692
+ ],
2693
+ "description": "Document to fetch and send to function",
2694
+ "exclusive": [
2695
+ "data",
2696
+ "file"
2697
+ ],
2698
+ "name": "document-id",
2699
+ "required": false,
2700
+ "hasDynamicHelp": false,
2701
+ "multiple": false,
2702
+ "type": "option"
2703
+ },
2704
+ "document-id-before": {
2705
+ "description": "Original document",
2706
+ "exclusive": [
2707
+ "data",
2708
+ "file",
2709
+ "document-id",
2710
+ "data-before",
2711
+ "data-after",
2712
+ "file-before",
2713
+ "file-after"
2714
+ ],
2715
+ "name": "document-id-before",
2716
+ "required": false,
2717
+ "hasDynamicHelp": false,
2718
+ "multiple": false,
2719
+ "type": "option"
2720
+ },
2721
+ "document-id-after": {
2722
+ "description": "Current document",
2723
+ "exclusive": [
2724
+ "data",
2725
+ "file",
2726
+ "document-id",
2727
+ "data-before",
2728
+ "data-after",
2729
+ "file-before",
2730
+ "file-after"
2731
+ ],
2732
+ "name": "document-id-after",
2733
+ "required": false,
2734
+ "hasDynamicHelp": false,
2735
+ "multiple": false,
2736
+ "type": "option"
2737
+ },
2738
+ "with-user-token": {
2739
+ "description": "Prime access token from CLI config",
2740
+ "name": "with-user-token",
2752
2741
  "allowNo": false,
2753
2742
  "type": "boolean"
2754
2743
  },
2755
- "all": {
2756
- "description": "List Stacks from every organization and project you have access to",
2744
+ "media-library-id": {
2745
+ "aliases": [
2746
+ "media"
2747
+ ],
2748
+ "description": "Sanity Media Library ID to use",
2757
2749
  "exclusive": [
2758
2750
  "project-id",
2759
- "organization-id",
2760
- "include-projects"
2751
+ "dataset"
2761
2752
  ],
2762
- "name": "all",
2753
+ "name": "media-library-id",
2754
+ "required": false,
2755
+ "hasDynamicHelp": false,
2756
+ "multiple": false,
2757
+ "type": "option"
2758
+ },
2759
+ "no-wait": {
2760
+ "description": "Skip durable wait delays instead of sleeping",
2761
+ "name": "no-wait",
2762
+ "required": false,
2763
2763
  "allowNo": false,
2764
2764
  "type": "boolean"
2765
2765
  }
2766
2766
  },
2767
2767
  "hasDynamicHelp": false,
2768
2768
  "hiddenAliases": [],
2769
- "id": "blueprints:stacks",
2769
+ "id": "functions:test",
2770
2770
  "pluginAlias": "@sanity/runtime-cli",
2771
2771
  "pluginName": "@sanity/runtime-cli",
2772
2772
  "pluginType": "core",
2773
2773
  "strict": true,
2774
- "summary": "List remote Stack deployments for your project or organization",
2774
+ "summary": "Invoke a local Sanity Function",
2775
2775
  "enableJsonFlag": true,
2776
2776
  "needs": [
2777
- "token"
2777
+ "blueprint"
2778
2778
  ],
2779
2779
  "isESM": true,
2780
2780
  "relativePath": [
2781
2781
  "dist",
2782
2782
  "commands",
2783
- "blueprints",
2784
- "stacks.js"
2783
+ "functions",
2784
+ "test.js"
2785
2785
  ]
2786
2786
  },
2787
2787
  "functions:env:add": {
@@ -3148,5 +3148,5 @@
3148
3148
  ]
3149
3149
  }
3150
3150
  },
3151
- "version": "17.13.0-next.g2501ffa"
3151
+ "version": "17.13.0"
3152
3152
  }