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