@sanity/cli 6.3.0 → 6.3.2
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 +295 -442
- package/dist/actions/build/decorateIndexWithStagingScript.js +16 -0
- package/dist/actions/build/decorateIndexWithStagingScript.js.map +1 -0
- package/dist/actions/build/writeSanityRuntime.js +3 -2
- package/dist/actions/build/writeSanityRuntime.js.map +1 -1
- package/dist/actions/dataset/create.js +4 -0
- package/dist/actions/dataset/create.js.map +1 -1
- package/dist/actions/deploy/findUserApplicationForApp.js +1 -0
- package/dist/actions/deploy/findUserApplicationForApp.js.map +1 -1
- package/dist/actions/deploy/types.js +1 -1
- package/dist/actions/deploy/types.js.map +1 -1
- package/dist/actions/init/templates/nextjs/index.js +1 -2
- package/dist/actions/init/templates/nextjs/index.js.map +1 -1
- package/dist/actions/manifest/types.js +1 -1
- package/dist/actions/manifest/types.js.map +1 -1
- package/dist/actions/schema/types.js +3 -3
- package/dist/actions/schema/types.js.map +1 -1
- package/dist/actions/users/validateEmail.js +2 -2
- package/dist/actions/users/validateEmail.js.map +1 -1
- package/dist/commands/backups/disable.js +1 -1
- package/dist/commands/backups/disable.js.map +1 -1
- package/dist/commands/backups/download.js +1 -1
- package/dist/commands/backups/download.js.map +1 -1
- package/dist/commands/backups/enable.js +1 -1
- package/dist/commands/backups/enable.js.map +1 -1
- package/dist/commands/backups/list.js +1 -1
- package/dist/commands/backups/list.js.map +1 -1
- package/dist/commands/build.js +1 -1
- package/dist/commands/build.js.map +1 -1
- package/dist/commands/cors/add.js +1 -1
- package/dist/commands/cors/add.js.map +1 -1
- package/dist/commands/cors/delete.js +1 -1
- package/dist/commands/cors/delete.js.map +1 -1
- package/dist/commands/cors/list.js +2 -2
- package/dist/commands/cors/list.js.map +1 -1
- package/dist/commands/datasets/alias/create.js +1 -1
- package/dist/commands/datasets/alias/create.js.map +1 -1
- package/dist/commands/datasets/alias/delete.js +1 -1
- package/dist/commands/datasets/alias/delete.js.map +1 -1
- package/dist/commands/datasets/alias/link.js +1 -1
- package/dist/commands/datasets/alias/link.js.map +1 -1
- package/dist/commands/datasets/alias/unlink.js +1 -1
- package/dist/commands/datasets/alias/unlink.js.map +1 -1
- package/dist/commands/datasets/copy.js +1 -1
- package/dist/commands/datasets/copy.js.map +1 -1
- package/dist/commands/datasets/create.js +1 -1
- package/dist/commands/datasets/create.js.map +1 -1
- package/dist/commands/datasets/delete.js +1 -1
- package/dist/commands/datasets/delete.js.map +1 -1
- package/dist/commands/datasets/embeddings/enable.js +11 -0
- package/dist/commands/datasets/embeddings/enable.js.map +1 -1
- package/dist/commands/datasets/export.js +2 -2
- package/dist/commands/datasets/export.js.map +1 -1
- package/dist/commands/datasets/list.js +2 -2
- package/dist/commands/datasets/list.js.map +1 -1
- package/dist/commands/debug.js +1 -1
- package/dist/commands/debug.js.map +1 -1
- package/dist/commands/deploy.js +3 -3
- package/dist/commands/deploy.js.map +1 -1
- package/dist/commands/dev.js +5 -5
- package/dist/commands/dev.js.map +1 -1
- package/dist/commands/docs/browse.js +1 -1
- package/dist/commands/docs/browse.js.map +1 -1
- package/dist/commands/documents/delete.js +1 -1
- package/dist/commands/documents/delete.js.map +1 -1
- package/dist/commands/exec.js +2 -2
- package/dist/commands/exec.js.map +1 -1
- package/dist/commands/graphql/deploy.js +2 -2
- package/dist/commands/graphql/deploy.js.map +1 -1
- package/dist/commands/graphql/list.js +2 -2
- package/dist/commands/graphql/list.js.map +1 -1
- package/dist/commands/hooks/create.js +2 -2
- package/dist/commands/hooks/create.js.map +1 -1
- package/dist/commands/hooks/delete.js +5 -5
- package/dist/commands/hooks/delete.js.map +1 -1
- package/dist/commands/hooks/list.js +3 -3
- package/dist/commands/hooks/list.js.map +1 -1
- package/dist/commands/hooks/logs.js +5 -5
- package/dist/commands/hooks/logs.js.map +1 -1
- package/dist/commands/init.js +30 -12
- package/dist/commands/init.js.map +1 -1
- package/dist/commands/install.js +1 -1
- package/dist/commands/install.js.map +1 -1
- package/dist/commands/learn.js +1 -1
- package/dist/commands/learn.js.map +1 -1
- package/dist/commands/login.js +1 -1
- package/dist/commands/login.js.map +1 -1
- package/dist/commands/logout.js +1 -1
- package/dist/commands/logout.js.map +1 -1
- package/dist/commands/manage.js +1 -1
- package/dist/commands/manage.js.map +1 -1
- package/dist/commands/manifest/extract.js +2 -2
- package/dist/commands/manifest/extract.js.map +1 -1
- package/dist/commands/media/delete-aspect.js +1 -1
- package/dist/commands/media/delete-aspect.js.map +1 -1
- package/dist/commands/media/export.js +1 -1
- package/dist/commands/media/export.js.map +1 -1
- package/dist/commands/preview.js +3 -3
- package/dist/commands/preview.js.map +1 -1
- package/dist/commands/projects/list.js +4 -2
- package/dist/commands/projects/list.js.map +1 -1
- package/dist/commands/schemas/deploy.js +3 -4
- package/dist/commands/schemas/deploy.js.map +1 -1
- package/dist/commands/schemas/extract.js +3 -3
- package/dist/commands/schemas/extract.js.map +1 -1
- package/dist/commands/schemas/list.js +4 -5
- package/dist/commands/schemas/list.js.map +1 -1
- package/dist/commands/telemetry/disable.js +2 -2
- package/dist/commands/telemetry/disable.js.map +1 -1
- package/dist/commands/telemetry/enable.js +2 -2
- package/dist/commands/telemetry/enable.js.map +1 -1
- package/dist/commands/telemetry/status.js +2 -2
- package/dist/commands/telemetry/status.js.map +1 -1
- package/dist/commands/tokens/add.js +1 -1
- package/dist/commands/tokens/add.js.map +1 -1
- package/dist/commands/tokens/delete.js +1 -1
- package/dist/commands/tokens/delete.js.map +1 -1
- package/dist/commands/tokens/list.js +2 -2
- package/dist/commands/tokens/list.js.map +1 -1
- package/dist/commands/users/list.js +1 -1
- package/dist/commands/users/list.js.map +1 -1
- package/dist/commands/versions.js +1 -1
- package/dist/commands/versions.js.map +1 -1
- package/dist/server/vite/plugin-sanity-build-entries.js +3 -2
- package/dist/server/vite/plugin-sanity-build-entries.js.map +1 -1
- package/dist/util/telemetry/createTelemetryStore.js +27 -12
- package/dist/util/telemetry/createTelemetryStore.js.map +1 -1
- package/dist/util/validateProjection.js +121 -0
- package/dist/util/validateProjection.js.map +1 -0
- package/oclif.manifest.json +317 -315
- package/package.json +27 -26
package/oclif.manifest.json
CHANGED
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
"name": "outputDir"
|
|
9
9
|
}
|
|
10
10
|
},
|
|
11
|
-
"description": "
|
|
11
|
+
"description": "Build Sanity Studio into a static bundle",
|
|
12
12
|
"examples": [
|
|
13
13
|
"<%= config.bin %> <%= command.id %>",
|
|
14
14
|
"<%= config.bin %> <%= command.id %> --no-minify --source-maps"
|
|
@@ -119,7 +119,7 @@
|
|
|
119
119
|
"debug": {
|
|
120
120
|
"aliases": [],
|
|
121
121
|
"args": {},
|
|
122
|
-
"description": "
|
|
122
|
+
"description": "Print diagnostic info for troubleshooting",
|
|
123
123
|
"examples": [
|
|
124
124
|
"<%= config.bin %> <%= command.id %>",
|
|
125
125
|
"<%= config.bin %> <%= command.id %> --secrets"
|
|
@@ -188,7 +188,7 @@
|
|
|
188
188
|
"type": "boolean"
|
|
189
189
|
},
|
|
190
190
|
"build": {
|
|
191
|
-
"description": "
|
|
191
|
+
"description": "Build the studio before deploying (use --no-build to deploy existing `dist/` output)",
|
|
192
192
|
"name": "build",
|
|
193
193
|
"allowNo": true,
|
|
194
194
|
"type": "boolean"
|
|
@@ -205,13 +205,13 @@
|
|
|
205
205
|
"type": "boolean"
|
|
206
206
|
},
|
|
207
207
|
"minify": {
|
|
208
|
-
"description": "
|
|
208
|
+
"description": "Minify built JavaScript (use --no-minify to skip for faster builds)",
|
|
209
209
|
"name": "minify",
|
|
210
210
|
"allowNo": true,
|
|
211
211
|
"type": "boolean"
|
|
212
212
|
},
|
|
213
213
|
"schema-required": {
|
|
214
|
-
"description": "Fail
|
|
214
|
+
"description": "Fail if schema deployment fails",
|
|
215
215
|
"name": "schema-required",
|
|
216
216
|
"allowNo": false,
|
|
217
217
|
"type": "boolean"
|
|
@@ -260,7 +260,7 @@
|
|
|
260
260
|
"dev": {
|
|
261
261
|
"aliases": [],
|
|
262
262
|
"args": {},
|
|
263
|
-
"description": "
|
|
263
|
+
"description": "Start a local development server with live reloading",
|
|
264
264
|
"examples": [
|
|
265
265
|
"<%= config.bin %> <%= command.id %> --host=0.0.0.0",
|
|
266
266
|
"<%= config.bin %> <%= command.id %> --port=1942",
|
|
@@ -268,26 +268,26 @@
|
|
|
268
268
|
],
|
|
269
269
|
"flags": {
|
|
270
270
|
"auto-updates": {
|
|
271
|
-
"description": "Automatically update Sanity Studio dependencies
|
|
271
|
+
"description": "Automatically update Sanity Studio dependencies",
|
|
272
272
|
"name": "auto-updates",
|
|
273
273
|
"allowNo": true,
|
|
274
274
|
"type": "boolean"
|
|
275
275
|
},
|
|
276
276
|
"host": {
|
|
277
|
-
"description": "
|
|
277
|
+
"description": "Local network interface to listen on (default: localhost)",
|
|
278
278
|
"name": "host",
|
|
279
279
|
"hasDynamicHelp": false,
|
|
280
280
|
"multiple": false,
|
|
281
281
|
"type": "option"
|
|
282
282
|
},
|
|
283
283
|
"load-in-dashboard": {
|
|
284
|
-
"description": "Load the app/studio in the Sanity dashboard
|
|
284
|
+
"description": "Load the app/studio in the Sanity dashboard",
|
|
285
285
|
"name": "load-in-dashboard",
|
|
286
286
|
"allowNo": true,
|
|
287
287
|
"type": "boolean"
|
|
288
288
|
},
|
|
289
289
|
"port": {
|
|
290
|
-
"description": "
|
|
290
|
+
"description": "TCP port to start server on (default: 3333)",
|
|
291
291
|
"name": "port",
|
|
292
292
|
"hasDynamicHelp": false,
|
|
293
293
|
"multiple": false,
|
|
@@ -382,13 +382,13 @@
|
|
|
382
382
|
],
|
|
383
383
|
"flags": {
|
|
384
384
|
"mock-browser-env": {
|
|
385
|
-
"description": "
|
|
385
|
+
"description": "Mock a browser environment with jsdom",
|
|
386
386
|
"name": "mock-browser-env",
|
|
387
387
|
"allowNo": false,
|
|
388
388
|
"type": "boolean"
|
|
389
389
|
},
|
|
390
390
|
"with-user-token": {
|
|
391
|
-
"description": "
|
|
391
|
+
"description": "Include your auth token in getCliClient()",
|
|
392
392
|
"name": "with-user-token",
|
|
393
393
|
"allowNo": false,
|
|
394
394
|
"type": "boolean"
|
|
@@ -747,7 +747,7 @@
|
|
|
747
747
|
"required": false
|
|
748
748
|
}
|
|
749
749
|
},
|
|
750
|
-
"description": "
|
|
750
|
+
"description": "Install dependencies for the Sanity Studio project",
|
|
751
751
|
"examples": [
|
|
752
752
|
"<%= config.bin %> <%= command.id %>",
|
|
753
753
|
"<%= config.bin %> <%= command.id %> @sanity/vision",
|
|
@@ -771,7 +771,7 @@
|
|
|
771
771
|
"learn": {
|
|
772
772
|
"aliases": [],
|
|
773
773
|
"args": {},
|
|
774
|
-
"description": "
|
|
774
|
+
"description": "Open Sanity Learn in your browser",
|
|
775
775
|
"flags": {},
|
|
776
776
|
"hasDynamicHelp": false,
|
|
777
777
|
"hiddenAliases": [],
|
|
@@ -791,7 +791,7 @@
|
|
|
791
791
|
"login": {
|
|
792
792
|
"aliases": [],
|
|
793
793
|
"args": {},
|
|
794
|
-
"description": "
|
|
794
|
+
"description": "Log in to your Sanity account",
|
|
795
795
|
"examples": [
|
|
796
796
|
{
|
|
797
797
|
"command": "<%= config.bin %> <%= command.id %>",
|
|
@@ -874,7 +874,7 @@
|
|
|
874
874
|
"logout": {
|
|
875
875
|
"aliases": [],
|
|
876
876
|
"args": {},
|
|
877
|
-
"description": "
|
|
877
|
+
"description": "Log out of the current session",
|
|
878
878
|
"flags": {},
|
|
879
879
|
"hasDynamicHelp": false,
|
|
880
880
|
"hiddenAliases": [],
|
|
@@ -893,7 +893,7 @@
|
|
|
893
893
|
"manage": {
|
|
894
894
|
"aliases": [],
|
|
895
895
|
"args": {},
|
|
896
|
-
"description": "
|
|
896
|
+
"description": "Open project settings in your browser",
|
|
897
897
|
"flags": {},
|
|
898
898
|
"hasDynamicHelp": false,
|
|
899
899
|
"hiddenAliases": [],
|
|
@@ -918,7 +918,7 @@
|
|
|
918
918
|
}
|
|
919
919
|
},
|
|
920
920
|
"deprecateAliases": true,
|
|
921
|
-
"description": "
|
|
921
|
+
"description": "Start a local server to preview a production build",
|
|
922
922
|
"examples": [
|
|
923
923
|
"<%= config.bin %> <%= command.id %> --host=0.0.0.0",
|
|
924
924
|
"<%= config.bin %> <%= command.id %> --port=1942",
|
|
@@ -926,14 +926,14 @@
|
|
|
926
926
|
],
|
|
927
927
|
"flags": {
|
|
928
928
|
"host": {
|
|
929
|
-
"description": "
|
|
929
|
+
"description": "Local network interface to listen on (default: localhost)",
|
|
930
930
|
"name": "host",
|
|
931
931
|
"hasDynamicHelp": false,
|
|
932
932
|
"multiple": false,
|
|
933
933
|
"type": "option"
|
|
934
934
|
},
|
|
935
935
|
"port": {
|
|
936
|
-
"description": "
|
|
936
|
+
"description": "TCP port to start server on (default: 3333)",
|
|
937
937
|
"name": "port",
|
|
938
938
|
"hasDynamicHelp": false,
|
|
939
939
|
"multiple": false,
|
|
@@ -986,7 +986,7 @@
|
|
|
986
986
|
"versions": {
|
|
987
987
|
"aliases": [],
|
|
988
988
|
"args": {},
|
|
989
|
-
"description": "
|
|
989
|
+
"description": "Show installed package versions",
|
|
990
990
|
"examples": [
|
|
991
991
|
"<%= config.bin %> <%= command.id %>"
|
|
992
992
|
],
|
|
@@ -1014,7 +1014,7 @@
|
|
|
1014
1014
|
"required": false
|
|
1015
1015
|
}
|
|
1016
1016
|
},
|
|
1017
|
-
"description": "Disable backup for a dataset
|
|
1017
|
+
"description": "Disable backup for a dataset",
|
|
1018
1018
|
"examples": [
|
|
1019
1019
|
{
|
|
1020
1020
|
"command": "<%= config.bin %> <%= command.id %>",
|
|
@@ -1063,7 +1063,7 @@
|
|
|
1063
1063
|
"required": false
|
|
1064
1064
|
}
|
|
1065
1065
|
},
|
|
1066
|
-
"description": "Download a dataset backup to a local file
|
|
1066
|
+
"description": "Download a dataset backup to a local file",
|
|
1067
1067
|
"examples": [
|
|
1068
1068
|
{
|
|
1069
1069
|
"command": "<%= config.bin %> <%= command.id %>",
|
|
@@ -1148,7 +1148,7 @@
|
|
|
1148
1148
|
"required": false
|
|
1149
1149
|
}
|
|
1150
1150
|
},
|
|
1151
|
-
"description": "Enable backup for a dataset
|
|
1151
|
+
"description": "Enable backup for a dataset",
|
|
1152
1152
|
"examples": [
|
|
1153
1153
|
{
|
|
1154
1154
|
"command": "<%= config.bin %> <%= command.id %>",
|
|
@@ -1197,7 +1197,7 @@
|
|
|
1197
1197
|
"required": false
|
|
1198
1198
|
}
|
|
1199
1199
|
},
|
|
1200
|
-
"description": "List available backups for a dataset
|
|
1200
|
+
"description": "List available backups for a dataset",
|
|
1201
1201
|
"examples": [
|
|
1202
1202
|
{
|
|
1203
1203
|
"command": "<%= config.bin %> <%= command.id %>",
|
|
@@ -1277,7 +1277,7 @@
|
|
|
1277
1277
|
"required": true
|
|
1278
1278
|
}
|
|
1279
1279
|
},
|
|
1280
|
-
"description": "
|
|
1280
|
+
"description": "Add a CORS origin to the project",
|
|
1281
1281
|
"examples": [
|
|
1282
1282
|
{
|
|
1283
1283
|
"command": "<%= config.bin %> <%= command.id %>",
|
|
@@ -1339,7 +1339,7 @@
|
|
|
1339
1339
|
"required": false
|
|
1340
1340
|
}
|
|
1341
1341
|
},
|
|
1342
|
-
"description": "Delete
|
|
1342
|
+
"description": "Delete a CORS origin from the project",
|
|
1343
1343
|
"examples": [
|
|
1344
1344
|
{
|
|
1345
1345
|
"command": "<%= config.bin %> <%= command.id %>",
|
|
@@ -1384,11 +1384,11 @@
|
|
|
1384
1384
|
"cors:list": {
|
|
1385
1385
|
"aliases": [],
|
|
1386
1386
|
"args": {},
|
|
1387
|
-
"description": "List
|
|
1387
|
+
"description": "List CORS origins for the project",
|
|
1388
1388
|
"examples": [
|
|
1389
1389
|
{
|
|
1390
1390
|
"command": "<%= config.bin %> <%= command.id %>",
|
|
1391
|
-
"description": "List CORS origins for the
|
|
1391
|
+
"description": "List CORS origins for the project"
|
|
1392
1392
|
},
|
|
1393
1393
|
{
|
|
1394
1394
|
"command": "<%= config.bin %> <%= command.id %> --project-id abc123",
|
|
@@ -1436,7 +1436,7 @@
|
|
|
1436
1436
|
"required": false
|
|
1437
1437
|
}
|
|
1438
1438
|
},
|
|
1439
|
-
"description": "
|
|
1439
|
+
"description": "Copy a dataset or manage copy jobs",
|
|
1440
1440
|
"examples": [
|
|
1441
1441
|
{
|
|
1442
1442
|
"command": "<%= config.bin %> <%= command.id %>",
|
|
@@ -1578,7 +1578,7 @@
|
|
|
1578
1578
|
"required": false
|
|
1579
1579
|
}
|
|
1580
1580
|
},
|
|
1581
|
-
"description": "Create a new dataset
|
|
1581
|
+
"description": "Create a new dataset for the project",
|
|
1582
1582
|
"examples": [
|
|
1583
1583
|
{
|
|
1584
1584
|
"command": "<%= config.bin %> <%= command.id %>",
|
|
@@ -1660,7 +1660,7 @@
|
|
|
1660
1660
|
"required": true
|
|
1661
1661
|
}
|
|
1662
1662
|
},
|
|
1663
|
-
"description": "Delete a dataset
|
|
1663
|
+
"description": "Delete a dataset from the project",
|
|
1664
1664
|
"examples": [
|
|
1665
1665
|
{
|
|
1666
1666
|
"command": "<%= config.bin %> <%= command.id %> my-dataset",
|
|
@@ -1719,7 +1719,7 @@
|
|
|
1719
1719
|
"name": "destination"
|
|
1720
1720
|
}
|
|
1721
1721
|
},
|
|
1722
|
-
"description": "Export dataset to local
|
|
1722
|
+
"description": "Export a dataset to a local gzipped tarball. Assets returning 401, 403, or 404 are excluded from the export.",
|
|
1723
1723
|
"examples": [
|
|
1724
1724
|
{
|
|
1725
1725
|
"command": "<%= config.bin %> <%= command.id %> moviedb localPath.tar.gz",
|
|
@@ -1758,7 +1758,7 @@
|
|
|
1758
1758
|
"type": "option"
|
|
1759
1759
|
},
|
|
1760
1760
|
"mode": {
|
|
1761
|
-
"description": "
|
|
1761
|
+
"description": "Export mode ('cursor' is faster for large datasets but may miss concurrent changes)",
|
|
1762
1762
|
"name": "mode",
|
|
1763
1763
|
"default": "stream",
|
|
1764
1764
|
"hasDynamicHelp": false,
|
|
@@ -1980,11 +1980,11 @@
|
|
|
1980
1980
|
"datasets:list": {
|
|
1981
1981
|
"aliases": [],
|
|
1982
1982
|
"args": {},
|
|
1983
|
-
"description": "List datasets
|
|
1983
|
+
"description": "List datasets for the project",
|
|
1984
1984
|
"examples": [
|
|
1985
1985
|
{
|
|
1986
1986
|
"command": "<%= config.bin %> <%= command.id %>",
|
|
1987
|
-
"description": "List datasets
|
|
1987
|
+
"description": "List datasets for the project"
|
|
1988
1988
|
},
|
|
1989
1989
|
{
|
|
1990
1990
|
"command": "<%= config.bin %> <%= command.id %> --project-id abc123",
|
|
@@ -2023,7 +2023,7 @@
|
|
|
2023
2023
|
"docs:browse": {
|
|
2024
2024
|
"aliases": [],
|
|
2025
2025
|
"args": {},
|
|
2026
|
-
"description": "Open Sanity docs in
|
|
2026
|
+
"description": "Open Sanity docs in your browser",
|
|
2027
2027
|
"flags": {},
|
|
2028
2028
|
"hasDynamicHelp": false,
|
|
2029
2029
|
"hiddenAliases": [],
|
|
@@ -2260,7 +2260,7 @@
|
|
|
2260
2260
|
"required": false
|
|
2261
2261
|
}
|
|
2262
2262
|
},
|
|
2263
|
-
"description": "Delete one or more documents from the
|
|
2263
|
+
"description": "Delete one or more documents from the project's configured dataset",
|
|
2264
2264
|
"examples": [
|
|
2265
2265
|
{
|
|
2266
2266
|
"command": "<%= config.bin %> <%= command.id %> myDocId",
|
|
@@ -2613,43 +2613,98 @@
|
|
|
2613
2613
|
"validate.js"
|
|
2614
2614
|
]
|
|
2615
2615
|
},
|
|
2616
|
-
"
|
|
2616
|
+
"graphql:deploy": {
|
|
2617
2617
|
"aliases": [],
|
|
2618
|
-
"args": {
|
|
2619
|
-
|
|
2620
|
-
"description": "The delivery attempt ID to get details for",
|
|
2621
|
-
"name": "attemptId",
|
|
2622
|
-
"required": true
|
|
2623
|
-
}
|
|
2624
|
-
},
|
|
2625
|
-
"description": "Print details of a given webhook delivery attempt",
|
|
2618
|
+
"args": {},
|
|
2619
|
+
"description": "Deploy a GraphQL API from the current Sanity schema",
|
|
2626
2620
|
"examples": [
|
|
2627
2621
|
{
|
|
2628
|
-
"command": "<%= config.bin %> <%= command.id %>
|
|
2629
|
-
"description": "
|
|
2622
|
+
"command": "<%= config.bin %> <%= command.id %>",
|
|
2623
|
+
"description": "Deploy all defined GraphQL APIs"
|
|
2630
2624
|
},
|
|
2631
2625
|
{
|
|
2632
|
-
"command": "<%= config.bin %> <%= command.id %>
|
|
2633
|
-
"description": "
|
|
2626
|
+
"command": "<%= config.bin %> <%= command.id %> --dry-run",
|
|
2627
|
+
"description": "Validate defined GraphQL APIs, check for breaking changes, skip deploy"
|
|
2628
|
+
},
|
|
2629
|
+
{
|
|
2630
|
+
"command": "<%= config.bin %> <%= command.id %> --api staging --api ios",
|
|
2631
|
+
"description": "Deploy only the GraphQL APIs with the IDs \"staging\" and \"ios\""
|
|
2632
|
+
},
|
|
2633
|
+
{
|
|
2634
|
+
"command": "<%= config.bin %> <%= command.id %> --playground",
|
|
2635
|
+
"description": "Deploy all defined GraphQL APIs, overriding any playground setting"
|
|
2634
2636
|
}
|
|
2635
2637
|
],
|
|
2636
2638
|
"flags": {
|
|
2637
|
-
"
|
|
2638
|
-
"
|
|
2639
|
-
"
|
|
2640
|
-
"
|
|
2641
|
-
"
|
|
2639
|
+
"api": {
|
|
2640
|
+
"description": "Only deploy API with this ID (can be specified multiple times)",
|
|
2641
|
+
"name": "api",
|
|
2642
|
+
"hasDynamicHelp": false,
|
|
2643
|
+
"multiple": true,
|
|
2644
|
+
"type": "option"
|
|
2645
|
+
},
|
|
2646
|
+
"dataset": {
|
|
2647
|
+
"char": "d",
|
|
2648
|
+
"description": "Deploy API for the given dataset",
|
|
2649
|
+
"name": "dataset",
|
|
2650
|
+
"hasDynamicHelp": false,
|
|
2651
|
+
"helpValue": "<name>",
|
|
2652
|
+
"multiple": false,
|
|
2653
|
+
"type": "option"
|
|
2654
|
+
},
|
|
2655
|
+
"dry-run": {
|
|
2656
|
+
"description": "Validate defined GraphQL APIs, check for breaking changes, skip deploy",
|
|
2657
|
+
"name": "dry-run",
|
|
2658
|
+
"allowNo": false,
|
|
2659
|
+
"type": "boolean"
|
|
2660
|
+
},
|
|
2661
|
+
"force": {
|
|
2662
|
+
"description": "Deploy API without confirming breaking changes",
|
|
2663
|
+
"name": "force",
|
|
2664
|
+
"allowNo": false,
|
|
2665
|
+
"type": "boolean"
|
|
2666
|
+
},
|
|
2667
|
+
"generation": {
|
|
2668
|
+
"description": "API generation to deploy (defaults to \"gen3\")",
|
|
2669
|
+
"name": "generation",
|
|
2670
|
+
"hasDynamicHelp": false,
|
|
2671
|
+
"multiple": false,
|
|
2672
|
+
"options": [
|
|
2673
|
+
"gen1",
|
|
2674
|
+
"gen2",
|
|
2675
|
+
"gen3"
|
|
2676
|
+
],
|
|
2677
|
+
"type": "option"
|
|
2678
|
+
},
|
|
2679
|
+
"non-null-document-fields": {
|
|
2680
|
+
"description": "Use non-null document fields (_id, _type etc)",
|
|
2681
|
+
"name": "non-null-document-fields",
|
|
2682
|
+
"allowNo": false,
|
|
2683
|
+
"type": "boolean"
|
|
2684
|
+
},
|
|
2685
|
+
"playground": {
|
|
2686
|
+
"description": "Enable GraphQL playground for easier debugging",
|
|
2687
|
+
"name": "playground",
|
|
2688
|
+
"allowNo": true,
|
|
2689
|
+
"type": "boolean"
|
|
2690
|
+
},
|
|
2691
|
+
"tag": {
|
|
2692
|
+
"description": "Deploy API(s) to given tag (defaults to \"default\")",
|
|
2693
|
+
"name": "tag",
|
|
2642
2694
|
"hasDynamicHelp": false,
|
|
2643
|
-
"helpValue": "<id>",
|
|
2644
2695
|
"multiple": false,
|
|
2645
2696
|
"type": "option"
|
|
2697
|
+
},
|
|
2698
|
+
"with-union-cache": {
|
|
2699
|
+
"description": "Cache union types (faster for schemas with many self-references)",
|
|
2700
|
+
"name": "with-union-cache",
|
|
2701
|
+
"allowNo": false,
|
|
2702
|
+
"type": "boolean"
|
|
2646
2703
|
}
|
|
2647
2704
|
},
|
|
2648
2705
|
"hasDynamicHelp": false,
|
|
2649
|
-
"hiddenAliases": [
|
|
2650
|
-
|
|
2651
|
-
],
|
|
2652
|
-
"id": "hooks:attempt",
|
|
2706
|
+
"hiddenAliases": [],
|
|
2707
|
+
"id": "graphql:deploy",
|
|
2653
2708
|
"pluginAlias": "@sanity/cli",
|
|
2654
2709
|
"pluginName": "@sanity/cli",
|
|
2655
2710
|
"pluginType": "core",
|
|
@@ -2658,28 +2713,28 @@
|
|
|
2658
2713
|
"relativePath": [
|
|
2659
2714
|
"dist",
|
|
2660
2715
|
"commands",
|
|
2661
|
-
"
|
|
2662
|
-
"
|
|
2716
|
+
"graphql",
|
|
2717
|
+
"deploy.js"
|
|
2663
2718
|
]
|
|
2664
2719
|
},
|
|
2665
|
-
"
|
|
2720
|
+
"graphql:list": {
|
|
2666
2721
|
"aliases": [],
|
|
2667
2722
|
"args": {},
|
|
2668
|
-
"description": "
|
|
2723
|
+
"description": "List deployed GraphQL endpoints for the project",
|
|
2669
2724
|
"examples": [
|
|
2670
2725
|
{
|
|
2671
2726
|
"command": "<%= config.bin %> <%= command.id %>",
|
|
2672
|
-
"description": "
|
|
2727
|
+
"description": "List GraphQL endpoints for the project"
|
|
2673
2728
|
},
|
|
2674
2729
|
{
|
|
2675
2730
|
"command": "<%= config.bin %> <%= command.id %> --project-id abc123",
|
|
2676
|
-
"description": "
|
|
2731
|
+
"description": "List GraphQL endpoints for a specific project"
|
|
2677
2732
|
}
|
|
2678
2733
|
],
|
|
2679
2734
|
"flags": {
|
|
2680
2735
|
"project-id": {
|
|
2681
2736
|
"char": "p",
|
|
2682
|
-
"description": "Project ID to
|
|
2737
|
+
"description": "Project ID to list GraphQL endpoints for (overrides CLI configuration)",
|
|
2683
2738
|
"helpGroup": "OVERRIDE",
|
|
2684
2739
|
"name": "project-id",
|
|
2685
2740
|
"hasDynamicHelp": false,
|
|
@@ -2689,10 +2744,8 @@
|
|
|
2689
2744
|
}
|
|
2690
2745
|
},
|
|
2691
2746
|
"hasDynamicHelp": false,
|
|
2692
|
-
"hiddenAliases": [
|
|
2693
|
-
|
|
2694
|
-
],
|
|
2695
|
-
"id": "hooks:create",
|
|
2747
|
+
"hiddenAliases": [],
|
|
2748
|
+
"id": "graphql:list",
|
|
2696
2749
|
"pluginAlias": "@sanity/cli",
|
|
2697
2750
|
"pluginName": "@sanity/cli",
|
|
2698
2751
|
"pluginType": "core",
|
|
@@ -2701,51 +2754,105 @@
|
|
|
2701
2754
|
"relativePath": [
|
|
2702
2755
|
"dist",
|
|
2703
2756
|
"commands",
|
|
2704
|
-
"
|
|
2705
|
-
"
|
|
2757
|
+
"graphql",
|
|
2758
|
+
"list.js"
|
|
2706
2759
|
]
|
|
2707
2760
|
},
|
|
2708
|
-
"
|
|
2761
|
+
"graphql:undeploy": {
|
|
2709
2762
|
"aliases": [],
|
|
2710
|
-
"args": {
|
|
2711
|
-
|
|
2712
|
-
"description": "Name of hook to delete (will prompt if not provided)",
|
|
2713
|
-
"name": "name",
|
|
2714
|
-
"required": false
|
|
2715
|
-
}
|
|
2716
|
-
},
|
|
2717
|
-
"description": "Delete a hook within your project",
|
|
2763
|
+
"args": {},
|
|
2764
|
+
"description": "Remove a deployed GraphQL API",
|
|
2718
2765
|
"examples": [
|
|
2719
2766
|
{
|
|
2720
2767
|
"command": "<%= config.bin %> <%= command.id %>",
|
|
2721
|
-
"description": "
|
|
2768
|
+
"description": "Undeploy GraphQL API for current project and dataset"
|
|
2722
2769
|
},
|
|
2723
2770
|
{
|
|
2724
|
-
"command": "<%= config.bin %> <%= command.id %>
|
|
2725
|
-
"description": "
|
|
2771
|
+
"command": "<%= config.bin %> <%= command.id %> --api ios",
|
|
2772
|
+
"description": "Undeploy API with ID \"ios\""
|
|
2726
2773
|
},
|
|
2727
2774
|
{
|
|
2728
|
-
"command": "<%= config.bin %> <%= command.id %> --
|
|
2729
|
-
"description": "
|
|
2775
|
+
"command": "<%= config.bin %> <%= command.id %> --dataset staging",
|
|
2776
|
+
"description": "Undeploy GraphQL API for staging dataset"
|
|
2777
|
+
},
|
|
2778
|
+
{
|
|
2779
|
+
"command": "<%= config.bin %> <%= command.id %> --dataset staging --tag next",
|
|
2780
|
+
"description": "Undeploy GraphQL API for staging dataset with \"next\" tag"
|
|
2781
|
+
},
|
|
2782
|
+
{
|
|
2783
|
+
"command": "<%= config.bin %> <%= command.id %> --force",
|
|
2784
|
+
"description": "Undeploy GraphQL API without confirmation prompt"
|
|
2785
|
+
},
|
|
2786
|
+
{
|
|
2787
|
+
"command": "<%= config.bin %> <%= command.id %> --project-id abc123 --dataset production",
|
|
2788
|
+
"description": "Undeploy GraphQL API for a specific project and dataset"
|
|
2730
2789
|
}
|
|
2731
2790
|
],
|
|
2732
2791
|
"flags": {
|
|
2733
2792
|
"project-id": {
|
|
2734
2793
|
"char": "p",
|
|
2735
|
-
"description": "Project ID to
|
|
2794
|
+
"description": "Project ID to undeploy GraphQL API from (overrides CLI configuration)",
|
|
2736
2795
|
"helpGroup": "OVERRIDE",
|
|
2737
2796
|
"name": "project-id",
|
|
2738
2797
|
"hasDynamicHelp": false,
|
|
2739
2798
|
"helpValue": "<id>",
|
|
2740
2799
|
"multiple": false,
|
|
2741
2800
|
"type": "option"
|
|
2801
|
+
},
|
|
2802
|
+
"api": {
|
|
2803
|
+
"description": "Undeploy API with this ID",
|
|
2804
|
+
"exclusive": [
|
|
2805
|
+
"project-id",
|
|
2806
|
+
"project"
|
|
2807
|
+
],
|
|
2808
|
+
"name": "api",
|
|
2809
|
+
"required": false,
|
|
2810
|
+
"hasDynamicHelp": false,
|
|
2811
|
+
"multiple": false,
|
|
2812
|
+
"type": "option"
|
|
2813
|
+
},
|
|
2814
|
+
"dataset": {
|
|
2815
|
+
"char": "d",
|
|
2816
|
+
"description": "Dataset to undeploy GraphQL API from (overrides CLI configuration)",
|
|
2817
|
+
"helpGroup": "OVERRIDE",
|
|
2818
|
+
"name": "dataset",
|
|
2819
|
+
"hasDynamicHelp": false,
|
|
2820
|
+
"helpValue": "<name>",
|
|
2821
|
+
"multiple": false,
|
|
2822
|
+
"type": "option"
|
|
2823
|
+
},
|
|
2824
|
+
"force": {
|
|
2825
|
+
"description": "Skip confirmation prompt",
|
|
2826
|
+
"name": "force",
|
|
2827
|
+
"required": false,
|
|
2828
|
+
"allowNo": false,
|
|
2829
|
+
"type": "boolean"
|
|
2830
|
+
},
|
|
2831
|
+
"project": {
|
|
2832
|
+
"deprecated": {
|
|
2833
|
+
"to": "project-id"
|
|
2834
|
+
},
|
|
2835
|
+
"description": "Project ID to delete GraphQL API for",
|
|
2836
|
+
"hidden": true,
|
|
2837
|
+
"name": "project",
|
|
2838
|
+
"required": false,
|
|
2839
|
+
"hasDynamicHelp": false,
|
|
2840
|
+
"multiple": false,
|
|
2841
|
+
"type": "option"
|
|
2842
|
+
},
|
|
2843
|
+
"tag": {
|
|
2844
|
+
"description": "Tag to undeploy GraphQL API from",
|
|
2845
|
+
"name": "tag",
|
|
2846
|
+
"required": false,
|
|
2847
|
+
"default": "default",
|
|
2848
|
+
"hasDynamicHelp": false,
|
|
2849
|
+
"multiple": false,
|
|
2850
|
+
"type": "option"
|
|
2742
2851
|
}
|
|
2743
2852
|
},
|
|
2744
2853
|
"hasDynamicHelp": false,
|
|
2745
|
-
"hiddenAliases": [
|
|
2746
|
-
|
|
2747
|
-
],
|
|
2748
|
-
"id": "hooks:delete",
|
|
2854
|
+
"hiddenAliases": [],
|
|
2855
|
+
"id": "graphql:undeploy",
|
|
2749
2856
|
"pluginAlias": "@sanity/cli",
|
|
2750
2857
|
"pluginName": "@sanity/cli",
|
|
2751
2858
|
"pluginType": "core",
|
|
@@ -2754,28 +2861,34 @@
|
|
|
2754
2861
|
"relativePath": [
|
|
2755
2862
|
"dist",
|
|
2756
2863
|
"commands",
|
|
2757
|
-
"
|
|
2758
|
-
"
|
|
2864
|
+
"graphql",
|
|
2865
|
+
"undeploy.js"
|
|
2759
2866
|
]
|
|
2760
2867
|
},
|
|
2761
|
-
"hooks:
|
|
2868
|
+
"hooks:attempt": {
|
|
2762
2869
|
"aliases": [],
|
|
2763
|
-
"args": {
|
|
2764
|
-
|
|
2870
|
+
"args": {
|
|
2871
|
+
"attemptId": {
|
|
2872
|
+
"description": "The delivery attempt ID to get details for",
|
|
2873
|
+
"name": "attemptId",
|
|
2874
|
+
"required": true
|
|
2875
|
+
}
|
|
2876
|
+
},
|
|
2877
|
+
"description": "Print details of a given webhook delivery attempt",
|
|
2765
2878
|
"examples": [
|
|
2766
2879
|
{
|
|
2767
|
-
"command": "<%= config.bin %> <%= command.id %>",
|
|
2768
|
-
"description": "
|
|
2880
|
+
"command": "<%= config.bin %> <%= command.id %> abc123",
|
|
2881
|
+
"description": "Print details of webhook delivery attempt with ID abc123"
|
|
2769
2882
|
},
|
|
2770
2883
|
{
|
|
2771
|
-
"command": "<%= config.bin %> <%= command.id %> --project-id
|
|
2772
|
-
"description": "
|
|
2884
|
+
"command": "<%= config.bin %> <%= command.id %> abc123 --project-id projectId",
|
|
2885
|
+
"description": "Get attempt details for a specific project"
|
|
2773
2886
|
}
|
|
2774
2887
|
],
|
|
2775
2888
|
"flags": {
|
|
2776
2889
|
"project-id": {
|
|
2777
2890
|
"char": "p",
|
|
2778
|
-
"description": "Project ID to
|
|
2891
|
+
"description": "Project ID to view webhook attempt for (overrides CLI configuration)",
|
|
2779
2892
|
"helpGroup": "OVERRIDE",
|
|
2780
2893
|
"name": "project-id",
|
|
2781
2894
|
"hasDynamicHelp": false,
|
|
@@ -2786,9 +2899,9 @@
|
|
|
2786
2899
|
},
|
|
2787
2900
|
"hasDynamicHelp": false,
|
|
2788
2901
|
"hiddenAliases": [
|
|
2789
|
-
"hook:
|
|
2902
|
+
"hook:attempt"
|
|
2790
2903
|
],
|
|
2791
|
-
"id": "hooks:
|
|
2904
|
+
"id": "hooks:attempt",
|
|
2792
2905
|
"pluginAlias": "@sanity/cli",
|
|
2793
2906
|
"pluginName": "@sanity/cli",
|
|
2794
2907
|
"pluginType": "core",
|
|
@@ -2798,57 +2911,40 @@
|
|
|
2798
2911
|
"dist",
|
|
2799
2912
|
"commands",
|
|
2800
2913
|
"hooks",
|
|
2801
|
-
"
|
|
2914
|
+
"attempt.js"
|
|
2802
2915
|
]
|
|
2803
2916
|
},
|
|
2804
|
-
"hooks:
|
|
2917
|
+
"hooks:create": {
|
|
2805
2918
|
"aliases": [],
|
|
2806
|
-
"args": {
|
|
2807
|
-
|
|
2808
|
-
"description": "Name of the hook to show logs for",
|
|
2809
|
-
"name": "name",
|
|
2810
|
-
"required": false
|
|
2811
|
-
}
|
|
2812
|
-
},
|
|
2813
|
-
"description": "List latest log entries for a given hook",
|
|
2919
|
+
"args": {},
|
|
2920
|
+
"description": "Create a new webhook for the project",
|
|
2814
2921
|
"examples": [
|
|
2815
2922
|
{
|
|
2816
2923
|
"command": "<%= config.bin %> <%= command.id %>",
|
|
2817
|
-
"description": "
|
|
2818
|
-
},
|
|
2819
|
-
{
|
|
2820
|
-
"command": "<%= config.bin %> <%= command.id %> [NAME]",
|
|
2821
|
-
"description": "List latest log entries for a specific hook by name"
|
|
2924
|
+
"description": "Create a new webhook for the project"
|
|
2822
2925
|
},
|
|
2823
2926
|
{
|
|
2824
2927
|
"command": "<%= config.bin %> <%= command.id %> --project-id abc123",
|
|
2825
|
-
"description": "
|
|
2928
|
+
"description": "Create a webhook for a specific project"
|
|
2826
2929
|
}
|
|
2827
2930
|
],
|
|
2828
2931
|
"flags": {
|
|
2829
2932
|
"project-id": {
|
|
2830
2933
|
"char": "p",
|
|
2831
|
-
"description": "Project ID to
|
|
2934
|
+
"description": "Project ID to create webhook for (overrides CLI configuration)",
|
|
2832
2935
|
"helpGroup": "OVERRIDE",
|
|
2833
2936
|
"name": "project-id",
|
|
2834
2937
|
"hasDynamicHelp": false,
|
|
2835
2938
|
"helpValue": "<id>",
|
|
2836
2939
|
"multiple": false,
|
|
2837
2940
|
"type": "option"
|
|
2838
|
-
},
|
|
2839
|
-
"detailed": {
|
|
2840
|
-
"description": "Include detailed payload and attempts",
|
|
2841
|
-
"name": "detailed",
|
|
2842
|
-
"required": false,
|
|
2843
|
-
"allowNo": false,
|
|
2844
|
-
"type": "boolean"
|
|
2845
2941
|
}
|
|
2846
2942
|
},
|
|
2847
2943
|
"hasDynamicHelp": false,
|
|
2848
2944
|
"hiddenAliases": [
|
|
2849
|
-
"hook:
|
|
2945
|
+
"hook:create"
|
|
2850
2946
|
],
|
|
2851
|
-
"id": "hooks:
|
|
2947
|
+
"id": "hooks:create",
|
|
2852
2948
|
"pluginAlias": "@sanity/cli",
|
|
2853
2949
|
"pluginName": "@sanity/cli",
|
|
2854
2950
|
"pluginType": "core",
|
|
@@ -2858,101 +2954,50 @@
|
|
|
2858
2954
|
"dist",
|
|
2859
2955
|
"commands",
|
|
2860
2956
|
"hooks",
|
|
2861
|
-
"
|
|
2957
|
+
"create.js"
|
|
2862
2958
|
]
|
|
2863
2959
|
},
|
|
2864
|
-
"
|
|
2960
|
+
"hooks:delete": {
|
|
2865
2961
|
"aliases": [],
|
|
2866
|
-
"args": {
|
|
2867
|
-
|
|
2962
|
+
"args": {
|
|
2963
|
+
"name": {
|
|
2964
|
+
"description": "Name of webhook to delete (will prompt if not provided)",
|
|
2965
|
+
"name": "name",
|
|
2966
|
+
"required": false
|
|
2967
|
+
}
|
|
2968
|
+
},
|
|
2969
|
+
"description": "Delete a webhook from the project",
|
|
2868
2970
|
"examples": [
|
|
2869
2971
|
{
|
|
2870
2972
|
"command": "<%= config.bin %> <%= command.id %>",
|
|
2871
|
-
"description": "
|
|
2973
|
+
"description": "Interactively select and delete a webhook"
|
|
2872
2974
|
},
|
|
2873
2975
|
{
|
|
2874
|
-
"command": "<%= config.bin %> <%= command.id %>
|
|
2875
|
-
"description": "
|
|
2876
|
-
},
|
|
2877
|
-
{
|
|
2878
|
-
"command": "<%= config.bin %> <%= command.id %> --api staging --api ios",
|
|
2879
|
-
"description": "Deploy only the GraphQL APIs with the IDs \"staging\" and \"ios\""
|
|
2976
|
+
"command": "<%= config.bin %> <%= command.id %> my-hook",
|
|
2977
|
+
"description": "Delete a specific webhook by name"
|
|
2880
2978
|
},
|
|
2881
2979
|
{
|
|
2882
|
-
"command": "<%= config.bin %> <%= command.id %> --
|
|
2883
|
-
"description": "
|
|
2980
|
+
"command": "<%= config.bin %> <%= command.id %> --project-id abc123",
|
|
2981
|
+
"description": "Delete a webhook from a specific project"
|
|
2884
2982
|
}
|
|
2885
2983
|
],
|
|
2886
2984
|
"flags": {
|
|
2887
|
-
"
|
|
2888
|
-
"
|
|
2889
|
-
"
|
|
2890
|
-
"
|
|
2891
|
-
"
|
|
2892
|
-
"type": "option"
|
|
2893
|
-
},
|
|
2894
|
-
"dataset": {
|
|
2895
|
-
"char": "d",
|
|
2896
|
-
"description": "Deploy API for the given dataset",
|
|
2897
|
-
"name": "dataset",
|
|
2898
|
-
"hasDynamicHelp": false,
|
|
2899
|
-
"helpValue": "<name>",
|
|
2900
|
-
"multiple": false,
|
|
2901
|
-
"type": "option"
|
|
2902
|
-
},
|
|
2903
|
-
"dry-run": {
|
|
2904
|
-
"description": "Validate defined GraphQL APIs, check for breaking changes, skip deploy",
|
|
2905
|
-
"name": "dry-run",
|
|
2906
|
-
"allowNo": false,
|
|
2907
|
-
"type": "boolean"
|
|
2908
|
-
},
|
|
2909
|
-
"force": {
|
|
2910
|
-
"description": "Deploy API without confirming breaking changes",
|
|
2911
|
-
"name": "force",
|
|
2912
|
-
"allowNo": false,
|
|
2913
|
-
"type": "boolean"
|
|
2914
|
-
},
|
|
2915
|
-
"generation": {
|
|
2916
|
-
"description": "API generation to deploy (defaults to \"gen3\")",
|
|
2917
|
-
"name": "generation",
|
|
2918
|
-
"hasDynamicHelp": false,
|
|
2919
|
-
"multiple": false,
|
|
2920
|
-
"options": [
|
|
2921
|
-
"gen1",
|
|
2922
|
-
"gen2",
|
|
2923
|
-
"gen3"
|
|
2924
|
-
],
|
|
2925
|
-
"type": "option"
|
|
2926
|
-
},
|
|
2927
|
-
"non-null-document-fields": {
|
|
2928
|
-
"description": "Use non-null document fields (_id, _type etc)",
|
|
2929
|
-
"name": "non-null-document-fields",
|
|
2930
|
-
"allowNo": false,
|
|
2931
|
-
"type": "boolean"
|
|
2932
|
-
},
|
|
2933
|
-
"playground": {
|
|
2934
|
-
"description": "Enable GraphQL playground for easier debugging",
|
|
2935
|
-
"name": "playground",
|
|
2936
|
-
"allowNo": true,
|
|
2937
|
-
"type": "boolean"
|
|
2938
|
-
},
|
|
2939
|
-
"tag": {
|
|
2940
|
-
"description": "Deploy API(s) to given tag (defaults to \"default\")",
|
|
2941
|
-
"name": "tag",
|
|
2985
|
+
"project-id": {
|
|
2986
|
+
"char": "p",
|
|
2987
|
+
"description": "Project ID to delete webhook from (overrides CLI configuration)",
|
|
2988
|
+
"helpGroup": "OVERRIDE",
|
|
2989
|
+
"name": "project-id",
|
|
2942
2990
|
"hasDynamicHelp": false,
|
|
2991
|
+
"helpValue": "<id>",
|
|
2943
2992
|
"multiple": false,
|
|
2944
2993
|
"type": "option"
|
|
2945
|
-
},
|
|
2946
|
-
"with-union-cache": {
|
|
2947
|
-
"description": "Enable union cache that optimizes schema generation for schemas with many self referencing types",
|
|
2948
|
-
"name": "with-union-cache",
|
|
2949
|
-
"allowNo": false,
|
|
2950
|
-
"type": "boolean"
|
|
2951
2994
|
}
|
|
2952
2995
|
},
|
|
2953
2996
|
"hasDynamicHelp": false,
|
|
2954
|
-
"hiddenAliases": [
|
|
2955
|
-
|
|
2997
|
+
"hiddenAliases": [
|
|
2998
|
+
"hook:delete"
|
|
2999
|
+
],
|
|
3000
|
+
"id": "hooks:delete",
|
|
2956
3001
|
"pluginAlias": "@sanity/cli",
|
|
2957
3002
|
"pluginName": "@sanity/cli",
|
|
2958
3003
|
"pluginType": "core",
|
|
@@ -2961,28 +3006,28 @@
|
|
|
2961
3006
|
"relativePath": [
|
|
2962
3007
|
"dist",
|
|
2963
3008
|
"commands",
|
|
2964
|
-
"
|
|
2965
|
-
"
|
|
3009
|
+
"hooks",
|
|
3010
|
+
"delete.js"
|
|
2966
3011
|
]
|
|
2967
3012
|
},
|
|
2968
|
-
"
|
|
3013
|
+
"hooks:list": {
|
|
2969
3014
|
"aliases": [],
|
|
2970
3015
|
"args": {},
|
|
2971
|
-
"description": "List
|
|
3016
|
+
"description": "List webhooks for the project",
|
|
2972
3017
|
"examples": [
|
|
2973
3018
|
{
|
|
2974
3019
|
"command": "<%= config.bin %> <%= command.id %>",
|
|
2975
|
-
"description": "List
|
|
3020
|
+
"description": "List webhooks for the project"
|
|
2976
3021
|
},
|
|
2977
3022
|
{
|
|
2978
3023
|
"command": "<%= config.bin %> <%= command.id %> --project-id abc123",
|
|
2979
|
-
"description": "List
|
|
3024
|
+
"description": "List webhooks for a specific project"
|
|
2980
3025
|
}
|
|
2981
3026
|
],
|
|
2982
3027
|
"flags": {
|
|
2983
3028
|
"project-id": {
|
|
2984
3029
|
"char": "p",
|
|
2985
|
-
"description": "Project ID to list
|
|
3030
|
+
"description": "Project ID to list webhooks for (overrides CLI configuration)",
|
|
2986
3031
|
"helpGroup": "OVERRIDE",
|
|
2987
3032
|
"name": "project-id",
|
|
2988
3033
|
"hasDynamicHelp": false,
|
|
@@ -2992,8 +3037,10 @@
|
|
|
2992
3037
|
}
|
|
2993
3038
|
},
|
|
2994
3039
|
"hasDynamicHelp": false,
|
|
2995
|
-
"hiddenAliases": [
|
|
2996
|
-
|
|
3040
|
+
"hiddenAliases": [
|
|
3041
|
+
"hook:list"
|
|
3042
|
+
],
|
|
3043
|
+
"id": "hooks:list",
|
|
2997
3044
|
"pluginAlias": "@sanity/cli",
|
|
2998
3045
|
"pluginName": "@sanity/cli",
|
|
2999
3046
|
"pluginType": "core",
|
|
@@ -3002,44 +3049,38 @@
|
|
|
3002
3049
|
"relativePath": [
|
|
3003
3050
|
"dist",
|
|
3004
3051
|
"commands",
|
|
3005
|
-
"
|
|
3052
|
+
"hooks",
|
|
3006
3053
|
"list.js"
|
|
3007
3054
|
]
|
|
3008
3055
|
},
|
|
3009
|
-
"
|
|
3056
|
+
"hooks:logs": {
|
|
3010
3057
|
"aliases": [],
|
|
3011
|
-
"args": {
|
|
3012
|
-
|
|
3058
|
+
"args": {
|
|
3059
|
+
"name": {
|
|
3060
|
+
"description": "Name of the webhook to show logs for",
|
|
3061
|
+
"name": "name",
|
|
3062
|
+
"required": false
|
|
3063
|
+
}
|
|
3064
|
+
},
|
|
3065
|
+
"description": "Show log entries for project webhooks",
|
|
3013
3066
|
"examples": [
|
|
3014
3067
|
{
|
|
3015
3068
|
"command": "<%= config.bin %> <%= command.id %>",
|
|
3016
|
-
"description": "
|
|
3069
|
+
"description": "Show log entries for project webhooks"
|
|
3017
3070
|
},
|
|
3018
3071
|
{
|
|
3019
|
-
"command": "<%= config.bin %> <%= command.id %>
|
|
3020
|
-
"description": "
|
|
3021
|
-
},
|
|
3022
|
-
{
|
|
3023
|
-
"command": "<%= config.bin %> <%= command.id %> --dataset staging",
|
|
3024
|
-
"description": "Undeploy GraphQL API for staging dataset"
|
|
3025
|
-
},
|
|
3026
|
-
{
|
|
3027
|
-
"command": "<%= config.bin %> <%= command.id %> --dataset staging --tag next",
|
|
3028
|
-
"description": "Undeploy GraphQL API for staging dataset with \"next\" tag"
|
|
3029
|
-
},
|
|
3030
|
-
{
|
|
3031
|
-
"command": "<%= config.bin %> <%= command.id %> --force",
|
|
3032
|
-
"description": "Undeploy GraphQL API without confirmation prompt"
|
|
3072
|
+
"command": "<%= config.bin %> <%= command.id %> [NAME]",
|
|
3073
|
+
"description": "Show log entries for a specific webhook by name"
|
|
3033
3074
|
},
|
|
3034
3075
|
{
|
|
3035
|
-
"command": "<%= config.bin %> <%= command.id %> --project-id abc123
|
|
3036
|
-
"description": "
|
|
3076
|
+
"command": "<%= config.bin %> <%= command.id %> --project-id abc123",
|
|
3077
|
+
"description": "Show log entries for a specific project"
|
|
3037
3078
|
}
|
|
3038
3079
|
],
|
|
3039
3080
|
"flags": {
|
|
3040
3081
|
"project-id": {
|
|
3041
3082
|
"char": "p",
|
|
3042
|
-
"description": "Project ID to
|
|
3083
|
+
"description": "Project ID to view webhook logs for (overrides CLI configuration)",
|
|
3043
3084
|
"helpGroup": "OVERRIDE",
|
|
3044
3085
|
"name": "project-id",
|
|
3045
3086
|
"hasDynamicHelp": false,
|
|
@@ -3047,60 +3088,19 @@
|
|
|
3047
3088
|
"multiple": false,
|
|
3048
3089
|
"type": "option"
|
|
3049
3090
|
},
|
|
3050
|
-
"
|
|
3051
|
-
"description": "
|
|
3052
|
-
"
|
|
3053
|
-
"project-id",
|
|
3054
|
-
"project"
|
|
3055
|
-
],
|
|
3056
|
-
"name": "api",
|
|
3057
|
-
"required": false,
|
|
3058
|
-
"hasDynamicHelp": false,
|
|
3059
|
-
"multiple": false,
|
|
3060
|
-
"type": "option"
|
|
3061
|
-
},
|
|
3062
|
-
"dataset": {
|
|
3063
|
-
"char": "d",
|
|
3064
|
-
"description": "Dataset to undeploy GraphQL API from (overrides CLI configuration)",
|
|
3065
|
-
"helpGroup": "OVERRIDE",
|
|
3066
|
-
"name": "dataset",
|
|
3067
|
-
"hasDynamicHelp": false,
|
|
3068
|
-
"helpValue": "<name>",
|
|
3069
|
-
"multiple": false,
|
|
3070
|
-
"type": "option"
|
|
3071
|
-
},
|
|
3072
|
-
"force": {
|
|
3073
|
-
"description": "Skip confirmation prompt",
|
|
3074
|
-
"name": "force",
|
|
3091
|
+
"detailed": {
|
|
3092
|
+
"description": "Include detailed payload and attempts",
|
|
3093
|
+
"name": "detailed",
|
|
3075
3094
|
"required": false,
|
|
3076
3095
|
"allowNo": false,
|
|
3077
3096
|
"type": "boolean"
|
|
3078
|
-
},
|
|
3079
|
-
"project": {
|
|
3080
|
-
"deprecated": {
|
|
3081
|
-
"to": "project-id"
|
|
3082
|
-
},
|
|
3083
|
-
"description": "Project ID to delete GraphQL API for",
|
|
3084
|
-
"hidden": true,
|
|
3085
|
-
"name": "project",
|
|
3086
|
-
"required": false,
|
|
3087
|
-
"hasDynamicHelp": false,
|
|
3088
|
-
"multiple": false,
|
|
3089
|
-
"type": "option"
|
|
3090
|
-
},
|
|
3091
|
-
"tag": {
|
|
3092
|
-
"description": "Tag to undeploy GraphQL API from",
|
|
3093
|
-
"name": "tag",
|
|
3094
|
-
"required": false,
|
|
3095
|
-
"default": "default",
|
|
3096
|
-
"hasDynamicHelp": false,
|
|
3097
|
-
"multiple": false,
|
|
3098
|
-
"type": "option"
|
|
3099
3097
|
}
|
|
3100
3098
|
},
|
|
3101
3099
|
"hasDynamicHelp": false,
|
|
3102
|
-
"hiddenAliases": [
|
|
3103
|
-
|
|
3100
|
+
"hiddenAliases": [
|
|
3101
|
+
"hook:logs"
|
|
3102
|
+
],
|
|
3103
|
+
"id": "hooks:logs",
|
|
3104
3104
|
"pluginAlias": "@sanity/cli",
|
|
3105
3105
|
"pluginName": "@sanity/cli",
|
|
3106
3106
|
"pluginType": "core",
|
|
@@ -3109,14 +3109,14 @@
|
|
|
3109
3109
|
"relativePath": [
|
|
3110
3110
|
"dist",
|
|
3111
3111
|
"commands",
|
|
3112
|
-
"
|
|
3113
|
-
"
|
|
3112
|
+
"hooks",
|
|
3113
|
+
"logs.js"
|
|
3114
3114
|
]
|
|
3115
3115
|
},
|
|
3116
3116
|
"manifest:extract": {
|
|
3117
3117
|
"aliases": [],
|
|
3118
3118
|
"args": {},
|
|
3119
|
-
"description": "
|
|
3119
|
+
"description": "Extract studio configuration as JSON manifest files.\n\nNote: This command is experimental and subject to change. It is currently intended for use with Create only.",
|
|
3120
3120
|
"examples": [
|
|
3121
3121
|
{
|
|
3122
3122
|
"command": "<%= config.bin %> <%= command.id %>",
|
|
@@ -3213,7 +3213,7 @@
|
|
|
3213
3213
|
"required": true
|
|
3214
3214
|
}
|
|
3215
3215
|
},
|
|
3216
|
-
"description": "
|
|
3216
|
+
"description": "Delete an aspect definition",
|
|
3217
3217
|
"examples": [
|
|
3218
3218
|
{
|
|
3219
3219
|
"command": "<%= config.bin %> <%= command.id %> someAspect",
|
|
@@ -3335,7 +3335,7 @@
|
|
|
3335
3335
|
"name": "destination"
|
|
3336
3336
|
}
|
|
3337
3337
|
},
|
|
3338
|
-
"description": "Export
|
|
3338
|
+
"description": "Export file and image assets from a media library (excludes video)",
|
|
3339
3339
|
"examples": [
|
|
3340
3340
|
{
|
|
3341
3341
|
"command": "<%= config.bin %> <%= command.id %>",
|
|
@@ -3673,7 +3673,7 @@
|
|
|
3673
3673
|
"projects:list": {
|
|
3674
3674
|
"aliases": [],
|
|
3675
3675
|
"args": {},
|
|
3676
|
-
"description": "
|
|
3676
|
+
"description": "List your projects",
|
|
3677
3677
|
"examples": [
|
|
3678
3678
|
{
|
|
3679
3679
|
"command": "<%= config.bin %> <%= command.id %>",
|
|
@@ -3681,11 +3681,12 @@
|
|
|
3681
3681
|
},
|
|
3682
3682
|
{
|
|
3683
3683
|
"command": "<%= config.bin %> <%= command.id %> --sort=members --order=asc",
|
|
3684
|
-
"description": "List
|
|
3684
|
+
"description": "List projects sorted by member count, ascending"
|
|
3685
3685
|
}
|
|
3686
3686
|
],
|
|
3687
3687
|
"flags": {
|
|
3688
3688
|
"order": {
|
|
3689
|
+
"description": "Sort direction",
|
|
3689
3690
|
"name": "order",
|
|
3690
3691
|
"default": "desc",
|
|
3691
3692
|
"hasDynamicHelp": false,
|
|
@@ -3697,6 +3698,7 @@
|
|
|
3697
3698
|
"type": "option"
|
|
3698
3699
|
},
|
|
3699
3700
|
"sort": {
|
|
3701
|
+
"description": "Sort field",
|
|
3700
3702
|
"name": "sort",
|
|
3701
3703
|
"default": "created",
|
|
3702
3704
|
"hasDynamicHelp": false,
|
|
@@ -3813,7 +3815,7 @@
|
|
|
3813
3815
|
"schemas:deploy": {
|
|
3814
3816
|
"aliases": [],
|
|
3815
3817
|
"args": {},
|
|
3816
|
-
"description": "Deploy schema documents into workspace datasets.\n\
|
|
3818
|
+
"description": "Deploy schema documents into workspace datasets.\n\nNote: This command is experimental and subject to change.\n\nRegenerates a manifest file by default. To re-use an existing manifest, use --no-extract-manifest.",
|
|
3817
3819
|
"examples": [
|
|
3818
3820
|
{
|
|
3819
3821
|
"command": "<%= config.bin %> <%= command.id %>",
|
|
@@ -3826,7 +3828,7 @@
|
|
|
3826
3828
|
],
|
|
3827
3829
|
"flags": {
|
|
3828
3830
|
"extract-manifest": {
|
|
3829
|
-
"description": "
|
|
3831
|
+
"description": "Regenerate manifest before deploying (use --no-extract-manifest to skip)",
|
|
3830
3832
|
"name": "extract-manifest",
|
|
3831
3833
|
"allowNo": true,
|
|
3832
3834
|
"type": "boolean"
|
|
@@ -3883,7 +3885,7 @@
|
|
|
3883
3885
|
"schemas:extract": {
|
|
3884
3886
|
"aliases": [],
|
|
3885
3887
|
"args": {},
|
|
3886
|
-
"description": "
|
|
3888
|
+
"description": "Extract a JSON representation of a Sanity schema within a Studio context.\n\nNote: This command is experimental and subject to change.",
|
|
3887
3889
|
"examples": [
|
|
3888
3890
|
{
|
|
3889
3891
|
"command": "<%= config.bin %> <%= command.id %> --workspace default",
|
|
@@ -3906,7 +3908,7 @@
|
|
|
3906
3908
|
"type": "boolean"
|
|
3907
3909
|
},
|
|
3908
3910
|
"format": {
|
|
3909
|
-
"description": "
|
|
3911
|
+
"description": "Output format (currently only groq-type-nodes)",
|
|
3910
3912
|
"name": "format",
|
|
3911
3913
|
"default": "groq-type-nodes",
|
|
3912
3914
|
"hasDynamicHelp": false,
|
|
@@ -3964,7 +3966,7 @@
|
|
|
3964
3966
|
"schemas:list": {
|
|
3965
3967
|
"aliases": [],
|
|
3966
3968
|
"args": {},
|
|
3967
|
-
"description": "
|
|
3969
|
+
"description": "List all schemas in the current dataset.\n\nNote: This command is experimental and subject to change.\n\nRegenerates a manifest file by default. To reuse an existing manifest, use --no-extract-manifest.",
|
|
3968
3970
|
"examples": [
|
|
3969
3971
|
{
|
|
3970
3972
|
"command": "<%= config.bin %> <%= command.id %>",
|
|
@@ -3985,7 +3987,7 @@
|
|
|
3985
3987
|
],
|
|
3986
3988
|
"flags": {
|
|
3987
3989
|
"extract-manifest": {
|
|
3988
|
-
"description": "
|
|
3990
|
+
"description": "Regenerate manifest before listing (use --no-extract-manifest to skip)",
|
|
3989
3991
|
"hidden": true,
|
|
3990
3992
|
"name": "extract-manifest",
|
|
3991
3993
|
"allowNo": true,
|
|
@@ -4117,11 +4119,11 @@
|
|
|
4117
4119
|
"telemetry:disable": {
|
|
4118
4120
|
"aliases": [],
|
|
4119
4121
|
"args": {},
|
|
4120
|
-
"description": "Disable telemetry for your
|
|
4122
|
+
"description": "Disable telemetry for your account",
|
|
4121
4123
|
"examples": [
|
|
4122
4124
|
{
|
|
4123
4125
|
"command": "<%= config.bin %> telemetry <%= command.id %>",
|
|
4124
|
-
"description": "Disable telemetry for your
|
|
4126
|
+
"description": "Disable telemetry for your account"
|
|
4125
4127
|
}
|
|
4126
4128
|
],
|
|
4127
4129
|
"flags": {},
|
|
@@ -4143,11 +4145,11 @@
|
|
|
4143
4145
|
"telemetry:enable": {
|
|
4144
4146
|
"aliases": [],
|
|
4145
4147
|
"args": {},
|
|
4146
|
-
"description": "Enable telemetry for your
|
|
4148
|
+
"description": "Enable telemetry for your account",
|
|
4147
4149
|
"examples": [
|
|
4148
4150
|
{
|
|
4149
4151
|
"command": "<%= config.bin %> telemetry <%= command.id %>",
|
|
4150
|
-
"description": "Enable telemetry for your
|
|
4152
|
+
"description": "Enable telemetry for your account"
|
|
4151
4153
|
}
|
|
4152
4154
|
],
|
|
4153
4155
|
"flags": {},
|
|
@@ -4169,11 +4171,11 @@
|
|
|
4169
4171
|
"telemetry:status": {
|
|
4170
4172
|
"aliases": [],
|
|
4171
4173
|
"args": {},
|
|
4172
|
-
"description": "Check telemetry
|
|
4174
|
+
"description": "Check telemetry status for your account",
|
|
4173
4175
|
"examples": [
|
|
4174
4176
|
{
|
|
4175
4177
|
"command": "<%= config.bin %> telemetry <%= command.id %>",
|
|
4176
|
-
"description": "Check telemetry
|
|
4178
|
+
"description": "Check telemetry status for your account"
|
|
4177
4179
|
}
|
|
4178
4180
|
],
|
|
4179
4181
|
"flags": {},
|
|
@@ -4201,7 +4203,7 @@
|
|
|
4201
4203
|
"required": false
|
|
4202
4204
|
}
|
|
4203
4205
|
},
|
|
4204
|
-
"description": "Create a new API token for
|
|
4206
|
+
"description": "Create a new API token for the project",
|
|
4205
4207
|
"examples": [
|
|
4206
4208
|
{
|
|
4207
4209
|
"command": "<%= config.bin %> <%= command.id %> \"My API Token\"",
|
|
@@ -4283,7 +4285,7 @@
|
|
|
4283
4285
|
"required": false
|
|
4284
4286
|
}
|
|
4285
4287
|
},
|
|
4286
|
-
"description": "Delete an API token from
|
|
4288
|
+
"description": "Delete an API token from the project",
|
|
4287
4289
|
"examples": [
|
|
4288
4290
|
{
|
|
4289
4291
|
"command": "<%= config.bin %> <%= command.id %>",
|
|
@@ -4344,11 +4346,11 @@
|
|
|
4344
4346
|
"tokens:list": {
|
|
4345
4347
|
"aliases": [],
|
|
4346
4348
|
"args": {},
|
|
4347
|
-
"description": "List API tokens for the
|
|
4349
|
+
"description": "List API tokens for the project",
|
|
4348
4350
|
"examples": [
|
|
4349
4351
|
{
|
|
4350
4352
|
"command": "<%= config.bin %> <%= command.id %>",
|
|
4351
|
-
"description": "List tokens for the
|
|
4353
|
+
"description": "List tokens for the project"
|
|
4352
4354
|
},
|
|
4353
4355
|
{
|
|
4354
4356
|
"command": "<%= config.bin %> <%= command.id %> --json",
|
|
@@ -4462,7 +4464,7 @@
|
|
|
4462
4464
|
"users:list": {
|
|
4463
4465
|
"aliases": [],
|
|
4464
4466
|
"args": {},
|
|
4465
|
-
"description": "List
|
|
4467
|
+
"description": "List project members",
|
|
4466
4468
|
"examples": [
|
|
4467
4469
|
{
|
|
4468
4470
|
"command": "<%= config.bin %> <%= command.id %>",
|
|
@@ -4562,7 +4564,7 @@
|
|
|
4562
4564
|
"required": false
|
|
4563
4565
|
}
|
|
4564
4566
|
},
|
|
4565
|
-
"description": "Create a dataset alias
|
|
4567
|
+
"description": "Create a dataset alias for the project",
|
|
4566
4568
|
"examples": [
|
|
4567
4569
|
{
|
|
4568
4570
|
"command": "<%= config.bin %> <%= command.id %> --project-id abc123 conference conf-2025",
|
|
@@ -4620,7 +4622,7 @@
|
|
|
4620
4622
|
"required": true
|
|
4621
4623
|
}
|
|
4622
4624
|
},
|
|
4623
|
-
"description": "Delete a dataset alias
|
|
4625
|
+
"description": "Delete a dataset alias from the project",
|
|
4624
4626
|
"examples": [
|
|
4625
4627
|
{
|
|
4626
4628
|
"command": "<%= config.bin %> <%= command.id %> conference",
|
|
@@ -4682,7 +4684,7 @@
|
|
|
4682
4684
|
"required": false
|
|
4683
4685
|
}
|
|
4684
4686
|
},
|
|
4685
|
-
"description": "Link a dataset alias to a dataset
|
|
4687
|
+
"description": "Link a dataset alias to a dataset in the project",
|
|
4686
4688
|
"examples": [
|
|
4687
4689
|
{
|
|
4688
4690
|
"command": "<%= config.bin %> <%= command.id %>",
|
|
@@ -4747,7 +4749,7 @@
|
|
|
4747
4749
|
"required": false
|
|
4748
4750
|
}
|
|
4749
4751
|
},
|
|
4750
|
-
"description": "Unlink a dataset alias from its dataset
|
|
4752
|
+
"description": "Unlink a dataset alias from its dataset in the project",
|
|
4751
4753
|
"examples": [
|
|
4752
4754
|
{
|
|
4753
4755
|
"command": "<%= config.bin %> <%= command.id %>",
|
|
@@ -5065,5 +5067,5 @@
|
|
|
5065
5067
|
]
|
|
5066
5068
|
}
|
|
5067
5069
|
},
|
|
5068
|
-
"version": "6.3.
|
|
5070
|
+
"version": "6.3.2"
|
|
5069
5071
|
}
|