@sanity/runtime-cli 16.0.3 → 17.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +27 -22
- package/dist/actions/functions/test.js +1 -1
- package/dist/baseCommands.js +13 -2
- package/dist/commands/blueprints/init.js +5 -2
- package/dist/config.d.ts +1 -0
- package/dist/config.js +7 -1
- package/dist/constants.d.ts +1 -0
- package/dist/constants.js +1 -0
- package/dist/cores/blueprints/init.js +16 -2
- package/dist/cores/functions/test.js +44 -0
- package/dist/server/app.js +31 -3
- package/dist/server/handlers/invoke.d.ts +2 -2
- package/dist/server/handlers/invoke.js +7 -4
- package/dist/server/static/components/console-panel.js +59 -8
- package/dist/server/static/components/rule-panel.js +11 -8
- package/dist/server/static/components/shared-styles.js +24 -21
- package/dist/server/static/index.html +1 -1
- package/dist/server/static/vendor/design-tokens/color.css +48 -48
- package/dist/server/static/vendor/design-tokens/index.css +0 -1
- package/dist/server/static/vendor/vendor.bundle.js +3807 -3259
- package/dist/server/static/web-socket.js +41 -0
- package/dist/utils/functions/child-process-wrapper.js +62 -7
- package/dist/utils/functions/{invoke-local.d.ts → invoke/local.d.ts} +1 -1
- package/dist/utils/functions/invoke/local.js +306 -0
- package/dist/utils/functions/invoke/nested.d.ts +25 -0
- package/dist/utils/functions/invoke/nested.js +41 -0
- package/dist/utils/functions/invoke/prepare.d.ts +20 -0
- package/dist/utils/functions/invoke/prepare.js +90 -0
- package/dist/utils/interactive.d.ts +1 -0
- package/dist/utils/interactive.js +4 -0
- package/dist/utils/isTrueish.d.ts +6 -0
- package/dist/utils/isTrueish.js +9 -0
- package/dist/utils/logger.d.ts +1 -0
- package/dist/utils/logger.js +1 -0
- package/dist/utils/style-text.js +4 -5
- package/dist/utils/traced-fetch.js +2 -0
- package/dist/utils/types.d.ts +62 -4
- package/oclif.manifest.json +928 -927
- package/package.json +18 -14
- package/dist/server/static/hot-reload.js +0 -16
- package/dist/utils/functions/invoke-local.js +0 -185
package/oclif.manifest.json
CHANGED
|
@@ -1,27 +1,15 @@
|
|
|
1
1
|
{
|
|
2
2
|
"commands": {
|
|
3
|
-
"
|
|
3
|
+
"functions:add": {
|
|
4
4
|
"aliases": [],
|
|
5
|
-
"args": {
|
|
6
|
-
|
|
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",
|
|
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.",
|
|
19
7
|
"examples": [
|
|
20
|
-
"<%= config.bin %> <%= command.id %>
|
|
21
|
-
"<%= config.bin %> <%= command.id %>
|
|
22
|
-
"<%= config.bin %> <%= command.id %>
|
|
23
|
-
"<%= config.bin %> <%= command.id %>
|
|
24
|
-
"<%= config.bin %> <%= command.id %>
|
|
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"
|
|
25
13
|
],
|
|
26
14
|
"flags": {
|
|
27
15
|
"json": {
|
|
@@ -107,7 +95,7 @@
|
|
|
107
95
|
"aliases": [
|
|
108
96
|
"recipe"
|
|
109
97
|
],
|
|
110
|
-
"description": "Example to use for the
|
|
98
|
+
"description": "Example to use for the Function",
|
|
111
99
|
"exclusive": [
|
|
112
100
|
"name",
|
|
113
101
|
"fn-type",
|
|
@@ -123,21 +111,18 @@
|
|
|
123
111
|
},
|
|
124
112
|
"name": {
|
|
125
113
|
"char": "n",
|
|
126
|
-
"description": "Name of the
|
|
114
|
+
"description": "Name of the Function to add",
|
|
127
115
|
"name": "name",
|
|
128
116
|
"hasDynamicHelp": false,
|
|
129
117
|
"multiple": false,
|
|
130
118
|
"type": "option"
|
|
131
119
|
},
|
|
132
|
-
"
|
|
133
|
-
"aliases": [
|
|
134
|
-
"function-type"
|
|
135
|
-
],
|
|
120
|
+
"type": {
|
|
136
121
|
"dependsOn": [
|
|
137
122
|
"name"
|
|
138
123
|
],
|
|
139
124
|
"description": "Document change event(s) that should trigger the function; you can specify multiple events by specifying this flag multiple times",
|
|
140
|
-
"name": "
|
|
125
|
+
"name": "type",
|
|
141
126
|
"hasDynamicHelp": false,
|
|
142
127
|
"multiple": true,
|
|
143
128
|
"options": [
|
|
@@ -155,11 +140,9 @@
|
|
|
155
140
|
},
|
|
156
141
|
"language": {
|
|
157
142
|
"aliases": [
|
|
158
|
-
"function-language",
|
|
159
|
-
"fn-language",
|
|
160
143
|
"lang"
|
|
161
144
|
],
|
|
162
|
-
"description": "Language of the new
|
|
145
|
+
"description": "Language of the new Function",
|
|
163
146
|
"name": "language",
|
|
164
147
|
"default": "ts",
|
|
165
148
|
"hasDynamicHelp": false,
|
|
@@ -182,23 +165,15 @@
|
|
|
182
165
|
"allowNo": false,
|
|
183
166
|
"type": "boolean"
|
|
184
167
|
},
|
|
185
|
-
"
|
|
186
|
-
"
|
|
187
|
-
|
|
188
|
-
"helpers"
|
|
189
|
-
],
|
|
190
|
-
"description": "Add helpers to the new function",
|
|
191
|
-
"name": "fn-helpers",
|
|
168
|
+
"helpers": {
|
|
169
|
+
"description": "Add helpers to the new Function",
|
|
170
|
+
"name": "helpers",
|
|
192
171
|
"allowNo": true,
|
|
193
172
|
"type": "boolean"
|
|
194
173
|
},
|
|
195
|
-
"
|
|
196
|
-
"
|
|
197
|
-
|
|
198
|
-
"installer"
|
|
199
|
-
],
|
|
200
|
-
"description": "Which package manager to use when installing the @sanity/functions helpers",
|
|
201
|
-
"name": "fn-installer",
|
|
174
|
+
"installer": {
|
|
175
|
+
"description": "How to install the @sanity/functions helpers",
|
|
176
|
+
"name": "installer",
|
|
202
177
|
"hasDynamicHelp": false,
|
|
203
178
|
"multiple": false,
|
|
204
179
|
"options": [
|
|
@@ -222,13 +197,12 @@
|
|
|
222
197
|
},
|
|
223
198
|
"hasDynamicHelp": false,
|
|
224
199
|
"hiddenAliases": [],
|
|
225
|
-
"id": "
|
|
200
|
+
"id": "functions:add",
|
|
226
201
|
"pluginAlias": "@sanity/runtime-cli",
|
|
227
202
|
"pluginName": "@sanity/runtime-cli",
|
|
228
203
|
"pluginType": "core",
|
|
229
|
-
"state": "deprecated",
|
|
230
204
|
"strict": true,
|
|
231
|
-
"summary": "
|
|
205
|
+
"summary": "Add a Function to your Blueprint",
|
|
232
206
|
"enableJsonFlag": true,
|
|
233
207
|
"needs": [
|
|
234
208
|
"blueprint"
|
|
@@ -237,20 +211,19 @@
|
|
|
237
211
|
"relativePath": [
|
|
238
212
|
"dist",
|
|
239
213
|
"commands",
|
|
240
|
-
"
|
|
214
|
+
"functions",
|
|
241
215
|
"add.js"
|
|
242
216
|
]
|
|
243
217
|
},
|
|
244
|
-
"
|
|
218
|
+
"functions:build": {
|
|
245
219
|
"aliases": [],
|
|
246
|
-
"args": {
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
],
|
|
220
|
+
"args": {
|
|
221
|
+
"name": {
|
|
222
|
+
"description": "The name of the Sanity Function",
|
|
223
|
+
"name": "name",
|
|
224
|
+
"required": false
|
|
225
|
+
}
|
|
226
|
+
},
|
|
254
227
|
"flags": {
|
|
255
228
|
"json": {
|
|
256
229
|
"description": "Format output as json",
|
|
@@ -293,14 +266,8 @@
|
|
|
293
266
|
"type": "boolean"
|
|
294
267
|
},
|
|
295
268
|
"stack": {
|
|
296
|
-
"
|
|
297
|
-
|
|
298
|
-
"stackId"
|
|
299
|
-
],
|
|
300
|
-
"dependsOn": [
|
|
301
|
-
"edit"
|
|
302
|
-
],
|
|
303
|
-
"description": "Stack name or ID to set in the configuration. Requires --edit flag",
|
|
269
|
+
"description": "Stack name or ID to use instead of the locally configured Stack",
|
|
270
|
+
"hidden": true,
|
|
304
271
|
"name": "stack",
|
|
305
272
|
"hasDynamicHelp": false,
|
|
306
273
|
"multiple": false,
|
|
@@ -311,13 +278,11 @@
|
|
|
311
278
|
"project",
|
|
312
279
|
"projectId"
|
|
313
280
|
],
|
|
314
|
-
"dependsOn": [
|
|
315
|
-
"edit"
|
|
316
|
-
],
|
|
317
281
|
"description": "Sanity project ID used to scope Blueprint and Stack",
|
|
318
282
|
"exclusive": [
|
|
319
283
|
"organization-id"
|
|
320
284
|
],
|
|
285
|
+
"hidden": true,
|
|
321
286
|
"name": "project-id",
|
|
322
287
|
"hasDynamicHelp": false,
|
|
323
288
|
"multiple": false,
|
|
@@ -329,59 +294,70 @@
|
|
|
329
294
|
"organizationId",
|
|
330
295
|
"org"
|
|
331
296
|
],
|
|
332
|
-
"dependsOn": [
|
|
333
|
-
"edit"
|
|
334
|
-
],
|
|
335
297
|
"description": "Sanity organization ID used to scope Blueprint and Stack",
|
|
336
298
|
"exclusive": [
|
|
337
299
|
"project-id"
|
|
338
300
|
],
|
|
301
|
+
"hidden": true,
|
|
339
302
|
"name": "organization-id",
|
|
340
303
|
"hasDynamicHelp": false,
|
|
341
304
|
"multiple": false,
|
|
342
305
|
"type": "option"
|
|
343
306
|
},
|
|
344
|
-
"
|
|
345
|
-
"
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
"
|
|
307
|
+
"fn-installer": {
|
|
308
|
+
"aliases": [
|
|
309
|
+
"function-installer",
|
|
310
|
+
"installer"
|
|
311
|
+
],
|
|
312
|
+
"description": "Which package manager to use when building Functions",
|
|
313
|
+
"hidden": true,
|
|
314
|
+
"name": "fn-installer",
|
|
315
|
+
"hasDynamicHelp": false,
|
|
316
|
+
"multiple": false,
|
|
317
|
+
"options": [
|
|
318
|
+
"npm",
|
|
319
|
+
"pnpm",
|
|
320
|
+
"yarn"
|
|
321
|
+
],
|
|
322
|
+
"type": "option"
|
|
323
|
+
},
|
|
324
|
+
"out-dir": {
|
|
325
|
+
"char": "o",
|
|
326
|
+
"description": "Output directory for zip files",
|
|
327
|
+
"name": "out-dir",
|
|
328
|
+
"hasDynamicHelp": false,
|
|
329
|
+
"multiple": false,
|
|
330
|
+
"type": "option"
|
|
350
331
|
}
|
|
351
332
|
},
|
|
352
333
|
"hasDynamicHelp": false,
|
|
334
|
+
"hidden": true,
|
|
353
335
|
"hiddenAliases": [],
|
|
354
|
-
"id": "
|
|
336
|
+
"id": "functions:build",
|
|
355
337
|
"pluginAlias": "@sanity/runtime-cli",
|
|
356
338
|
"pluginName": "@sanity/runtime-cli",
|
|
357
339
|
"pluginType": "core",
|
|
358
340
|
"strict": true,
|
|
359
|
-
"summary": "
|
|
341
|
+
"summary": "Build Sanity Function(s) to zip archives",
|
|
360
342
|
"enableJsonFlag": true,
|
|
361
343
|
"needs": [
|
|
362
|
-
"token",
|
|
363
344
|
"blueprint"
|
|
364
345
|
],
|
|
365
346
|
"isESM": true,
|
|
366
347
|
"relativePath": [
|
|
367
348
|
"dist",
|
|
368
349
|
"commands",
|
|
369
|
-
"
|
|
370
|
-
"
|
|
350
|
+
"functions",
|
|
351
|
+
"build.js"
|
|
371
352
|
]
|
|
372
353
|
},
|
|
373
|
-
"
|
|
354
|
+
"functions:dev": {
|
|
374
355
|
"aliases": [],
|
|
375
356
|
"args": {},
|
|
376
|
-
"description": "
|
|
357
|
+
"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. Function timeout can be configured with the --timeout flag.\n\nTo invoke a function with the CLI, use 'functions test'.",
|
|
377
358
|
"examples": [
|
|
378
|
-
"<%= config.bin %> <%= command.id %>",
|
|
379
|
-
"<%= config.bin %> <%= command.id %> --
|
|
380
|
-
"<%= config.bin %> <%= command.id %> --no-wait",
|
|
381
|
-
"<%= config.bin %> <%= command.id %> --fn-installer npm",
|
|
382
|
-
"<%= config.bin %> <%= command.id %> --stack <name-or-id>",
|
|
383
|
-
"<%= config.bin %> <%= command.id %> --organization-id <orgId> --stack <name-or-id>",
|
|
384
|
-
"<%= config.bin %> <%= command.id %> --new-stack-name <new-name>"
|
|
359
|
+
"<%= config.bin %> <%= command.id %> --host 127.0.0.1 --port 8974",
|
|
360
|
+
"<%= config.bin %> <%= command.id %> --timeout 60"
|
|
385
361
|
],
|
|
386
362
|
"flags": {
|
|
387
363
|
"json": {
|
|
@@ -426,6 +402,7 @@
|
|
|
426
402
|
},
|
|
427
403
|
"stack": {
|
|
428
404
|
"description": "Stack name or ID to use instead of the locally configured Stack",
|
|
405
|
+
"hidden": true,
|
|
429
406
|
"name": "stack",
|
|
430
407
|
"hasDynamicHelp": false,
|
|
431
408
|
"multiple": false,
|
|
@@ -440,6 +417,7 @@
|
|
|
440
417
|
"exclusive": [
|
|
441
418
|
"organization-id"
|
|
442
419
|
],
|
|
420
|
+
"hidden": true,
|
|
443
421
|
"name": "project-id",
|
|
444
422
|
"hasDynamicHelp": false,
|
|
445
423
|
"multiple": false,
|
|
@@ -455,45 +433,35 @@
|
|
|
455
433
|
"exclusive": [
|
|
456
434
|
"project-id"
|
|
457
435
|
],
|
|
436
|
+
"hidden": true,
|
|
458
437
|
"name": "organization-id",
|
|
459
438
|
"hasDynamicHelp": false,
|
|
460
439
|
"multiple": false,
|
|
461
440
|
"type": "option"
|
|
462
441
|
},
|
|
463
|
-
"
|
|
464
|
-
"char": "
|
|
465
|
-
"description": "
|
|
466
|
-
"name": "
|
|
442
|
+
"host": {
|
|
443
|
+
"char": "h",
|
|
444
|
+
"description": "The local network interface at which to listen. [default: \"localhost\"]",
|
|
445
|
+
"name": "host",
|
|
446
|
+
"required": false,
|
|
467
447
|
"hasDynamicHelp": false,
|
|
468
448
|
"multiple": false,
|
|
469
449
|
"type": "option"
|
|
470
450
|
},
|
|
471
|
-
"
|
|
472
|
-
"
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
"description": "Which package manager to use when installing Function dependencies",
|
|
477
|
-
"hidden": true,
|
|
478
|
-
"name": "fn-installer",
|
|
451
|
+
"port": {
|
|
452
|
+
"char": "p",
|
|
453
|
+
"description": "TCP port to start emulator on. [default: 8080]",
|
|
454
|
+
"name": "port",
|
|
455
|
+
"required": false,
|
|
479
456
|
"hasDynamicHelp": false,
|
|
480
457
|
"multiple": false,
|
|
481
|
-
"options": [
|
|
482
|
-
"npm",
|
|
483
|
-
"pnpm",
|
|
484
|
-
"yarn"
|
|
485
|
-
],
|
|
486
458
|
"type": "option"
|
|
487
459
|
},
|
|
488
|
-
"
|
|
489
|
-
"
|
|
490
|
-
"
|
|
491
|
-
"
|
|
492
|
-
"
|
|
493
|
-
},
|
|
494
|
-
"new-stack-name": {
|
|
495
|
-
"description": "Set a new name for the Stack",
|
|
496
|
-
"name": "new-stack-name",
|
|
460
|
+
"timeout": {
|
|
461
|
+
"char": "t",
|
|
462
|
+
"description": "Maximum execution time for all functions, in seconds. Takes precedence over function-specific `timeout`",
|
|
463
|
+
"name": "timeout",
|
|
464
|
+
"required": false,
|
|
497
465
|
"hasDynamicHelp": false,
|
|
498
466
|
"multiple": false,
|
|
499
467
|
"type": "option"
|
|
@@ -501,32 +469,39 @@
|
|
|
501
469
|
},
|
|
502
470
|
"hasDynamicHelp": false,
|
|
503
471
|
"hiddenAliases": [],
|
|
504
|
-
"id": "
|
|
472
|
+
"id": "functions:dev",
|
|
505
473
|
"pluginAlias": "@sanity/runtime-cli",
|
|
506
474
|
"pluginName": "@sanity/runtime-cli",
|
|
507
475
|
"pluginType": "core",
|
|
508
476
|
"strict": true,
|
|
509
|
-
"summary": "
|
|
477
|
+
"summary": "Start the Sanity Function emulator",
|
|
510
478
|
"enableJsonFlag": true,
|
|
511
479
|
"needs": [
|
|
512
|
-
"deployedStack",
|
|
513
480
|
"blueprint"
|
|
514
481
|
],
|
|
515
482
|
"isESM": true,
|
|
516
483
|
"relativePath": [
|
|
517
484
|
"dist",
|
|
518
485
|
"commands",
|
|
519
|
-
"
|
|
520
|
-
"
|
|
486
|
+
"functions",
|
|
487
|
+
"dev.js"
|
|
521
488
|
]
|
|
522
489
|
},
|
|
523
|
-
"
|
|
490
|
+
"functions:logs": {
|
|
524
491
|
"aliases": [],
|
|
525
|
-
"args": {
|
|
526
|
-
|
|
492
|
+
"args": {
|
|
493
|
+
"name": {
|
|
494
|
+
"description": "The name of the Sanity Function",
|
|
495
|
+
"name": "name",
|
|
496
|
+
"required": false
|
|
497
|
+
}
|
|
498
|
+
},
|
|
499
|
+
"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).",
|
|
527
500
|
"examples": [
|
|
528
|
-
"<%= config.bin %> <%= command.id %>",
|
|
529
|
-
"<%= config.bin %> <%= command.id %>
|
|
501
|
+
"<%= config.bin %> <%= command.id %> <name>",
|
|
502
|
+
"<%= config.bin %> <%= command.id %> <name> --json",
|
|
503
|
+
"<%= config.bin %> <%= command.id %> <name> --limit 100",
|
|
504
|
+
"<%= config.bin %> <%= command.id %> <name> --delete"
|
|
530
505
|
],
|
|
531
506
|
"flags": {
|
|
532
507
|
"json": {
|
|
@@ -570,11 +545,7 @@
|
|
|
570
545
|
"type": "boolean"
|
|
571
546
|
},
|
|
572
547
|
"stack": {
|
|
573
|
-
"
|
|
574
|
-
"stack-id",
|
|
575
|
-
"stackId"
|
|
576
|
-
],
|
|
577
|
-
"description": "Stack name or ID to destroy (defaults to the locally configured Stack)",
|
|
548
|
+
"description": "Stack name or ID to use instead of the locally configured Stack",
|
|
578
549
|
"name": "stack",
|
|
579
550
|
"hasDynamicHelp": false,
|
|
580
551
|
"multiple": false,
|
|
@@ -585,14 +556,11 @@
|
|
|
585
556
|
"project",
|
|
586
557
|
"projectId"
|
|
587
558
|
],
|
|
588
|
-
"dependsOn": [
|
|
589
|
-
"stack",
|
|
590
|
-
"force"
|
|
591
|
-
],
|
|
592
559
|
"description": "Sanity project ID used to scope Blueprint and Stack",
|
|
593
560
|
"exclusive": [
|
|
594
561
|
"organization-id"
|
|
595
562
|
],
|
|
563
|
+
"hidden": true,
|
|
596
564
|
"name": "project-id",
|
|
597
565
|
"hasDynamicHelp": false,
|
|
598
566
|
"multiple": false,
|
|
@@ -604,62 +572,104 @@
|
|
|
604
572
|
"organizationId",
|
|
605
573
|
"org"
|
|
606
574
|
],
|
|
607
|
-
"dependsOn": [
|
|
608
|
-
"stack",
|
|
609
|
-
"force"
|
|
610
|
-
],
|
|
611
575
|
"description": "Sanity organization ID used to scope Blueprint and Stack",
|
|
612
576
|
"exclusive": [
|
|
613
577
|
"project-id"
|
|
614
578
|
],
|
|
579
|
+
"hidden": true,
|
|
615
580
|
"name": "organization-id",
|
|
616
581
|
"hasDynamicHelp": false,
|
|
617
582
|
"multiple": false,
|
|
618
583
|
"type": "option"
|
|
619
584
|
},
|
|
620
|
-
"
|
|
621
|
-
"
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
"
|
|
625
|
-
"
|
|
626
|
-
"
|
|
627
|
-
"
|
|
628
|
-
|
|
629
|
-
|
|
630
|
-
|
|
631
|
-
"
|
|
585
|
+
"limit": {
|
|
586
|
+
"char": "l",
|
|
587
|
+
"description": "Total number of log entries to retrieve",
|
|
588
|
+
"name": "limit",
|
|
589
|
+
"required": false,
|
|
590
|
+
"default": 50,
|
|
591
|
+
"hasDynamicHelp": false,
|
|
592
|
+
"multiple": false,
|
|
593
|
+
"type": "option"
|
|
594
|
+
},
|
|
595
|
+
"utc": {
|
|
596
|
+
"char": "u",
|
|
597
|
+
"description": "Show dates in UTC time zone",
|
|
598
|
+
"name": "utc",
|
|
599
|
+
"required": false,
|
|
600
|
+
"allowNo": false,
|
|
601
|
+
"type": "boolean"
|
|
602
|
+
},
|
|
603
|
+
"delete": {
|
|
604
|
+
"char": "d",
|
|
605
|
+
"description": "Delete all logs for the function",
|
|
606
|
+
"exclusive": [
|
|
607
|
+
"limit",
|
|
608
|
+
"json"
|
|
609
|
+
],
|
|
610
|
+
"name": "delete",
|
|
611
|
+
"required": false,
|
|
612
|
+
"allowNo": false,
|
|
613
|
+
"type": "boolean"
|
|
614
|
+
},
|
|
615
|
+
"force": {
|
|
616
|
+
"char": "f",
|
|
617
|
+
"dependsOn": [
|
|
618
|
+
"delete"
|
|
619
|
+
],
|
|
620
|
+
"description": "Skip confirmation for deleting logs",
|
|
621
|
+
"name": "force",
|
|
622
|
+
"required": false,
|
|
623
|
+
"allowNo": false,
|
|
624
|
+
"type": "boolean"
|
|
625
|
+
},
|
|
626
|
+
"watch": {
|
|
627
|
+
"aliases": [
|
|
628
|
+
"follow"
|
|
629
|
+
],
|
|
630
|
+
"char": "w",
|
|
631
|
+
"description": "Watch for new logs (streaming mode)",
|
|
632
|
+
"name": "watch",
|
|
632
633
|
"allowNo": false,
|
|
633
634
|
"type": "boolean"
|
|
634
635
|
}
|
|
635
636
|
},
|
|
636
637
|
"hasDynamicHelp": false,
|
|
637
638
|
"hiddenAliases": [],
|
|
638
|
-
"id": "
|
|
639
|
+
"id": "functions:logs",
|
|
639
640
|
"pluginAlias": "@sanity/runtime-cli",
|
|
640
641
|
"pluginName": "@sanity/runtime-cli",
|
|
641
642
|
"pluginType": "core",
|
|
642
643
|
"strict": true,
|
|
643
|
-
"summary": "
|
|
644
|
+
"summary": "Retrieve or delete logs for a Sanity Function",
|
|
644
645
|
"enableJsonFlag": true,
|
|
645
646
|
"needs": [
|
|
646
|
-
"
|
|
647
|
+
"deployedStack",
|
|
648
|
+
"blueprint"
|
|
647
649
|
],
|
|
648
650
|
"isESM": true,
|
|
649
651
|
"relativePath": [
|
|
650
652
|
"dist",
|
|
651
653
|
"commands",
|
|
652
|
-
"
|
|
653
|
-
"
|
|
654
|
+
"functions",
|
|
655
|
+
"logs.js"
|
|
654
656
|
]
|
|
655
657
|
},
|
|
656
|
-
"
|
|
658
|
+
"functions:test": {
|
|
657
659
|
"aliases": [],
|
|
658
|
-
"args": {
|
|
659
|
-
|
|
660
|
+
"args": {
|
|
661
|
+
"name": {
|
|
662
|
+
"description": "The name of the Sanity Function",
|
|
663
|
+
"name": "name",
|
|
664
|
+
"required": false
|
|
665
|
+
}
|
|
666
|
+
},
|
|
667
|
+
"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.",
|
|
660
668
|
"examples": [
|
|
661
|
-
"<%= config.bin %> <%= command.id %>",
|
|
662
|
-
"<%= config.bin %> <%= command.id %> --
|
|
669
|
+
"<%= config.bin %> <%= command.id %> <name> --data '{ \"id\": 1 }'",
|
|
670
|
+
"<%= config.bin %> <%= command.id %> <name> --file 'payload.json'",
|
|
671
|
+
"<%= config.bin %> <%= command.id %> <name> --data '{ \"id\": 1 }' --timeout 60",
|
|
672
|
+
"<%= config.bin %> <%= command.id %> <name> --event update --data-before '{ \"title\": \"before\" }' --data-after '{ \"title\": \"after\" }'"
|
|
663
673
|
],
|
|
664
674
|
"flags": {
|
|
665
675
|
"json": {
|
|
@@ -672,67 +682,321 @@
|
|
|
672
682
|
"aliases": [
|
|
673
683
|
"blueprint-path"
|
|
674
684
|
],
|
|
675
|
-
"char": "p",
|
|
676
|
-
"description": "Path to a Blueprint file or directory containing one",
|
|
677
|
-
"env": "SANITY_BLUEPRINT_PATH",
|
|
678
|
-
"
|
|
685
|
+
"char": "p",
|
|
686
|
+
"description": "Path to a Blueprint file or directory containing one",
|
|
687
|
+
"env": "SANITY_BLUEPRINT_PATH",
|
|
688
|
+
"hidden": true,
|
|
689
|
+
"name": "path",
|
|
690
|
+
"hasDynamicHelp": false,
|
|
691
|
+
"multiple": false,
|
|
692
|
+
"type": "option"
|
|
693
|
+
},
|
|
694
|
+
"trace": {
|
|
695
|
+
"description": "Trace output",
|
|
696
|
+
"hidden": true,
|
|
697
|
+
"name": "trace",
|
|
698
|
+
"allowNo": false,
|
|
699
|
+
"type": "boolean"
|
|
700
|
+
},
|
|
701
|
+
"validate-resources": {
|
|
702
|
+
"description": "Validate resources",
|
|
703
|
+
"hidden": true,
|
|
704
|
+
"name": "validate-resources",
|
|
705
|
+
"allowNo": true,
|
|
706
|
+
"type": "boolean"
|
|
707
|
+
},
|
|
708
|
+
"verbose": {
|
|
709
|
+
"description": "Verbose output",
|
|
710
|
+
"hidden": true,
|
|
711
|
+
"name": "verbose",
|
|
712
|
+
"allowNo": false,
|
|
713
|
+
"type": "boolean"
|
|
714
|
+
},
|
|
715
|
+
"stack": {
|
|
716
|
+
"description": "Stack name or ID to use instead of the locally configured Stack",
|
|
717
|
+
"hidden": true,
|
|
718
|
+
"name": "stack",
|
|
719
|
+
"hasDynamicHelp": false,
|
|
720
|
+
"multiple": false,
|
|
721
|
+
"type": "option"
|
|
722
|
+
},
|
|
723
|
+
"project-id": {
|
|
724
|
+
"aliases": [
|
|
725
|
+
"project",
|
|
726
|
+
"projectId"
|
|
727
|
+
],
|
|
728
|
+
"description": "Sanity project ID used to scope Blueprint and Stack",
|
|
729
|
+
"exclusive": [
|
|
730
|
+
"organization-id"
|
|
731
|
+
],
|
|
732
|
+
"name": "project-id",
|
|
733
|
+
"hasDynamicHelp": false,
|
|
734
|
+
"multiple": false,
|
|
735
|
+
"type": "option"
|
|
736
|
+
},
|
|
737
|
+
"organization-id": {
|
|
738
|
+
"aliases": [
|
|
739
|
+
"organization",
|
|
740
|
+
"organizationId",
|
|
741
|
+
"org"
|
|
742
|
+
],
|
|
743
|
+
"description": "Sanity organization ID used to scope Blueprint and Stack",
|
|
744
|
+
"exclusive": [
|
|
745
|
+
"project-id"
|
|
746
|
+
],
|
|
747
|
+
"name": "organization-id",
|
|
748
|
+
"hasDynamicHelp": false,
|
|
749
|
+
"multiple": false,
|
|
750
|
+
"type": "option"
|
|
751
|
+
},
|
|
752
|
+
"data": {
|
|
753
|
+
"char": "d",
|
|
754
|
+
"description": "Data to send to the function",
|
|
755
|
+
"exclusive": [
|
|
756
|
+
"file",
|
|
757
|
+
"document-id"
|
|
758
|
+
],
|
|
759
|
+
"name": "data",
|
|
760
|
+
"required": false,
|
|
761
|
+
"hasDynamicHelp": false,
|
|
762
|
+
"multiple": false,
|
|
763
|
+
"type": "option"
|
|
764
|
+
},
|
|
765
|
+
"data-before": {
|
|
766
|
+
"description": "Original document",
|
|
767
|
+
"exclusive": [
|
|
768
|
+
"data",
|
|
769
|
+
"file",
|
|
770
|
+
"document-id",
|
|
771
|
+
"file-before",
|
|
772
|
+
"file-after",
|
|
773
|
+
"document-id-before",
|
|
774
|
+
"document-id-after"
|
|
775
|
+
],
|
|
776
|
+
"name": "data-before",
|
|
777
|
+
"required": false,
|
|
778
|
+
"hasDynamicHelp": false,
|
|
779
|
+
"multiple": false,
|
|
780
|
+
"type": "option"
|
|
781
|
+
},
|
|
782
|
+
"data-after": {
|
|
783
|
+
"description": "Current document",
|
|
784
|
+
"exclusive": [
|
|
785
|
+
"data",
|
|
786
|
+
"file",
|
|
787
|
+
"document-id",
|
|
788
|
+
"file-before",
|
|
789
|
+
"file-after",
|
|
790
|
+
"document-id-before",
|
|
791
|
+
"document-id-after"
|
|
792
|
+
],
|
|
793
|
+
"name": "data-after",
|
|
794
|
+
"required": false,
|
|
795
|
+
"hasDynamicHelp": false,
|
|
796
|
+
"multiple": false,
|
|
797
|
+
"type": "option"
|
|
798
|
+
},
|
|
799
|
+
"event": {
|
|
800
|
+
"char": "e",
|
|
801
|
+
"description": "Type of event (create, update, delete)",
|
|
802
|
+
"name": "event",
|
|
803
|
+
"required": false,
|
|
804
|
+
"hasDynamicHelp": false,
|
|
805
|
+
"multiple": false,
|
|
806
|
+
"options": [
|
|
807
|
+
"create",
|
|
808
|
+
"update",
|
|
809
|
+
"delete"
|
|
810
|
+
],
|
|
811
|
+
"type": "option"
|
|
812
|
+
},
|
|
813
|
+
"file": {
|
|
814
|
+
"char": "f",
|
|
815
|
+
"description": "Read data from file and send to the function",
|
|
816
|
+
"exclusive": [
|
|
817
|
+
"data",
|
|
818
|
+
"document-id"
|
|
819
|
+
],
|
|
820
|
+
"name": "file",
|
|
821
|
+
"required": false,
|
|
822
|
+
"hasDynamicHelp": false,
|
|
823
|
+
"multiple": false,
|
|
824
|
+
"type": "option"
|
|
825
|
+
},
|
|
826
|
+
"file-before": {
|
|
827
|
+
"description": "Original document",
|
|
828
|
+
"exclusive": [
|
|
829
|
+
"data",
|
|
830
|
+
"file",
|
|
831
|
+
"document-id",
|
|
832
|
+
"data-before",
|
|
833
|
+
"data-after",
|
|
834
|
+
"document-id-before",
|
|
835
|
+
"document-id-after"
|
|
836
|
+
],
|
|
837
|
+
"name": "file-before",
|
|
838
|
+
"required": false,
|
|
839
|
+
"hasDynamicHelp": false,
|
|
840
|
+
"multiple": false,
|
|
841
|
+
"type": "option"
|
|
842
|
+
},
|
|
843
|
+
"file-after": {
|
|
844
|
+
"description": "Current document",
|
|
845
|
+
"exclusive": [
|
|
846
|
+
"data",
|
|
847
|
+
"file",
|
|
848
|
+
"document-id",
|
|
849
|
+
"data-before",
|
|
850
|
+
"data-after",
|
|
851
|
+
"document-id-before",
|
|
852
|
+
"document-id-after"
|
|
853
|
+
],
|
|
854
|
+
"name": "file-after",
|
|
855
|
+
"required": false,
|
|
856
|
+
"hasDynamicHelp": false,
|
|
857
|
+
"multiple": false,
|
|
858
|
+
"type": "option"
|
|
859
|
+
},
|
|
860
|
+
"timeout": {
|
|
861
|
+
"char": "t",
|
|
862
|
+
"description": "Execution timeout value in seconds",
|
|
863
|
+
"name": "timeout",
|
|
864
|
+
"required": false,
|
|
865
|
+
"hasDynamicHelp": false,
|
|
866
|
+
"multiple": false,
|
|
867
|
+
"type": "option"
|
|
868
|
+
},
|
|
869
|
+
"api": {
|
|
870
|
+
"char": "a",
|
|
871
|
+
"description": "Sanity API Version to use",
|
|
872
|
+
"name": "api",
|
|
873
|
+
"required": false,
|
|
874
|
+
"hasDynamicHelp": false,
|
|
875
|
+
"multiple": false,
|
|
876
|
+
"type": "option"
|
|
877
|
+
},
|
|
878
|
+
"dataset": {
|
|
879
|
+
"description": "The Sanity dataset to use",
|
|
880
|
+
"name": "dataset",
|
|
881
|
+
"required": false,
|
|
882
|
+
"hasDynamicHelp": false,
|
|
883
|
+
"multiple": false,
|
|
884
|
+
"type": "option"
|
|
885
|
+
},
|
|
886
|
+
"document-id": {
|
|
887
|
+
"aliases": [
|
|
888
|
+
"doc",
|
|
889
|
+
"documentId"
|
|
890
|
+
],
|
|
891
|
+
"description": "Document to fetch and send to function",
|
|
892
|
+
"exclusive": [
|
|
893
|
+
"data",
|
|
894
|
+
"file"
|
|
895
|
+
],
|
|
896
|
+
"name": "document-id",
|
|
897
|
+
"required": false,
|
|
898
|
+
"hasDynamicHelp": false,
|
|
899
|
+
"multiple": false,
|
|
900
|
+
"type": "option"
|
|
901
|
+
},
|
|
902
|
+
"document-id-before": {
|
|
903
|
+
"description": "Original document",
|
|
904
|
+
"exclusive": [
|
|
905
|
+
"data",
|
|
906
|
+
"file",
|
|
907
|
+
"document-id",
|
|
908
|
+
"data-before",
|
|
909
|
+
"data-after",
|
|
910
|
+
"file-before",
|
|
911
|
+
"file-after"
|
|
912
|
+
],
|
|
913
|
+
"name": "document-id-before",
|
|
914
|
+
"required": false,
|
|
915
|
+
"hasDynamicHelp": false,
|
|
916
|
+
"multiple": false,
|
|
917
|
+
"type": "option"
|
|
918
|
+
},
|
|
919
|
+
"document-id-after": {
|
|
920
|
+
"description": "Current document",
|
|
921
|
+
"exclusive": [
|
|
922
|
+
"data",
|
|
923
|
+
"file",
|
|
924
|
+
"document-id",
|
|
925
|
+
"data-before",
|
|
926
|
+
"data-after",
|
|
927
|
+
"file-before",
|
|
928
|
+
"file-after"
|
|
929
|
+
],
|
|
930
|
+
"name": "document-id-after",
|
|
931
|
+
"required": false,
|
|
679
932
|
"hasDynamicHelp": false,
|
|
680
933
|
"multiple": false,
|
|
681
934
|
"type": "option"
|
|
682
935
|
},
|
|
683
|
-
"
|
|
684
|
-
"description": "
|
|
685
|
-
"
|
|
686
|
-
"name": "trace",
|
|
936
|
+
"with-user-token": {
|
|
937
|
+
"description": "Prime access token from CLI config",
|
|
938
|
+
"name": "with-user-token",
|
|
687
939
|
"allowNo": false,
|
|
688
940
|
"type": "boolean"
|
|
689
941
|
},
|
|
690
|
-
"
|
|
691
|
-
"
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
"
|
|
695
|
-
"
|
|
696
|
-
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
"name": "
|
|
700
|
-
"
|
|
701
|
-
"
|
|
702
|
-
|
|
703
|
-
|
|
704
|
-
"description": "Interactively fix configuration issues",
|
|
705
|
-
"name": "fix",
|
|
706
|
-
"allowNo": false,
|
|
707
|
-
"type": "boolean"
|
|
942
|
+
"media-library-id": {
|
|
943
|
+
"aliases": [
|
|
944
|
+
"media"
|
|
945
|
+
],
|
|
946
|
+
"description": "Sanity Media Library ID to use",
|
|
947
|
+
"exclusive": [
|
|
948
|
+
"project-id",
|
|
949
|
+
"dataset"
|
|
950
|
+
],
|
|
951
|
+
"name": "media-library-id",
|
|
952
|
+
"required": false,
|
|
953
|
+
"hasDynamicHelp": false,
|
|
954
|
+
"multiple": false,
|
|
955
|
+
"type": "option"
|
|
708
956
|
}
|
|
709
957
|
},
|
|
710
958
|
"hasDynamicHelp": false,
|
|
711
959
|
"hiddenAliases": [],
|
|
712
|
-
"id": "
|
|
960
|
+
"id": "functions:test",
|
|
713
961
|
"pluginAlias": "@sanity/runtime-cli",
|
|
714
962
|
"pluginName": "@sanity/runtime-cli",
|
|
715
963
|
"pluginType": "core",
|
|
716
964
|
"strict": true,
|
|
717
|
-
"summary": "
|
|
965
|
+
"summary": "Invoke a local Sanity Function",
|
|
718
966
|
"enableJsonFlag": true,
|
|
967
|
+
"needs": [
|
|
968
|
+
"blueprint"
|
|
969
|
+
],
|
|
719
970
|
"isESM": true,
|
|
720
971
|
"relativePath": [
|
|
721
972
|
"dist",
|
|
722
973
|
"commands",
|
|
723
|
-
"
|
|
724
|
-
"
|
|
974
|
+
"functions",
|
|
975
|
+
"test.js"
|
|
725
976
|
]
|
|
726
977
|
},
|
|
727
|
-
"blueprints:
|
|
978
|
+
"blueprints:add": {
|
|
728
979
|
"aliases": [],
|
|
729
|
-
"args": {
|
|
730
|
-
|
|
980
|
+
"args": {
|
|
981
|
+
"type": {
|
|
982
|
+
"description": "Type of resource to add (only \"function\" is supported)",
|
|
983
|
+
"name": "type",
|
|
984
|
+
"options": [
|
|
985
|
+
"function"
|
|
986
|
+
],
|
|
987
|
+
"required": true
|
|
988
|
+
}
|
|
989
|
+
},
|
|
990
|
+
"deprecationOptions": {
|
|
991
|
+
"to": "functions add"
|
|
992
|
+
},
|
|
993
|
+
"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",
|
|
731
994
|
"examples": [
|
|
732
|
-
"<%= config.bin %> <%= command.id %>",
|
|
733
|
-
"<%= config.bin %> <%= command.id %> --
|
|
734
|
-
"<%= config.bin %> <%= command.id %>
|
|
735
|
-
"<%= config.bin %> <%= command.id %> --
|
|
995
|
+
"<%= config.bin %> <%= command.id %> function",
|
|
996
|
+
"<%= config.bin %> <%= command.id %> function --helpers",
|
|
997
|
+
"<%= config.bin %> <%= command.id %> function --name my-function",
|
|
998
|
+
"<%= config.bin %> <%= command.id %> function --name my-function --fn-type document-create",
|
|
999
|
+
"<%= config.bin %> <%= command.id %> function --name my-function --fn-type document-create --fn-type document-update --lang js"
|
|
736
1000
|
],
|
|
737
1001
|
"flags": {
|
|
738
1002
|
"json": {
|
|
@@ -776,10 +1040,8 @@
|
|
|
776
1040
|
"type": "boolean"
|
|
777
1041
|
},
|
|
778
1042
|
"stack": {
|
|
779
|
-
"
|
|
780
|
-
|
|
781
|
-
],
|
|
782
|
-
"description": "Stack name or ID",
|
|
1043
|
+
"description": "Stack name or ID to use instead of the locally configured Stack",
|
|
1044
|
+
"hidden": true,
|
|
783
1045
|
"name": "stack",
|
|
784
1046
|
"hasDynamicHelp": false,
|
|
785
1047
|
"multiple": false,
|
|
@@ -794,6 +1056,7 @@
|
|
|
794
1056
|
"exclusive": [
|
|
795
1057
|
"organization-id"
|
|
796
1058
|
],
|
|
1059
|
+
"hidden": true,
|
|
797
1060
|
"name": "project-id",
|
|
798
1061
|
"hasDynamicHelp": false,
|
|
799
1062
|
"multiple": false,
|
|
@@ -809,51 +1072,159 @@
|
|
|
809
1072
|
"exclusive": [
|
|
810
1073
|
"project-id"
|
|
811
1074
|
],
|
|
1075
|
+
"hidden": true,
|
|
812
1076
|
"name": "organization-id",
|
|
813
1077
|
"hasDynamicHelp": false,
|
|
814
1078
|
"multiple": false,
|
|
815
1079
|
"type": "option"
|
|
1080
|
+
},
|
|
1081
|
+
"example": {
|
|
1082
|
+
"aliases": [
|
|
1083
|
+
"recipe"
|
|
1084
|
+
],
|
|
1085
|
+
"description": "Example to use for the function resource. Discover examples at https://www.sanity.io/exchange/type=recipes/by=sanity",
|
|
1086
|
+
"exclusive": [
|
|
1087
|
+
"name",
|
|
1088
|
+
"fn-type",
|
|
1089
|
+
"language",
|
|
1090
|
+
"javascript",
|
|
1091
|
+
"fn-helpers",
|
|
1092
|
+
"fn-installer"
|
|
1093
|
+
],
|
|
1094
|
+
"name": "example",
|
|
1095
|
+
"hasDynamicHelp": false,
|
|
1096
|
+
"multiple": false,
|
|
1097
|
+
"type": "option"
|
|
1098
|
+
},
|
|
1099
|
+
"name": {
|
|
1100
|
+
"char": "n",
|
|
1101
|
+
"description": "Name of the resource to add",
|
|
1102
|
+
"name": "name",
|
|
1103
|
+
"hasDynamicHelp": false,
|
|
1104
|
+
"multiple": false,
|
|
1105
|
+
"type": "option"
|
|
1106
|
+
},
|
|
1107
|
+
"fn-type": {
|
|
1108
|
+
"aliases": [
|
|
1109
|
+
"function-type"
|
|
1110
|
+
],
|
|
1111
|
+
"dependsOn": [
|
|
1112
|
+
"name"
|
|
1113
|
+
],
|
|
1114
|
+
"description": "Document change event(s) that should trigger the function; you can specify multiple events by specifying this flag multiple times",
|
|
1115
|
+
"name": "fn-type",
|
|
1116
|
+
"hasDynamicHelp": false,
|
|
1117
|
+
"multiple": true,
|
|
1118
|
+
"options": [
|
|
1119
|
+
"document-publish",
|
|
1120
|
+
"document-create",
|
|
1121
|
+
"document-delete",
|
|
1122
|
+
"document-update",
|
|
1123
|
+
"media-library-asset-create",
|
|
1124
|
+
"media-library-asset-delete",
|
|
1125
|
+
"media-library-asset-update",
|
|
1126
|
+
"scheduled-function",
|
|
1127
|
+
"sync-tag-invalidate"
|
|
1128
|
+
],
|
|
1129
|
+
"type": "option"
|
|
1130
|
+
},
|
|
1131
|
+
"language": {
|
|
1132
|
+
"aliases": [
|
|
1133
|
+
"function-language",
|
|
1134
|
+
"fn-language",
|
|
1135
|
+
"lang"
|
|
1136
|
+
],
|
|
1137
|
+
"description": "Language of the new function",
|
|
1138
|
+
"name": "language",
|
|
1139
|
+
"default": "ts",
|
|
1140
|
+
"hasDynamicHelp": false,
|
|
1141
|
+
"multiple": false,
|
|
1142
|
+
"options": [
|
|
1143
|
+
"ts",
|
|
1144
|
+
"js"
|
|
1145
|
+
],
|
|
1146
|
+
"type": "option"
|
|
1147
|
+
},
|
|
1148
|
+
"javascript": {
|
|
1149
|
+
"aliases": [
|
|
1150
|
+
"js"
|
|
1151
|
+
],
|
|
1152
|
+
"description": "Use JavaScript instead of TypeScript",
|
|
1153
|
+
"exclusive": [
|
|
1154
|
+
"language"
|
|
1155
|
+
],
|
|
1156
|
+
"name": "javascript",
|
|
1157
|
+
"allowNo": false,
|
|
1158
|
+
"type": "boolean"
|
|
1159
|
+
},
|
|
1160
|
+
"fn-helpers": {
|
|
1161
|
+
"aliases": [
|
|
1162
|
+
"function-helpers",
|
|
1163
|
+
"helpers"
|
|
1164
|
+
],
|
|
1165
|
+
"description": "Add helpers to the new function",
|
|
1166
|
+
"name": "fn-helpers",
|
|
1167
|
+
"allowNo": true,
|
|
1168
|
+
"type": "boolean"
|
|
1169
|
+
},
|
|
1170
|
+
"fn-installer": {
|
|
1171
|
+
"aliases": [
|
|
1172
|
+
"function-installer",
|
|
1173
|
+
"installer"
|
|
1174
|
+
],
|
|
1175
|
+
"description": "Which package manager to use when installing the @sanity/functions helpers",
|
|
1176
|
+
"name": "fn-installer",
|
|
1177
|
+
"hasDynamicHelp": false,
|
|
1178
|
+
"multiple": false,
|
|
1179
|
+
"options": [
|
|
1180
|
+
"skip",
|
|
1181
|
+
"npm",
|
|
1182
|
+
"pnpm",
|
|
1183
|
+
"yarn"
|
|
1184
|
+
],
|
|
1185
|
+
"type": "option"
|
|
1186
|
+
},
|
|
1187
|
+
"install": {
|
|
1188
|
+
"char": "i",
|
|
1189
|
+
"description": "Shortcut for --fn-installer npm",
|
|
1190
|
+
"exclusive": [
|
|
1191
|
+
"fn-installer"
|
|
1192
|
+
],
|
|
1193
|
+
"name": "install",
|
|
1194
|
+
"allowNo": false,
|
|
1195
|
+
"type": "boolean"
|
|
816
1196
|
}
|
|
817
1197
|
},
|
|
818
1198
|
"hasDynamicHelp": false,
|
|
819
1199
|
"hiddenAliases": [],
|
|
820
|
-
"id": "blueprints:
|
|
1200
|
+
"id": "blueprints:add",
|
|
821
1201
|
"pluginAlias": "@sanity/runtime-cli",
|
|
822
1202
|
"pluginName": "@sanity/runtime-cli",
|
|
823
1203
|
"pluginType": "core",
|
|
1204
|
+
"state": "deprecated",
|
|
824
1205
|
"strict": true,
|
|
825
|
-
"summary": "
|
|
1206
|
+
"summary": "[deprecated] Use \"functions add\" instead",
|
|
826
1207
|
"enableJsonFlag": true,
|
|
827
1208
|
"needs": [
|
|
828
|
-
"
|
|
1209
|
+
"blueprint"
|
|
829
1210
|
],
|
|
830
1211
|
"isESM": true,
|
|
831
1212
|
"relativePath": [
|
|
832
1213
|
"dist",
|
|
833
1214
|
"commands",
|
|
834
1215
|
"blueprints",
|
|
835
|
-
"
|
|
1216
|
+
"add.js"
|
|
836
1217
|
]
|
|
837
1218
|
},
|
|
838
|
-
"blueprints:
|
|
1219
|
+
"blueprints:config": {
|
|
839
1220
|
"aliases": [],
|
|
840
|
-
"args": {
|
|
841
|
-
|
|
842
|
-
"description": "Directory to create the local Blueprint in",
|
|
843
|
-
"name": "dir"
|
|
844
|
-
}
|
|
845
|
-
},
|
|
846
|
-
"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[NOTE: Currently, accounts are limited to three (3) Stacks per project scope.]\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. This is .gitignored by default.\n\nAfter initialization, use 'blueprints plan' to preview changes, then 'blueprints deploy' to apply them.",
|
|
1221
|
+
"args": {},
|
|
1222
|
+
"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.",
|
|
847
1223
|
"examples": [
|
|
848
1224
|
"<%= config.bin %> <%= command.id %>",
|
|
849
|
-
"<%= config.bin %> <%= command.id %>
|
|
850
|
-
"<%= config.bin %> <%= command.id %> --
|
|
851
|
-
"<%= config.bin %> <%= command.id %> --
|
|
852
|
-
"<%= config.bin %> <%= command.id %> --project-id <projectId>",
|
|
853
|
-
"<%= config.bin %> <%= command.id %> --stack-name <newStackName>",
|
|
854
|
-
"<%= config.bin %> <%= command.id %> --stack-id <existingStackId>",
|
|
855
|
-
"<%= config.bin %> <%= command.id %> new-stack --type <json|js|ts> --org <organizationId> --name <newStackName>",
|
|
856
|
-
"<%= config.bin %> <%= command.id %> old-stack --type <json|js|ts> --project-id <projectId> --stack-id <existingStackId>"
|
|
1225
|
+
"<%= config.bin %> <%= command.id %> --edit",
|
|
1226
|
+
"<%= config.bin %> <%= command.id %> --edit --project-id <projectId>",
|
|
1227
|
+
"<%= config.bin %> <%= command.id %> --edit --project-id <projectId> --stack <name-or-id>"
|
|
857
1228
|
],
|
|
858
1229
|
"flags": {
|
|
859
1230
|
"json": {
|
|
@@ -896,41 +1267,18 @@
|
|
|
896
1267
|
"allowNo": false,
|
|
897
1268
|
"type": "boolean"
|
|
898
1269
|
},
|
|
899
|
-
"
|
|
900
|
-
"description": "Directory to create the local Blueprint in",
|
|
901
|
-
"name": "dir",
|
|
902
|
-
"hasDynamicHelp": false,
|
|
903
|
-
"multiple": false,
|
|
904
|
-
"type": "option"
|
|
905
|
-
},
|
|
906
|
-
"example": {
|
|
1270
|
+
"stack": {
|
|
907
1271
|
"aliases": [
|
|
908
|
-
"recipe"
|
|
909
|
-
],
|
|
910
|
-
"description": "Example to use for the local Blueprint",
|
|
911
|
-
"exclusive": [
|
|
912
|
-
"blueprint-type",
|
|
913
1272
|
"stack-id",
|
|
914
|
-
"
|
|
1273
|
+
"stackId"
|
|
915
1274
|
],
|
|
916
|
-
"
|
|
917
|
-
|
|
918
|
-
"multiple": false,
|
|
919
|
-
"type": "option"
|
|
920
|
-
},
|
|
921
|
-
"blueprint-type": {
|
|
922
|
-
"aliases": [
|
|
923
|
-
"type"
|
|
1275
|
+
"dependsOn": [
|
|
1276
|
+
"edit"
|
|
924
1277
|
],
|
|
925
|
-
"description": "
|
|
926
|
-
"name": "
|
|
1278
|
+
"description": "Stack name or ID to set in the configuration. Requires --edit flag",
|
|
1279
|
+
"name": "stack",
|
|
927
1280
|
"hasDynamicHelp": false,
|
|
928
1281
|
"multiple": false,
|
|
929
|
-
"options": [
|
|
930
|
-
"json",
|
|
931
|
-
"js",
|
|
932
|
-
"ts"
|
|
933
|
-
],
|
|
934
1282
|
"type": "option"
|
|
935
1283
|
},
|
|
936
1284
|
"project-id": {
|
|
@@ -938,6 +1286,9 @@
|
|
|
938
1286
|
"project",
|
|
939
1287
|
"projectId"
|
|
940
1288
|
],
|
|
1289
|
+
"dependsOn": [
|
|
1290
|
+
"edit"
|
|
1291
|
+
],
|
|
941
1292
|
"description": "Sanity project ID used to scope Blueprint and Stack",
|
|
942
1293
|
"exclusive": [
|
|
943
1294
|
"organization-id"
|
|
@@ -953,6 +1304,9 @@
|
|
|
953
1304
|
"organizationId",
|
|
954
1305
|
"org"
|
|
955
1306
|
],
|
|
1307
|
+
"dependsOn": [
|
|
1308
|
+
"edit"
|
|
1309
|
+
],
|
|
956
1310
|
"description": "Sanity organization ID used to scope Blueprint and Stack",
|
|
957
1311
|
"exclusive": [
|
|
958
1312
|
"project-id"
|
|
@@ -962,79 +1316,47 @@
|
|
|
962
1316
|
"multiple": false,
|
|
963
1317
|
"type": "option"
|
|
964
1318
|
},
|
|
965
|
-
"
|
|
966
|
-
"
|
|
967
|
-
|
|
968
|
-
|
|
969
|
-
"
|
|
970
|
-
"
|
|
971
|
-
"stack-name"
|
|
972
|
-
],
|
|
973
|
-
"name": "stack-id",
|
|
974
|
-
"relationships": [
|
|
975
|
-
{
|
|
976
|
-
"type": "some",
|
|
977
|
-
"flags": [
|
|
978
|
-
"project-id",
|
|
979
|
-
"organization-id"
|
|
980
|
-
]
|
|
981
|
-
}
|
|
982
|
-
],
|
|
983
|
-
"hasDynamicHelp": false,
|
|
984
|
-
"multiple": false,
|
|
985
|
-
"type": "option"
|
|
986
|
-
},
|
|
987
|
-
"stack-name": {
|
|
988
|
-
"aliases": [
|
|
989
|
-
"name"
|
|
990
|
-
],
|
|
991
|
-
"description": "Name to use for a new Stack provisioned during initialization",
|
|
992
|
-
"exclusive": [
|
|
993
|
-
"stack-id"
|
|
994
|
-
],
|
|
995
|
-
"name": "stack-name",
|
|
996
|
-
"relationships": [
|
|
997
|
-
{
|
|
998
|
-
"type": "some",
|
|
999
|
-
"flags": [
|
|
1000
|
-
"project-id",
|
|
1001
|
-
"organization-id"
|
|
1002
|
-
]
|
|
1003
|
-
}
|
|
1004
|
-
],
|
|
1005
|
-
"hasDynamicHelp": false,
|
|
1006
|
-
"multiple": false,
|
|
1007
|
-
"type": "option"
|
|
1319
|
+
"edit": {
|
|
1320
|
+
"char": "e",
|
|
1321
|
+
"description": "Modify the configuration interactively, or directly when combined with ID flags.",
|
|
1322
|
+
"name": "edit",
|
|
1323
|
+
"allowNo": false,
|
|
1324
|
+
"type": "boolean"
|
|
1008
1325
|
}
|
|
1009
1326
|
},
|
|
1010
1327
|
"hasDynamicHelp": false,
|
|
1011
1328
|
"hiddenAliases": [],
|
|
1012
|
-
"id": "blueprints:
|
|
1329
|
+
"id": "blueprints:config",
|
|
1013
1330
|
"pluginAlias": "@sanity/runtime-cli",
|
|
1014
1331
|
"pluginName": "@sanity/runtime-cli",
|
|
1015
1332
|
"pluginType": "core",
|
|
1016
1333
|
"strict": true,
|
|
1017
|
-
"summary": "
|
|
1334
|
+
"summary": "View or edit the local Blueprint configuration",
|
|
1018
1335
|
"enableJsonFlag": true,
|
|
1336
|
+
"needs": [
|
|
1337
|
+
"token",
|
|
1338
|
+
"blueprint"
|
|
1339
|
+
],
|
|
1019
1340
|
"isESM": true,
|
|
1020
1341
|
"relativePath": [
|
|
1021
1342
|
"dist",
|
|
1022
1343
|
"commands",
|
|
1023
1344
|
"blueprints",
|
|
1024
|
-
"
|
|
1345
|
+
"config.js"
|
|
1025
1346
|
]
|
|
1026
1347
|
},
|
|
1027
|
-
"blueprints:
|
|
1348
|
+
"blueprints:deploy": {
|
|
1028
1349
|
"aliases": [],
|
|
1029
1350
|
"args": {},
|
|
1030
|
-
"description": "
|
|
1351
|
+
"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 60-second timeout for processing resource assets.\n\nExit codes: 0 deployed, 2 deployment failed, 75 deployment accepted but completion could not be confirmed (rerun 'blueprints info' to check).",
|
|
1031
1352
|
"examples": [
|
|
1032
1353
|
"<%= config.bin %> <%= command.id %>",
|
|
1033
|
-
"<%= config.bin %> <%= command.id %> --
|
|
1354
|
+
"<%= config.bin %> <%= command.id %> --message \"Enable staging dataset\"",
|
|
1355
|
+
"<%= config.bin %> <%= command.id %> --no-wait",
|
|
1356
|
+
"<%= config.bin %> <%= command.id %> --fn-installer npm",
|
|
1034
1357
|
"<%= config.bin %> <%= command.id %> --stack <name-or-id>",
|
|
1035
|
-
"<%= config.bin %> <%= command.id %> --
|
|
1036
|
-
"<%= config.bin %> <%= command.id %> --
|
|
1037
|
-
"<%= config.bin %> <%= command.id %> --before 2026-05-01T00:00:00Z"
|
|
1358
|
+
"<%= config.bin %> <%= command.id %> --organization-id <orgId> --stack <name-or-id>",
|
|
1359
|
+
"<%= config.bin %> <%= command.id %> --new-stack-name <new-name>"
|
|
1038
1360
|
],
|
|
1039
1361
|
"flags": {
|
|
1040
1362
|
"json": {
|
|
@@ -1113,43 +1435,40 @@
|
|
|
1113
1435
|
"multiple": false,
|
|
1114
1436
|
"type": "option"
|
|
1115
1437
|
},
|
|
1116
|
-
"
|
|
1117
|
-
"
|
|
1118
|
-
|
|
1119
|
-
|
|
1120
|
-
"char": "w",
|
|
1121
|
-
"description": "Watch for new Stack logs",
|
|
1122
|
-
"name": "watch",
|
|
1123
|
-
"allowNo": false,
|
|
1124
|
-
"type": "boolean"
|
|
1125
|
-
},
|
|
1126
|
-
"limit": {
|
|
1127
|
-
"char": "l",
|
|
1128
|
-
"description": "Maximum number of log entries to retrieve (1-500)",
|
|
1129
|
-
"exclusive": [
|
|
1130
|
-
"watch"
|
|
1131
|
-
],
|
|
1132
|
-
"name": "limit",
|
|
1438
|
+
"message": {
|
|
1439
|
+
"char": "m",
|
|
1440
|
+
"description": "Message describing the deployment (e.g. reason for change)",
|
|
1441
|
+
"name": "message",
|
|
1133
1442
|
"hasDynamicHelp": false,
|
|
1134
1443
|
"multiple": false,
|
|
1135
1444
|
"type": "option"
|
|
1136
1445
|
},
|
|
1137
|
-
"
|
|
1138
|
-
"
|
|
1139
|
-
|
|
1140
|
-
"
|
|
1446
|
+
"fn-installer": {
|
|
1447
|
+
"aliases": [
|
|
1448
|
+
"function-installer",
|
|
1449
|
+
"installer"
|
|
1141
1450
|
],
|
|
1142
|
-
"
|
|
1451
|
+
"description": "Which package manager to use when installing Function dependencies",
|
|
1452
|
+
"hidden": true,
|
|
1453
|
+
"name": "fn-installer",
|
|
1143
1454
|
"hasDynamicHelp": false,
|
|
1144
1455
|
"multiple": false,
|
|
1456
|
+
"options": [
|
|
1457
|
+
"npm",
|
|
1458
|
+
"pnpm",
|
|
1459
|
+
"yarn"
|
|
1460
|
+
],
|
|
1145
1461
|
"type": "option"
|
|
1146
1462
|
},
|
|
1147
|
-
"
|
|
1148
|
-
"description": "
|
|
1149
|
-
"
|
|
1150
|
-
|
|
1151
|
-
|
|
1152
|
-
|
|
1463
|
+
"no-wait": {
|
|
1464
|
+
"description": "Do not wait for Stack deployment to complete",
|
|
1465
|
+
"name": "no-wait",
|
|
1466
|
+
"allowNo": false,
|
|
1467
|
+
"type": "boolean"
|
|
1468
|
+
},
|
|
1469
|
+
"new-stack-name": {
|
|
1470
|
+
"description": "Set a new name for the Stack",
|
|
1471
|
+
"name": "new-stack-name",
|
|
1153
1472
|
"hasDynamicHelp": false,
|
|
1154
1473
|
"multiple": false,
|
|
1155
1474
|
"type": "option"
|
|
@@ -1157,36 +1476,32 @@
|
|
|
1157
1476
|
},
|
|
1158
1477
|
"hasDynamicHelp": false,
|
|
1159
1478
|
"hiddenAliases": [],
|
|
1160
|
-
"id": "blueprints:
|
|
1479
|
+
"id": "blueprints:deploy",
|
|
1161
1480
|
"pluginAlias": "@sanity/runtime-cli",
|
|
1162
1481
|
"pluginName": "@sanity/runtime-cli",
|
|
1163
1482
|
"pluginType": "core",
|
|
1164
1483
|
"strict": true,
|
|
1165
|
-
"summary": "
|
|
1484
|
+
"summary": "Deploy the local Blueprint to the remote Stack",
|
|
1166
1485
|
"enableJsonFlag": true,
|
|
1167
1486
|
"needs": [
|
|
1168
|
-
"deployedStack"
|
|
1487
|
+
"deployedStack",
|
|
1488
|
+
"blueprint"
|
|
1169
1489
|
],
|
|
1170
1490
|
"isESM": true,
|
|
1171
1491
|
"relativePath": [
|
|
1172
1492
|
"dist",
|
|
1173
1493
|
"commands",
|
|
1174
1494
|
"blueprints",
|
|
1175
|
-
"
|
|
1495
|
+
"deploy.js"
|
|
1176
1496
|
]
|
|
1177
1497
|
},
|
|
1178
|
-
"blueprints:
|
|
1498
|
+
"blueprints:destroy": {
|
|
1179
1499
|
"aliases": [],
|
|
1180
1500
|
"args": {},
|
|
1181
|
-
"description": "
|
|
1501
|
+
"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).",
|
|
1182
1502
|
"examples": [
|
|
1183
1503
|
"<%= config.bin %> <%= command.id %>",
|
|
1184
|
-
"<%= config.bin %> <%= command.id %> --
|
|
1185
|
-
"<%= config.bin %> <%= command.id %> --print",
|
|
1186
|
-
"export SANITY_AUTH_TOKEN=$(<%= config.bin %> <%= command.id %> --print)",
|
|
1187
|
-
"<%= config.bin %> <%= command.id %> --json",
|
|
1188
|
-
"<%= config.bin %> <%= command.id %> --project-id <projectId>",
|
|
1189
|
-
"<%= config.bin %> <%= command.id %> --organization-id <orgId>"
|
|
1504
|
+
"<%= config.bin %> <%= command.id %> --stack <name-or-id> --project-id <projectId> --force --no-wait"
|
|
1190
1505
|
],
|
|
1191
1506
|
"flags": {
|
|
1192
1507
|
"json": {
|
|
@@ -1230,8 +1545,11 @@
|
|
|
1230
1545
|
"type": "boolean"
|
|
1231
1546
|
},
|
|
1232
1547
|
"stack": {
|
|
1233
|
-
"
|
|
1234
|
-
|
|
1548
|
+
"aliases": [
|
|
1549
|
+
"stack-id",
|
|
1550
|
+
"stackId"
|
|
1551
|
+
],
|
|
1552
|
+
"description": "Stack name or ID to destroy (defaults to the locally configured Stack)",
|
|
1235
1553
|
"name": "stack",
|
|
1236
1554
|
"hasDynamicHelp": false,
|
|
1237
1555
|
"multiple": false,
|
|
@@ -1242,6 +1560,10 @@
|
|
|
1242
1560
|
"project",
|
|
1243
1561
|
"projectId"
|
|
1244
1562
|
],
|
|
1563
|
+
"dependsOn": [
|
|
1564
|
+
"stack",
|
|
1565
|
+
"force"
|
|
1566
|
+
],
|
|
1245
1567
|
"description": "Sanity project ID used to scope Blueprint and Stack",
|
|
1246
1568
|
"exclusive": [
|
|
1247
1569
|
"organization-id"
|
|
@@ -1257,6 +1579,10 @@
|
|
|
1257
1579
|
"organizationId",
|
|
1258
1580
|
"org"
|
|
1259
1581
|
],
|
|
1582
|
+
"dependsOn": [
|
|
1583
|
+
"stack",
|
|
1584
|
+
"force"
|
|
1585
|
+
],
|
|
1260
1586
|
"description": "Sanity organization ID used to scope Blueprint and Stack",
|
|
1261
1587
|
"exclusive": [
|
|
1262
1588
|
"project-id"
|
|
@@ -1266,32 +1592,30 @@
|
|
|
1266
1592
|
"multiple": false,
|
|
1267
1593
|
"type": "option"
|
|
1268
1594
|
},
|
|
1269
|
-
"
|
|
1270
|
-
"
|
|
1271
|
-
|
|
1272
|
-
"hasDynamicHelp": false,
|
|
1273
|
-
"multiple": false,
|
|
1274
|
-
"type": "option"
|
|
1275
|
-
},
|
|
1276
|
-
"print": {
|
|
1277
|
-
"char": "P",
|
|
1278
|
-
"description": "Print only the raw token to stdout (suitable for shell substitution)",
|
|
1279
|
-
"exclusive": [
|
|
1280
|
-
"json"
|
|
1595
|
+
"force": {
|
|
1596
|
+
"aliases": [
|
|
1597
|
+
"f"
|
|
1281
1598
|
],
|
|
1282
|
-
"
|
|
1599
|
+
"description": "Force Stack destruction (skip confirmation)",
|
|
1600
|
+
"name": "force",
|
|
1601
|
+
"allowNo": false,
|
|
1602
|
+
"type": "boolean"
|
|
1603
|
+
},
|
|
1604
|
+
"no-wait": {
|
|
1605
|
+
"description": "Do not wait for Stack destruction to complete",
|
|
1606
|
+
"name": "no-wait",
|
|
1283
1607
|
"allowNo": false,
|
|
1284
1608
|
"type": "boolean"
|
|
1285
1609
|
}
|
|
1286
1610
|
},
|
|
1287
1611
|
"hasDynamicHelp": false,
|
|
1288
1612
|
"hiddenAliases": [],
|
|
1289
|
-
"id": "blueprints:
|
|
1613
|
+
"id": "blueprints:destroy",
|
|
1290
1614
|
"pluginAlias": "@sanity/runtime-cli",
|
|
1291
1615
|
"pluginName": "@sanity/runtime-cli",
|
|
1292
1616
|
"pluginType": "core",
|
|
1293
1617
|
"strict": true,
|
|
1294
|
-
"summary": "
|
|
1618
|
+
"summary": "Destroy a remote Stack deployment and its resources",
|
|
1295
1619
|
"enableJsonFlag": true,
|
|
1296
1620
|
"needs": [
|
|
1297
1621
|
"scope"
|
|
@@ -1301,17 +1625,16 @@
|
|
|
1301
1625
|
"dist",
|
|
1302
1626
|
"commands",
|
|
1303
1627
|
"blueprints",
|
|
1304
|
-
"
|
|
1628
|
+
"destroy.js"
|
|
1305
1629
|
]
|
|
1306
1630
|
},
|
|
1307
|
-
"blueprints:
|
|
1631
|
+
"blueprints:doctor": {
|
|
1308
1632
|
"aliases": [],
|
|
1309
1633
|
"args": {},
|
|
1310
|
-
"description": "
|
|
1634
|
+
"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.",
|
|
1311
1635
|
"examples": [
|
|
1312
1636
|
"<%= config.bin %> <%= command.id %>",
|
|
1313
|
-
"<%= config.bin %> <%= command.id %> --
|
|
1314
|
-
"<%= config.bin %> <%= command.id %> --organization-id <orgId> --stack <name-or-id>"
|
|
1637
|
+
"<%= config.bin %> <%= command.id %> --fix"
|
|
1315
1638
|
],
|
|
1316
1639
|
"flags": {
|
|
1317
1640
|
"json": {
|
|
@@ -1327,7 +1650,6 @@
|
|
|
1327
1650
|
"char": "p",
|
|
1328
1651
|
"description": "Path to a Blueprint file or directory containing one",
|
|
1329
1652
|
"env": "SANITY_BLUEPRINT_PATH",
|
|
1330
|
-
"hidden": true,
|
|
1331
1653
|
"name": "path",
|
|
1332
1654
|
"hasDynamicHelp": false,
|
|
1333
1655
|
"multiple": false,
|
|
@@ -1348,79 +1670,44 @@
|
|
|
1348
1670
|
"type": "boolean"
|
|
1349
1671
|
},
|
|
1350
1672
|
"verbose": {
|
|
1351
|
-
"description": "Verbose output",
|
|
1352
|
-
"
|
|
1353
|
-
"
|
|
1354
|
-
"
|
|
1355
|
-
"type": "boolean"
|
|
1356
|
-
},
|
|
1357
|
-
"stack": {
|
|
1358
|
-
"description": "Stack name or ID to use instead of the locally configured Stack",
|
|
1359
|
-
"name": "stack",
|
|
1360
|
-
"hasDynamicHelp": false,
|
|
1361
|
-
"multiple": false,
|
|
1362
|
-
"type": "option"
|
|
1363
|
-
},
|
|
1364
|
-
"project-id": {
|
|
1365
|
-
"aliases": [
|
|
1366
|
-
"project",
|
|
1367
|
-
"projectId"
|
|
1368
|
-
],
|
|
1369
|
-
"description": "Sanity project ID used to scope Blueprint and Stack",
|
|
1370
|
-
"exclusive": [
|
|
1371
|
-
"organization-id"
|
|
1372
|
-
],
|
|
1373
|
-
"name": "project-id",
|
|
1374
|
-
"hasDynamicHelp": false,
|
|
1375
|
-
"multiple": false,
|
|
1376
|
-
"type": "option"
|
|
1673
|
+
"description": "Verbose output; defaults to true",
|
|
1674
|
+
"name": "verbose",
|
|
1675
|
+
"allowNo": true,
|
|
1676
|
+
"type": "boolean"
|
|
1377
1677
|
},
|
|
1378
|
-
"
|
|
1379
|
-
"
|
|
1380
|
-
|
|
1381
|
-
|
|
1382
|
-
|
|
1383
|
-
],
|
|
1384
|
-
"description": "Sanity organization ID used to scope Blueprint and Stack",
|
|
1385
|
-
"exclusive": [
|
|
1386
|
-
"project-id"
|
|
1387
|
-
],
|
|
1388
|
-
"name": "organization-id",
|
|
1389
|
-
"hasDynamicHelp": false,
|
|
1390
|
-
"multiple": false,
|
|
1391
|
-
"type": "option"
|
|
1678
|
+
"fix": {
|
|
1679
|
+
"description": "Interactively fix configuration issues",
|
|
1680
|
+
"name": "fix",
|
|
1681
|
+
"allowNo": false,
|
|
1682
|
+
"type": "boolean"
|
|
1392
1683
|
}
|
|
1393
1684
|
},
|
|
1394
1685
|
"hasDynamicHelp": false,
|
|
1395
1686
|
"hiddenAliases": [],
|
|
1396
|
-
"id": "blueprints:
|
|
1687
|
+
"id": "blueprints:doctor",
|
|
1397
1688
|
"pluginAlias": "@sanity/runtime-cli",
|
|
1398
1689
|
"pluginName": "@sanity/runtime-cli",
|
|
1399
1690
|
"pluginType": "core",
|
|
1400
1691
|
"strict": true,
|
|
1401
|
-
"summary": "
|
|
1692
|
+
"summary": "Diagnose potential issues with local Blueprint and remote Stack configuration",
|
|
1402
1693
|
"enableJsonFlag": true,
|
|
1403
|
-
"needs": [
|
|
1404
|
-
"token",
|
|
1405
|
-
"blueprint"
|
|
1406
|
-
],
|
|
1407
1694
|
"isESM": true,
|
|
1408
1695
|
"relativePath": [
|
|
1409
1696
|
"dist",
|
|
1410
1697
|
"commands",
|
|
1411
1698
|
"blueprints",
|
|
1412
|
-
"
|
|
1699
|
+
"doctor.js"
|
|
1413
1700
|
]
|
|
1414
1701
|
},
|
|
1415
|
-
"blueprints:
|
|
1702
|
+
"blueprints:info": {
|
|
1416
1703
|
"aliases": [],
|
|
1417
1704
|
"args": {},
|
|
1418
|
-
"description": "
|
|
1705
|
+
"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.",
|
|
1419
1706
|
"examples": [
|
|
1420
1707
|
"<%= config.bin %> <%= command.id %>",
|
|
1421
1708
|
"<%= config.bin %> <%= command.id %> --stack <name-or-id>",
|
|
1422
|
-
"<%= config.bin %> <%= command.id %> --project-id <
|
|
1423
|
-
"<%= config.bin %> <%= command.id %> --
|
|
1709
|
+
"<%= config.bin %> <%= command.id %> --project-id <id> --stack <name-or-id>",
|
|
1710
|
+
"<%= config.bin %> <%= command.id %> --organization-id <orgId> --stack <name-or-id>"
|
|
1424
1711
|
],
|
|
1425
1712
|
"flags": {
|
|
1426
1713
|
"json": {
|
|
@@ -1467,7 +1754,7 @@
|
|
|
1467
1754
|
"aliases": [
|
|
1468
1755
|
"id"
|
|
1469
1756
|
],
|
|
1470
|
-
"description": "Stack name or ID
|
|
1757
|
+
"description": "Stack name or ID",
|
|
1471
1758
|
"name": "stack",
|
|
1472
1759
|
"hasDynamicHelp": false,
|
|
1473
1760
|
"multiple": false,
|
|
@@ -1497,56 +1784,52 @@
|
|
|
1497
1784
|
"exclusive": [
|
|
1498
1785
|
"project-id"
|
|
1499
1786
|
],
|
|
1500
|
-
"hidden": true,
|
|
1501
1787
|
"name": "organization-id",
|
|
1502
1788
|
"hasDynamicHelp": false,
|
|
1503
1789
|
"multiple": false,
|
|
1504
1790
|
"type": "option"
|
|
1505
|
-
},
|
|
1506
|
-
"force": {
|
|
1507
|
-
"description": "Skip confirmation prompt",
|
|
1508
|
-
"name": "force",
|
|
1509
|
-
"allowNo": false,
|
|
1510
|
-
"type": "boolean"
|
|
1511
|
-
},
|
|
1512
|
-
"new-stack-name": {
|
|
1513
|
-
"description": "Set a new name for the Stack while promoting",
|
|
1514
|
-
"name": "new-stack-name",
|
|
1515
|
-
"hasDynamicHelp": false,
|
|
1516
|
-
"multiple": false,
|
|
1517
|
-
"type": "option"
|
|
1518
1791
|
}
|
|
1519
1792
|
},
|
|
1520
1793
|
"hasDynamicHelp": false,
|
|
1521
1794
|
"hiddenAliases": [],
|
|
1522
|
-
"id": "blueprints:
|
|
1795
|
+
"id": "blueprints:info",
|
|
1523
1796
|
"pluginAlias": "@sanity/runtime-cli",
|
|
1524
1797
|
"pluginName": "@sanity/runtime-cli",
|
|
1525
1798
|
"pluginType": "core",
|
|
1526
1799
|
"strict": true,
|
|
1527
|
-
"summary": "
|
|
1800
|
+
"summary": "Display the status and resources of the remote Stack deployment",
|
|
1528
1801
|
"enableJsonFlag": true,
|
|
1529
1802
|
"needs": [
|
|
1530
|
-
"deployedStack"
|
|
1531
|
-
"blueprint"
|
|
1803
|
+
"deployedStack"
|
|
1532
1804
|
],
|
|
1533
1805
|
"isESM": true,
|
|
1534
1806
|
"relativePath": [
|
|
1535
1807
|
"dist",
|
|
1536
1808
|
"commands",
|
|
1537
1809
|
"blueprints",
|
|
1538
|
-
"
|
|
1810
|
+
"info.js"
|
|
1539
1811
|
]
|
|
1540
1812
|
},
|
|
1541
|
-
"blueprints:
|
|
1813
|
+
"blueprints:init": {
|
|
1542
1814
|
"aliases": [],
|
|
1543
|
-
"args": {
|
|
1544
|
-
|
|
1815
|
+
"args": {
|
|
1816
|
+
"dir": {
|
|
1817
|
+
"description": "Directory to create the local Blueprint in (defaults to the current directory)",
|
|
1818
|
+
"name": "dir"
|
|
1819
|
+
}
|
|
1820
|
+
},
|
|
1821
|
+
"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[NOTE: Currently, accounts are limited to three (3) Stacks per project scope.]\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. This is .gitignored by default.\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.",
|
|
1545
1822
|
"examples": [
|
|
1546
1823
|
"<%= config.bin %> <%= command.id %>",
|
|
1547
|
-
"<%= config.bin %> <%= command.id %>
|
|
1824
|
+
"<%= config.bin %> <%= command.id %> .",
|
|
1825
|
+
"<%= config.bin %> <%= command.id %> [directory]",
|
|
1826
|
+
"<%= config.bin %> <%= command.id %> --blueprint-type <json|js|ts>",
|
|
1548
1827
|
"<%= config.bin %> <%= command.id %> --organization-id <organizationId>",
|
|
1549
|
-
"<%= config.bin %> <%= command.id %> --
|
|
1828
|
+
"<%= config.bin %> <%= command.id %> --project-id <projectId>",
|
|
1829
|
+
"<%= config.bin %> <%= command.id %> --stack-name <newStackName>",
|
|
1830
|
+
"<%= config.bin %> <%= command.id %> --stack-id <existingStackId>",
|
|
1831
|
+
"<%= config.bin %> <%= command.id %> new-stack --type <json|js|ts> --org <organizationId> --name <newStackName>",
|
|
1832
|
+
"<%= config.bin %> <%= command.id %> old-stack --type <json|js|ts> --project-id <projectId> --stack-id <existingStackId>"
|
|
1550
1833
|
],
|
|
1551
1834
|
"flags": {
|
|
1552
1835
|
"json": {
|
|
@@ -1589,12 +1872,41 @@
|
|
|
1589
1872
|
"allowNo": false,
|
|
1590
1873
|
"type": "boolean"
|
|
1591
1874
|
},
|
|
1592
|
-
"
|
|
1593
|
-
"description": "
|
|
1594
|
-
"
|
|
1595
|
-
"
|
|
1875
|
+
"dir": {
|
|
1876
|
+
"description": "Directory to create the local Blueprint in",
|
|
1877
|
+
"name": "dir",
|
|
1878
|
+
"hasDynamicHelp": false,
|
|
1879
|
+
"multiple": false,
|
|
1880
|
+
"type": "option"
|
|
1881
|
+
},
|
|
1882
|
+
"example": {
|
|
1883
|
+
"aliases": [
|
|
1884
|
+
"recipe"
|
|
1885
|
+
],
|
|
1886
|
+
"description": "Example to use for the local Blueprint",
|
|
1887
|
+
"exclusive": [
|
|
1888
|
+
"blueprint-type",
|
|
1889
|
+
"stack-id",
|
|
1890
|
+
"stack-name"
|
|
1891
|
+
],
|
|
1892
|
+
"name": "example",
|
|
1893
|
+
"hasDynamicHelp": false,
|
|
1894
|
+
"multiple": false,
|
|
1895
|
+
"type": "option"
|
|
1896
|
+
},
|
|
1897
|
+
"blueprint-type": {
|
|
1898
|
+
"aliases": [
|
|
1899
|
+
"type"
|
|
1900
|
+
],
|
|
1901
|
+
"description": "Blueprint manifest type to use for the local Blueprint",
|
|
1902
|
+
"name": "blueprint-type",
|
|
1596
1903
|
"hasDynamicHelp": false,
|
|
1597
1904
|
"multiple": false,
|
|
1905
|
+
"options": [
|
|
1906
|
+
"json",
|
|
1907
|
+
"js",
|
|
1908
|
+
"ts"
|
|
1909
|
+
],
|
|
1598
1910
|
"type": "option"
|
|
1599
1911
|
},
|
|
1600
1912
|
"project-id": {
|
|
@@ -1604,8 +1916,7 @@
|
|
|
1604
1916
|
],
|
|
1605
1917
|
"description": "Sanity project ID used to scope Blueprint and Stack",
|
|
1606
1918
|
"exclusive": [
|
|
1607
|
-
"organization-id"
|
|
1608
|
-
"include-projects"
|
|
1919
|
+
"organization-id"
|
|
1609
1920
|
],
|
|
1610
1921
|
"name": "project-id",
|
|
1611
1922
|
"hasDynamicHelp": false,
|
|
@@ -1627,46 +1938,79 @@
|
|
|
1627
1938
|
"multiple": false,
|
|
1628
1939
|
"type": "option"
|
|
1629
1940
|
},
|
|
1630
|
-
"
|
|
1631
|
-
"
|
|
1632
|
-
"
|
|
1941
|
+
"stack-id": {
|
|
1942
|
+
"aliases": [
|
|
1943
|
+
"stackId"
|
|
1633
1944
|
],
|
|
1634
|
-
"description": "
|
|
1635
|
-
"
|
|
1636
|
-
|
|
1637
|
-
|
|
1945
|
+
"description": "Existing Stack ID used to scope local Blueprint",
|
|
1946
|
+
"exclusive": [
|
|
1947
|
+
"stack-name"
|
|
1948
|
+
],
|
|
1949
|
+
"name": "stack-id",
|
|
1950
|
+
"relationships": [
|
|
1951
|
+
{
|
|
1952
|
+
"type": "some",
|
|
1953
|
+
"flags": [
|
|
1954
|
+
"project-id",
|
|
1955
|
+
"organization-id"
|
|
1956
|
+
]
|
|
1957
|
+
}
|
|
1958
|
+
],
|
|
1959
|
+
"hasDynamicHelp": false,
|
|
1960
|
+
"multiple": false,
|
|
1961
|
+
"type": "option"
|
|
1962
|
+
},
|
|
1963
|
+
"stack-name": {
|
|
1964
|
+
"aliases": [
|
|
1965
|
+
"name"
|
|
1966
|
+
],
|
|
1967
|
+
"description": "Name to use for a new Stack provisioned during initialization",
|
|
1968
|
+
"exclusive": [
|
|
1969
|
+
"stack-id"
|
|
1970
|
+
],
|
|
1971
|
+
"name": "stack-name",
|
|
1972
|
+
"relationships": [
|
|
1973
|
+
{
|
|
1974
|
+
"type": "some",
|
|
1975
|
+
"flags": [
|
|
1976
|
+
"project-id",
|
|
1977
|
+
"organization-id"
|
|
1978
|
+
]
|
|
1979
|
+
}
|
|
1980
|
+
],
|
|
1981
|
+
"hasDynamicHelp": false,
|
|
1982
|
+
"multiple": false,
|
|
1983
|
+
"type": "option"
|
|
1638
1984
|
}
|
|
1639
1985
|
},
|
|
1640
1986
|
"hasDynamicHelp": false,
|
|
1641
1987
|
"hiddenAliases": [],
|
|
1642
|
-
"id": "blueprints:
|
|
1988
|
+
"id": "blueprints:init",
|
|
1643
1989
|
"pluginAlias": "@sanity/runtime-cli",
|
|
1644
1990
|
"pluginName": "@sanity/runtime-cli",
|
|
1645
1991
|
"pluginType": "core",
|
|
1646
1992
|
"strict": true,
|
|
1647
|
-
"summary": "
|
|
1993
|
+
"summary": "Initialize a Blueprint and create a remote Stack",
|
|
1648
1994
|
"enableJsonFlag": true,
|
|
1649
|
-
"needs": [
|
|
1650
|
-
"scope"
|
|
1651
|
-
],
|
|
1652
1995
|
"isESM": true,
|
|
1653
1996
|
"relativePath": [
|
|
1654
1997
|
"dist",
|
|
1655
1998
|
"commands",
|
|
1656
1999
|
"blueprints",
|
|
1657
|
-
"
|
|
2000
|
+
"init.js"
|
|
1658
2001
|
]
|
|
1659
2002
|
},
|
|
1660
|
-
"
|
|
2003
|
+
"blueprints:logs": {
|
|
1661
2004
|
"aliases": [],
|
|
1662
2005
|
"args": {},
|
|
1663
|
-
"description": "
|
|
2006
|
+
"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'.",
|
|
1664
2007
|
"examples": [
|
|
1665
2008
|
"<%= config.bin %> <%= command.id %>",
|
|
1666
|
-
"<%= config.bin %> <%= command.id %> --
|
|
1667
|
-
"<%= config.bin %> <%= command.id %> --name
|
|
1668
|
-
"<%= config.bin %> <%= command.id %> --
|
|
1669
|
-
"<%= config.bin %> <%= command.id %> --
|
|
2009
|
+
"<%= config.bin %> <%= command.id %> --watch",
|
|
2010
|
+
"<%= config.bin %> <%= command.id %> --stack <name-or-id>",
|
|
2011
|
+
"<%= config.bin %> <%= command.id %> --limit 500",
|
|
2012
|
+
"<%= config.bin %> <%= command.id %> --since 2026-05-01T00:00:00Z",
|
|
2013
|
+
"<%= config.bin %> <%= command.id %> --before 2026-05-01T00:00:00Z"
|
|
1670
2014
|
],
|
|
1671
2015
|
"flags": {
|
|
1672
2016
|
"json": {
|
|
@@ -1711,7 +2055,6 @@
|
|
|
1711
2055
|
},
|
|
1712
2056
|
"stack": {
|
|
1713
2057
|
"description": "Stack name or ID to use instead of the locally configured Stack",
|
|
1714
|
-
"hidden": true,
|
|
1715
2058
|
"name": "stack",
|
|
1716
2059
|
"hasDynamicHelp": false,
|
|
1717
2060
|
"multiple": false,
|
|
@@ -1726,7 +2069,6 @@
|
|
|
1726
2069
|
"exclusive": [
|
|
1727
2070
|
"organization-id"
|
|
1728
2071
|
],
|
|
1729
|
-
"hidden": true,
|
|
1730
2072
|
"name": "project-id",
|
|
1731
2073
|
"hasDynamicHelp": false,
|
|
1732
2074
|
"multiple": false,
|
|
@@ -1742,145 +2084,86 @@
|
|
|
1742
2084
|
"exclusive": [
|
|
1743
2085
|
"project-id"
|
|
1744
2086
|
],
|
|
1745
|
-
"hidden": true,
|
|
1746
2087
|
"name": "organization-id",
|
|
1747
2088
|
"hasDynamicHelp": false,
|
|
1748
2089
|
"multiple": false,
|
|
1749
2090
|
"type": "option"
|
|
1750
2091
|
},
|
|
1751
|
-
"
|
|
1752
|
-
"aliases": [
|
|
1753
|
-
"recipe"
|
|
1754
|
-
],
|
|
1755
|
-
"description": "Example to use for the Function",
|
|
1756
|
-
"exclusive": [
|
|
1757
|
-
"name",
|
|
1758
|
-
"fn-type",
|
|
1759
|
-
"language",
|
|
1760
|
-
"javascript",
|
|
1761
|
-
"fn-helpers",
|
|
1762
|
-
"fn-installer"
|
|
1763
|
-
],
|
|
1764
|
-
"name": "example",
|
|
1765
|
-
"hasDynamicHelp": false,
|
|
1766
|
-
"multiple": false,
|
|
1767
|
-
"type": "option"
|
|
1768
|
-
},
|
|
1769
|
-
"name": {
|
|
1770
|
-
"char": "n",
|
|
1771
|
-
"description": "Name of the Function to add",
|
|
1772
|
-
"name": "name",
|
|
1773
|
-
"hasDynamicHelp": false,
|
|
1774
|
-
"multiple": false,
|
|
1775
|
-
"type": "option"
|
|
1776
|
-
},
|
|
1777
|
-
"type": {
|
|
1778
|
-
"dependsOn": [
|
|
1779
|
-
"name"
|
|
1780
|
-
],
|
|
1781
|
-
"description": "Document change event(s) that should trigger the function; you can specify multiple events by specifying this flag multiple times",
|
|
1782
|
-
"name": "type",
|
|
1783
|
-
"hasDynamicHelp": false,
|
|
1784
|
-
"multiple": true,
|
|
1785
|
-
"options": [
|
|
1786
|
-
"document-publish",
|
|
1787
|
-
"document-create",
|
|
1788
|
-
"document-delete",
|
|
1789
|
-
"document-update",
|
|
1790
|
-
"media-library-asset-create",
|
|
1791
|
-
"media-library-asset-delete",
|
|
1792
|
-
"media-library-asset-update",
|
|
1793
|
-
"scheduled-function",
|
|
1794
|
-
"sync-tag-invalidate"
|
|
1795
|
-
],
|
|
1796
|
-
"type": "option"
|
|
1797
|
-
},
|
|
1798
|
-
"language": {
|
|
1799
|
-
"aliases": [
|
|
1800
|
-
"lang"
|
|
1801
|
-
],
|
|
1802
|
-
"description": "Language of the new Function",
|
|
1803
|
-
"name": "language",
|
|
1804
|
-
"default": "ts",
|
|
1805
|
-
"hasDynamicHelp": false,
|
|
1806
|
-
"multiple": false,
|
|
1807
|
-
"options": [
|
|
1808
|
-
"ts",
|
|
1809
|
-
"js"
|
|
1810
|
-
],
|
|
1811
|
-
"type": "option"
|
|
1812
|
-
},
|
|
1813
|
-
"javascript": {
|
|
2092
|
+
"watch": {
|
|
1814
2093
|
"aliases": [
|
|
1815
|
-
"
|
|
1816
|
-
],
|
|
1817
|
-
"description": "Use JavaScript instead of TypeScript",
|
|
1818
|
-
"exclusive": [
|
|
1819
|
-
"language"
|
|
2094
|
+
"follow"
|
|
1820
2095
|
],
|
|
1821
|
-
"
|
|
2096
|
+
"char": "w",
|
|
2097
|
+
"description": "Watch for new Stack logs",
|
|
2098
|
+
"name": "watch",
|
|
1822
2099
|
"allowNo": false,
|
|
1823
2100
|
"type": "boolean"
|
|
1824
2101
|
},
|
|
1825
|
-
"
|
|
1826
|
-
"
|
|
1827
|
-
"
|
|
1828
|
-
"
|
|
1829
|
-
|
|
1830
|
-
|
|
1831
|
-
|
|
1832
|
-
"description": "How to install the @sanity/functions helpers",
|
|
1833
|
-
"name": "installer",
|
|
2102
|
+
"limit": {
|
|
2103
|
+
"char": "l",
|
|
2104
|
+
"description": "Maximum number of log entries to retrieve (1-500)",
|
|
2105
|
+
"exclusive": [
|
|
2106
|
+
"watch"
|
|
2107
|
+
],
|
|
2108
|
+
"name": "limit",
|
|
1834
2109
|
"hasDynamicHelp": false,
|
|
1835
2110
|
"multiple": false,
|
|
1836
|
-
"
|
|
1837
|
-
|
|
1838
|
-
|
|
1839
|
-
|
|
1840
|
-
|
|
2111
|
+
"type": "option"
|
|
2112
|
+
},
|
|
2113
|
+
"since": {
|
|
2114
|
+
"description": "Only show logs after this ISO 8601 timestamp",
|
|
2115
|
+
"exclusive": [
|
|
2116
|
+
"watch"
|
|
1841
2117
|
],
|
|
2118
|
+
"name": "since",
|
|
2119
|
+
"hasDynamicHelp": false,
|
|
2120
|
+
"multiple": false,
|
|
1842
2121
|
"type": "option"
|
|
1843
2122
|
},
|
|
1844
|
-
"
|
|
1845
|
-
"
|
|
1846
|
-
"description": "Shortcut for --fn-installer npm",
|
|
2123
|
+
"before": {
|
|
2124
|
+
"description": "Only show logs before this ISO 8601 timestamp",
|
|
1847
2125
|
"exclusive": [
|
|
1848
|
-
"
|
|
2126
|
+
"watch"
|
|
1849
2127
|
],
|
|
1850
|
-
"name": "
|
|
1851
|
-
"
|
|
1852
|
-
"
|
|
2128
|
+
"name": "before",
|
|
2129
|
+
"hasDynamicHelp": false,
|
|
2130
|
+
"multiple": false,
|
|
2131
|
+
"type": "option"
|
|
1853
2132
|
}
|
|
1854
2133
|
},
|
|
1855
2134
|
"hasDynamicHelp": false,
|
|
1856
2135
|
"hiddenAliases": [],
|
|
1857
|
-
"id": "
|
|
2136
|
+
"id": "blueprints:logs",
|
|
1858
2137
|
"pluginAlias": "@sanity/runtime-cli",
|
|
1859
2138
|
"pluginName": "@sanity/runtime-cli",
|
|
1860
2139
|
"pluginType": "core",
|
|
1861
2140
|
"strict": true,
|
|
1862
|
-
"summary": "
|
|
2141
|
+
"summary": "Display logs for the current Blueprint's Stack deployment",
|
|
1863
2142
|
"enableJsonFlag": true,
|
|
1864
2143
|
"needs": [
|
|
1865
|
-
"
|
|
2144
|
+
"deployedStack"
|
|
1866
2145
|
],
|
|
1867
2146
|
"isESM": true,
|
|
1868
2147
|
"relativePath": [
|
|
1869
2148
|
"dist",
|
|
1870
2149
|
"commands",
|
|
1871
|
-
"
|
|
1872
|
-
"
|
|
2150
|
+
"blueprints",
|
|
2151
|
+
"logs.js"
|
|
1873
2152
|
]
|
|
1874
2153
|
},
|
|
1875
|
-
"
|
|
2154
|
+
"blueprints:mint-deploy-token": {
|
|
1876
2155
|
"aliases": [],
|
|
1877
|
-
"args": {
|
|
1878
|
-
|
|
1879
|
-
|
|
1880
|
-
|
|
1881
|
-
|
|
1882
|
-
|
|
1883
|
-
|
|
2156
|
+
"args": {},
|
|
2157
|
+
"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.",
|
|
2158
|
+
"examples": [
|
|
2159
|
+
"<%= config.bin %> <%= command.id %>",
|
|
2160
|
+
"<%= config.bin %> <%= command.id %> --label \"ci-deploy\"",
|
|
2161
|
+
"<%= config.bin %> <%= command.id %> --print",
|
|
2162
|
+
"export SANITY_AUTH_TOKEN=$(<%= config.bin %> <%= command.id %> --print)",
|
|
2163
|
+
"<%= config.bin %> <%= command.id %> --json",
|
|
2164
|
+
"<%= config.bin %> <%= command.id %> --project-id <projectId>",
|
|
2165
|
+
"<%= config.bin %> <%= command.id %> --organization-id <orgId>"
|
|
2166
|
+
],
|
|
1884
2167
|
"flags": {
|
|
1885
2168
|
"json": {
|
|
1886
2169
|
"description": "Format output as json",
|
|
@@ -1939,7 +2222,6 @@
|
|
|
1939
2222
|
"exclusive": [
|
|
1940
2223
|
"organization-id"
|
|
1941
2224
|
],
|
|
1942
|
-
"hidden": true,
|
|
1943
2225
|
"name": "project-id",
|
|
1944
2226
|
"hasDynamicHelp": false,
|
|
1945
2227
|
"multiple": false,
|
|
@@ -1955,66 +2237,57 @@
|
|
|
1955
2237
|
"exclusive": [
|
|
1956
2238
|
"project-id"
|
|
1957
2239
|
],
|
|
1958
|
-
"hidden": true,
|
|
1959
2240
|
"name": "organization-id",
|
|
1960
2241
|
"hasDynamicHelp": false,
|
|
1961
2242
|
"multiple": false,
|
|
1962
2243
|
"type": "option"
|
|
1963
2244
|
},
|
|
1964
|
-
"
|
|
1965
|
-
"
|
|
1966
|
-
|
|
1967
|
-
"installer"
|
|
1968
|
-
],
|
|
1969
|
-
"description": "Which package manager to use when building Functions",
|
|
1970
|
-
"hidden": true,
|
|
1971
|
-
"name": "fn-installer",
|
|
2245
|
+
"label": {
|
|
2246
|
+
"description": "Human-readable label for the robot. Defaults to a generated value.",
|
|
2247
|
+
"name": "label",
|
|
1972
2248
|
"hasDynamicHelp": false,
|
|
1973
2249
|
"multiple": false,
|
|
1974
|
-
"options": [
|
|
1975
|
-
"npm",
|
|
1976
|
-
"pnpm",
|
|
1977
|
-
"yarn"
|
|
1978
|
-
],
|
|
1979
2250
|
"type": "option"
|
|
1980
2251
|
},
|
|
1981
|
-
"
|
|
1982
|
-
"char": "
|
|
1983
|
-
"description": "
|
|
1984
|
-
"
|
|
1985
|
-
|
|
1986
|
-
|
|
1987
|
-
"
|
|
2252
|
+
"print": {
|
|
2253
|
+
"char": "P",
|
|
2254
|
+
"description": "Print only the raw token to stdout (suitable for shell substitution)",
|
|
2255
|
+
"exclusive": [
|
|
2256
|
+
"json"
|
|
2257
|
+
],
|
|
2258
|
+
"name": "print",
|
|
2259
|
+
"allowNo": false,
|
|
2260
|
+
"type": "boolean"
|
|
1988
2261
|
}
|
|
1989
2262
|
},
|
|
1990
2263
|
"hasDynamicHelp": false,
|
|
1991
|
-
"hidden": true,
|
|
1992
2264
|
"hiddenAliases": [],
|
|
1993
|
-
"id": "
|
|
2265
|
+
"id": "blueprints:mint-deploy-token",
|
|
1994
2266
|
"pluginAlias": "@sanity/runtime-cli",
|
|
1995
2267
|
"pluginName": "@sanity/runtime-cli",
|
|
1996
2268
|
"pluginType": "core",
|
|
1997
2269
|
"strict": true,
|
|
1998
|
-
"summary": "
|
|
2270
|
+
"summary": "Create a robot API token for deploying Blueprints from CI/CD",
|
|
1999
2271
|
"enableJsonFlag": true,
|
|
2000
2272
|
"needs": [
|
|
2001
|
-
"
|
|
2273
|
+
"scope"
|
|
2002
2274
|
],
|
|
2003
2275
|
"isESM": true,
|
|
2004
2276
|
"relativePath": [
|
|
2005
2277
|
"dist",
|
|
2006
2278
|
"commands",
|
|
2007
|
-
"
|
|
2008
|
-
"
|
|
2279
|
+
"blueprints",
|
|
2280
|
+
"mint-deploy-token.js"
|
|
2009
2281
|
]
|
|
2010
2282
|
},
|
|
2011
|
-
"
|
|
2283
|
+
"blueprints:plan": {
|
|
2012
2284
|
"aliases": [],
|
|
2013
2285
|
"args": {},
|
|
2014
|
-
"description": "
|
|
2286
|
+
"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.",
|
|
2015
2287
|
"examples": [
|
|
2016
|
-
"<%= config.bin %> <%= command.id %>
|
|
2017
|
-
"<%= config.bin %> <%= command.id %> --
|
|
2288
|
+
"<%= config.bin %> <%= command.id %>",
|
|
2289
|
+
"<%= config.bin %> <%= command.id %> --stack <name-or-id>",
|
|
2290
|
+
"<%= config.bin %> <%= command.id %> --organization-id <orgId> --stack <name-or-id>"
|
|
2018
2291
|
],
|
|
2019
2292
|
"flags": {
|
|
2020
2293
|
"json": {
|
|
@@ -2059,7 +2332,6 @@
|
|
|
2059
2332
|
},
|
|
2060
2333
|
"stack": {
|
|
2061
2334
|
"description": "Stack name or ID to use instead of the locally configured Stack",
|
|
2062
|
-
"hidden": true,
|
|
2063
2335
|
"name": "stack",
|
|
2064
2336
|
"hasDynamicHelp": false,
|
|
2065
2337
|
"multiple": false,
|
|
@@ -2074,7 +2346,6 @@
|
|
|
2074
2346
|
"exclusive": [
|
|
2075
2347
|
"organization-id"
|
|
2076
2348
|
],
|
|
2077
|
-
"hidden": true,
|
|
2078
2349
|
"name": "project-id",
|
|
2079
2350
|
"hasDynamicHelp": false,
|
|
2080
2351
|
"multiple": false,
|
|
@@ -2090,75 +2361,42 @@
|
|
|
2090
2361
|
"exclusive": [
|
|
2091
2362
|
"project-id"
|
|
2092
2363
|
],
|
|
2093
|
-
"hidden": true,
|
|
2094
2364
|
"name": "organization-id",
|
|
2095
2365
|
"hasDynamicHelp": false,
|
|
2096
2366
|
"multiple": false,
|
|
2097
2367
|
"type": "option"
|
|
2098
|
-
},
|
|
2099
|
-
"host": {
|
|
2100
|
-
"char": "h",
|
|
2101
|
-
"description": "The local network interface at which to listen. [default: \"localhost\"]",
|
|
2102
|
-
"name": "host",
|
|
2103
|
-
"required": false,
|
|
2104
|
-
"hasDynamicHelp": false,
|
|
2105
|
-
"multiple": false,
|
|
2106
|
-
"type": "option"
|
|
2107
|
-
},
|
|
2108
|
-
"port": {
|
|
2109
|
-
"char": "p",
|
|
2110
|
-
"description": "TCP port to start emulator on. [default: 8080]",
|
|
2111
|
-
"name": "port",
|
|
2112
|
-
"required": false,
|
|
2113
|
-
"hasDynamicHelp": false,
|
|
2114
|
-
"multiple": false,
|
|
2115
|
-
"type": "option"
|
|
2116
|
-
},
|
|
2117
|
-
"timeout": {
|
|
2118
|
-
"char": "t",
|
|
2119
|
-
"description": "Maximum execution time for all functions, in seconds. Takes precedence over function-specific `timeout`",
|
|
2120
|
-
"name": "timeout",
|
|
2121
|
-
"required": false,
|
|
2122
|
-
"hasDynamicHelp": false,
|
|
2123
|
-
"multiple": false,
|
|
2124
|
-
"type": "option"
|
|
2125
2368
|
}
|
|
2126
2369
|
},
|
|
2127
2370
|
"hasDynamicHelp": false,
|
|
2128
2371
|
"hiddenAliases": [],
|
|
2129
|
-
"id": "
|
|
2372
|
+
"id": "blueprints:plan",
|
|
2130
2373
|
"pluginAlias": "@sanity/runtime-cli",
|
|
2131
2374
|
"pluginName": "@sanity/runtime-cli",
|
|
2132
2375
|
"pluginType": "core",
|
|
2133
2376
|
"strict": true,
|
|
2134
|
-
"summary": "
|
|
2377
|
+
"summary": "Preview changes that will be applied to the remote Stack",
|
|
2135
2378
|
"enableJsonFlag": true,
|
|
2136
2379
|
"needs": [
|
|
2380
|
+
"token",
|
|
2137
2381
|
"blueprint"
|
|
2138
2382
|
],
|
|
2139
2383
|
"isESM": true,
|
|
2140
2384
|
"relativePath": [
|
|
2141
2385
|
"dist",
|
|
2142
2386
|
"commands",
|
|
2143
|
-
"
|
|
2144
|
-
"
|
|
2387
|
+
"blueprints",
|
|
2388
|
+
"plan.js"
|
|
2145
2389
|
]
|
|
2146
2390
|
},
|
|
2147
|
-
"
|
|
2391
|
+
"blueprints:promote": {
|
|
2148
2392
|
"aliases": [],
|
|
2149
|
-
"args": {
|
|
2150
|
-
|
|
2151
|
-
"description": "The name of the Sanity Function",
|
|
2152
|
-
"name": "name",
|
|
2153
|
-
"required": false
|
|
2154
|
-
}
|
|
2155
|
-
},
|
|
2156
|
-
"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).",
|
|
2393
|
+
"args": {},
|
|
2394
|
+
"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.",
|
|
2157
2395
|
"examples": [
|
|
2158
|
-
"<%= config.bin %> <%= command.id %>
|
|
2159
|
-
"<%= config.bin %> <%= command.id %> <name>
|
|
2160
|
-
"<%= config.bin %> <%= command.id %> <
|
|
2161
|
-
"<%= config.bin %> <%= command.id %> <name>
|
|
2396
|
+
"<%= config.bin %> <%= command.id %>",
|
|
2397
|
+
"<%= config.bin %> <%= command.id %> --stack <name-or-id>",
|
|
2398
|
+
"<%= config.bin %> <%= command.id %> --project-id <projectId> --stack <name-or-id>",
|
|
2399
|
+
"<%= config.bin %> <%= command.id %> --new-stack-name <new-name>"
|
|
2162
2400
|
],
|
|
2163
2401
|
"flags": {
|
|
2164
2402
|
"json": {
|
|
@@ -2202,7 +2440,10 @@
|
|
|
2202
2440
|
"type": "boolean"
|
|
2203
2441
|
},
|
|
2204
2442
|
"stack": {
|
|
2205
|
-
"
|
|
2443
|
+
"aliases": [
|
|
2444
|
+
"id"
|
|
2445
|
+
],
|
|
2446
|
+
"description": "Stack name or ID to promote",
|
|
2206
2447
|
"name": "stack",
|
|
2207
2448
|
"hasDynamicHelp": false,
|
|
2208
2449
|
"multiple": false,
|
|
@@ -2217,7 +2458,6 @@
|
|
|
2217
2458
|
"exclusive": [
|
|
2218
2459
|
"organization-id"
|
|
2219
2460
|
],
|
|
2220
|
-
"hidden": true,
|
|
2221
2461
|
"name": "project-id",
|
|
2222
2462
|
"hasDynamicHelp": false,
|
|
2223
2463
|
"multiple": false,
|
|
@@ -2239,66 +2479,28 @@
|
|
|
2239
2479
|
"multiple": false,
|
|
2240
2480
|
"type": "option"
|
|
2241
2481
|
},
|
|
2242
|
-
"limit": {
|
|
2243
|
-
"char": "l",
|
|
2244
|
-
"description": "Total number of log entries to retrieve",
|
|
2245
|
-
"name": "limit",
|
|
2246
|
-
"required": false,
|
|
2247
|
-
"default": 50,
|
|
2248
|
-
"hasDynamicHelp": false,
|
|
2249
|
-
"multiple": false,
|
|
2250
|
-
"type": "option"
|
|
2251
|
-
},
|
|
2252
|
-
"utc": {
|
|
2253
|
-
"char": "u",
|
|
2254
|
-
"description": "Show dates in UTC time zone",
|
|
2255
|
-
"name": "utc",
|
|
2256
|
-
"required": false,
|
|
2257
|
-
"allowNo": false,
|
|
2258
|
-
"type": "boolean"
|
|
2259
|
-
},
|
|
2260
|
-
"delete": {
|
|
2261
|
-
"char": "d",
|
|
2262
|
-
"description": "Delete all logs for the function",
|
|
2263
|
-
"exclusive": [
|
|
2264
|
-
"limit",
|
|
2265
|
-
"json"
|
|
2266
|
-
],
|
|
2267
|
-
"name": "delete",
|
|
2268
|
-
"required": false,
|
|
2269
|
-
"allowNo": false,
|
|
2270
|
-
"type": "boolean"
|
|
2271
|
-
},
|
|
2272
2482
|
"force": {
|
|
2273
|
-
"
|
|
2274
|
-
"
|
|
2275
|
-
"delete"
|
|
2276
|
-
],
|
|
2277
|
-
"description": "Skip confirmation for deleting logs",
|
|
2278
|
-
"name": "force",
|
|
2279
|
-
"required": false,
|
|
2280
|
-
"allowNo": false,
|
|
2281
|
-
"type": "boolean"
|
|
2282
|
-
},
|
|
2283
|
-
"watch": {
|
|
2284
|
-
"aliases": [
|
|
2285
|
-
"follow"
|
|
2286
|
-
],
|
|
2287
|
-
"char": "w",
|
|
2288
|
-
"description": "Watch for new logs (streaming mode)",
|
|
2289
|
-
"name": "watch",
|
|
2483
|
+
"description": "Skip confirmation prompt",
|
|
2484
|
+
"name": "force",
|
|
2290
2485
|
"allowNo": false,
|
|
2291
2486
|
"type": "boolean"
|
|
2487
|
+
},
|
|
2488
|
+
"new-stack-name": {
|
|
2489
|
+
"description": "Set a new name for the Stack while promoting",
|
|
2490
|
+
"name": "new-stack-name",
|
|
2491
|
+
"hasDynamicHelp": false,
|
|
2492
|
+
"multiple": false,
|
|
2493
|
+
"type": "option"
|
|
2292
2494
|
}
|
|
2293
2495
|
},
|
|
2294
2496
|
"hasDynamicHelp": false,
|
|
2295
2497
|
"hiddenAliases": [],
|
|
2296
|
-
"id": "
|
|
2498
|
+
"id": "blueprints:promote",
|
|
2297
2499
|
"pluginAlias": "@sanity/runtime-cli",
|
|
2298
2500
|
"pluginName": "@sanity/runtime-cli",
|
|
2299
2501
|
"pluginType": "core",
|
|
2300
2502
|
"strict": true,
|
|
2301
|
-
"summary": "
|
|
2503
|
+
"summary": "Promote a Stack from project scope to organization scope",
|
|
2302
2504
|
"enableJsonFlag": true,
|
|
2303
2505
|
"needs": [
|
|
2304
2506
|
"deployedStack",
|
|
@@ -2308,25 +2510,19 @@
|
|
|
2308
2510
|
"relativePath": [
|
|
2309
2511
|
"dist",
|
|
2310
2512
|
"commands",
|
|
2311
|
-
"
|
|
2312
|
-
"
|
|
2513
|
+
"blueprints",
|
|
2514
|
+
"promote.js"
|
|
2313
2515
|
]
|
|
2314
2516
|
},
|
|
2315
|
-
"
|
|
2517
|
+
"blueprints:stacks": {
|
|
2316
2518
|
"aliases": [],
|
|
2317
|
-
"args": {
|
|
2318
|
-
|
|
2319
|
-
"description": "The name of the Sanity Function",
|
|
2320
|
-
"name": "name",
|
|
2321
|
-
"required": false
|
|
2322
|
-
}
|
|
2323
|
-
},
|
|
2324
|
-
"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.",
|
|
2519
|
+
"args": {},
|
|
2520
|
+
"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\nUse --include-projects with --organization-id to also list Stacks from all projects within the organization.",
|
|
2325
2521
|
"examples": [
|
|
2326
|
-
"<%= config.bin %> <%= command.id %>
|
|
2327
|
-
"<%= config.bin %> <%= command.id %> <
|
|
2328
|
-
"<%= config.bin %> <%= command.id %>
|
|
2329
|
-
"<%= config.bin %> <%= command.id %>
|
|
2522
|
+
"<%= config.bin %> <%= command.id %>",
|
|
2523
|
+
"<%= config.bin %> <%= command.id %> --project-id <projectId>",
|
|
2524
|
+
"<%= config.bin %> <%= command.id %> --organization-id <organizationId>",
|
|
2525
|
+
"<%= config.bin %> <%= command.id %> --organization-id <organizationId> --include-projects"
|
|
2330
2526
|
],
|
|
2331
2527
|
"flags": {
|
|
2332
2528
|
"json": {
|
|
@@ -2384,7 +2580,8 @@
|
|
|
2384
2580
|
],
|
|
2385
2581
|
"description": "Sanity project ID used to scope Blueprint and Stack",
|
|
2386
2582
|
"exclusive": [
|
|
2387
|
-
"organization-id"
|
|
2583
|
+
"organization-id",
|
|
2584
|
+
"include-projects"
|
|
2388
2585
|
],
|
|
2389
2586
|
"name": "project-id",
|
|
2390
2587
|
"hasDynamicHelp": false,
|
|
@@ -2406,230 +2603,34 @@
|
|
|
2406
2603
|
"multiple": false,
|
|
2407
2604
|
"type": "option"
|
|
2408
2605
|
},
|
|
2409
|
-
"
|
|
2410
|
-
"
|
|
2411
|
-
|
|
2412
|
-
"exclusive": [
|
|
2413
|
-
"file",
|
|
2414
|
-
"document-id"
|
|
2415
|
-
],
|
|
2416
|
-
"name": "data",
|
|
2417
|
-
"required": false,
|
|
2418
|
-
"hasDynamicHelp": false,
|
|
2419
|
-
"multiple": false,
|
|
2420
|
-
"type": "option"
|
|
2421
|
-
},
|
|
2422
|
-
"data-before": {
|
|
2423
|
-
"description": "Original document",
|
|
2424
|
-
"exclusive": [
|
|
2425
|
-
"data",
|
|
2426
|
-
"file",
|
|
2427
|
-
"document-id",
|
|
2428
|
-
"file-before",
|
|
2429
|
-
"file-after",
|
|
2430
|
-
"document-id-before",
|
|
2431
|
-
"document-id-after"
|
|
2432
|
-
],
|
|
2433
|
-
"name": "data-before",
|
|
2434
|
-
"required": false,
|
|
2435
|
-
"hasDynamicHelp": false,
|
|
2436
|
-
"multiple": false,
|
|
2437
|
-
"type": "option"
|
|
2438
|
-
},
|
|
2439
|
-
"data-after": {
|
|
2440
|
-
"description": "Current document",
|
|
2441
|
-
"exclusive": [
|
|
2442
|
-
"data",
|
|
2443
|
-
"file",
|
|
2444
|
-
"document-id",
|
|
2445
|
-
"file-before",
|
|
2446
|
-
"file-after",
|
|
2447
|
-
"document-id-before",
|
|
2448
|
-
"document-id-after"
|
|
2449
|
-
],
|
|
2450
|
-
"name": "data-after",
|
|
2451
|
-
"required": false,
|
|
2452
|
-
"hasDynamicHelp": false,
|
|
2453
|
-
"multiple": false,
|
|
2454
|
-
"type": "option"
|
|
2455
|
-
},
|
|
2456
|
-
"event": {
|
|
2457
|
-
"char": "e",
|
|
2458
|
-
"description": "Type of event (create, update, delete)",
|
|
2459
|
-
"name": "event",
|
|
2460
|
-
"required": false,
|
|
2461
|
-
"hasDynamicHelp": false,
|
|
2462
|
-
"multiple": false,
|
|
2463
|
-
"options": [
|
|
2464
|
-
"create",
|
|
2465
|
-
"update",
|
|
2466
|
-
"delete"
|
|
2467
|
-
],
|
|
2468
|
-
"type": "option"
|
|
2469
|
-
},
|
|
2470
|
-
"file": {
|
|
2471
|
-
"char": "f",
|
|
2472
|
-
"description": "Read data from file and send to the function",
|
|
2473
|
-
"exclusive": [
|
|
2474
|
-
"data",
|
|
2475
|
-
"document-id"
|
|
2476
|
-
],
|
|
2477
|
-
"name": "file",
|
|
2478
|
-
"required": false,
|
|
2479
|
-
"hasDynamicHelp": false,
|
|
2480
|
-
"multiple": false,
|
|
2481
|
-
"type": "option"
|
|
2482
|
-
},
|
|
2483
|
-
"file-before": {
|
|
2484
|
-
"description": "Original document",
|
|
2485
|
-
"exclusive": [
|
|
2486
|
-
"data",
|
|
2487
|
-
"file",
|
|
2488
|
-
"document-id",
|
|
2489
|
-
"data-before",
|
|
2490
|
-
"data-after",
|
|
2491
|
-
"document-id-before",
|
|
2492
|
-
"document-id-after"
|
|
2493
|
-
],
|
|
2494
|
-
"name": "file-before",
|
|
2495
|
-
"required": false,
|
|
2496
|
-
"hasDynamicHelp": false,
|
|
2497
|
-
"multiple": false,
|
|
2498
|
-
"type": "option"
|
|
2499
|
-
},
|
|
2500
|
-
"file-after": {
|
|
2501
|
-
"description": "Current document",
|
|
2502
|
-
"exclusive": [
|
|
2503
|
-
"data",
|
|
2504
|
-
"file",
|
|
2505
|
-
"document-id",
|
|
2506
|
-
"data-before",
|
|
2507
|
-
"data-after",
|
|
2508
|
-
"document-id-before",
|
|
2509
|
-
"document-id-after"
|
|
2510
|
-
],
|
|
2511
|
-
"name": "file-after",
|
|
2512
|
-
"required": false,
|
|
2513
|
-
"hasDynamicHelp": false,
|
|
2514
|
-
"multiple": false,
|
|
2515
|
-
"type": "option"
|
|
2516
|
-
},
|
|
2517
|
-
"timeout": {
|
|
2518
|
-
"char": "t",
|
|
2519
|
-
"description": "Execution timeout value in seconds",
|
|
2520
|
-
"name": "timeout",
|
|
2521
|
-
"required": false,
|
|
2522
|
-
"hasDynamicHelp": false,
|
|
2523
|
-
"multiple": false,
|
|
2524
|
-
"type": "option"
|
|
2525
|
-
},
|
|
2526
|
-
"api": {
|
|
2527
|
-
"char": "a",
|
|
2528
|
-
"description": "Sanity API Version to use",
|
|
2529
|
-
"name": "api",
|
|
2530
|
-
"required": false,
|
|
2531
|
-
"hasDynamicHelp": false,
|
|
2532
|
-
"multiple": false,
|
|
2533
|
-
"type": "option"
|
|
2534
|
-
},
|
|
2535
|
-
"dataset": {
|
|
2536
|
-
"description": "The Sanity dataset to use",
|
|
2537
|
-
"name": "dataset",
|
|
2538
|
-
"required": false,
|
|
2539
|
-
"hasDynamicHelp": false,
|
|
2540
|
-
"multiple": false,
|
|
2541
|
-
"type": "option"
|
|
2542
|
-
},
|
|
2543
|
-
"document-id": {
|
|
2544
|
-
"aliases": [
|
|
2545
|
-
"doc",
|
|
2546
|
-
"documentId"
|
|
2547
|
-
],
|
|
2548
|
-
"description": "Document to fetch and send to function",
|
|
2549
|
-
"exclusive": [
|
|
2550
|
-
"data",
|
|
2551
|
-
"file"
|
|
2552
|
-
],
|
|
2553
|
-
"name": "document-id",
|
|
2554
|
-
"required": false,
|
|
2555
|
-
"hasDynamicHelp": false,
|
|
2556
|
-
"multiple": false,
|
|
2557
|
-
"type": "option"
|
|
2558
|
-
},
|
|
2559
|
-
"document-id-before": {
|
|
2560
|
-
"description": "Original document",
|
|
2561
|
-
"exclusive": [
|
|
2562
|
-
"data",
|
|
2563
|
-
"file",
|
|
2564
|
-
"document-id",
|
|
2565
|
-
"data-before",
|
|
2566
|
-
"data-after",
|
|
2567
|
-
"file-before",
|
|
2568
|
-
"file-after"
|
|
2569
|
-
],
|
|
2570
|
-
"name": "document-id-before",
|
|
2571
|
-
"required": false,
|
|
2572
|
-
"hasDynamicHelp": false,
|
|
2573
|
-
"multiple": false,
|
|
2574
|
-
"type": "option"
|
|
2575
|
-
},
|
|
2576
|
-
"document-id-after": {
|
|
2577
|
-
"description": "Current document",
|
|
2578
|
-
"exclusive": [
|
|
2579
|
-
"data",
|
|
2580
|
-
"file",
|
|
2581
|
-
"document-id",
|
|
2582
|
-
"data-before",
|
|
2583
|
-
"data-after",
|
|
2584
|
-
"file-before",
|
|
2585
|
-
"file-after"
|
|
2606
|
+
"include-projects": {
|
|
2607
|
+
"dependsOn": [
|
|
2608
|
+
"organization-id"
|
|
2586
2609
|
],
|
|
2587
|
-
"
|
|
2588
|
-
"
|
|
2589
|
-
"hasDynamicHelp": false,
|
|
2590
|
-
"multiple": false,
|
|
2591
|
-
"type": "option"
|
|
2592
|
-
},
|
|
2593
|
-
"with-user-token": {
|
|
2594
|
-
"description": "Prime access token from CLI config",
|
|
2595
|
-
"name": "with-user-token",
|
|
2610
|
+
"description": "Include Stacks from all projects within the organization. Requires --organization-id.",
|
|
2611
|
+
"name": "include-projects",
|
|
2596
2612
|
"allowNo": false,
|
|
2597
2613
|
"type": "boolean"
|
|
2598
|
-
},
|
|
2599
|
-
"media-library-id": {
|
|
2600
|
-
"aliases": [
|
|
2601
|
-
"media"
|
|
2602
|
-
],
|
|
2603
|
-
"description": "Sanity Media Library ID to use",
|
|
2604
|
-
"exclusive": [
|
|
2605
|
-
"project-id",
|
|
2606
|
-
"dataset"
|
|
2607
|
-
],
|
|
2608
|
-
"name": "media-library-id",
|
|
2609
|
-
"required": false,
|
|
2610
|
-
"hasDynamicHelp": false,
|
|
2611
|
-
"multiple": false,
|
|
2612
|
-
"type": "option"
|
|
2613
2614
|
}
|
|
2614
2615
|
},
|
|
2615
2616
|
"hasDynamicHelp": false,
|
|
2616
2617
|
"hiddenAliases": [],
|
|
2617
|
-
"id": "
|
|
2618
|
+
"id": "blueprints:stacks",
|
|
2618
2619
|
"pluginAlias": "@sanity/runtime-cli",
|
|
2619
2620
|
"pluginName": "@sanity/runtime-cli",
|
|
2620
2621
|
"pluginType": "core",
|
|
2621
2622
|
"strict": true,
|
|
2622
|
-
"summary": "
|
|
2623
|
+
"summary": "List remote Stack deployments for your project or organization",
|
|
2623
2624
|
"enableJsonFlag": true,
|
|
2624
2625
|
"needs": [
|
|
2625
|
-
"
|
|
2626
|
+
"scope"
|
|
2626
2627
|
],
|
|
2627
2628
|
"isESM": true,
|
|
2628
2629
|
"relativePath": [
|
|
2629
2630
|
"dist",
|
|
2630
2631
|
"commands",
|
|
2631
|
-
"
|
|
2632
|
-
"
|
|
2632
|
+
"blueprints",
|
|
2633
|
+
"stacks.js"
|
|
2633
2634
|
]
|
|
2634
2635
|
},
|
|
2635
2636
|
"functions:env:add": {
|
|
@@ -2996,5 +2997,5 @@
|
|
|
2996
2997
|
]
|
|
2997
2998
|
}
|
|
2998
2999
|
},
|
|
2999
|
-
"version": "
|
|
3000
|
+
"version": "17.1.0"
|
|
3000
3001
|
}
|