@sanity/runtime-cli 1.6.0 → 1.8.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (57) hide show
  1. package/README.md +184 -122
  2. package/dist/actions/blueprints/blueprint.d.ts +24 -7
  3. package/dist/actions/blueprints/blueprint.js +65 -44
  4. package/dist/actions/blueprints/logs.d.ts +3 -0
  5. package/dist/actions/blueprints/logs.js +24 -0
  6. package/dist/actions/blueprints/projects.d.ts +5 -0
  7. package/dist/actions/blueprints/projects.js +21 -0
  8. package/dist/actions/blueprints/resources.d.ts +13 -0
  9. package/dist/actions/blueprints/resources.js +37 -0
  10. package/dist/actions/blueprints/stacks.js +1 -1
  11. package/dist/commands/blueprints/add.d.ts +10 -0
  12. package/dist/commands/blueprints/add.js +67 -0
  13. package/dist/commands/blueprints/config.d.ts +9 -0
  14. package/dist/commands/blueprints/config.js +72 -0
  15. package/dist/commands/blueprints/deploy.js +13 -12
  16. package/dist/commands/blueprints/info.js +1 -1
  17. package/dist/commands/blueprints/init.d.ts +6 -0
  18. package/dist/commands/blueprints/init.js +56 -0
  19. package/dist/commands/blueprints/logs.js +24 -64
  20. package/dist/commands/blueprints/stacks.js +3 -15
  21. package/dist/commands/functions/invoke.d.ts +1 -1
  22. package/dist/commands/functions/invoke.js +9 -7
  23. package/dist/commands/functions/logs.d.ts +1 -1
  24. package/dist/commands/functions/logs.js +21 -12
  25. package/dist/commands/functions/test.d.ts +1 -1
  26. package/dist/commands/functions/test.js +25 -16
  27. package/dist/config.d.ts +1 -0
  28. package/dist/config.js +12 -5
  29. package/dist/server/app.js +2 -2
  30. package/dist/server/static/api.js +43 -38
  31. package/dist/server/static/components/api-base.js +7 -6
  32. package/dist/server/static/components/function-list.js +48 -44
  33. package/dist/server/static/components/network-spinner.js +7 -6
  34. package/dist/server/static/components/payload-panel.js +36 -32
  35. package/dist/server/static/components/response-panel.js +64 -50
  36. package/dist/server/static/vendor/vendor.bundle.js +1029 -913
  37. package/dist/utils/display/blueprints-formatting.d.ts +3 -1
  38. package/dist/utils/display/blueprints-formatting.js +27 -2
  39. package/dist/utils/display/logs-formatting.d.ts +5 -0
  40. package/dist/utils/display/logs-formatting.js +50 -0
  41. package/dist/utils/find-function.d.ts +2 -0
  42. package/dist/utils/find-function.js +6 -0
  43. package/dist/utils/types.d.ts +0 -1
  44. package/oclif.manifest.json +102 -13
  45. package/package.json +10 -10
  46. package/dist/server/static/static/api.js +0 -53
  47. package/dist/server/static/static/components/api-base.js +0 -10
  48. package/dist/server/static/static/components/function-list.js +0 -54
  49. package/dist/server/static/static/components/network-spinner.js +0 -71
  50. package/dist/server/static/static/components/payload-panel.js +0 -45
  51. package/dist/server/static/static/components/response-panel.js +0 -83
  52. package/dist/server/static/static/vendor/vendor.bundle.js +0 -26879
  53. package/dist/utils/spinner.d.ts +0 -9
  54. package/dist/utils/spinner.js +0 -25
  55. /package/dist/server/static/{static/components → components}/app.css +0 -0
  56. /package/dist/server/static/{static/index.html → index.html} +0 -0
  57. /package/dist/server/static/{static/sanity-logo-sm.svg → sanity-logo-sm.svg} +0 -0
package/README.md CHANGED
@@ -17,63 +17,108 @@ A new CLI generated with oclif
17
17
  <!-- usage -->
18
18
  ```sh-session
19
19
  $ npm install -g @sanity/runtime-cli
20
- $ sanity COMMAND
20
+ $ sanity-run COMMAND
21
21
  running command...
22
- $ sanity (--version)
23
- @sanity/runtime-cli/1.6.0 linux-x64 node-v22.14.0
24
- $ sanity --help [COMMAND]
22
+ $ sanity-run (--version)
23
+ @sanity/runtime-cli/1.8.1 linux-x64 node-v22.14.0
24
+ $ sanity-run --help [COMMAND]
25
25
  USAGE
26
- $ sanity COMMAND
26
+ $ sanity-run COMMAND
27
27
  ...
28
28
  ```
29
29
  <!-- usagestop -->
30
30
  # Commands
31
31
  <!-- commands -->
32
- * [`sanity blueprints deploy`](#sanity-blueprints-deploy)
33
- * [`sanity blueprints info`](#sanity-blueprints-info)
34
- * [`sanity blueprints logs`](#sanity-blueprints-logs)
35
- * [`sanity blueprints plan`](#sanity-blueprints-plan)
36
- * [`sanity blueprints stacks`](#sanity-blueprints-stacks)
37
- * [`sanity functions dev`](#sanity-functions-dev)
38
- * [`sanity functions invoke ID`](#sanity-functions-invoke-id)
39
- * [`sanity functions logs ID`](#sanity-functions-logs-id)
40
- * [`sanity functions test PATH`](#sanity-functions-test-path)
41
- * [`sanity help [COMMAND]`](#sanity-help-command)
42
- * [`sanity plugins`](#sanity-plugins)
43
- * [`sanity plugins add PLUGIN`](#sanity-plugins-add-plugin)
44
- * [`sanity plugins:inspect PLUGIN...`](#sanity-pluginsinspect-plugin)
45
- * [`sanity plugins install PLUGIN`](#sanity-plugins-install-plugin)
46
- * [`sanity plugins link PATH`](#sanity-plugins-link-path)
47
- * [`sanity plugins remove [PLUGIN]`](#sanity-plugins-remove-plugin)
48
- * [`sanity plugins reset`](#sanity-plugins-reset)
49
- * [`sanity plugins uninstall [PLUGIN]`](#sanity-plugins-uninstall-plugin)
50
- * [`sanity plugins unlink [PLUGIN]`](#sanity-plugins-unlink-plugin)
51
- * [`sanity plugins update`](#sanity-plugins-update)
52
-
53
- ## `sanity blueprints deploy`
32
+ * [`sanity-run blueprints add TYPE`](#sanity-run-blueprints-add-type)
33
+ * [`sanity-run blueprints config`](#sanity-run-blueprints-config)
34
+ * [`sanity-run blueprints deploy`](#sanity-run-blueprints-deploy)
35
+ * [`sanity-run blueprints info`](#sanity-run-blueprints-info)
36
+ * [`sanity-run blueprints init`](#sanity-run-blueprints-init)
37
+ * [`sanity-run blueprints logs`](#sanity-run-blueprints-logs)
38
+ * [`sanity-run blueprints plan`](#sanity-run-blueprints-plan)
39
+ * [`sanity-run blueprints stacks`](#sanity-run-blueprints-stacks)
40
+ * [`sanity-run functions dev`](#sanity-run-functions-dev)
41
+ * [`sanity-run functions invoke NAME`](#sanity-run-functions-invoke-name)
42
+ * [`sanity-run functions logs NAME`](#sanity-run-functions-logs-name)
43
+ * [`sanity-run functions test NAME`](#sanity-run-functions-test-name)
44
+ * [`sanity-run help [COMMAND]`](#sanity-run-help-command)
45
+ * [`sanity-run plugins`](#sanity-run-plugins)
46
+ * [`sanity-run plugins add PLUGIN`](#sanity-run-plugins-add-plugin)
47
+ * [`sanity-run plugins:inspect PLUGIN...`](#sanity-run-pluginsinspect-plugin)
48
+ * [`sanity-run plugins install PLUGIN`](#sanity-run-plugins-install-plugin)
49
+ * [`sanity-run plugins link PATH`](#sanity-run-plugins-link-path)
50
+ * [`sanity-run plugins remove [PLUGIN]`](#sanity-run-plugins-remove-plugin)
51
+ * [`sanity-run plugins reset`](#sanity-run-plugins-reset)
52
+ * [`sanity-run plugins uninstall [PLUGIN]`](#sanity-run-plugins-uninstall-plugin)
53
+ * [`sanity-run plugins unlink [PLUGIN]`](#sanity-run-plugins-unlink-plugin)
54
+ * [`sanity-run plugins update`](#sanity-run-plugins-update)
55
+
56
+ ## `sanity-run blueprints add TYPE`
57
+
58
+ Add a resource to a Blueprint
59
+
60
+ ```
61
+ USAGE
62
+ $ sanity-run blueprints add TYPE
63
+
64
+ ARGUMENTS
65
+ TYPE (function) Type of resource to add (e.g. function)
66
+
67
+ DESCRIPTION
68
+ Add a resource to a Blueprint
69
+
70
+ EXAMPLES
71
+ $ sanity-run blueprints add function
72
+ ```
73
+
74
+ _See code: [src/commands/blueprints/add.ts](https://github.com/sanity-io/runtime-cli/blob/v1.8.1/src/commands/blueprints/add.ts)_
75
+
76
+ ## `sanity-run blueprints config`
77
+
78
+ View or edit Blueprint configuration
79
+
80
+ ```
81
+ USAGE
82
+ $ sanity-run blueprints config [--edit]
83
+
84
+ FLAGS
85
+ --edit Edit the configuration
86
+
87
+ DESCRIPTION
88
+ View or edit Blueprint configuration
89
+
90
+ EXAMPLES
91
+ $ sanity-run blueprints config
92
+
93
+ $ sanity-run blueprints config --edit
94
+ ```
95
+
96
+ _See code: [src/commands/blueprints/config.ts](https://github.com/sanity-io/runtime-cli/blob/v1.8.1/src/commands/blueprints/config.ts)_
97
+
98
+ ## `sanity-run blueprints deploy`
54
99
 
55
100
  Deploy a Blueprint
56
101
 
57
102
  ```
58
103
  USAGE
59
- $ sanity blueprints deploy
104
+ $ sanity-run blueprints deploy
60
105
 
61
106
  DESCRIPTION
62
107
  Deploy a Blueprint
63
108
 
64
109
  EXAMPLES
65
- $ sanity blueprints deploy
110
+ $ sanity-run blueprints deploy
66
111
  ```
67
112
 
68
- _See code: [src/commands/blueprints/deploy.ts](https://github.com/sanity-io/runtime-cli/blob/v1.6.0/src/commands/blueprints/deploy.ts)_
113
+ _See code: [src/commands/blueprints/deploy.ts](https://github.com/sanity-io/runtime-cli/blob/v1.8.1/src/commands/blueprints/deploy.ts)_
69
114
 
70
- ## `sanity blueprints info`
115
+ ## `sanity-run blueprints info`
71
116
 
72
117
  Show information about a Blueprint
73
118
 
74
119
  ```
75
120
  USAGE
76
- $ sanity blueprints info [--id <value>]
121
+ $ sanity-run blueprints info [--id <value>]
77
122
 
78
123
  FLAGS
79
124
  --id=<value> Stack ID to show info for (defaults to current stack)
@@ -82,20 +127,37 @@ DESCRIPTION
82
127
  Show information about a Blueprint
83
128
 
84
129
  EXAMPLES
85
- $ sanity blueprints info
130
+ $ sanity-run blueprints info
86
131
 
87
- $ sanity blueprints info --id abc123
132
+ $ sanity-run blueprints info --id abc123
88
133
  ```
89
134
 
90
- _See code: [src/commands/blueprints/info.ts](https://github.com/sanity-io/runtime-cli/blob/v1.6.0/src/commands/blueprints/info.ts)_
135
+ _See code: [src/commands/blueprints/info.ts](https://github.com/sanity-io/runtime-cli/blob/v1.8.1/src/commands/blueprints/info.ts)_
136
+
137
+ ## `sanity-run blueprints init`
91
138
 
92
- ## `sanity blueprints logs`
139
+ Initialize a new Blueprint
140
+
141
+ ```
142
+ USAGE
143
+ $ sanity-run blueprints init
144
+
145
+ DESCRIPTION
146
+ Initialize a new Blueprint
147
+
148
+ EXAMPLES
149
+ $ sanity-run blueprints init
150
+ ```
151
+
152
+ _See code: [src/commands/blueprints/init.ts](https://github.com/sanity-io/runtime-cli/blob/v1.8.1/src/commands/blueprints/init.ts)_
153
+
154
+ ## `sanity-run blueprints logs`
93
155
 
94
156
  Display logs for a Blueprint stack
95
157
 
96
158
  ```
97
159
  USAGE
98
- $ sanity blueprints logs [-w]
160
+ $ sanity-run blueprints logs [-w]
99
161
 
100
162
  FLAGS
101
163
  -w, --watch Watch for new logs (streaming mode)
@@ -104,54 +166,54 @@ DESCRIPTION
104
166
  Display logs for a Blueprint stack
105
167
 
106
168
  EXAMPLES
107
- $ sanity blueprints logs
169
+ $ sanity-run blueprints logs
108
170
 
109
- $ sanity blueprints logs --watch
171
+ $ sanity-run blueprints logs --watch
110
172
  ```
111
173
 
112
- _See code: [src/commands/blueprints/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v1.6.0/src/commands/blueprints/logs.ts)_
174
+ _See code: [src/commands/blueprints/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v1.8.1/src/commands/blueprints/logs.ts)_
113
175
 
114
- ## `sanity blueprints plan`
176
+ ## `sanity-run blueprints plan`
115
177
 
116
178
  Enumerate resources to be deployed - will not modify any resources
117
179
 
118
180
  ```
119
181
  USAGE
120
- $ sanity blueprints plan
182
+ $ sanity-run blueprints plan
121
183
 
122
184
  DESCRIPTION
123
185
  Enumerate resources to be deployed - will not modify any resources
124
186
 
125
187
  EXAMPLES
126
- $ sanity blueprints plan
188
+ $ sanity-run blueprints plan
127
189
  ```
128
190
 
129
- _See code: [src/commands/blueprints/plan.ts](https://github.com/sanity-io/runtime-cli/blob/v1.6.0/src/commands/blueprints/plan.ts)_
191
+ _See code: [src/commands/blueprints/plan.ts](https://github.com/sanity-io/runtime-cli/blob/v1.8.1/src/commands/blueprints/plan.ts)_
130
192
 
131
- ## `sanity blueprints stacks`
193
+ ## `sanity-run blueprints stacks`
132
194
 
133
195
  List all Blueprint stacks
134
196
 
135
197
  ```
136
198
  USAGE
137
- $ sanity blueprints stacks
199
+ $ sanity-run blueprints stacks
138
200
 
139
201
  DESCRIPTION
140
202
  List all Blueprint stacks
141
203
 
142
204
  EXAMPLES
143
- $ sanity blueprints stacks
205
+ $ sanity-run blueprints stacks
144
206
  ```
145
207
 
146
- _See code: [src/commands/blueprints/stacks.ts](https://github.com/sanity-io/runtime-cli/blob/v1.6.0/src/commands/blueprints/stacks.ts)_
208
+ _See code: [src/commands/blueprints/stacks.ts](https://github.com/sanity-io/runtime-cli/blob/v1.8.1/src/commands/blueprints/stacks.ts)_
147
209
 
148
- ## `sanity functions dev`
210
+ ## `sanity-run functions dev`
149
211
 
150
212
  Start the Sanity Function emulator
151
213
 
152
214
  ```
153
215
  USAGE
154
- $ sanity functions dev [-p <value>]
216
+ $ sanity-run functions dev [-p <value>]
155
217
 
156
218
  FLAGS
157
219
  -p, --port=<value> Port to start emulator on
@@ -160,21 +222,21 @@ DESCRIPTION
160
222
  Start the Sanity Function emulator
161
223
 
162
224
  EXAMPLES
163
- $ sanity functions dev --port 8974
225
+ $ sanity-run functions dev --port 8974
164
226
  ```
165
227
 
166
- _See code: [src/commands/functions/dev.ts](https://github.com/sanity-io/runtime-cli/blob/v1.6.0/src/commands/functions/dev.ts)_
228
+ _See code: [src/commands/functions/dev.ts](https://github.com/sanity-io/runtime-cli/blob/v1.8.1/src/commands/functions/dev.ts)_
167
229
 
168
- ## `sanity functions invoke ID`
230
+ ## `sanity-run functions invoke NAME`
169
231
 
170
232
  Invoke a remote Sanity Function
171
233
 
172
234
  ```
173
235
  USAGE
174
- $ sanity functions invoke ID [-d <value>] [-f <value>]
236
+ $ sanity-run functions invoke NAME [-d <value>] [-f <value>]
175
237
 
176
238
  ARGUMENTS
177
- ID The ID of the function to invoke
239
+ NAME The name of the Sanity Function
178
240
 
179
241
  FLAGS
180
242
  -d, --data=<value> Data to send to the function
@@ -184,43 +246,43 @@ DESCRIPTION
184
246
  Invoke a remote Sanity Function
185
247
 
186
248
  EXAMPLES
187
- $ sanity functions invoke <ID> --data '{ "id": 1 }'
249
+ $ sanity-run functions invoke <ID> --data '{ "id": 1 }'
188
250
 
189
- $ sanity functions invoke <ID> --file 'payload.json'
251
+ $ sanity-run functions invoke <ID> --file 'payload.json'
190
252
  ```
191
253
 
192
- _See code: [src/commands/functions/invoke.ts](https://github.com/sanity-io/runtime-cli/blob/v1.6.0/src/commands/functions/invoke.ts)_
254
+ _See code: [src/commands/functions/invoke.ts](https://github.com/sanity-io/runtime-cli/blob/v1.8.1/src/commands/functions/invoke.ts)_
193
255
 
194
- ## `sanity functions logs ID`
256
+ ## `sanity-run functions logs NAME`
195
257
 
196
258
  Retrieve logs for a Sanity Function
197
259
 
198
260
  ```
199
261
  USAGE
200
- $ sanity functions logs ID
262
+ $ sanity-run functions logs NAME
201
263
 
202
264
  ARGUMENTS
203
- ID The ID of the function to retrieve logs for
265
+ NAME The name of the Sanity Function
204
266
 
205
267
  DESCRIPTION
206
268
  Retrieve logs for a Sanity Function
207
269
 
208
270
  EXAMPLES
209
- $ sanity functions logs <ID>
271
+ $ sanity-run functions logs <ID>
210
272
  ```
211
273
 
212
- _See code: [src/commands/functions/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v1.6.0/src/commands/functions/logs.ts)_
274
+ _See code: [src/commands/functions/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v1.8.1/src/commands/functions/logs.ts)_
213
275
 
214
- ## `sanity functions test PATH`
276
+ ## `sanity-run functions test NAME`
215
277
 
216
278
  Invoke a local Sanity Function
217
279
 
218
280
  ```
219
281
  USAGE
220
- $ sanity functions test PATH [-d <value>] [-f <value>] [-t <value>]
282
+ $ sanity-run functions test NAME [-d <value>] [-f <value>] [-t <value>]
221
283
 
222
284
  ARGUMENTS
223
- PATH The path to the function source code
285
+ NAME The name of the Sanity Function
224
286
 
225
287
  FLAGS
226
288
  -d, --data=<value> Data to send to the function
@@ -231,22 +293,22 @@ DESCRIPTION
231
293
  Invoke a local Sanity Function
232
294
 
233
295
  EXAMPLES
234
- $ sanity functions test ./test.ts --data '{ "id": 1 }'
296
+ $ sanity-run functions test echo-fn --data '{ "id": 1 }'
235
297
 
236
- $ sanity functions test ./test.js --file 'payload.json'
298
+ $ sanity-run functions test echo-fn --file 'payload.json'
237
299
 
238
- $ sanity functions test ./test.ts --data '{ "id": 1 }' --timeout 60
300
+ $ sanity-run functions test echo-fn --data '{ "id": 1 }' --timeout 60
239
301
  ```
240
302
 
241
- _See code: [src/commands/functions/test.ts](https://github.com/sanity-io/runtime-cli/blob/v1.6.0/src/commands/functions/test.ts)_
303
+ _See code: [src/commands/functions/test.ts](https://github.com/sanity-io/runtime-cli/blob/v1.8.1/src/commands/functions/test.ts)_
242
304
 
243
- ## `sanity help [COMMAND]`
305
+ ## `sanity-run help [COMMAND]`
244
306
 
245
- Display help for sanity.
307
+ Display help for sanity-run.
246
308
 
247
309
  ```
248
310
  USAGE
249
- $ sanity help [COMMAND...] [-n]
311
+ $ sanity-run help [COMMAND...] [-n]
250
312
 
251
313
  ARGUMENTS
252
314
  COMMAND... Command to show help for.
@@ -255,18 +317,18 @@ FLAGS
255
317
  -n, --nested-commands Include all nested commands in the output.
256
318
 
257
319
  DESCRIPTION
258
- Display help for sanity.
320
+ Display help for sanity-run.
259
321
  ```
260
322
 
261
323
  _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.26/src/commands/help.ts)_
262
324
 
263
- ## `sanity plugins`
325
+ ## `sanity-run plugins`
264
326
 
265
327
  List installed plugins.
266
328
 
267
329
  ```
268
330
  USAGE
269
- $ sanity plugins [--json] [--core]
331
+ $ sanity-run plugins [--json] [--core]
270
332
 
271
333
  FLAGS
272
334
  --core Show core plugins.
@@ -278,18 +340,18 @@ DESCRIPTION
278
340
  List installed plugins.
279
341
 
280
342
  EXAMPLES
281
- $ sanity plugins
343
+ $ sanity-run plugins
282
344
  ```
283
345
 
284
346
  _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.34/src/commands/plugins/index.ts)_
285
347
 
286
- ## `sanity plugins add PLUGIN`
348
+ ## `sanity-run plugins add PLUGIN`
287
349
 
288
- Installs a plugin into sanity.
350
+ Installs a plugin into sanity-run.
289
351
 
290
352
  ```
291
353
  USAGE
292
- $ sanity plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]
354
+ $ sanity-run plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]
293
355
 
294
356
  ARGUMENTS
295
357
  PLUGIN... Plugin to install.
@@ -304,39 +366,39 @@ GLOBAL FLAGS
304
366
  --json Format output as json.
305
367
 
306
368
  DESCRIPTION
307
- Installs a plugin into sanity.
369
+ Installs a plugin into sanity-run.
308
370
 
309
371
  Uses npm to install plugins.
310
372
 
311
373
  Installation of a user-installed plugin will override a core plugin.
312
374
 
313
- Use the SANITY_NPM_LOG_LEVEL environment variable to set the npm loglevel.
314
- Use the SANITY_NPM_REGISTRY environment variable to set the npm registry.
375
+ Use the SANITY_RUN_NPM_LOG_LEVEL environment variable to set the npm loglevel.
376
+ Use the SANITY_RUN_NPM_REGISTRY environment variable to set the npm registry.
315
377
 
316
378
  ALIASES
317
- $ sanity plugins add
379
+ $ sanity-run plugins add
318
380
 
319
381
  EXAMPLES
320
382
  Install a plugin from npm registry.
321
383
 
322
- $ sanity plugins add myplugin
384
+ $ sanity-run plugins add myplugin
323
385
 
324
386
  Install a plugin from a github url.
325
387
 
326
- $ sanity plugins add https://github.com/someuser/someplugin
388
+ $ sanity-run plugins add https://github.com/someuser/someplugin
327
389
 
328
390
  Install a plugin from a github slug.
329
391
 
330
- $ sanity plugins add someuser/someplugin
392
+ $ sanity-run plugins add someuser/someplugin
331
393
  ```
332
394
 
333
- ## `sanity plugins:inspect PLUGIN...`
395
+ ## `sanity-run plugins:inspect PLUGIN...`
334
396
 
335
397
  Displays installation properties of a plugin.
336
398
 
337
399
  ```
338
400
  USAGE
339
- $ sanity plugins inspect PLUGIN...
401
+ $ sanity-run plugins inspect PLUGIN...
340
402
 
341
403
  ARGUMENTS
342
404
  PLUGIN... [default: .] Plugin to inspect.
@@ -352,18 +414,18 @@ DESCRIPTION
352
414
  Displays installation properties of a plugin.
353
415
 
354
416
  EXAMPLES
355
- $ sanity plugins inspect myplugin
417
+ $ sanity-run plugins inspect myplugin
356
418
  ```
357
419
 
358
420
  _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.34/src/commands/plugins/inspect.ts)_
359
421
 
360
- ## `sanity plugins install PLUGIN`
422
+ ## `sanity-run plugins install PLUGIN`
361
423
 
362
- Installs a plugin into sanity.
424
+ Installs a plugin into sanity-run.
363
425
 
364
426
  ```
365
427
  USAGE
366
- $ sanity plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]
428
+ $ sanity-run plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]
367
429
 
368
430
  ARGUMENTS
369
431
  PLUGIN... Plugin to install.
@@ -378,41 +440,41 @@ GLOBAL FLAGS
378
440
  --json Format output as json.
379
441
 
380
442
  DESCRIPTION
381
- Installs a plugin into sanity.
443
+ Installs a plugin into sanity-run.
382
444
 
383
445
  Uses npm to install plugins.
384
446
 
385
447
  Installation of a user-installed plugin will override a core plugin.
386
448
 
387
- Use the SANITY_NPM_LOG_LEVEL environment variable to set the npm loglevel.
388
- Use the SANITY_NPM_REGISTRY environment variable to set the npm registry.
449
+ Use the SANITY_RUN_NPM_LOG_LEVEL environment variable to set the npm loglevel.
450
+ Use the SANITY_RUN_NPM_REGISTRY environment variable to set the npm registry.
389
451
 
390
452
  ALIASES
391
- $ sanity plugins add
453
+ $ sanity-run plugins add
392
454
 
393
455
  EXAMPLES
394
456
  Install a plugin from npm registry.
395
457
 
396
- $ sanity plugins install myplugin
458
+ $ sanity-run plugins install myplugin
397
459
 
398
460
  Install a plugin from a github url.
399
461
 
400
- $ sanity plugins install https://github.com/someuser/someplugin
462
+ $ sanity-run plugins install https://github.com/someuser/someplugin
401
463
 
402
464
  Install a plugin from a github slug.
403
465
 
404
- $ sanity plugins install someuser/someplugin
466
+ $ sanity-run plugins install someuser/someplugin
405
467
  ```
406
468
 
407
469
  _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.34/src/commands/plugins/install.ts)_
408
470
 
409
- ## `sanity plugins link PATH`
471
+ ## `sanity-run plugins link PATH`
410
472
 
411
473
  Links a plugin into the CLI for development.
412
474
 
413
475
  ```
414
476
  USAGE
415
- $ sanity plugins link PATH [-h] [--install] [-v]
477
+ $ sanity-run plugins link PATH [-h] [--install] [-v]
416
478
 
417
479
  ARGUMENTS
418
480
  PATH [default: .] path to plugin
@@ -432,18 +494,18 @@ DESCRIPTION
432
494
 
433
495
 
434
496
  EXAMPLES
435
- $ sanity plugins link myplugin
497
+ $ sanity-run plugins link myplugin
436
498
  ```
437
499
 
438
500
  _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.34/src/commands/plugins/link.ts)_
439
501
 
440
- ## `sanity plugins remove [PLUGIN]`
502
+ ## `sanity-run plugins remove [PLUGIN]`
441
503
 
442
504
  Removes a plugin from the CLI.
443
505
 
444
506
  ```
445
507
  USAGE
446
- $ sanity plugins remove [PLUGIN...] [-h] [-v]
508
+ $ sanity-run plugins remove [PLUGIN...] [-h] [-v]
447
509
 
448
510
  ARGUMENTS
449
511
  PLUGIN... plugin to uninstall
@@ -456,20 +518,20 @@ DESCRIPTION
456
518
  Removes a plugin from the CLI.
457
519
 
458
520
  ALIASES
459
- $ sanity plugins unlink
460
- $ sanity plugins remove
521
+ $ sanity-run plugins unlink
522
+ $ sanity-run plugins remove
461
523
 
462
524
  EXAMPLES
463
- $ sanity plugins remove myplugin
525
+ $ sanity-run plugins remove myplugin
464
526
  ```
465
527
 
466
- ## `sanity plugins reset`
528
+ ## `sanity-run plugins reset`
467
529
 
468
530
  Remove all user-installed and linked plugins.
469
531
 
470
532
  ```
471
533
  USAGE
472
- $ sanity plugins reset [--hard] [--reinstall]
534
+ $ sanity-run plugins reset [--hard] [--reinstall]
473
535
 
474
536
  FLAGS
475
537
  --hard Delete node_modules and package manager related files in addition to uninstalling plugins.
@@ -478,13 +540,13 @@ FLAGS
478
540
 
479
541
  _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.34/src/commands/plugins/reset.ts)_
480
542
 
481
- ## `sanity plugins uninstall [PLUGIN]`
543
+ ## `sanity-run plugins uninstall [PLUGIN]`
482
544
 
483
545
  Removes a plugin from the CLI.
484
546
 
485
547
  ```
486
548
  USAGE
487
- $ sanity plugins uninstall [PLUGIN...] [-h] [-v]
549
+ $ sanity-run plugins uninstall [PLUGIN...] [-h] [-v]
488
550
 
489
551
  ARGUMENTS
490
552
  PLUGIN... plugin to uninstall
@@ -497,22 +559,22 @@ DESCRIPTION
497
559
  Removes a plugin from the CLI.
498
560
 
499
561
  ALIASES
500
- $ sanity plugins unlink
501
- $ sanity plugins remove
562
+ $ sanity-run plugins unlink
563
+ $ sanity-run plugins remove
502
564
 
503
565
  EXAMPLES
504
- $ sanity plugins uninstall myplugin
566
+ $ sanity-run plugins uninstall myplugin
505
567
  ```
506
568
 
507
569
  _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.34/src/commands/plugins/uninstall.ts)_
508
570
 
509
- ## `sanity plugins unlink [PLUGIN]`
571
+ ## `sanity-run plugins unlink [PLUGIN]`
510
572
 
511
573
  Removes a plugin from the CLI.
512
574
 
513
575
  ```
514
576
  USAGE
515
- $ sanity plugins unlink [PLUGIN...] [-h] [-v]
577
+ $ sanity-run plugins unlink [PLUGIN...] [-h] [-v]
516
578
 
517
579
  ARGUMENTS
518
580
  PLUGIN... plugin to uninstall
@@ -525,20 +587,20 @@ DESCRIPTION
525
587
  Removes a plugin from the CLI.
526
588
 
527
589
  ALIASES
528
- $ sanity plugins unlink
529
- $ sanity plugins remove
590
+ $ sanity-run plugins unlink
591
+ $ sanity-run plugins remove
530
592
 
531
593
  EXAMPLES
532
- $ sanity plugins unlink myplugin
594
+ $ sanity-run plugins unlink myplugin
533
595
  ```
534
596
 
535
- ## `sanity plugins update`
597
+ ## `sanity-run plugins update`
536
598
 
537
599
  Update installed plugins.
538
600
 
539
601
  ```
540
602
  USAGE
541
- $ sanity plugins update [-h] [-v]
603
+ $ sanity-run plugins update [-h] [-v]
542
604
 
543
605
  FLAGS
544
606
  -h, --help Show CLI help.
@@ -1,4 +1,13 @@
1
1
  import type { Blueprint, BlueprintError, BlueprintStack } from '../../utils/types.js';
2
+ export declare const DEFAULT_BLUEPRINT_CONTENT: {
3
+ blueprintVersion: string;
4
+ resources: never[];
5
+ };
6
+ export declare function findBlueprintFile(blueprintPath: string | undefined): {
7
+ path: string;
8
+ fileName: string;
9
+ extension: string;
10
+ } | null;
2
11
  export declare function readBlueprintOnDisk({ blueprintPath, getStack, }?: {
3
12
  blueprintPath?: string;
4
13
  getStack?: boolean;
@@ -14,13 +23,21 @@ export declare function readBlueprintOnDisk({ blueprintPath, getStack, }?: {
14
23
  stackId?: string;
15
24
  deployedStack?: BlueprintStack;
16
25
  }>;
17
- /** @experimental */ export declare function updateBlueprintMetadata({ blueprintPath, projectId, stackId, }: {
18
- blueprintPath?: string;
19
- projectId: string;
20
- stackId: string;
21
- }): Promise<void>;
22
- export declare function writeBlueprintConfig({ blueprintPath, projectId, stackId, }: {
26
+ export declare function writeBlueprintToDisk({ path, fileType, content, }: {
27
+ path: string;
28
+ fileType: 'json' | 'js' | 'ts';
29
+ content?: Record<string, unknown>;
30
+ }): string;
31
+ export declare function readConfigFile(blueprintPath?: string | undefined): {
32
+ projectId?: string;
33
+ stackId?: string;
34
+ } | null;
35
+ export declare function writeConfigFile({ blueprintPath, projectId, stackId, }: {
23
36
  blueprintPath?: string;
24
37
  projectId: string;
25
- stackId: string;
38
+ stackId?: string;
26
39
  }): void;
40
+ export declare function addResourceToBlueprint({ blueprintPath, resource, }: {
41
+ blueprintPath?: string;
42
+ resource: Record<string, unknown>;
43
+ }): Record<string, unknown> | undefined;