@sanity/cli 6.2.0 → 6.3.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 +299 -303
- package/dist/SanityHelp.js +38 -0
- package/dist/SanityHelp.js.map +1 -1
- package/dist/actions/auth/login/getProvider.js +9 -4
- package/dist/actions/auth/login/getProvider.js.map +1 -1
- package/dist/actions/auth/login/getSSOProvider.js +21 -2
- package/dist/actions/auth/login/getSSOProvider.js.map +1 -1
- package/dist/actions/auth/login/login.js +5 -4
- package/dist/actions/auth/login/login.js.map +1 -1
- package/dist/actions/build/buildApp.js +1 -0
- package/dist/actions/build/buildApp.js.map +1 -1
- package/dist/actions/build/buildStaticFiles.js +2 -1
- package/dist/actions/build/buildStaticFiles.js.map +1 -1
- package/dist/actions/build/renderDocument.js.map +1 -1
- package/dist/actions/build/renderDocumentWorker/components/BasicDocument.js +2 -2
- package/dist/actions/build/renderDocumentWorker/components/BasicDocument.js.map +1 -1
- package/dist/actions/build/renderDocumentWorker/types.js.map +1 -1
- package/dist/actions/build/writeSanityRuntime.js +3 -2
- package/dist/actions/build/writeSanityRuntime.js.map +1 -1
- package/dist/actions/deploy/deployStudio.js +53 -3
- package/dist/actions/deploy/deployStudio.js.map +1 -1
- package/dist/actions/deploy/findUserApplicationForStudio.js +10 -4
- package/dist/actions/deploy/findUserApplicationForStudio.js.map +1 -1
- package/dist/actions/dev/startAppDevServer.js +2 -0
- package/dist/actions/dev/startAppDevServer.js.map +1 -1
- package/dist/actions/init/git.js +5 -2
- package/dist/actions/init/git.js.map +1 -1
- package/dist/actions/init/remoteTemplate.js +3 -1
- package/dist/actions/init/remoteTemplate.js.map +1 -1
- package/dist/actions/init/templates/nextjs/index.js +1 -1
- package/dist/actions/init/templates/nextjs/index.js.map +1 -1
- package/dist/actions/manifest/extractAppManifest.js +3 -1
- package/dist/actions/manifest/extractAppManifest.js.map +1 -1
- package/dist/actions/manifest/schemaTypeTransformer.js +2 -1
- package/dist/actions/manifest/schemaTypeTransformer.js.map +1 -1
- package/dist/actions/telemetry/setConsent.js +6 -2
- package/dist/actions/telemetry/setConsent.js.map +1 -1
- package/dist/commands/datasets/alias/create.js +0 -4
- package/dist/commands/datasets/alias/create.js.map +1 -1
- package/dist/commands/datasets/alias/delete.js +1 -5
- package/dist/commands/datasets/alias/delete.js.map +1 -1
- package/dist/commands/datasets/alias/link.js +0 -4
- package/dist/commands/datasets/alias/link.js.map +1 -1
- package/dist/commands/datasets/alias/unlink.js +0 -4
- 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/import.js +45 -15
- package/dist/commands/datasets/import.js.map +1 -1
- package/dist/commands/deploy.js +3 -0
- package/dist/commands/deploy.js.map +1 -1
- package/dist/commands/init.js +10 -9
- package/dist/commands/init.js.map +1 -1
- package/dist/commands/login.js +14 -2
- package/dist/commands/login.js.map +1 -1
- package/dist/commands/logout.js +6 -8
- package/dist/commands/logout.js.map +1 -1
- package/dist/hooks/prerun/setupTelemetry.js +1 -1
- package/dist/hooks/prerun/setupTelemetry.js.map +1 -1
- package/dist/server/devServer.js +2 -1
- package/dist/server/devServer.js.map +1 -1
- package/dist/services/telemetry.js +23 -2
- package/dist/services/telemetry.js.map +1 -1
- package/dist/util/compareDependencyVersions.js +3 -1
- package/dist/util/compareDependencyVersions.js.map +1 -1
- package/dist/util/createExpiringConfig.js +0 -3
- package/dist/util/createExpiringConfig.js.map +1 -1
- package/dist/util/getCliVersion.js +3 -1
- package/dist/util/getCliVersion.js.map +1 -1
- package/dist/util/packageManager/packageManagerChoice.js +1 -2
- package/dist/util/packageManager/packageManagerChoice.js.map +1 -1
- package/dist/util/telemetry/logger.js +13 -0
- package/dist/util/telemetry/logger.js.map +1 -1
- package/oclif.manifest.json +282 -272
- package/package.json +27 -27
- package/dist/actions/graphql/__tests__/fixtures/many-self-refs.js +0 -540
- package/dist/actions/graphql/__tests__/fixtures/many-self-refs.js.map +0 -1
- package/dist/actions/graphql/__tests__/fixtures/test-studio.js +0 -1143
- package/dist/actions/graphql/__tests__/fixtures/test-studio.js.map +0 -1
- package/dist/actions/graphql/__tests__/fixtures/union-refs.js +0 -591
- package/dist/actions/graphql/__tests__/fixtures/union-refs.js.map +0 -1
- package/dist/actions/graphql/__tests__/helpers.js +0 -23
- package/dist/actions/graphql/__tests__/helpers.js.map +0 -1
- package/dist/actions/manifest/__tests__/resolveSchemaIcon.test.js +0 -157
- package/dist/actions/manifest/__tests__/resolveSchemaIcon.test.js.map +0 -1
- package/dist/actions/media/__tests__/createMockClient.js +0 -32
- package/dist/actions/media/__tests__/createMockClient.js.map +0 -1
package/README.md
CHANGED
|
@@ -12,10 +12,10 @@ Code for sanity cli
|
|
|
12
12
|
|
|
13
13
|
<!-- commands -->
|
|
14
14
|
|
|
15
|
-
- [`sanity
|
|
16
|
-
- [`sanity
|
|
17
|
-
- [`sanity
|
|
18
|
-
- [`sanity
|
|
15
|
+
- [`sanity backups disable [DATASET]`](#sanity-backups-disable-dataset)
|
|
16
|
+
- [`sanity backups download [DATASET]`](#sanity-backups-download-dataset)
|
|
17
|
+
- [`sanity backups enable [DATASET]`](#sanity-backups-enable-dataset)
|
|
18
|
+
- [`sanity backups list [DATASET]`](#sanity-backups-list-dataset)
|
|
19
19
|
- [`sanity blueprints add TYPE`](#sanity-blueprints-add-type)
|
|
20
20
|
- [`sanity blueprints config`](#sanity-blueprints-config)
|
|
21
21
|
- [`sanity blueprints deploy`](#sanity-blueprints-deploy)
|
|
@@ -31,21 +31,21 @@ Code for sanity cli
|
|
|
31
31
|
- [`sanity cors add ORIGIN`](#sanity-cors-add-origin)
|
|
32
32
|
- [`sanity cors delete [ORIGIN]`](#sanity-cors-delete-origin)
|
|
33
33
|
- [`sanity cors list`](#sanity-cors-list)
|
|
34
|
-
- [`sanity
|
|
35
|
-
- [`sanity
|
|
36
|
-
- [`sanity
|
|
37
|
-
- [`sanity
|
|
38
|
-
- [`sanity
|
|
39
|
-
- [`sanity
|
|
40
|
-
- [`sanity
|
|
41
|
-
- [`sanity
|
|
42
|
-
- [`sanity
|
|
43
|
-
- [`sanity
|
|
44
|
-
- [`sanity
|
|
45
|
-
- [`sanity
|
|
46
|
-
- [`sanity
|
|
47
|
-
- [`sanity
|
|
48
|
-
- [`sanity
|
|
34
|
+
- [`sanity datasets alias create [ALIASNAME] [TARGETDATASET]`](#sanity-datasets-alias-create-aliasname-targetdataset)
|
|
35
|
+
- [`sanity datasets alias delete ALIASNAME`](#sanity-datasets-alias-delete-aliasname)
|
|
36
|
+
- [`sanity datasets alias link [ALIASNAME] [TARGETDATASET]`](#sanity-datasets-alias-link-aliasname-targetdataset)
|
|
37
|
+
- [`sanity datasets alias unlink [ALIASNAME]`](#sanity-datasets-alias-unlink-aliasname)
|
|
38
|
+
- [`sanity datasets copy [SOURCE] [TARGET]`](#sanity-datasets-copy-source-target)
|
|
39
|
+
- [`sanity datasets create [NAME]`](#sanity-datasets-create-name)
|
|
40
|
+
- [`sanity datasets delete DATASETNAME`](#sanity-datasets-delete-datasetname)
|
|
41
|
+
- [`sanity datasets embeddings disable [DATASET]`](#sanity-datasets-embeddings-disable-dataset)
|
|
42
|
+
- [`sanity datasets embeddings enable [DATASET]`](#sanity-datasets-embeddings-enable-dataset)
|
|
43
|
+
- [`sanity datasets embeddings status [DATASET]`](#sanity-datasets-embeddings-status-dataset)
|
|
44
|
+
- [`sanity datasets export [NAME] [DESTINATION]`](#sanity-datasets-export-name-destination)
|
|
45
|
+
- [`sanity datasets import SOURCE [TARGETDATASET]`](#sanity-datasets-import-source-targetdataset)
|
|
46
|
+
- [`sanity datasets list`](#sanity-datasets-list)
|
|
47
|
+
- [`sanity datasets visibility get DATASET`](#sanity-datasets-visibility-get-dataset)
|
|
48
|
+
- [`sanity datasets visibility set DATASET MODE`](#sanity-datasets-visibility-set-dataset-mode)
|
|
49
49
|
- [`sanity debug`](#sanity-debug)
|
|
50
50
|
- [`sanity deploy [SOURCEDIR]`](#sanity-deploy-sourcedir)
|
|
51
51
|
- [`sanity dev`](#sanity-dev)
|
|
@@ -70,11 +70,11 @@ Code for sanity cli
|
|
|
70
70
|
- [`sanity graphql list`](#sanity-graphql-list)
|
|
71
71
|
- [`sanity graphql undeploy`](#sanity-graphql-undeploy)
|
|
72
72
|
- [`sanity help [COMMAND]`](#sanity-help-command)
|
|
73
|
-
- [`sanity
|
|
74
|
-
- [`sanity
|
|
75
|
-
- [`sanity
|
|
76
|
-
- [`sanity
|
|
77
|
-
- [`sanity
|
|
73
|
+
- [`sanity hooks attempt ATTEMPTID`](#sanity-hooks-attempt-attemptid)
|
|
74
|
+
- [`sanity hooks create`](#sanity-hooks-create)
|
|
75
|
+
- [`sanity hooks delete [NAME]`](#sanity-hooks-delete-name)
|
|
76
|
+
- [`sanity hooks list`](#sanity-hooks-list)
|
|
77
|
+
- [`sanity hooks logs [NAME]`](#sanity-hooks-logs-name)
|
|
78
78
|
- [`sanity init`](#sanity-init)
|
|
79
79
|
- [`sanity install [PACKAGES]`](#sanity-install-packages)
|
|
80
80
|
- [`sanity learn`](#sanity-learn)
|
|
@@ -88,19 +88,19 @@ Code for sanity cli
|
|
|
88
88
|
- [`sanity media deploy-aspect [ASPECTNAME]`](#sanity-media-deploy-aspect-aspectname)
|
|
89
89
|
- [`sanity media export [DESTINATION]`](#sanity-media-export-destination)
|
|
90
90
|
- [`sanity media import SOURCE`](#sanity-media-import-source)
|
|
91
|
-
- [`sanity
|
|
92
|
-
- [`sanity
|
|
93
|
-
- [`sanity
|
|
91
|
+
- [`sanity migrations create [TITLE]`](#sanity-migrations-create-title)
|
|
92
|
+
- [`sanity migrations list`](#sanity-migrations-list)
|
|
93
|
+
- [`sanity migrations run [ID]`](#sanity-migrations-run-id)
|
|
94
94
|
- [`sanity openapi get SLUG`](#sanity-openapi-get-slug)
|
|
95
95
|
- [`sanity openapi list`](#sanity-openapi-list)
|
|
96
96
|
- [`sanity preview [OUTPUTDIR]`](#sanity-preview-outputdir)
|
|
97
97
|
- [`sanity projects create [PROJECTNAME]`](#sanity-projects-create-projectname)
|
|
98
98
|
- [`sanity projects list`](#sanity-projects-list)
|
|
99
|
-
- [`sanity
|
|
100
|
-
- [`sanity
|
|
101
|
-
- [`sanity
|
|
102
|
-
- [`sanity
|
|
103
|
-
- [`sanity
|
|
99
|
+
- [`sanity schemas delete`](#sanity-schemas-delete)
|
|
100
|
+
- [`sanity schemas deploy`](#sanity-schemas-deploy)
|
|
101
|
+
- [`sanity schemas extract`](#sanity-schemas-extract)
|
|
102
|
+
- [`sanity schemas list`](#sanity-schemas-list)
|
|
103
|
+
- [`sanity schemas validate`](#sanity-schemas-validate)
|
|
104
104
|
- [`sanity telemetry disable`](#sanity-telemetry-disable)
|
|
105
105
|
- [`sanity telemetry enable`](#sanity-telemetry-enable)
|
|
106
106
|
- [`sanity telemetry status`](#sanity-telemetry-status)
|
|
@@ -113,13 +113,13 @@ Code for sanity cli
|
|
|
113
113
|
- [`sanity users list`](#sanity-users-list)
|
|
114
114
|
- [`sanity versions`](#sanity-versions)
|
|
115
115
|
|
|
116
|
-
## `sanity
|
|
116
|
+
## `sanity backups disable [DATASET]`
|
|
117
117
|
|
|
118
118
|
Disable backup for a dataset.
|
|
119
119
|
|
|
120
120
|
```
|
|
121
121
|
USAGE
|
|
122
|
-
$ sanity
|
|
122
|
+
$ sanity backups disable [DATASET] [-p <id>]
|
|
123
123
|
|
|
124
124
|
ARGUMENTS
|
|
125
125
|
[DATASET] Dataset name to disable backup for
|
|
@@ -133,22 +133,22 @@ DESCRIPTION
|
|
|
133
133
|
EXAMPLES
|
|
134
134
|
Interactively disable backup for a dataset
|
|
135
135
|
|
|
136
|
-
$ sanity
|
|
136
|
+
$ sanity backups disable
|
|
137
137
|
|
|
138
138
|
Disable backup for the production dataset
|
|
139
139
|
|
|
140
|
-
$ sanity
|
|
140
|
+
$ sanity backups disable production
|
|
141
141
|
```
|
|
142
142
|
|
|
143
|
-
_See code: [src/commands/
|
|
143
|
+
_See code: [src/commands/backups/disable.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/backups/disable.ts)_
|
|
144
144
|
|
|
145
|
-
## `sanity
|
|
145
|
+
## `sanity backups download [DATASET]`
|
|
146
146
|
|
|
147
147
|
Download a dataset backup to a local file.
|
|
148
148
|
|
|
149
149
|
```
|
|
150
150
|
USAGE
|
|
151
|
-
$ sanity
|
|
151
|
+
$ sanity backups download [DATASET] [-p <id>] [--backup-id <value>] [--concurrency <value>] [--out <value>]
|
|
152
152
|
[--overwrite]
|
|
153
153
|
|
|
154
154
|
ARGUMENTS
|
|
@@ -169,30 +169,30 @@ DESCRIPTION
|
|
|
169
169
|
EXAMPLES
|
|
170
170
|
Interactively download a backup
|
|
171
171
|
|
|
172
|
-
$ sanity
|
|
172
|
+
$ sanity backups download
|
|
173
173
|
|
|
174
174
|
Download a specific backup for the production dataset
|
|
175
175
|
|
|
176
|
-
$ sanity
|
|
176
|
+
$ sanity backups download production --backup-id 2024-01-01-backup-1
|
|
177
177
|
|
|
178
178
|
Download backup to a specific file
|
|
179
179
|
|
|
180
|
-
$ sanity
|
|
180
|
+
$ sanity backups download production --backup-id 2024-01-01-backup-2 --out /path/to/file
|
|
181
181
|
|
|
182
182
|
Download backup and overwrite existing file
|
|
183
183
|
|
|
184
|
-
$ sanity
|
|
184
|
+
$ sanity backups download production --backup-id 2024-01-01-backup-3 --out /path/to/file --overwrite
|
|
185
185
|
```
|
|
186
186
|
|
|
187
|
-
_See code: [src/commands/
|
|
187
|
+
_See code: [src/commands/backups/download.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/backups/download.ts)_
|
|
188
188
|
|
|
189
|
-
## `sanity
|
|
189
|
+
## `sanity backups enable [DATASET]`
|
|
190
190
|
|
|
191
191
|
Enable backup for a dataset.
|
|
192
192
|
|
|
193
193
|
```
|
|
194
194
|
USAGE
|
|
195
|
-
$ sanity
|
|
195
|
+
$ sanity backups enable [DATASET] [-p <id>]
|
|
196
196
|
|
|
197
197
|
ARGUMENTS
|
|
198
198
|
[DATASET] Dataset name to enable backup for
|
|
@@ -206,22 +206,22 @@ DESCRIPTION
|
|
|
206
206
|
EXAMPLES
|
|
207
207
|
Interactively enable backup for a dataset
|
|
208
208
|
|
|
209
|
-
$ sanity
|
|
209
|
+
$ sanity backups enable
|
|
210
210
|
|
|
211
211
|
Enable backup for the production dataset
|
|
212
212
|
|
|
213
|
-
$ sanity
|
|
213
|
+
$ sanity backups enable production
|
|
214
214
|
```
|
|
215
215
|
|
|
216
|
-
_See code: [src/commands/
|
|
216
|
+
_See code: [src/commands/backups/enable.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/backups/enable.ts)_
|
|
217
217
|
|
|
218
|
-
## `sanity
|
|
218
|
+
## `sanity backups list [DATASET]`
|
|
219
219
|
|
|
220
220
|
List available backups for a dataset.
|
|
221
221
|
|
|
222
222
|
```
|
|
223
223
|
USAGE
|
|
224
|
-
$ sanity
|
|
224
|
+
$ sanity backups list [DATASET] [-p <id>] [--after <value>] [--before <value>] [-l <value>]
|
|
225
225
|
|
|
226
226
|
ARGUMENTS
|
|
227
227
|
[DATASET] Dataset name to list backups for
|
|
@@ -240,22 +240,22 @@ DESCRIPTION
|
|
|
240
240
|
EXAMPLES
|
|
241
241
|
List backups for a dataset interactively
|
|
242
242
|
|
|
243
|
-
$ sanity
|
|
243
|
+
$ sanity backups list
|
|
244
244
|
|
|
245
245
|
List backups for the production dataset
|
|
246
246
|
|
|
247
|
-
$ sanity
|
|
247
|
+
$ sanity backups list production
|
|
248
248
|
|
|
249
249
|
List up to 50 backups for the production dataset
|
|
250
250
|
|
|
251
|
-
$ sanity
|
|
251
|
+
$ sanity backups list production --limit 50
|
|
252
252
|
|
|
253
253
|
List up to 10 backups created after 2024-01-31
|
|
254
254
|
|
|
255
|
-
$ sanity
|
|
255
|
+
$ sanity backups list production --after 2024-01-31 --limit 10
|
|
256
256
|
```
|
|
257
257
|
|
|
258
|
-
_See code: [src/commands/
|
|
258
|
+
_See code: [src/commands/backups/list.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/backups/list.ts)_
|
|
259
259
|
|
|
260
260
|
## `sanity blueprints add TYPE`
|
|
261
261
|
|
|
@@ -307,7 +307,7 @@ EXAMPLES
|
|
|
307
307
|
$ sanity blueprints add function --name my-function --fn-type document-create --fn-type document-update --lang js
|
|
308
308
|
```
|
|
309
309
|
|
|
310
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.
|
|
310
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.7.2/src/commands/blueprints/add.ts)_
|
|
311
311
|
|
|
312
312
|
## `sanity blueprints config`
|
|
313
313
|
|
|
@@ -342,7 +342,7 @@ EXAMPLES
|
|
|
342
342
|
$ sanity blueprints config --edit --project-id <projectId> --stack <name-or-id>
|
|
343
343
|
```
|
|
344
344
|
|
|
345
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.
|
|
345
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.7.2/src/commands/blueprints/config.ts)_
|
|
346
346
|
|
|
347
347
|
## `sanity blueprints deploy`
|
|
348
348
|
|
|
@@ -379,7 +379,7 @@ EXAMPLES
|
|
|
379
379
|
$ sanity blueprints deploy --fn-installer npm
|
|
380
380
|
```
|
|
381
381
|
|
|
382
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.
|
|
382
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.7.2/src/commands/blueprints/deploy.ts)_
|
|
383
383
|
|
|
384
384
|
## `sanity blueprints destroy`
|
|
385
385
|
|
|
@@ -411,7 +411,7 @@ EXAMPLES
|
|
|
411
411
|
$ sanity blueprints destroy --stack <name-or-id> --project-id <projectId> --force --no-wait
|
|
412
412
|
```
|
|
413
413
|
|
|
414
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.
|
|
414
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.7.2/src/commands/blueprints/destroy.ts)_
|
|
415
415
|
|
|
416
416
|
## `sanity blueprints doctor`
|
|
417
417
|
|
|
@@ -437,7 +437,7 @@ DESCRIPTION
|
|
|
437
437
|
issues.
|
|
438
438
|
```
|
|
439
439
|
|
|
440
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.
|
|
440
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.7.2/src/commands/blueprints/doctor.ts)_
|
|
441
441
|
|
|
442
442
|
## `sanity blueprints info`
|
|
443
443
|
|
|
@@ -467,7 +467,7 @@ EXAMPLES
|
|
|
467
467
|
$ sanity blueprints info --stack <name-or-id>
|
|
468
468
|
```
|
|
469
469
|
|
|
470
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.
|
|
470
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.7.2/src/commands/blueprints/info.ts)_
|
|
471
471
|
|
|
472
472
|
## `sanity blueprints init [DIR]`
|
|
473
473
|
|
|
@@ -517,7 +517,7 @@ EXAMPLES
|
|
|
517
517
|
$ sanity blueprints init --blueprint-type <json|js|ts> --stack-name <stackName>
|
|
518
518
|
```
|
|
519
519
|
|
|
520
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.
|
|
520
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.7.2/src/commands/blueprints/init.ts)_
|
|
521
521
|
|
|
522
522
|
## `sanity blueprints logs`
|
|
523
523
|
|
|
@@ -546,7 +546,7 @@ EXAMPLES
|
|
|
546
546
|
$ sanity blueprints logs --watch
|
|
547
547
|
```
|
|
548
548
|
|
|
549
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.
|
|
549
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.7.2/src/commands/blueprints/logs.ts)_
|
|
550
550
|
|
|
551
551
|
## `sanity blueprints plan`
|
|
552
552
|
|
|
@@ -572,7 +572,7 @@ EXAMPLES
|
|
|
572
572
|
$ sanity blueprints plan
|
|
573
573
|
```
|
|
574
574
|
|
|
575
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.
|
|
575
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.7.2/src/commands/blueprints/plan.ts)_
|
|
576
576
|
|
|
577
577
|
## `sanity blueprints stacks`
|
|
578
578
|
|
|
@@ -601,7 +601,7 @@ EXAMPLES
|
|
|
601
601
|
$ sanity blueprints stacks --organization-id <organizationId>
|
|
602
602
|
```
|
|
603
603
|
|
|
604
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.
|
|
604
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.7.2/src/commands/blueprints/stacks.ts)_
|
|
605
605
|
|
|
606
606
|
## `sanity build [OUTPUTDIR]`
|
|
607
607
|
|
|
@@ -630,7 +630,7 @@ EXAMPLES
|
|
|
630
630
|
$ sanity build --no-minify --source-maps
|
|
631
631
|
```
|
|
632
632
|
|
|
633
|
-
_See code: [src/commands/build.ts](https://github.com/sanity-io/cli/blob/v6.1
|
|
633
|
+
_See code: [src/commands/build.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/build.ts)_
|
|
634
634
|
|
|
635
635
|
## `sanity codemod [CODEMODNAME]`
|
|
636
636
|
|
|
@@ -661,7 +661,7 @@ EXAMPLES
|
|
|
661
661
|
$ sanity codemod reactIconsV3 --dry
|
|
662
662
|
```
|
|
663
663
|
|
|
664
|
-
_See code: [src/commands/codemod.ts](https://github.com/sanity-io/cli/blob/v6.1
|
|
664
|
+
_See code: [src/commands/codemod.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/codemod.ts)_
|
|
665
665
|
|
|
666
666
|
## `sanity cors add ORIGIN`
|
|
667
667
|
|
|
@@ -701,7 +701,7 @@ EXAMPLES
|
|
|
701
701
|
$ sanity cors add https://myapp.com --project-id abc123
|
|
702
702
|
```
|
|
703
703
|
|
|
704
|
-
_See code: [src/commands/cors/add.ts](https://github.com/sanity-io/cli/blob/v6.1
|
|
704
|
+
_See code: [src/commands/cors/add.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/cors/add.ts)_
|
|
705
705
|
|
|
706
706
|
## `sanity cors delete [ORIGIN]`
|
|
707
707
|
|
|
@@ -734,7 +734,7 @@ EXAMPLES
|
|
|
734
734
|
$ sanity cors delete --project-id abc123
|
|
735
735
|
```
|
|
736
736
|
|
|
737
|
-
_See code: [src/commands/cors/delete.ts](https://github.com/sanity-io/cli/blob/v6.1
|
|
737
|
+
_See code: [src/commands/cors/delete.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/cors/delete.ts)_
|
|
738
738
|
|
|
739
739
|
## `sanity cors list`
|
|
740
740
|
|
|
@@ -760,15 +760,15 @@ EXAMPLES
|
|
|
760
760
|
$ sanity cors list --project-id abc123
|
|
761
761
|
```
|
|
762
762
|
|
|
763
|
-
_See code: [src/commands/cors/list.ts](https://github.com/sanity-io/cli/blob/v6.1
|
|
763
|
+
_See code: [src/commands/cors/list.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/cors/list.ts)_
|
|
764
764
|
|
|
765
|
-
## `sanity
|
|
765
|
+
## `sanity datasets alias create [ALIASNAME] [TARGETDATASET]`
|
|
766
766
|
|
|
767
767
|
Create a dataset alias within your project
|
|
768
768
|
|
|
769
769
|
```
|
|
770
770
|
USAGE
|
|
771
|
-
$ sanity
|
|
771
|
+
$ sanity datasets alias create [ALIASNAME] [TARGETDATASET] [-p <id>]
|
|
772
772
|
|
|
773
773
|
ARGUMENTS
|
|
774
774
|
[ALIASNAME] Dataset alias name to create
|
|
@@ -783,34 +783,30 @@ DESCRIPTION
|
|
|
783
783
|
EXAMPLES
|
|
784
784
|
Create alias in a specific project
|
|
785
785
|
|
|
786
|
-
$ sanity
|
|
786
|
+
$ sanity datasets alias create --project-id abc123 conference conf-2025
|
|
787
787
|
|
|
788
788
|
Create an alias with interactive prompts
|
|
789
789
|
|
|
790
|
-
$ sanity
|
|
790
|
+
$ sanity datasets alias create
|
|
791
791
|
|
|
792
792
|
Create alias named "conference" with interactive dataset selection
|
|
793
793
|
|
|
794
|
-
$ sanity
|
|
794
|
+
$ sanity datasets alias create conference
|
|
795
795
|
|
|
796
796
|
Create alias "conference" linked to "conf-2025" dataset
|
|
797
797
|
|
|
798
|
-
$ sanity
|
|
799
|
-
|
|
800
|
-
Create alias with explicit ~ prefix
|
|
801
|
-
|
|
802
|
-
$ sanity dataset alias create ~conference conf-2025
|
|
798
|
+
$ sanity datasets alias create conference conf-2025
|
|
803
799
|
```
|
|
804
800
|
|
|
805
|
-
_See code: [src/commands/
|
|
801
|
+
_See code: [src/commands/datasets/alias/create.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/datasets/alias/create.ts)_
|
|
806
802
|
|
|
807
|
-
## `sanity
|
|
803
|
+
## `sanity datasets alias delete ALIASNAME`
|
|
808
804
|
|
|
809
805
|
Delete a dataset alias within your project
|
|
810
806
|
|
|
811
807
|
```
|
|
812
808
|
USAGE
|
|
813
|
-
$ sanity
|
|
809
|
+
$ sanity datasets alias delete ALIASNAME [-p <id>] [--force]
|
|
814
810
|
|
|
815
811
|
ARGUMENTS
|
|
816
812
|
ALIASNAME Dataset alias name to delete
|
|
@@ -827,26 +823,22 @@ DESCRIPTION
|
|
|
827
823
|
EXAMPLES
|
|
828
824
|
Delete alias named "conference" with confirmation prompt
|
|
829
825
|
|
|
830
|
-
$ sanity
|
|
831
|
-
|
|
832
|
-
Delete alias with explicit ~ prefix
|
|
833
|
-
|
|
834
|
-
$ sanity dataset alias delete ~conference
|
|
826
|
+
$ sanity datasets alias delete conference
|
|
835
827
|
|
|
836
828
|
Delete alias named "conference" without confirmation prompt
|
|
837
829
|
|
|
838
|
-
$ sanity
|
|
830
|
+
$ sanity datasets alias delete conference --force
|
|
839
831
|
```
|
|
840
832
|
|
|
841
|
-
_See code: [src/commands/
|
|
833
|
+
_See code: [src/commands/datasets/alias/delete.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/datasets/alias/delete.ts)_
|
|
842
834
|
|
|
843
|
-
## `sanity
|
|
835
|
+
## `sanity datasets alias link [ALIASNAME] [TARGETDATASET]`
|
|
844
836
|
|
|
845
837
|
Link a dataset alias to a dataset within your project
|
|
846
838
|
|
|
847
839
|
```
|
|
848
840
|
USAGE
|
|
849
|
-
$ sanity
|
|
841
|
+
$ sanity datasets alias link [ALIASNAME] [TARGETDATASET] [-p <id>] [--force]
|
|
850
842
|
|
|
851
843
|
ARGUMENTS
|
|
852
844
|
[ALIASNAME] Dataset alias name to link
|
|
@@ -864,34 +856,30 @@ DESCRIPTION
|
|
|
864
856
|
EXAMPLES
|
|
865
857
|
Link an alias with interactive prompts
|
|
866
858
|
|
|
867
|
-
$ sanity
|
|
859
|
+
$ sanity datasets alias link
|
|
868
860
|
|
|
869
861
|
Link alias named "conference" with interactive dataset selection
|
|
870
862
|
|
|
871
|
-
$ sanity
|
|
863
|
+
$ sanity datasets alias link conference
|
|
872
864
|
|
|
873
865
|
Link alias "conference" to "conf-2025" dataset
|
|
874
866
|
|
|
875
|
-
$ sanity
|
|
876
|
-
|
|
877
|
-
Link alias with explicit ~ prefix
|
|
878
|
-
|
|
879
|
-
$ sanity dataset alias link ~conference conf-2025
|
|
867
|
+
$ sanity datasets alias link conference conf-2025
|
|
880
868
|
|
|
881
869
|
Force link without confirmation (skip relink prompt)
|
|
882
870
|
|
|
883
|
-
$ sanity
|
|
871
|
+
$ sanity datasets alias link conference conf-2025 --force
|
|
884
872
|
```
|
|
885
873
|
|
|
886
|
-
_See code: [src/commands/
|
|
874
|
+
_See code: [src/commands/datasets/alias/link.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/datasets/alias/link.ts)_
|
|
887
875
|
|
|
888
|
-
## `sanity
|
|
876
|
+
## `sanity datasets alias unlink [ALIASNAME]`
|
|
889
877
|
|
|
890
878
|
Unlink a dataset alias from its dataset within your project
|
|
891
879
|
|
|
892
880
|
```
|
|
893
881
|
USAGE
|
|
894
|
-
$ sanity
|
|
882
|
+
$ sanity datasets alias unlink [ALIASNAME] [-p <id>] [--force]
|
|
895
883
|
|
|
896
884
|
ARGUMENTS
|
|
897
885
|
[ALIASNAME] Dataset alias name to unlink
|
|
@@ -908,30 +896,26 @@ DESCRIPTION
|
|
|
908
896
|
EXAMPLES
|
|
909
897
|
Unlink an alias with interactive selection
|
|
910
898
|
|
|
911
|
-
$ sanity
|
|
899
|
+
$ sanity datasets alias unlink
|
|
912
900
|
|
|
913
901
|
Unlink alias "conference" with confirmation prompt
|
|
914
902
|
|
|
915
|
-
$ sanity
|
|
916
|
-
|
|
917
|
-
Unlink alias with explicit ~ prefix
|
|
918
|
-
|
|
919
|
-
$ sanity dataset alias unlink ~conference
|
|
903
|
+
$ sanity datasets alias unlink conference
|
|
920
904
|
|
|
921
905
|
Unlink alias "conference" without confirmation prompt
|
|
922
906
|
|
|
923
|
-
$ sanity
|
|
907
|
+
$ sanity datasets alias unlink conference --force
|
|
924
908
|
```
|
|
925
909
|
|
|
926
|
-
_See code: [src/commands/
|
|
910
|
+
_See code: [src/commands/datasets/alias/unlink.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/datasets/alias/unlink.ts)_
|
|
927
911
|
|
|
928
|
-
## `sanity
|
|
912
|
+
## `sanity datasets copy [SOURCE] [TARGET]`
|
|
929
913
|
|
|
930
914
|
Manages dataset copying, including starting a new copy job, listing copy jobs and following the progress of a running copy job
|
|
931
915
|
|
|
932
916
|
```
|
|
933
917
|
USAGE
|
|
934
|
-
$ sanity
|
|
918
|
+
$ sanity datasets copy [SOURCE] [TARGET] [-p <id>] [--attach <value> | --list | --detach | --skip-history]
|
|
935
919
|
[--limit <value> ] [--offset <value> ]
|
|
936
920
|
|
|
937
921
|
ARGUMENTS
|
|
@@ -956,46 +940,46 @@ DESCRIPTION
|
|
|
956
940
|
EXAMPLES
|
|
957
941
|
Interactively copy a dataset
|
|
958
942
|
|
|
959
|
-
$ sanity
|
|
943
|
+
$ sanity datasets copy
|
|
960
944
|
|
|
961
945
|
Copy from source-dataset (prompts for target)
|
|
962
946
|
|
|
963
|
-
$ sanity
|
|
947
|
+
$ sanity datasets copy source-dataset
|
|
964
948
|
|
|
965
949
|
Copy from source-dataset to target-dataset
|
|
966
950
|
|
|
967
|
-
$ sanity
|
|
951
|
+
$ sanity datasets copy source-dataset target-dataset
|
|
968
952
|
|
|
969
953
|
Copy without preserving document history (faster for large datasets)
|
|
970
954
|
|
|
971
|
-
$ sanity
|
|
955
|
+
$ sanity datasets copy --skip-history source target
|
|
972
956
|
|
|
973
957
|
Start copy job without waiting for completion
|
|
974
958
|
|
|
975
|
-
$ sanity
|
|
959
|
+
$ sanity datasets copy --detach source target
|
|
976
960
|
|
|
977
961
|
Attach to a running copy job to follow progress
|
|
978
962
|
|
|
979
|
-
$ sanity
|
|
963
|
+
$ sanity datasets copy --attach <job-id>
|
|
980
964
|
|
|
981
965
|
List all dataset copy jobs
|
|
982
966
|
|
|
983
|
-
$ sanity
|
|
967
|
+
$ sanity datasets copy --list
|
|
984
968
|
|
|
985
969
|
List copy jobs with pagination
|
|
986
970
|
|
|
987
|
-
$ sanity
|
|
971
|
+
$ sanity datasets copy --list --offset 2 --limit 10
|
|
988
972
|
```
|
|
989
973
|
|
|
990
|
-
_See code: [src/commands/
|
|
974
|
+
_See code: [src/commands/datasets/copy.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/datasets/copy.ts)_
|
|
991
975
|
|
|
992
|
-
## `sanity
|
|
976
|
+
## `sanity datasets create [NAME]`
|
|
993
977
|
|
|
994
978
|
Create a new dataset within your project
|
|
995
979
|
|
|
996
980
|
```
|
|
997
981
|
USAGE
|
|
998
|
-
$ sanity
|
|
982
|
+
$ sanity datasets create [NAME] [-p <id>] [--embeddings-projection <value> --embeddings] [--visibility
|
|
999
983
|
custom|private|public]
|
|
1000
984
|
|
|
1001
985
|
ARGUMENTS
|
|
@@ -1016,26 +1000,26 @@ DESCRIPTION
|
|
|
1016
1000
|
EXAMPLES
|
|
1017
1001
|
Interactively create a dataset
|
|
1018
1002
|
|
|
1019
|
-
$ sanity
|
|
1003
|
+
$ sanity datasets create
|
|
1020
1004
|
|
|
1021
1005
|
Create a dataset named "my-dataset"
|
|
1022
1006
|
|
|
1023
|
-
$ sanity
|
|
1007
|
+
$ sanity datasets create my-dataset
|
|
1024
1008
|
|
|
1025
1009
|
Create a private dataset named "my-dataset"
|
|
1026
1010
|
|
|
1027
|
-
$ sanity
|
|
1011
|
+
$ sanity datasets create my-dataset --visibility private
|
|
1028
1012
|
```
|
|
1029
1013
|
|
|
1030
|
-
_See code: [src/commands/
|
|
1014
|
+
_See code: [src/commands/datasets/create.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/datasets/create.ts)_
|
|
1031
1015
|
|
|
1032
|
-
## `sanity
|
|
1016
|
+
## `sanity datasets delete DATASETNAME`
|
|
1033
1017
|
|
|
1034
1018
|
Delete a dataset within your project
|
|
1035
1019
|
|
|
1036
1020
|
```
|
|
1037
1021
|
USAGE
|
|
1038
|
-
$ sanity
|
|
1022
|
+
$ sanity datasets delete DATASETNAME [-p <id>] [--force]
|
|
1039
1023
|
|
|
1040
1024
|
ARGUMENTS
|
|
1041
1025
|
DATASETNAME Dataset name to delete
|
|
@@ -1052,22 +1036,22 @@ DESCRIPTION
|
|
|
1052
1036
|
EXAMPLES
|
|
1053
1037
|
Delete a specific dataset
|
|
1054
1038
|
|
|
1055
|
-
$ sanity
|
|
1039
|
+
$ sanity datasets delete my-dataset
|
|
1056
1040
|
|
|
1057
1041
|
Delete a specific dataset without confirmation
|
|
1058
1042
|
|
|
1059
|
-
$ sanity
|
|
1043
|
+
$ sanity datasets delete my-dataset --force
|
|
1060
1044
|
```
|
|
1061
1045
|
|
|
1062
|
-
_See code: [src/commands/
|
|
1046
|
+
_See code: [src/commands/datasets/delete.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/datasets/delete.ts)_
|
|
1063
1047
|
|
|
1064
|
-
## `sanity
|
|
1048
|
+
## `sanity datasets embeddings disable [DATASET]`
|
|
1065
1049
|
|
|
1066
1050
|
Disable embeddings for a dataset
|
|
1067
1051
|
|
|
1068
1052
|
```
|
|
1069
1053
|
USAGE
|
|
1070
|
-
$ sanity
|
|
1054
|
+
$ sanity datasets embeddings disable [DATASET] [-p <id>]
|
|
1071
1055
|
|
|
1072
1056
|
ARGUMENTS
|
|
1073
1057
|
[DATASET] Dataset name to disable embeddings for
|
|
@@ -1081,18 +1065,18 @@ DESCRIPTION
|
|
|
1081
1065
|
EXAMPLES
|
|
1082
1066
|
Disable embeddings for the production dataset
|
|
1083
1067
|
|
|
1084
|
-
$ sanity
|
|
1068
|
+
$ sanity datasets embeddings disable production
|
|
1085
1069
|
```
|
|
1086
1070
|
|
|
1087
|
-
_See code: [src/commands/
|
|
1071
|
+
_See code: [src/commands/datasets/embeddings/disable.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/datasets/embeddings/disable.ts)_
|
|
1088
1072
|
|
|
1089
|
-
## `sanity
|
|
1073
|
+
## `sanity datasets embeddings enable [DATASET]`
|
|
1090
1074
|
|
|
1091
1075
|
Enable embeddings for a dataset
|
|
1092
1076
|
|
|
1093
1077
|
```
|
|
1094
1078
|
USAGE
|
|
1095
|
-
$ sanity
|
|
1079
|
+
$ sanity datasets embeddings enable [DATASET] [-p <id>] [--projection <value>] [--wait]
|
|
1096
1080
|
|
|
1097
1081
|
ARGUMENTS
|
|
1098
1082
|
[DATASET] Dataset name to enable embeddings for
|
|
@@ -1110,26 +1094,26 @@ DESCRIPTION
|
|
|
1110
1094
|
EXAMPLES
|
|
1111
1095
|
Enable embeddings for the production dataset
|
|
1112
1096
|
|
|
1113
|
-
$ sanity
|
|
1097
|
+
$ sanity datasets embeddings enable production
|
|
1114
1098
|
|
|
1115
1099
|
Enable embeddings with a specific projection
|
|
1116
1100
|
|
|
1117
|
-
$ sanity
|
|
1101
|
+
$ sanity datasets embeddings enable production --projection "{ title, body }"
|
|
1118
1102
|
|
|
1119
1103
|
Enable embeddings and wait for processing to complete
|
|
1120
1104
|
|
|
1121
|
-
$ sanity
|
|
1105
|
+
$ sanity datasets embeddings enable production --wait
|
|
1122
1106
|
```
|
|
1123
1107
|
|
|
1124
|
-
_See code: [src/commands/
|
|
1108
|
+
_See code: [src/commands/datasets/embeddings/enable.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/datasets/embeddings/enable.ts)_
|
|
1125
1109
|
|
|
1126
|
-
## `sanity
|
|
1110
|
+
## `sanity datasets embeddings status [DATASET]`
|
|
1127
1111
|
|
|
1128
1112
|
Show embeddings settings and status for a dataset
|
|
1129
1113
|
|
|
1130
1114
|
```
|
|
1131
1115
|
USAGE
|
|
1132
|
-
$ sanity
|
|
1116
|
+
$ sanity datasets embeddings status [DATASET] [-p <id>]
|
|
1133
1117
|
|
|
1134
1118
|
ARGUMENTS
|
|
1135
1119
|
[DATASET] The name of the dataset to check embeddings status for
|
|
@@ -1143,18 +1127,18 @@ DESCRIPTION
|
|
|
1143
1127
|
EXAMPLES
|
|
1144
1128
|
Show embeddings status for the production dataset
|
|
1145
1129
|
|
|
1146
|
-
$ sanity
|
|
1130
|
+
$ sanity datasets embeddings status production
|
|
1147
1131
|
```
|
|
1148
1132
|
|
|
1149
|
-
_See code: [src/commands/
|
|
1133
|
+
_See code: [src/commands/datasets/embeddings/status.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/datasets/embeddings/status.ts)_
|
|
1150
1134
|
|
|
1151
|
-
## `sanity
|
|
1135
|
+
## `sanity datasets export [NAME] [DESTINATION]`
|
|
1152
1136
|
|
|
1153
1137
|
Export dataset to local filesystem as a gzipped tarball. Assets failing with HTTP status codes 401, 403 and 404 upon download are ignored and excluded from export.
|
|
1154
1138
|
|
|
1155
1139
|
```
|
|
1156
1140
|
USAGE
|
|
1157
|
-
$ sanity
|
|
1141
|
+
$ sanity datasets export [NAME] [DESTINATION] [-p <id>] [--asset-concurrency <value>] [--mode stream|cursor]
|
|
1158
1142
|
[--no-assets] [--no-compress] [--no-drafts] [--overwrite] [--raw] [--types <value>]
|
|
1159
1143
|
|
|
1160
1144
|
ARGUMENTS
|
|
@@ -1184,30 +1168,30 @@ DESCRIPTION
|
|
|
1184
1168
|
EXAMPLES
|
|
1185
1169
|
Export dataset "moviedb" to localPath.tar.gz
|
|
1186
1170
|
|
|
1187
|
-
$ sanity
|
|
1171
|
+
$ sanity datasets export moviedb localPath.tar.gz
|
|
1188
1172
|
|
|
1189
1173
|
Export dataset without assets
|
|
1190
1174
|
|
|
1191
|
-
$ sanity
|
|
1175
|
+
$ sanity datasets export moviedb assetless.tar.gz --no-assets
|
|
1192
1176
|
|
|
1193
1177
|
Export raw documents without asset reference rewriting
|
|
1194
1178
|
|
|
1195
|
-
$ sanity
|
|
1179
|
+
$ sanity datasets export staging staging.tar.gz --raw
|
|
1196
1180
|
|
|
1197
1181
|
Export specific document types
|
|
1198
1182
|
|
|
1199
|
-
$ sanity
|
|
1183
|
+
$ sanity datasets export staging staging.tar.gz --types products,shops
|
|
1200
1184
|
```
|
|
1201
1185
|
|
|
1202
|
-
_See code: [src/commands/
|
|
1186
|
+
_See code: [src/commands/datasets/export.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/datasets/export.ts)_
|
|
1203
1187
|
|
|
1204
|
-
## `sanity
|
|
1188
|
+
## `sanity datasets import SOURCE [TARGETDATASET]`
|
|
1205
1189
|
|
|
1206
1190
|
Import documents to a Sanity dataset
|
|
1207
1191
|
|
|
1208
1192
|
```
|
|
1209
1193
|
USAGE
|
|
1210
|
-
$ sanity
|
|
1194
|
+
$ sanity datasets import SOURCE [TARGETDATASET] [--allow-assets-in-different-dataset] [--allow-failing-assets]
|
|
1211
1195
|
[--allow-replacement-characters] [--allow-system-documents] [--asset-concurrency <value>] [-d <name>] [--missing |
|
|
1212
1196
|
--replace] [-p <id>] [--replace-assets] [--skip-cross-dataset-references] [-t <value>]
|
|
1213
1197
|
|
|
@@ -1237,26 +1221,30 @@ DESCRIPTION
|
|
|
1237
1221
|
EXAMPLES
|
|
1238
1222
|
Import "./my-dataset.ndjson" into dataset "staging"
|
|
1239
1223
|
|
|
1240
|
-
$ sanity
|
|
1224
|
+
$ sanity datasets import -d staging my-dataset.ndjson
|
|
1241
1225
|
|
|
1242
1226
|
Import into dataset "test" from stdin
|
|
1243
1227
|
|
|
1244
|
-
cat my-dataset.ndjson | sanity
|
|
1228
|
+
cat my-dataset.ndjson | sanity datasets import -d test -
|
|
1245
1229
|
|
|
1246
1230
|
Import with explicit project ID (overrides CLI configuration)
|
|
1247
1231
|
|
|
1248
|
-
$ sanity
|
|
1232
|
+
$ sanity datasets import -p projectId -d staging my-dataset.ndjson
|
|
1233
|
+
|
|
1234
|
+
Import with an explicit token (e.g. for CI/CD)
|
|
1235
|
+
|
|
1236
|
+
$ sanity datasets import -d staging -t someSecretToken my-dataset.ndjson
|
|
1249
1237
|
```
|
|
1250
1238
|
|
|
1251
|
-
_See code: [src/commands/
|
|
1239
|
+
_See code: [src/commands/datasets/import.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/datasets/import.ts)_
|
|
1252
1240
|
|
|
1253
|
-
## `sanity
|
|
1241
|
+
## `sanity datasets list`
|
|
1254
1242
|
|
|
1255
1243
|
List datasets of your project
|
|
1256
1244
|
|
|
1257
1245
|
```
|
|
1258
1246
|
USAGE
|
|
1259
|
-
$ sanity
|
|
1247
|
+
$ sanity datasets list [-p <id>]
|
|
1260
1248
|
|
|
1261
1249
|
OVERRIDE FLAGS
|
|
1262
1250
|
-p, --project-id=<id> Project ID to list datasets for (overrides CLI configuration)
|
|
@@ -1267,22 +1255,22 @@ DESCRIPTION
|
|
|
1267
1255
|
EXAMPLES
|
|
1268
1256
|
List datasets of your project
|
|
1269
1257
|
|
|
1270
|
-
$ sanity
|
|
1258
|
+
$ sanity datasets list
|
|
1271
1259
|
|
|
1272
1260
|
List datasets for a specific project
|
|
1273
1261
|
|
|
1274
|
-
$ sanity
|
|
1262
|
+
$ sanity datasets list --project-id abc123
|
|
1275
1263
|
```
|
|
1276
1264
|
|
|
1277
|
-
_See code: [src/commands/
|
|
1265
|
+
_See code: [src/commands/datasets/list.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/datasets/list.ts)_
|
|
1278
1266
|
|
|
1279
|
-
## `sanity
|
|
1267
|
+
## `sanity datasets visibility get DATASET`
|
|
1280
1268
|
|
|
1281
1269
|
Get the visibility of a dataset
|
|
1282
1270
|
|
|
1283
1271
|
```
|
|
1284
1272
|
USAGE
|
|
1285
|
-
$ sanity
|
|
1273
|
+
$ sanity datasets visibility get DATASET [-p <id>]
|
|
1286
1274
|
|
|
1287
1275
|
ARGUMENTS
|
|
1288
1276
|
DATASET The name of the dataset to get visibility for
|
|
@@ -1296,18 +1284,18 @@ DESCRIPTION
|
|
|
1296
1284
|
EXAMPLES
|
|
1297
1285
|
Check the visibility of a dataset
|
|
1298
1286
|
|
|
1299
|
-
$ sanity
|
|
1287
|
+
$ sanity datasets visibility get my-dataset
|
|
1300
1288
|
```
|
|
1301
1289
|
|
|
1302
|
-
_See code: [src/commands/
|
|
1290
|
+
_See code: [src/commands/datasets/visibility/get.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/datasets/visibility/get.ts)_
|
|
1303
1291
|
|
|
1304
|
-
## `sanity
|
|
1292
|
+
## `sanity datasets visibility set DATASET MODE`
|
|
1305
1293
|
|
|
1306
1294
|
Set the visibility of a dataset
|
|
1307
1295
|
|
|
1308
1296
|
```
|
|
1309
1297
|
USAGE
|
|
1310
|
-
$ sanity
|
|
1298
|
+
$ sanity datasets visibility set DATASET MODE [-p <id>]
|
|
1311
1299
|
|
|
1312
1300
|
ARGUMENTS
|
|
1313
1301
|
DATASET The name of the dataset to set visibility for
|
|
@@ -1322,14 +1310,14 @@ DESCRIPTION
|
|
|
1322
1310
|
EXAMPLES
|
|
1323
1311
|
Make a dataset private
|
|
1324
1312
|
|
|
1325
|
-
$ sanity
|
|
1313
|
+
$ sanity datasets visibility set my-dataset private
|
|
1326
1314
|
|
|
1327
1315
|
Make a dataset public
|
|
1328
1316
|
|
|
1329
|
-
$ sanity
|
|
1317
|
+
$ sanity datasets visibility set my-dataset public
|
|
1330
1318
|
```
|
|
1331
1319
|
|
|
1332
|
-
_See code: [src/commands/
|
|
1320
|
+
_See code: [src/commands/datasets/visibility/set.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/datasets/visibility/set.ts)_
|
|
1333
1321
|
|
|
1334
1322
|
## `sanity debug`
|
|
1335
1323
|
|
|
@@ -1352,7 +1340,7 @@ EXAMPLES
|
|
|
1352
1340
|
$ sanity debug --secrets
|
|
1353
1341
|
```
|
|
1354
1342
|
|
|
1355
|
-
_See code: [src/commands/debug.ts](https://github.com/sanity-io/cli/blob/v6.1
|
|
1343
|
+
_See code: [src/commands/debug.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/debug.ts)_
|
|
1356
1344
|
|
|
1357
1345
|
## `sanity deploy [SOURCEDIR]`
|
|
1358
1346
|
|
|
@@ -1361,7 +1349,7 @@ Builds and deploys Sanity Studio or application to Sanity hosting
|
|
|
1361
1349
|
```
|
|
1362
1350
|
USAGE
|
|
1363
1351
|
$ sanity deploy [SOURCEDIR] [--auto-updates] [--external | --source-maps | --minify | --build]
|
|
1364
|
-
[--schema-required] [--verbose] [-y]
|
|
1352
|
+
[--schema-required] [--url <value>] [--verbose] [-y]
|
|
1365
1353
|
|
|
1366
1354
|
ARGUMENTS
|
|
1367
1355
|
[SOURCEDIR] Source directory
|
|
@@ -1374,6 +1362,8 @@ FLAGS
|
|
|
1374
1362
|
--[no-]minify Skip minifying built JavaScript (speeds up build, increases size of bundle)
|
|
1375
1363
|
--schema-required Fail-fast deployment if schema store fails
|
|
1376
1364
|
--source-maps Enable source maps for built bundles (increases size of bundle)
|
|
1365
|
+
--url=<value> Studio URL for deployment. For external studios, the full URL. For hosted studios, the
|
|
1366
|
+
hostname (e.g. "my-studio" or "my-studio.sanity.studio")
|
|
1377
1367
|
--verbose Enable verbose logging
|
|
1378
1368
|
|
|
1379
1369
|
DESCRIPTION
|
|
@@ -1397,7 +1387,7 @@ EXAMPLES
|
|
|
1397
1387
|
$ sanity deploy --external
|
|
1398
1388
|
```
|
|
1399
1389
|
|
|
1400
|
-
_See code: [src/commands/deploy.ts](https://github.com/sanity-io/cli/blob/v6.1
|
|
1390
|
+
_See code: [src/commands/deploy.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/deploy.ts)_
|
|
1401
1391
|
|
|
1402
1392
|
## `sanity dev`
|
|
1403
1393
|
|
|
@@ -1424,7 +1414,7 @@ EXAMPLES
|
|
|
1424
1414
|
$ sanity dev --load-in-dashboard
|
|
1425
1415
|
```
|
|
1426
1416
|
|
|
1427
|
-
_See code: [src/commands/dev.ts](https://github.com/sanity-io/cli/blob/v6.1
|
|
1417
|
+
_See code: [src/commands/dev.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/dev.ts)_
|
|
1428
1418
|
|
|
1429
1419
|
## `sanity docs browse`
|
|
1430
1420
|
|
|
@@ -1438,7 +1428,7 @@ DESCRIPTION
|
|
|
1438
1428
|
Open Sanity docs in a web browser
|
|
1439
1429
|
```
|
|
1440
1430
|
|
|
1441
|
-
_See code: [src/commands/docs/browse.ts](https://github.com/sanity-io/cli/blob/v6.1
|
|
1431
|
+
_See code: [src/commands/docs/browse.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/docs/browse.ts)_
|
|
1442
1432
|
|
|
1443
1433
|
## `sanity docs read PATH`
|
|
1444
1434
|
|
|
@@ -1475,7 +1465,7 @@ EXAMPLES
|
|
|
1475
1465
|
$ sanity docs read https://www.sanity.io/docs/studio/installation -w
|
|
1476
1466
|
```
|
|
1477
1467
|
|
|
1478
|
-
_See code: [src/commands/docs/read.ts](https://github.com/sanity-io/cli/blob/v6.1
|
|
1468
|
+
_See code: [src/commands/docs/read.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/docs/read.ts)_
|
|
1479
1469
|
|
|
1480
1470
|
## `sanity docs search QUERY`
|
|
1481
1471
|
|
|
@@ -1508,7 +1498,7 @@ EXAMPLES
|
|
|
1508
1498
|
$ sanity docs search "deployment" --limit=5
|
|
1509
1499
|
```
|
|
1510
1500
|
|
|
1511
|
-
_See code: [src/commands/docs/search.ts](https://github.com/sanity-io/cli/blob/v6.1
|
|
1501
|
+
_See code: [src/commands/docs/search.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/docs/search.ts)_
|
|
1512
1502
|
|
|
1513
1503
|
## `sanity doctor [CHECKS]`
|
|
1514
1504
|
|
|
@@ -1539,7 +1529,7 @@ EXAMPLES
|
|
|
1539
1529
|
$ sanity doctor cli
|
|
1540
1530
|
```
|
|
1541
1531
|
|
|
1542
|
-
_See code: [src/commands/doctor.ts](https://github.com/sanity-io/cli/blob/v6.1
|
|
1532
|
+
_See code: [src/commands/doctor.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/doctor.ts)_
|
|
1543
1533
|
|
|
1544
1534
|
## `sanity documents create [FILE]`
|
|
1545
1535
|
|
|
@@ -1590,7 +1580,7 @@ EXAMPLES
|
|
|
1590
1580
|
$ sanity documents create myDocument.json --project-id abc123
|
|
1591
1581
|
```
|
|
1592
1582
|
|
|
1593
|
-
_See code: [src/commands/documents/create.ts](https://github.com/sanity-io/cli/blob/v6.1
|
|
1583
|
+
_See code: [src/commands/documents/create.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/documents/create.ts)_
|
|
1594
1584
|
|
|
1595
1585
|
## `sanity documents delete ID [IDS]`
|
|
1596
1586
|
|
|
@@ -1633,7 +1623,7 @@ EXAMPLES
|
|
|
1633
1623
|
$ sanity documents delete myDocId --project-id abc123
|
|
1634
1624
|
```
|
|
1635
1625
|
|
|
1636
|
-
_See code: [src/commands/documents/delete.ts](https://github.com/sanity-io/cli/blob/v6.1
|
|
1626
|
+
_See code: [src/commands/documents/delete.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/documents/delete.ts)_
|
|
1637
1627
|
|
|
1638
1628
|
## `sanity documents get DOCUMENTID`
|
|
1639
1629
|
|
|
@@ -1674,7 +1664,7 @@ EXAMPLES
|
|
|
1674
1664
|
$ sanity documents get myDocId --project-id abc123
|
|
1675
1665
|
```
|
|
1676
1666
|
|
|
1677
|
-
_See code: [src/commands/documents/get.ts](https://github.com/sanity-io/cli/blob/v6.1
|
|
1667
|
+
_See code: [src/commands/documents/get.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/documents/get.ts)_
|
|
1678
1668
|
|
|
1679
1669
|
## `sanity documents query QUERY`
|
|
1680
1670
|
|
|
@@ -1717,7 +1707,7 @@ EXAMPLES
|
|
|
1717
1707
|
$ sanity documents query '*[_type == "post"]' --project-id abc123 --dataset production
|
|
1718
1708
|
```
|
|
1719
1709
|
|
|
1720
|
-
_See code: [src/commands/documents/query.ts](https://github.com/sanity-io/cli/blob/v6.1
|
|
1710
|
+
_See code: [src/commands/documents/query.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/documents/query.ts)_
|
|
1721
1711
|
|
|
1722
1712
|
## `sanity documents validate`
|
|
1723
1713
|
|
|
@@ -1771,7 +1761,7 @@ EXAMPLES
|
|
|
1771
1761
|
$ sanity documents validate --project-id abc123 --dataset production
|
|
1772
1762
|
```
|
|
1773
1763
|
|
|
1774
|
-
_See code: [src/commands/documents/validate.ts](https://github.com/sanity-io/cli/blob/v6.1
|
|
1764
|
+
_See code: [src/commands/documents/validate.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/documents/validate.ts)_
|
|
1775
1765
|
|
|
1776
1766
|
## `sanity exec SCRIPT`
|
|
1777
1767
|
|
|
@@ -1812,7 +1802,7 @@ EXAMPLES
|
|
|
1812
1802
|
$ sanity exec --mock-browser-env myscript.js -- --dry-run positional-argument
|
|
1813
1803
|
```
|
|
1814
1804
|
|
|
1815
|
-
_See code: [src/commands/exec.ts](https://github.com/sanity-io/cli/blob/v6.1
|
|
1805
|
+
_See code: [src/commands/exec.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/exec.ts)_
|
|
1816
1806
|
|
|
1817
1807
|
## `sanity functions add`
|
|
1818
1808
|
|
|
@@ -1861,7 +1851,7 @@ EXAMPLES
|
|
|
1861
1851
|
$ sanity functions add --name my-function --type document-create --type document-update --lang js
|
|
1862
1852
|
```
|
|
1863
1853
|
|
|
1864
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.
|
|
1854
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.7.2/src/commands/functions/add.ts)_
|
|
1865
1855
|
|
|
1866
1856
|
## `sanity functions dev`
|
|
1867
1857
|
|
|
@@ -1895,7 +1885,7 @@ EXAMPLES
|
|
|
1895
1885
|
$ sanity functions dev --timeout 60
|
|
1896
1886
|
```
|
|
1897
1887
|
|
|
1898
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.
|
|
1888
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.7.2/src/commands/functions/dev.ts)_
|
|
1899
1889
|
|
|
1900
1890
|
## `sanity functions env add NAME KEY VALUE`
|
|
1901
1891
|
|
|
@@ -1922,7 +1912,7 @@ EXAMPLES
|
|
|
1922
1912
|
$ sanity functions env add MyFunction API_URL https://api.example.com/
|
|
1923
1913
|
```
|
|
1924
1914
|
|
|
1925
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.
|
|
1915
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.7.2/src/commands/functions/env/add.ts)_
|
|
1926
1916
|
|
|
1927
1917
|
## `sanity functions env list NAME`
|
|
1928
1918
|
|
|
@@ -1946,7 +1936,7 @@ EXAMPLES
|
|
|
1946
1936
|
$ sanity functions env list MyFunction
|
|
1947
1937
|
```
|
|
1948
1938
|
|
|
1949
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.
|
|
1939
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.7.2/src/commands/functions/env/list.ts)_
|
|
1950
1940
|
|
|
1951
1941
|
## `sanity functions env remove NAME KEY`
|
|
1952
1942
|
|
|
@@ -1972,7 +1962,7 @@ EXAMPLES
|
|
|
1972
1962
|
$ sanity functions env remove MyFunction API_URL
|
|
1973
1963
|
```
|
|
1974
1964
|
|
|
1975
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.
|
|
1965
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.7.2/src/commands/functions/env/remove.ts)_
|
|
1976
1966
|
|
|
1977
1967
|
## `sanity functions logs [NAME]`
|
|
1978
1968
|
|
|
@@ -2012,7 +2002,7 @@ EXAMPLES
|
|
|
2012
2002
|
$ sanity functions logs <name> --delete
|
|
2013
2003
|
```
|
|
2014
2004
|
|
|
2015
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.
|
|
2005
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.7.2/src/commands/functions/logs.ts)_
|
|
2016
2006
|
|
|
2017
2007
|
## `sanity functions test [NAME]`
|
|
2018
2008
|
|
|
@@ -2066,7 +2056,7 @@ EXAMPLES
|
|
|
2066
2056
|
$ sanity functions test <name> --event update --data-before '{ "title": "before" }' --data-after '{ "title": "after" }'
|
|
2067
2057
|
```
|
|
2068
2058
|
|
|
2069
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.
|
|
2059
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.7.2/src/commands/functions/test.ts)_
|
|
2070
2060
|
|
|
2071
2061
|
## `sanity graphql deploy`
|
|
2072
2062
|
|
|
@@ -2111,7 +2101,7 @@ EXAMPLES
|
|
|
2111
2101
|
$ sanity graphql deploy --playground
|
|
2112
2102
|
```
|
|
2113
2103
|
|
|
2114
|
-
_See code: [src/commands/graphql/deploy.ts](https://github.com/sanity-io/cli/blob/v6.1
|
|
2104
|
+
_See code: [src/commands/graphql/deploy.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/graphql/deploy.ts)_
|
|
2115
2105
|
|
|
2116
2106
|
## `sanity graphql list`
|
|
2117
2107
|
|
|
@@ -2137,7 +2127,7 @@ EXAMPLES
|
|
|
2137
2127
|
$ sanity graphql list --project-id abc123
|
|
2138
2128
|
```
|
|
2139
2129
|
|
|
2140
|
-
_See code: [src/commands/graphql/list.ts](https://github.com/sanity-io/cli/blob/v6.1
|
|
2130
|
+
_See code: [src/commands/graphql/list.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/graphql/list.ts)_
|
|
2141
2131
|
|
|
2142
2132
|
## `sanity graphql undeploy`
|
|
2143
2133
|
|
|
@@ -2185,7 +2175,7 @@ EXAMPLES
|
|
|
2185
2175
|
$ sanity graphql undeploy --project-id abc123 --dataset production
|
|
2186
2176
|
```
|
|
2187
2177
|
|
|
2188
|
-
_See code: [src/commands/graphql/undeploy.ts](https://github.com/sanity-io/cli/blob/v6.1
|
|
2178
|
+
_See code: [src/commands/graphql/undeploy.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/graphql/undeploy.ts)_
|
|
2189
2179
|
|
|
2190
2180
|
## `sanity help [COMMAND]`
|
|
2191
2181
|
|
|
@@ -2205,15 +2195,15 @@ DESCRIPTION
|
|
|
2205
2195
|
Display help for sanity.
|
|
2206
2196
|
```
|
|
2207
2197
|
|
|
2208
|
-
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/6.2.
|
|
2198
|
+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/6.2.40/src/commands/help.ts)_
|
|
2209
2199
|
|
|
2210
|
-
## `sanity
|
|
2200
|
+
## `sanity hooks attempt ATTEMPTID`
|
|
2211
2201
|
|
|
2212
2202
|
Print details of a given webhook delivery attempt
|
|
2213
2203
|
|
|
2214
2204
|
```
|
|
2215
2205
|
USAGE
|
|
2216
|
-
$ sanity
|
|
2206
|
+
$ sanity hooks attempt ATTEMPTID [-p <id>]
|
|
2217
2207
|
|
|
2218
2208
|
ARGUMENTS
|
|
2219
2209
|
ATTEMPTID The delivery attempt ID to get details for
|
|
@@ -2227,22 +2217,22 @@ DESCRIPTION
|
|
|
2227
2217
|
EXAMPLES
|
|
2228
2218
|
Print details of webhook delivery attempt with ID abc123
|
|
2229
2219
|
|
|
2230
|
-
$ sanity
|
|
2220
|
+
$ sanity hooks attempt abc123
|
|
2231
2221
|
|
|
2232
2222
|
Get attempt details for a specific project
|
|
2233
2223
|
|
|
2234
|
-
$ sanity
|
|
2224
|
+
$ sanity hooks attempt abc123 --project-id projectId
|
|
2235
2225
|
```
|
|
2236
2226
|
|
|
2237
|
-
_See code: [src/commands/
|
|
2227
|
+
_See code: [src/commands/hooks/attempt.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/hooks/attempt.ts)_
|
|
2238
2228
|
|
|
2239
|
-
## `sanity
|
|
2229
|
+
## `sanity hooks create`
|
|
2240
2230
|
|
|
2241
2231
|
Create a new webhook for the current project
|
|
2242
2232
|
|
|
2243
2233
|
```
|
|
2244
2234
|
USAGE
|
|
2245
|
-
$ sanity
|
|
2235
|
+
$ sanity hooks create [-p <id>]
|
|
2246
2236
|
|
|
2247
2237
|
OVERRIDE FLAGS
|
|
2248
2238
|
-p, --project-id=<id> Project ID to create webhook for (overrides CLI configuration)
|
|
@@ -2253,22 +2243,22 @@ DESCRIPTION
|
|
|
2253
2243
|
EXAMPLES
|
|
2254
2244
|
Create a new webhook for the current project
|
|
2255
2245
|
|
|
2256
|
-
$ sanity
|
|
2246
|
+
$ sanity hooks create
|
|
2257
2247
|
|
|
2258
2248
|
Create a webhook for a specific project
|
|
2259
2249
|
|
|
2260
|
-
$ sanity
|
|
2250
|
+
$ sanity hooks create --project-id abc123
|
|
2261
2251
|
```
|
|
2262
2252
|
|
|
2263
|
-
_See code: [src/commands/
|
|
2253
|
+
_See code: [src/commands/hooks/create.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/hooks/create.ts)_
|
|
2264
2254
|
|
|
2265
|
-
## `sanity
|
|
2255
|
+
## `sanity hooks delete [NAME]`
|
|
2266
2256
|
|
|
2267
2257
|
Delete a hook within your project
|
|
2268
2258
|
|
|
2269
2259
|
```
|
|
2270
2260
|
USAGE
|
|
2271
|
-
$ sanity
|
|
2261
|
+
$ sanity hooks delete [NAME] [-p <id>]
|
|
2272
2262
|
|
|
2273
2263
|
ARGUMENTS
|
|
2274
2264
|
[NAME] Name of hook to delete (will prompt if not provided)
|
|
@@ -2282,26 +2272,26 @@ DESCRIPTION
|
|
|
2282
2272
|
EXAMPLES
|
|
2283
2273
|
Interactively select and delete a hook
|
|
2284
2274
|
|
|
2285
|
-
$ sanity
|
|
2275
|
+
$ sanity hooks delete
|
|
2286
2276
|
|
|
2287
2277
|
Delete a specific hook by name
|
|
2288
2278
|
|
|
2289
|
-
$ sanity
|
|
2279
|
+
$ sanity hooks delete my-hook
|
|
2290
2280
|
|
|
2291
2281
|
Delete a hook from a specific project
|
|
2292
2282
|
|
|
2293
|
-
$ sanity
|
|
2283
|
+
$ sanity hooks delete --project-id abc123
|
|
2294
2284
|
```
|
|
2295
2285
|
|
|
2296
|
-
_See code: [src/commands/
|
|
2286
|
+
_See code: [src/commands/hooks/delete.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/hooks/delete.ts)_
|
|
2297
2287
|
|
|
2298
|
-
## `sanity
|
|
2288
|
+
## `sanity hooks list`
|
|
2299
2289
|
|
|
2300
2290
|
List hooks for a given project
|
|
2301
2291
|
|
|
2302
2292
|
```
|
|
2303
2293
|
USAGE
|
|
2304
|
-
$ sanity
|
|
2294
|
+
$ sanity hooks list [-p <id>]
|
|
2305
2295
|
|
|
2306
2296
|
OVERRIDE FLAGS
|
|
2307
2297
|
-p, --project-id=<id> Project ID to list webhooks for (overrides CLI configuration)
|
|
@@ -2312,22 +2302,22 @@ DESCRIPTION
|
|
|
2312
2302
|
EXAMPLES
|
|
2313
2303
|
List hooks for a given project
|
|
2314
2304
|
|
|
2315
|
-
$ sanity
|
|
2305
|
+
$ sanity hooks list
|
|
2316
2306
|
|
|
2317
2307
|
List hooks for a specific project
|
|
2318
2308
|
|
|
2319
|
-
$ sanity
|
|
2309
|
+
$ sanity hooks list --project-id abc123
|
|
2320
2310
|
```
|
|
2321
2311
|
|
|
2322
|
-
_See code: [src/commands/
|
|
2312
|
+
_See code: [src/commands/hooks/list.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/hooks/list.ts)_
|
|
2323
2313
|
|
|
2324
|
-
## `sanity
|
|
2314
|
+
## `sanity hooks logs [NAME]`
|
|
2325
2315
|
|
|
2326
2316
|
List latest log entries for a given hook
|
|
2327
2317
|
|
|
2328
2318
|
```
|
|
2329
2319
|
USAGE
|
|
2330
|
-
$ sanity
|
|
2320
|
+
$ sanity hooks logs [NAME] [-p <id>] [--detailed]
|
|
2331
2321
|
|
|
2332
2322
|
ARGUMENTS
|
|
2333
2323
|
[NAME] Name of the hook to show logs for
|
|
@@ -2344,18 +2334,18 @@ DESCRIPTION
|
|
|
2344
2334
|
EXAMPLES
|
|
2345
2335
|
List latest log entries for a given hook
|
|
2346
2336
|
|
|
2347
|
-
$ sanity
|
|
2337
|
+
$ sanity hooks logs
|
|
2348
2338
|
|
|
2349
2339
|
List latest log entries for a specific hook by name
|
|
2350
2340
|
|
|
2351
|
-
$ sanity
|
|
2341
|
+
$ sanity hooks logs [NAME]
|
|
2352
2342
|
|
|
2353
2343
|
List hook logs for a specific project
|
|
2354
2344
|
|
|
2355
|
-
$ sanity
|
|
2345
|
+
$ sanity hooks logs --project-id abc123
|
|
2356
2346
|
```
|
|
2357
2347
|
|
|
2358
|
-
_See code: [src/commands/
|
|
2348
|
+
_See code: [src/commands/hooks/logs.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/hooks/logs.ts)_
|
|
2359
2349
|
|
|
2360
2350
|
## `sanity init`
|
|
2361
2351
|
|
|
@@ -2425,7 +2415,7 @@ EXAMPLES
|
|
|
2425
2415
|
--output-path /Users/espenh/movies-unlimited
|
|
2426
2416
|
```
|
|
2427
2417
|
|
|
2428
|
-
_See code: [src/commands/init.ts](https://github.com/sanity-io/cli/blob/v6.1
|
|
2418
|
+
_See code: [src/commands/init.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/init.ts)_
|
|
2429
2419
|
|
|
2430
2420
|
## `sanity install [PACKAGES]`
|
|
2431
2421
|
|
|
@@ -2449,7 +2439,7 @@ EXAMPLES
|
|
|
2449
2439
|
$ sanity install some-package another-package
|
|
2450
2440
|
```
|
|
2451
2441
|
|
|
2452
|
-
_See code: [src/commands/install.ts](https://github.com/sanity-io/cli/blob/v6.1
|
|
2442
|
+
_See code: [src/commands/install.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/install.ts)_
|
|
2453
2443
|
|
|
2454
2444
|
## `sanity learn`
|
|
2455
2445
|
|
|
@@ -2463,7 +2453,7 @@ DESCRIPTION
|
|
|
2463
2453
|
Opens Sanity Learn in your web browser
|
|
2464
2454
|
```
|
|
2465
2455
|
|
|
2466
|
-
_See code: [src/commands/learn.ts](https://github.com/sanity-io/cli/blob/v6.1
|
|
2456
|
+
_See code: [src/commands/learn.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/learn.ts)_
|
|
2467
2457
|
|
|
2468
2458
|
## `sanity login`
|
|
2469
2459
|
|
|
@@ -2471,12 +2461,13 @@ Authenticates the CLI for access to Sanity projects
|
|
|
2471
2461
|
|
|
2472
2462
|
```
|
|
2473
2463
|
USAGE
|
|
2474
|
-
$ sanity login [--open] [--provider <providerId> | --sso <slug>]
|
|
2464
|
+
$ sanity login [--open] [--provider <providerId> | --sso <slug>] [--sso-provider <name> ]
|
|
2475
2465
|
|
|
2476
2466
|
FLAGS
|
|
2477
2467
|
--[no-]open Open a browser window to log in (`--no-open` only prints URL)
|
|
2478
2468
|
--provider=<providerId> Log in using the given provider
|
|
2479
2469
|
--sso=<slug> Log in using Single Sign-On, using the given organization slug
|
|
2470
|
+
--sso-provider=<name> Select a specific SSO provider by name (use with --sso)
|
|
2480
2471
|
|
|
2481
2472
|
DESCRIPTION
|
|
2482
2473
|
Authenticates the CLI for access to Sanity projects
|
|
@@ -2486,16 +2477,20 @@ EXAMPLES
|
|
|
2486
2477
|
|
|
2487
2478
|
$ sanity login
|
|
2488
2479
|
|
|
2480
|
+
Login with GitHub provider, but do not open a browser window automatically
|
|
2481
|
+
|
|
2482
|
+
$ sanity login --provider github --no-open
|
|
2483
|
+
|
|
2489
2484
|
Log in using Single Sign-On with the "my-organization" slug
|
|
2490
2485
|
|
|
2491
2486
|
$ sanity login --sso my-organization
|
|
2492
2487
|
|
|
2493
|
-
|
|
2488
|
+
Log in using a specific SSO provider within an organization
|
|
2494
2489
|
|
|
2495
|
-
$ sanity login --
|
|
2490
|
+
$ sanity login --sso my-organization --sso-provider "Okta SSO"
|
|
2496
2491
|
```
|
|
2497
2492
|
|
|
2498
|
-
_See code: [src/commands/login.ts](https://github.com/sanity-io/cli/blob/v6.1
|
|
2493
|
+
_See code: [src/commands/login.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/login.ts)_
|
|
2499
2494
|
|
|
2500
2495
|
## `sanity logout`
|
|
2501
2496
|
|
|
@@ -2509,7 +2504,7 @@ DESCRIPTION
|
|
|
2509
2504
|
Logs out the CLI from the current user session
|
|
2510
2505
|
```
|
|
2511
2506
|
|
|
2512
|
-
_See code: [src/commands/logout.ts](https://github.com/sanity-io/cli/blob/v6.1
|
|
2507
|
+
_See code: [src/commands/logout.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/logout.ts)_
|
|
2513
2508
|
|
|
2514
2509
|
## `sanity manage`
|
|
2515
2510
|
|
|
@@ -2523,7 +2518,7 @@ DESCRIPTION
|
|
|
2523
2518
|
Opens project management interface in your web browser
|
|
2524
2519
|
```
|
|
2525
2520
|
|
|
2526
|
-
_See code: [src/commands/manage.ts](https://github.com/sanity-io/cli/blob/v6.1
|
|
2521
|
+
_See code: [src/commands/manage.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/manage.ts)_
|
|
2527
2522
|
|
|
2528
2523
|
## `sanity manifest extract`
|
|
2529
2524
|
|
|
@@ -2551,7 +2546,7 @@ EXAMPLES
|
|
|
2551
2546
|
$ sanity manifest extract --path /public/static
|
|
2552
2547
|
```
|
|
2553
2548
|
|
|
2554
|
-
_See code: [src/commands/manifest/extract.ts](https://github.com/sanity-io/cli/blob/v6.1
|
|
2549
|
+
_See code: [src/commands/manifest/extract.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/manifest/extract.ts)_
|
|
2555
2550
|
|
|
2556
2551
|
## `sanity mcp configure`
|
|
2557
2552
|
|
|
@@ -2570,7 +2565,7 @@ EXAMPLES
|
|
|
2570
2565
|
$ sanity mcp configure
|
|
2571
2566
|
```
|
|
2572
2567
|
|
|
2573
|
-
_See code: [src/commands/mcp/configure.ts](https://github.com/sanity-io/cli/blob/v6.1
|
|
2568
|
+
_See code: [src/commands/mcp/configure.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/mcp/configure.ts)_
|
|
2574
2569
|
|
|
2575
2570
|
## `sanity media create-aspect`
|
|
2576
2571
|
|
|
@@ -2589,7 +2584,7 @@ EXAMPLES
|
|
|
2589
2584
|
$ sanity media create-aspect
|
|
2590
2585
|
```
|
|
2591
2586
|
|
|
2592
|
-
_See code: [src/commands/media/create-aspect.ts](https://github.com/sanity-io/cli/blob/v6.1
|
|
2587
|
+
_See code: [src/commands/media/create-aspect.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/media/create-aspect.ts)_
|
|
2593
2588
|
|
|
2594
2589
|
## `sanity media delete-aspect ASPECTNAME`
|
|
2595
2590
|
|
|
@@ -2618,7 +2613,7 @@ EXAMPLES
|
|
|
2618
2613
|
$ sanity media delete-aspect someAspect
|
|
2619
2614
|
```
|
|
2620
2615
|
|
|
2621
|
-
_See code: [src/commands/media/delete-aspect.ts](https://github.com/sanity-io/cli/blob/v6.1
|
|
2616
|
+
_See code: [src/commands/media/delete-aspect.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/media/delete-aspect.ts)_
|
|
2622
2617
|
|
|
2623
2618
|
## `sanity media deploy-aspect [ASPECTNAME]`
|
|
2624
2619
|
|
|
@@ -2651,7 +2646,7 @@ EXAMPLES
|
|
|
2651
2646
|
$ sanity media deploy-aspect --all
|
|
2652
2647
|
```
|
|
2653
2648
|
|
|
2654
|
-
_See code: [src/commands/media/deploy-aspect.ts](https://github.com/sanity-io/cli/blob/v6.1
|
|
2649
|
+
_See code: [src/commands/media/deploy-aspect.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/media/deploy-aspect.ts)_
|
|
2655
2650
|
|
|
2656
2651
|
## `sanity media export [DESTINATION]`
|
|
2657
2652
|
|
|
@@ -2692,7 +2687,7 @@ EXAMPLES
|
|
|
2692
2687
|
$ sanity media export --media-library-id my-library-id
|
|
2693
2688
|
```
|
|
2694
2689
|
|
|
2695
|
-
_See code: [src/commands/media/export.ts](https://github.com/sanity-io/cli/blob/v6.1
|
|
2690
|
+
_See code: [src/commands/media/export.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/media/export.ts)_
|
|
2696
2691
|
|
|
2697
2692
|
## `sanity media import SOURCE`
|
|
2698
2693
|
|
|
@@ -2730,15 +2725,15 @@ EXAMPLES
|
|
|
2730
2725
|
$ sanity media import products --replace-aspects
|
|
2731
2726
|
```
|
|
2732
2727
|
|
|
2733
|
-
_See code: [src/commands/media/import.ts](https://github.com/sanity-io/cli/blob/v6.1
|
|
2728
|
+
_See code: [src/commands/media/import.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/media/import.ts)_
|
|
2734
2729
|
|
|
2735
|
-
## `sanity
|
|
2730
|
+
## `sanity migrations create [TITLE]`
|
|
2736
2731
|
|
|
2737
2732
|
Create a new migration within your project
|
|
2738
2733
|
|
|
2739
2734
|
```
|
|
2740
2735
|
USAGE
|
|
2741
|
-
$ sanity
|
|
2736
|
+
$ sanity migrations create [TITLE]
|
|
2742
2737
|
|
|
2743
2738
|
ARGUMENTS
|
|
2744
2739
|
[TITLE] Title of migration
|
|
@@ -2749,22 +2744,22 @@ DESCRIPTION
|
|
|
2749
2744
|
EXAMPLES
|
|
2750
2745
|
Create a new migration, prompting for title and options
|
|
2751
2746
|
|
|
2752
|
-
$ sanity
|
|
2747
|
+
$ sanity migrations create
|
|
2753
2748
|
|
|
2754
2749
|
Create a new migration with the provided title, prompting for options
|
|
2755
2750
|
|
|
2756
|
-
$ sanity
|
|
2751
|
+
$ sanity migrations create "Rename field from location to address"
|
|
2757
2752
|
```
|
|
2758
2753
|
|
|
2759
|
-
_See code: [@sanity/migrate](https://github.com/sanity-io/migrate/blob/v6.
|
|
2754
|
+
_See code: [@sanity/migrate](https://github.com/sanity-io/migrate/blob/v6.1.0/src/commands/migrations/create.ts)_
|
|
2760
2755
|
|
|
2761
|
-
## `sanity
|
|
2756
|
+
## `sanity migrations list`
|
|
2762
2757
|
|
|
2763
2758
|
List available migrations
|
|
2764
2759
|
|
|
2765
2760
|
```
|
|
2766
2761
|
USAGE
|
|
2767
|
-
$ sanity
|
|
2762
|
+
$ sanity migrations list
|
|
2768
2763
|
|
|
2769
2764
|
DESCRIPTION
|
|
2770
2765
|
List available migrations
|
|
@@ -2772,18 +2767,18 @@ DESCRIPTION
|
|
|
2772
2767
|
EXAMPLES
|
|
2773
2768
|
List all available migrations in the project
|
|
2774
2769
|
|
|
2775
|
-
$ sanity
|
|
2770
|
+
$ sanity migrations list
|
|
2776
2771
|
```
|
|
2777
2772
|
|
|
2778
|
-
_See code: [@sanity/migrate](https://github.com/sanity-io/migrate/blob/v6.
|
|
2773
|
+
_See code: [@sanity/migrate](https://github.com/sanity-io/migrate/blob/v6.1.0/src/commands/migrations/list.ts)_
|
|
2779
2774
|
|
|
2780
|
-
## `sanity
|
|
2775
|
+
## `sanity migrations run [ID]`
|
|
2781
2776
|
|
|
2782
2777
|
Run a migration against a dataset
|
|
2783
2778
|
|
|
2784
2779
|
```
|
|
2785
2780
|
USAGE
|
|
2786
|
-
$ sanity
|
|
2781
|
+
$ sanity migrations run [ID] [--api-version <value>] [--concurrency <value>] [--confirm] [--dataset <value>]
|
|
2787
2782
|
[--dry-run] [--from-export <value>] [--progress] [--project <value>]
|
|
2788
2783
|
|
|
2789
2784
|
ARGUMENTS
|
|
@@ -2808,18 +2803,18 @@ DESCRIPTION
|
|
|
2808
2803
|
EXAMPLES
|
|
2809
2804
|
dry run the migration
|
|
2810
2805
|
|
|
2811
|
-
$ sanity
|
|
2806
|
+
$ sanity migrations run <id>
|
|
2812
2807
|
|
|
2813
2808
|
execute the migration against a dataset
|
|
2814
2809
|
|
|
2815
|
-
$ sanity
|
|
2810
|
+
$ sanity migrations run <id> --no-dry-run --project xyz --dataset staging
|
|
2816
2811
|
|
|
2817
2812
|
execute the migration using a dataset export as the source
|
|
2818
2813
|
|
|
2819
|
-
$ sanity
|
|
2814
|
+
$ sanity migrations run <id> --from-export=production.tar.gz --no-dry-run --project xyz --dataset staging
|
|
2820
2815
|
```
|
|
2821
2816
|
|
|
2822
|
-
_See code: [@sanity/migrate](https://github.com/sanity-io/migrate/blob/v6.
|
|
2817
|
+
_See code: [@sanity/migrate](https://github.com/sanity-io/migrate/blob/v6.1.0/src/commands/migrations/run.ts)_
|
|
2823
2818
|
|
|
2824
2819
|
## `sanity openapi get SLUG`
|
|
2825
2820
|
|
|
@@ -2858,7 +2853,7 @@ EXAMPLES
|
|
|
2858
2853
|
$ sanity openapi get query > query-api.yaml
|
|
2859
2854
|
```
|
|
2860
2855
|
|
|
2861
|
-
_See code: [src/commands/openapi/get.ts](https://github.com/sanity-io/cli/blob/v6.1
|
|
2856
|
+
_See code: [src/commands/openapi/get.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/openapi/get.ts)_
|
|
2862
2857
|
|
|
2863
2858
|
## `sanity openapi list`
|
|
2864
2859
|
|
|
@@ -2889,7 +2884,7 @@ EXAMPLES
|
|
|
2889
2884
|
$ sanity openapi list --web
|
|
2890
2885
|
```
|
|
2891
2886
|
|
|
2892
|
-
_See code: [src/commands/openapi/list.ts](https://github.com/sanity-io/cli/blob/v6.1
|
|
2887
|
+
_See code: [src/commands/openapi/list.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/openapi/list.ts)_
|
|
2893
2888
|
|
|
2894
2889
|
## `sanity preview [OUTPUTDIR]`
|
|
2895
2890
|
|
|
@@ -2917,7 +2912,7 @@ EXAMPLES
|
|
|
2917
2912
|
$ sanity preview some/build-output-dir
|
|
2918
2913
|
```
|
|
2919
2914
|
|
|
2920
|
-
_See code: [src/commands/preview.ts](https://github.com/sanity-io/cli/blob/v6.1
|
|
2915
|
+
_See code: [src/commands/preview.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/preview.ts)_
|
|
2921
2916
|
|
|
2922
2917
|
## `sanity projects create [PROJECTNAME]`
|
|
2923
2918
|
|
|
@@ -2965,7 +2960,7 @@ EXAMPLES
|
|
|
2965
2960
|
$ sanity projects create "CI Project" --yes --json
|
|
2966
2961
|
```
|
|
2967
2962
|
|
|
2968
|
-
_See code: [src/commands/projects/create.ts](https://github.com/sanity-io/cli/blob/v6.1
|
|
2963
|
+
_See code: [src/commands/projects/create.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/projects/create.ts)_
|
|
2969
2964
|
|
|
2970
2965
|
## `sanity projects list`
|
|
2971
2966
|
|
|
@@ -2994,15 +2989,15 @@ EXAMPLES
|
|
|
2994
2989
|
$ sanity projects list --sort=members --order=asc
|
|
2995
2990
|
```
|
|
2996
2991
|
|
|
2997
|
-
_See code: [src/commands/projects/list.ts](https://github.com/sanity-io/cli/blob/v6.1
|
|
2992
|
+
_See code: [src/commands/projects/list.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/projects/list.ts)_
|
|
2998
2993
|
|
|
2999
|
-
## `sanity
|
|
2994
|
+
## `sanity schemas delete`
|
|
3000
2995
|
|
|
3001
2996
|
Delete schema documents by id
|
|
3002
2997
|
|
|
3003
2998
|
```
|
|
3004
2999
|
USAGE
|
|
3005
|
-
$ sanity
|
|
3000
|
+
$ sanity schemas delete --ids <value> [-p <id>] [-d <name>] [--verbose]
|
|
3006
3001
|
|
|
3007
3002
|
FLAGS
|
|
3008
3003
|
-d, --dataset=<name> Delete schemas from a specific dataset
|
|
@@ -3018,22 +3013,23 @@ DESCRIPTION
|
|
|
3018
3013
|
EXAMPLES
|
|
3019
3014
|
Delete a single schema
|
|
3020
3015
|
|
|
3021
|
-
$ sanity
|
|
3016
|
+
$ sanity schemas delete --ids sanity.workspace.schema.workspaceName
|
|
3022
3017
|
|
|
3023
3018
|
Delete multiple schemas
|
|
3024
3019
|
|
|
3025
|
-
$ sanity
|
|
3020
|
+
$ sanity schemas delete --ids \
|
|
3021
|
+
sanity.workspace.schema.workspaceName,prefix.sanity.workspace.schema.otherWorkspace
|
|
3026
3022
|
```
|
|
3027
3023
|
|
|
3028
|
-
_See code: [src/commands/
|
|
3024
|
+
_See code: [src/commands/schemas/delete.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/schemas/delete.ts)_
|
|
3029
3025
|
|
|
3030
|
-
## `sanity
|
|
3026
|
+
## `sanity schemas deploy`
|
|
3031
3027
|
|
|
3032
3028
|
Deploy schema documents into workspace datasets.
|
|
3033
3029
|
|
|
3034
3030
|
```
|
|
3035
3031
|
USAGE
|
|
3036
|
-
$ sanity
|
|
3032
|
+
$ sanity schemas deploy [--extract-manifest] [--manifest-dir <directory>] [--tag <tag>] [--verbose] [--workspace
|
|
3037
3033
|
<name>]
|
|
3038
3034
|
|
|
3039
3035
|
FLAGS
|
|
@@ -3054,22 +3050,22 @@ DESCRIPTION
|
|
|
3054
3050
|
EXAMPLES
|
|
3055
3051
|
Deploy all workspace schemas
|
|
3056
3052
|
|
|
3057
|
-
$ sanity
|
|
3053
|
+
$ sanity schemas deploy
|
|
3058
3054
|
|
|
3059
3055
|
Deploy the schema for only the workspace "default"
|
|
3060
3056
|
|
|
3061
|
-
$ sanity
|
|
3057
|
+
$ sanity schemas deploy --workspace default
|
|
3062
3058
|
```
|
|
3063
3059
|
|
|
3064
|
-
_See code: [src/commands/
|
|
3060
|
+
_See code: [src/commands/schemas/deploy.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/schemas/deploy.ts)_
|
|
3065
3061
|
|
|
3066
|
-
## `sanity
|
|
3062
|
+
## `sanity schemas extract`
|
|
3067
3063
|
|
|
3068
3064
|
Extracts a JSON representation of a Sanity schema within a Studio context.
|
|
3069
3065
|
|
|
3070
3066
|
```
|
|
3071
3067
|
USAGE
|
|
3072
|
-
$ sanity
|
|
3068
|
+
$ sanity schemas extract [--enforce-required-fields] [--format <format>] [--path <value>] [--watch]
|
|
3073
3069
|
[--watch-patterns <glob>...] [--workspace <name>]
|
|
3074
3070
|
|
|
3075
3071
|
FLAGS
|
|
@@ -3089,26 +3085,26 @@ DESCRIPTION
|
|
|
3089
3085
|
EXAMPLES
|
|
3090
3086
|
Extracts schema types in a Sanity project with more than one workspace
|
|
3091
3087
|
|
|
3092
|
-
$ sanity
|
|
3088
|
+
$ sanity schemas extract --workspace default
|
|
3093
3089
|
|
|
3094
3090
|
Watch mode - re-extract on changes
|
|
3095
3091
|
|
|
3096
|
-
$ sanity
|
|
3092
|
+
$ sanity schemas extract --watch
|
|
3097
3093
|
|
|
3098
3094
|
Watch with custom glob patterns
|
|
3099
3095
|
|
|
3100
|
-
$ sanity
|
|
3096
|
+
$ sanity schemas extract --watch --watch-patterns "lib/**/*.ts"
|
|
3101
3097
|
```
|
|
3102
3098
|
|
|
3103
|
-
_See code: [src/commands/
|
|
3099
|
+
_See code: [src/commands/schemas/extract.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/schemas/extract.ts)_
|
|
3104
3100
|
|
|
3105
|
-
## `sanity
|
|
3101
|
+
## `sanity schemas list`
|
|
3106
3102
|
|
|
3107
3103
|
Lists all schemas in the current dataset.
|
|
3108
3104
|
|
|
3109
3105
|
```
|
|
3110
3106
|
USAGE
|
|
3111
|
-
$ sanity
|
|
3107
|
+
$ sanity schemas list [--id <schema_id>] [--json]
|
|
3112
3108
|
|
|
3113
3109
|
FLAGS
|
|
3114
3110
|
--id=<schema_id> Fetch a single schema by id
|
|
@@ -3125,30 +3121,30 @@ DESCRIPTION
|
|
|
3125
3121
|
EXAMPLES
|
|
3126
3122
|
List all schemas found in any workspace dataset in a table
|
|
3127
3123
|
|
|
3128
|
-
$ sanity
|
|
3124
|
+
$ sanity schemas list
|
|
3129
3125
|
|
|
3130
3126
|
Get a schema for a given id
|
|
3131
3127
|
|
|
3132
|
-
$ sanity
|
|
3128
|
+
$ sanity schemas list --id _.schemas.workspaceName
|
|
3133
3129
|
|
|
3134
3130
|
Get stored schemas as pretty-printed json-array
|
|
3135
3131
|
|
|
3136
|
-
$ sanity
|
|
3132
|
+
$ sanity schemas list --json
|
|
3137
3133
|
|
|
3138
3134
|
Get singular stored schema as pretty-printed json-object
|
|
3139
3135
|
|
|
3140
|
-
$ sanity
|
|
3136
|
+
$ sanity schemas list --json --id _.schemas.workspaceName
|
|
3141
3137
|
```
|
|
3142
3138
|
|
|
3143
|
-
_See code: [src/commands/
|
|
3139
|
+
_See code: [src/commands/schemas/list.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/schemas/list.ts)_
|
|
3144
3140
|
|
|
3145
|
-
## `sanity
|
|
3141
|
+
## `sanity schemas validate`
|
|
3146
3142
|
|
|
3147
3143
|
Validates all schema types specified in a workspace
|
|
3148
3144
|
|
|
3149
3145
|
```
|
|
3150
3146
|
USAGE
|
|
3151
|
-
$ sanity
|
|
3147
|
+
$ sanity schemas validate [--debug-metafile-path <value>] [--format pretty|ndjson|json] [--level error|warning]
|
|
3152
3148
|
[--workspace <value>]
|
|
3153
3149
|
|
|
3154
3150
|
FLAGS
|
|
@@ -3168,22 +3164,22 @@ DESCRIPTION
|
|
|
3168
3164
|
EXAMPLES
|
|
3169
3165
|
Validates all schema types in a Sanity project with more than one workspace
|
|
3170
3166
|
|
|
3171
|
-
$ sanity
|
|
3167
|
+
$ sanity schemas validate --workspace default
|
|
3172
3168
|
|
|
3173
3169
|
Save the results of the report into a file
|
|
3174
3170
|
|
|
3175
|
-
$ sanity
|
|
3171
|
+
$ sanity schemas validate > report.txt
|
|
3176
3172
|
|
|
3177
3173
|
Report out only errors
|
|
3178
3174
|
|
|
3179
|
-
$ sanity
|
|
3175
|
+
$ sanity schemas validate --level error
|
|
3180
3176
|
|
|
3181
3177
|
Generate a report which can be analyzed with https://esbuild.github.io/analyze/
|
|
3182
3178
|
|
|
3183
|
-
$ sanity
|
|
3179
|
+
$ sanity schemas validate --debug-metafile-path metafile.json
|
|
3184
3180
|
```
|
|
3185
3181
|
|
|
3186
|
-
_See code: [src/commands/
|
|
3182
|
+
_See code: [src/commands/schemas/validate.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/schemas/validate.ts)_
|
|
3187
3183
|
|
|
3188
3184
|
## `sanity telemetry disable`
|
|
3189
3185
|
|
|
@@ -3202,7 +3198,7 @@ EXAMPLES
|
|
|
3202
3198
|
$ sanity telemetry telemetry disable
|
|
3203
3199
|
```
|
|
3204
3200
|
|
|
3205
|
-
_See code: [src/commands/telemetry/disable.ts](https://github.com/sanity-io/cli/blob/v6.1
|
|
3201
|
+
_See code: [src/commands/telemetry/disable.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/telemetry/disable.ts)_
|
|
3206
3202
|
|
|
3207
3203
|
## `sanity telemetry enable`
|
|
3208
3204
|
|
|
@@ -3221,7 +3217,7 @@ EXAMPLES
|
|
|
3221
3217
|
$ sanity telemetry telemetry enable
|
|
3222
3218
|
```
|
|
3223
3219
|
|
|
3224
|
-
_See code: [src/commands/telemetry/enable.ts](https://github.com/sanity-io/cli/blob/v6.1
|
|
3220
|
+
_See code: [src/commands/telemetry/enable.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/telemetry/enable.ts)_
|
|
3225
3221
|
|
|
3226
3222
|
## `sanity telemetry status`
|
|
3227
3223
|
|
|
@@ -3240,7 +3236,7 @@ EXAMPLES
|
|
|
3240
3236
|
$ sanity telemetry telemetry status
|
|
3241
3237
|
```
|
|
3242
3238
|
|
|
3243
|
-
_See code: [src/commands/telemetry/status.ts](https://github.com/sanity-io/cli/blob/v6.1
|
|
3239
|
+
_See code: [src/commands/telemetry/status.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/telemetry/status.ts)_
|
|
3244
3240
|
|
|
3245
3241
|
## `sanity tokens add [LABEL]`
|
|
3246
3242
|
|
|
@@ -3286,7 +3282,7 @@ EXAMPLES
|
|
|
3286
3282
|
$ sanity tokens add "My Token" --project-id abc123 --role=editor
|
|
3287
3283
|
```
|
|
3288
3284
|
|
|
3289
|
-
_See code: [src/commands/tokens/add.ts](https://github.com/sanity-io/cli/blob/v6.1
|
|
3285
|
+
_See code: [src/commands/tokens/add.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/tokens/add.ts)_
|
|
3290
3286
|
|
|
3291
3287
|
## `sanity tokens delete [TOKENID]`
|
|
3292
3288
|
|
|
@@ -3326,7 +3322,7 @@ EXAMPLES
|
|
|
3326
3322
|
$ sanity tokens delete --project-id abc123
|
|
3327
3323
|
```
|
|
3328
3324
|
|
|
3329
|
-
_See code: [src/commands/tokens/delete.ts](https://github.com/sanity-io/cli/blob/v6.1
|
|
3325
|
+
_See code: [src/commands/tokens/delete.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/tokens/delete.ts)_
|
|
3330
3326
|
|
|
3331
3327
|
## `sanity tokens list`
|
|
3332
3328
|
|
|
@@ -3359,7 +3355,7 @@ EXAMPLES
|
|
|
3359
3355
|
$ sanity tokens list --project-id abc123
|
|
3360
3356
|
```
|
|
3361
3357
|
|
|
3362
|
-
_See code: [src/commands/tokens/list.ts](https://github.com/sanity-io/cli/blob/v6.1
|
|
3358
|
+
_See code: [src/commands/tokens/list.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/tokens/list.ts)_
|
|
3363
3359
|
|
|
3364
3360
|
## `sanity typegen generate`
|
|
3365
3361
|
|
|
@@ -3422,7 +3418,7 @@ DESCRIPTION
|
|
|
3422
3418
|
Removes the deployed Sanity Studio/App from Sanity hosting
|
|
3423
3419
|
```
|
|
3424
3420
|
|
|
3425
|
-
_See code: [src/commands/undeploy.ts](https://github.com/sanity-io/cli/blob/v6.1
|
|
3421
|
+
_See code: [src/commands/undeploy.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/undeploy.ts)_
|
|
3426
3422
|
|
|
3427
3423
|
## `sanity users invite [EMAIL]`
|
|
3428
3424
|
|
|
@@ -3462,7 +3458,7 @@ EXAMPLES
|
|
|
3462
3458
|
$ sanity users invite pippi@sanity.io --project-id abc123
|
|
3463
3459
|
```
|
|
3464
3460
|
|
|
3465
|
-
_See code: [src/commands/users/invite.ts](https://github.com/sanity-io/cli/blob/v6.1
|
|
3461
|
+
_See code: [src/commands/users/invite.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/users/invite.ts)_
|
|
3466
3462
|
|
|
3467
3463
|
## `sanity users list`
|
|
3468
3464
|
|
|
@@ -3504,7 +3500,7 @@ EXAMPLES
|
|
|
3504
3500
|
$ sanity users list --project-id abc123
|
|
3505
3501
|
```
|
|
3506
3502
|
|
|
3507
|
-
_See code: [src/commands/users/list.ts](https://github.com/sanity-io/cli/blob/v6.1
|
|
3503
|
+
_See code: [src/commands/users/list.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/users/list.ts)_
|
|
3508
3504
|
|
|
3509
3505
|
## `sanity versions`
|
|
3510
3506
|
|
|
@@ -3521,6 +3517,6 @@ EXAMPLES
|
|
|
3521
3517
|
$ sanity versions
|
|
3522
3518
|
```
|
|
3523
3519
|
|
|
3524
|
-
_See code: [src/commands/versions.ts](https://github.com/sanity-io/cli/blob/v6.1
|
|
3520
|
+
_See code: [src/commands/versions.ts](https://github.com/sanity-io/cli/blob/v6.2.1/src/commands/versions.ts)_
|
|
3525
3521
|
|
|
3526
3522
|
<!-- commandsstop -->
|