@sanity/cli 6.1.8 → 6.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +301 -294
- package/dist/actions/debug/gatherDebugInfo.js +130 -81
- package/dist/actions/debug/gatherDebugInfo.js.map +1 -1
- package/dist/actions/debug/output.js +25 -0
- package/dist/actions/debug/output.js.map +1 -0
- package/dist/actions/debug/types.js.map +1 -1
- package/dist/actions/manifest/__tests__/testHelpers.js +21 -0
- package/dist/actions/manifest/__tests__/testHelpers.js.map +1 -0
- package/dist/actions/manifest/schemaTypeTransformer.js +2 -1
- package/dist/actions/manifest/schemaTypeTransformer.js.map +1 -1
- package/dist/actions/mcp/setupMCP.js +5 -5
- package/dist/actions/mcp/setupMCP.js.map +1 -1
- package/dist/actions/schema/getExtractOptions.js.map +1 -1
- package/dist/commands/{backup → backups}/disable.js +3 -0
- package/dist/commands/backups/disable.js.map +1 -0
- package/dist/commands/{backup → backups}/download.js +3 -0
- package/dist/commands/backups/download.js.map +1 -0
- package/dist/commands/{backup → backups}/enable.js +3 -0
- package/dist/commands/backups/enable.js.map +1 -0
- package/dist/commands/{backup → backups}/list.js +3 -0
- package/dist/commands/backups/list.js.map +1 -0
- package/dist/commands/{dataset → datasets}/alias/create.js +3 -0
- package/dist/commands/datasets/alias/create.js.map +1 -0
- package/dist/commands/{dataset → datasets}/alias/delete.js +3 -0
- package/dist/commands/datasets/alias/delete.js.map +1 -0
- package/dist/commands/{dataset → datasets}/alias/link.js +3 -0
- package/dist/commands/datasets/alias/link.js.map +1 -0
- package/dist/commands/{dataset → datasets}/alias/unlink.js +3 -0
- package/dist/commands/datasets/alias/unlink.js.map +1 -0
- package/dist/commands/{dataset → datasets}/copy.js +3 -0
- package/dist/commands/datasets/copy.js.map +1 -0
- package/dist/commands/{dataset → datasets}/create.js +3 -0
- package/dist/commands/datasets/create.js.map +1 -0
- package/dist/commands/{dataset → datasets}/delete.js +3 -0
- package/dist/commands/datasets/delete.js.map +1 -0
- package/dist/commands/{dataset → datasets}/embeddings/disable.js +3 -0
- package/dist/commands/datasets/embeddings/disable.js.map +1 -0
- package/dist/commands/{dataset → datasets}/embeddings/enable.js +3 -0
- package/dist/commands/datasets/embeddings/enable.js.map +1 -0
- package/dist/commands/{dataset → datasets}/embeddings/status.js +3 -0
- package/dist/commands/datasets/embeddings/status.js.map +1 -0
- package/dist/commands/{dataset → datasets}/export.js +3 -0
- package/dist/commands/datasets/export.js.map +1 -0
- package/dist/commands/{dataset → datasets}/import.js +14 -10
- package/dist/commands/datasets/import.js.map +1 -0
- package/dist/commands/{dataset → datasets}/list.js +3 -0
- package/dist/commands/datasets/list.js.map +1 -0
- package/dist/commands/{dataset → datasets}/visibility/get.js +3 -0
- package/dist/commands/datasets/visibility/get.js.map +1 -0
- package/dist/commands/{dataset → datasets}/visibility/set.js +3 -0
- package/dist/commands/datasets/visibility/set.js.map +1 -0
- package/dist/commands/debug.js +189 -74
- package/dist/commands/debug.js.map +1 -1
- package/dist/commands/documents/create.js +3 -0
- package/dist/commands/documents/create.js.map +1 -1
- package/dist/commands/documents/delete.js +3 -0
- package/dist/commands/documents/delete.js.map +1 -1
- package/dist/commands/documents/get.js +3 -0
- package/dist/commands/documents/get.js.map +1 -1
- package/dist/commands/documents/query.js +3 -0
- package/dist/commands/documents/query.js.map +1 -1
- package/dist/commands/documents/validate.js +3 -0
- package/dist/commands/documents/validate.js.map +1 -1
- package/dist/commands/{hook → hooks}/attempt.js +3 -0
- package/dist/commands/hooks/attempt.js.map +1 -0
- package/dist/commands/{hook → hooks}/create.js +3 -0
- package/dist/commands/hooks/create.js.map +1 -0
- package/dist/commands/{hook → hooks}/delete.js +3 -0
- package/dist/commands/hooks/delete.js.map +1 -0
- package/dist/commands/{hook → hooks}/list.js +3 -0
- package/dist/commands/hooks/list.js.map +1 -0
- package/dist/commands/{hook → hooks}/logs.js +3 -0
- package/dist/commands/hooks/logs.js.map +1 -0
- package/dist/commands/init.js +65 -13
- package/dist/commands/init.js.map +1 -1
- package/dist/commands/mcp/configure.js +3 -2
- package/dist/commands/mcp/configure.js.map +1 -1
- package/dist/commands/preview.js +1 -0
- package/dist/commands/preview.js.map +1 -1
- package/dist/commands/projects/create.js +3 -0
- package/dist/commands/projects/create.js.map +1 -1
- package/dist/commands/projects/list.js +3 -0
- package/dist/commands/projects/list.js.map +1 -1
- package/dist/commands/{schema → schemas}/delete.js +3 -0
- package/dist/commands/schemas/delete.js.map +1 -0
- package/dist/commands/{schema → schemas}/deploy.js +3 -0
- package/dist/commands/schemas/deploy.js.map +1 -0
- package/dist/commands/{schema → schemas}/extract.js +3 -0
- package/dist/commands/schemas/extract.js.map +1 -0
- package/dist/commands/{schema → schemas}/list.js +3 -0
- package/dist/commands/schemas/list.js.map +1 -0
- package/dist/commands/{schema → schemas}/validate.js +3 -0
- package/dist/commands/schemas/validate.js.map +1 -0
- package/dist/commands/tokens/add.js +3 -0
- package/dist/commands/tokens/add.js.map +1 -1
- package/dist/commands/tokens/delete.js +3 -0
- package/dist/commands/tokens/delete.js.map +1 -1
- package/dist/commands/tokens/list.js +3 -0
- package/dist/commands/tokens/list.js.map +1 -1
- package/dist/commands/users/invite.js +3 -0
- package/dist/commands/users/invite.js.map +1 -1
- package/dist/commands/users/list.js +3 -0
- package/dist/commands/users/list.js.map +1 -1
- package/dist/hooks/commandNotFound/topicAliases.js +71 -0
- package/dist/hooks/commandNotFound/topicAliases.js.map +1 -0
- package/dist/services/telemetry.js +23 -2
- package/dist/services/telemetry.js.map +1 -1
- package/dist/topicAliases.js +51 -0
- package/dist/topicAliases.js.map +1 -0
- package/dist/util/packageManager/packageManagerChoice.js +1 -2
- package/dist/util/packageManager/packageManagerChoice.js.map +1 -1
- package/oclif.config.js +20 -7
- package/oclif.manifest.json +478 -362
- package/package.json +17 -16
- package/dist/actions/debug/formatters.js +0 -22
- package/dist/actions/debug/formatters.js.map +0 -1
- package/dist/actions/debug/getGlobalConfigLocation.js +0 -7
- package/dist/actions/debug/getGlobalConfigLocation.js.map +0 -1
- package/dist/commands/backup/disable.js.map +0 -1
- package/dist/commands/backup/download.js.map +0 -1
- package/dist/commands/backup/enable.js.map +0 -1
- package/dist/commands/backup/list.js.map +0 -1
- package/dist/commands/dataset/alias/create.js.map +0 -1
- package/dist/commands/dataset/alias/delete.js.map +0 -1
- package/dist/commands/dataset/alias/link.js.map +0 -1
- package/dist/commands/dataset/alias/unlink.js.map +0 -1
- package/dist/commands/dataset/copy.js.map +0 -1
- package/dist/commands/dataset/create.js.map +0 -1
- package/dist/commands/dataset/delete.js.map +0 -1
- package/dist/commands/dataset/embeddings/disable.js.map +0 -1
- package/dist/commands/dataset/embeddings/enable.js.map +0 -1
- package/dist/commands/dataset/embeddings/status.js.map +0 -1
- package/dist/commands/dataset/export.js.map +0 -1
- package/dist/commands/dataset/import.js.map +0 -1
- package/dist/commands/dataset/list.js.map +0 -1
- package/dist/commands/dataset/visibility/get.js.map +0 -1
- package/dist/commands/dataset/visibility/set.js.map +0 -1
- package/dist/commands/hook/attempt.js.map +0 -1
- package/dist/commands/hook/create.js.map +0 -1
- package/dist/commands/hook/delete.js.map +0 -1
- package/dist/commands/hook/list.js.map +0 -1
- package/dist/commands/hook/logs.js.map +0 -1
- package/dist/commands/schema/delete.js.map +0 -1
- package/dist/commands/schema/deploy.js.map +0 -1
- package/dist/commands/schema/extract.js.map +0 -1
- package/dist/commands/schema/list.js.map +0 -1
- package/dist/commands/schema/validate.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.0/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.0/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.0/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.0/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.6.1/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.6.1/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.6.1/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.6.1/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.6.1/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.6.1/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.6.1/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.6.1/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.6.1/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.6.1/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.
|
|
633
|
+
_See code: [src/commands/build.ts](https://github.com/sanity-io/cli/blob/v6.2.0/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.
|
|
664
|
+
_See code: [src/commands/codemod.ts](https://github.com/sanity-io/cli/blob/v6.2.0/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.
|
|
704
|
+
_See code: [src/commands/cors/add.ts](https://github.com/sanity-io/cli/blob/v6.2.0/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.
|
|
737
|
+
_See code: [src/commands/cors/delete.ts](https://github.com/sanity-io/cli/blob/v6.2.0/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.
|
|
763
|
+
_See code: [src/commands/cors/list.ts](https://github.com/sanity-io/cli/blob/v6.2.0/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,34 @@ 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
|
|
798
|
+
$ sanity datasets alias create conference conf-2025
|
|
799
799
|
|
|
800
800
|
Create alias with explicit ~ prefix
|
|
801
801
|
|
|
802
|
-
$ sanity
|
|
802
|
+
$ sanity datasets alias create ~conference conf-2025
|
|
803
803
|
```
|
|
804
804
|
|
|
805
|
-
_See code: [src/commands/
|
|
805
|
+
_See code: [src/commands/datasets/alias/create.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/datasets/alias/create.ts)_
|
|
806
806
|
|
|
807
|
-
## `sanity
|
|
807
|
+
## `sanity datasets alias delete ALIASNAME`
|
|
808
808
|
|
|
809
809
|
Delete a dataset alias within your project
|
|
810
810
|
|
|
811
811
|
```
|
|
812
812
|
USAGE
|
|
813
|
-
$ sanity
|
|
813
|
+
$ sanity datasets alias delete ALIASNAME [-p <id>] [--force]
|
|
814
814
|
|
|
815
815
|
ARGUMENTS
|
|
816
816
|
ALIASNAME Dataset alias name to delete
|
|
@@ -827,26 +827,26 @@ DESCRIPTION
|
|
|
827
827
|
EXAMPLES
|
|
828
828
|
Delete alias named "conference" with confirmation prompt
|
|
829
829
|
|
|
830
|
-
$ sanity
|
|
830
|
+
$ sanity datasets alias delete conference
|
|
831
831
|
|
|
832
832
|
Delete alias with explicit ~ prefix
|
|
833
833
|
|
|
834
|
-
$ sanity
|
|
834
|
+
$ sanity datasets alias delete ~conference
|
|
835
835
|
|
|
836
836
|
Delete alias named "conference" without confirmation prompt
|
|
837
837
|
|
|
838
|
-
$ sanity
|
|
838
|
+
$ sanity datasets alias delete conference --force
|
|
839
839
|
```
|
|
840
840
|
|
|
841
|
-
_See code: [src/commands/
|
|
841
|
+
_See code: [src/commands/datasets/alias/delete.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/datasets/alias/delete.ts)_
|
|
842
842
|
|
|
843
|
-
## `sanity
|
|
843
|
+
## `sanity datasets alias link [ALIASNAME] [TARGETDATASET]`
|
|
844
844
|
|
|
845
845
|
Link a dataset alias to a dataset within your project
|
|
846
846
|
|
|
847
847
|
```
|
|
848
848
|
USAGE
|
|
849
|
-
$ sanity
|
|
849
|
+
$ sanity datasets alias link [ALIASNAME] [TARGETDATASET] [-p <id>] [--force]
|
|
850
850
|
|
|
851
851
|
ARGUMENTS
|
|
852
852
|
[ALIASNAME] Dataset alias name to link
|
|
@@ -864,34 +864,34 @@ DESCRIPTION
|
|
|
864
864
|
EXAMPLES
|
|
865
865
|
Link an alias with interactive prompts
|
|
866
866
|
|
|
867
|
-
$ sanity
|
|
867
|
+
$ sanity datasets alias link
|
|
868
868
|
|
|
869
869
|
Link alias named "conference" with interactive dataset selection
|
|
870
870
|
|
|
871
|
-
$ sanity
|
|
871
|
+
$ sanity datasets alias link conference
|
|
872
872
|
|
|
873
873
|
Link alias "conference" to "conf-2025" dataset
|
|
874
874
|
|
|
875
|
-
$ sanity
|
|
875
|
+
$ sanity datasets alias link conference conf-2025
|
|
876
876
|
|
|
877
877
|
Link alias with explicit ~ prefix
|
|
878
878
|
|
|
879
|
-
$ sanity
|
|
879
|
+
$ sanity datasets alias link ~conference conf-2025
|
|
880
880
|
|
|
881
881
|
Force link without confirmation (skip relink prompt)
|
|
882
882
|
|
|
883
|
-
$ sanity
|
|
883
|
+
$ sanity datasets alias link conference conf-2025 --force
|
|
884
884
|
```
|
|
885
885
|
|
|
886
|
-
_See code: [src/commands/
|
|
886
|
+
_See code: [src/commands/datasets/alias/link.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/datasets/alias/link.ts)_
|
|
887
887
|
|
|
888
|
-
## `sanity
|
|
888
|
+
## `sanity datasets alias unlink [ALIASNAME]`
|
|
889
889
|
|
|
890
890
|
Unlink a dataset alias from its dataset within your project
|
|
891
891
|
|
|
892
892
|
```
|
|
893
893
|
USAGE
|
|
894
|
-
$ sanity
|
|
894
|
+
$ sanity datasets alias unlink [ALIASNAME] [-p <id>] [--force]
|
|
895
895
|
|
|
896
896
|
ARGUMENTS
|
|
897
897
|
[ALIASNAME] Dataset alias name to unlink
|
|
@@ -908,30 +908,30 @@ DESCRIPTION
|
|
|
908
908
|
EXAMPLES
|
|
909
909
|
Unlink an alias with interactive selection
|
|
910
910
|
|
|
911
|
-
$ sanity
|
|
911
|
+
$ sanity datasets alias unlink
|
|
912
912
|
|
|
913
913
|
Unlink alias "conference" with confirmation prompt
|
|
914
914
|
|
|
915
|
-
$ sanity
|
|
915
|
+
$ sanity datasets alias unlink conference
|
|
916
916
|
|
|
917
917
|
Unlink alias with explicit ~ prefix
|
|
918
918
|
|
|
919
|
-
$ sanity
|
|
919
|
+
$ sanity datasets alias unlink ~conference
|
|
920
920
|
|
|
921
921
|
Unlink alias "conference" without confirmation prompt
|
|
922
922
|
|
|
923
|
-
$ sanity
|
|
923
|
+
$ sanity datasets alias unlink conference --force
|
|
924
924
|
```
|
|
925
925
|
|
|
926
|
-
_See code: [src/commands/
|
|
926
|
+
_See code: [src/commands/datasets/alias/unlink.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/datasets/alias/unlink.ts)_
|
|
927
927
|
|
|
928
|
-
## `sanity
|
|
928
|
+
## `sanity datasets copy [SOURCE] [TARGET]`
|
|
929
929
|
|
|
930
930
|
Manages dataset copying, including starting a new copy job, listing copy jobs and following the progress of a running copy job
|
|
931
931
|
|
|
932
932
|
```
|
|
933
933
|
USAGE
|
|
934
|
-
$ sanity
|
|
934
|
+
$ sanity datasets copy [SOURCE] [TARGET] [-p <id>] [--attach <value> | --list | --detach | --skip-history]
|
|
935
935
|
[--limit <value> ] [--offset <value> ]
|
|
936
936
|
|
|
937
937
|
ARGUMENTS
|
|
@@ -956,46 +956,46 @@ DESCRIPTION
|
|
|
956
956
|
EXAMPLES
|
|
957
957
|
Interactively copy a dataset
|
|
958
958
|
|
|
959
|
-
$ sanity
|
|
959
|
+
$ sanity datasets copy
|
|
960
960
|
|
|
961
961
|
Copy from source-dataset (prompts for target)
|
|
962
962
|
|
|
963
|
-
$ sanity
|
|
963
|
+
$ sanity datasets copy source-dataset
|
|
964
964
|
|
|
965
965
|
Copy from source-dataset to target-dataset
|
|
966
966
|
|
|
967
|
-
$ sanity
|
|
967
|
+
$ sanity datasets copy source-dataset target-dataset
|
|
968
968
|
|
|
969
969
|
Copy without preserving document history (faster for large datasets)
|
|
970
970
|
|
|
971
|
-
$ sanity
|
|
971
|
+
$ sanity datasets copy --skip-history source target
|
|
972
972
|
|
|
973
973
|
Start copy job without waiting for completion
|
|
974
974
|
|
|
975
|
-
$ sanity
|
|
975
|
+
$ sanity datasets copy --detach source target
|
|
976
976
|
|
|
977
977
|
Attach to a running copy job to follow progress
|
|
978
978
|
|
|
979
|
-
$ sanity
|
|
979
|
+
$ sanity datasets copy --attach <job-id>
|
|
980
980
|
|
|
981
981
|
List all dataset copy jobs
|
|
982
982
|
|
|
983
|
-
$ sanity
|
|
983
|
+
$ sanity datasets copy --list
|
|
984
984
|
|
|
985
985
|
List copy jobs with pagination
|
|
986
986
|
|
|
987
|
-
$ sanity
|
|
987
|
+
$ sanity datasets copy --list --offset 2 --limit 10
|
|
988
988
|
```
|
|
989
989
|
|
|
990
|
-
_See code: [src/commands/
|
|
990
|
+
_See code: [src/commands/datasets/copy.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/datasets/copy.ts)_
|
|
991
991
|
|
|
992
|
-
## `sanity
|
|
992
|
+
## `sanity datasets create [NAME]`
|
|
993
993
|
|
|
994
994
|
Create a new dataset within your project
|
|
995
995
|
|
|
996
996
|
```
|
|
997
997
|
USAGE
|
|
998
|
-
$ sanity
|
|
998
|
+
$ sanity datasets create [NAME] [-p <id>] [--embeddings-projection <value> --embeddings] [--visibility
|
|
999
999
|
custom|private|public]
|
|
1000
1000
|
|
|
1001
1001
|
ARGUMENTS
|
|
@@ -1016,26 +1016,26 @@ DESCRIPTION
|
|
|
1016
1016
|
EXAMPLES
|
|
1017
1017
|
Interactively create a dataset
|
|
1018
1018
|
|
|
1019
|
-
$ sanity
|
|
1019
|
+
$ sanity datasets create
|
|
1020
1020
|
|
|
1021
1021
|
Create a dataset named "my-dataset"
|
|
1022
1022
|
|
|
1023
|
-
$ sanity
|
|
1023
|
+
$ sanity datasets create my-dataset
|
|
1024
1024
|
|
|
1025
1025
|
Create a private dataset named "my-dataset"
|
|
1026
1026
|
|
|
1027
|
-
$ sanity
|
|
1027
|
+
$ sanity datasets create my-dataset --visibility private
|
|
1028
1028
|
```
|
|
1029
1029
|
|
|
1030
|
-
_See code: [src/commands/
|
|
1030
|
+
_See code: [src/commands/datasets/create.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/datasets/create.ts)_
|
|
1031
1031
|
|
|
1032
|
-
## `sanity
|
|
1032
|
+
## `sanity datasets delete DATASETNAME`
|
|
1033
1033
|
|
|
1034
1034
|
Delete a dataset within your project
|
|
1035
1035
|
|
|
1036
1036
|
```
|
|
1037
1037
|
USAGE
|
|
1038
|
-
$ sanity
|
|
1038
|
+
$ sanity datasets delete DATASETNAME [-p <id>] [--force]
|
|
1039
1039
|
|
|
1040
1040
|
ARGUMENTS
|
|
1041
1041
|
DATASETNAME Dataset name to delete
|
|
@@ -1052,22 +1052,22 @@ DESCRIPTION
|
|
|
1052
1052
|
EXAMPLES
|
|
1053
1053
|
Delete a specific dataset
|
|
1054
1054
|
|
|
1055
|
-
$ sanity
|
|
1055
|
+
$ sanity datasets delete my-dataset
|
|
1056
1056
|
|
|
1057
1057
|
Delete a specific dataset without confirmation
|
|
1058
1058
|
|
|
1059
|
-
$ sanity
|
|
1059
|
+
$ sanity datasets delete my-dataset --force
|
|
1060
1060
|
```
|
|
1061
1061
|
|
|
1062
|
-
_See code: [src/commands/
|
|
1062
|
+
_See code: [src/commands/datasets/delete.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/datasets/delete.ts)_
|
|
1063
1063
|
|
|
1064
|
-
## `sanity
|
|
1064
|
+
## `sanity datasets embeddings disable [DATASET]`
|
|
1065
1065
|
|
|
1066
1066
|
Disable embeddings for a dataset
|
|
1067
1067
|
|
|
1068
1068
|
```
|
|
1069
1069
|
USAGE
|
|
1070
|
-
$ sanity
|
|
1070
|
+
$ sanity datasets embeddings disable [DATASET] [-p <id>]
|
|
1071
1071
|
|
|
1072
1072
|
ARGUMENTS
|
|
1073
1073
|
[DATASET] Dataset name to disable embeddings for
|
|
@@ -1081,18 +1081,18 @@ DESCRIPTION
|
|
|
1081
1081
|
EXAMPLES
|
|
1082
1082
|
Disable embeddings for the production dataset
|
|
1083
1083
|
|
|
1084
|
-
$ sanity
|
|
1084
|
+
$ sanity datasets embeddings disable production
|
|
1085
1085
|
```
|
|
1086
1086
|
|
|
1087
|
-
_See code: [src/commands/
|
|
1087
|
+
_See code: [src/commands/datasets/embeddings/disable.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/datasets/embeddings/disable.ts)_
|
|
1088
1088
|
|
|
1089
|
-
## `sanity
|
|
1089
|
+
## `sanity datasets embeddings enable [DATASET]`
|
|
1090
1090
|
|
|
1091
1091
|
Enable embeddings for a dataset
|
|
1092
1092
|
|
|
1093
1093
|
```
|
|
1094
1094
|
USAGE
|
|
1095
|
-
$ sanity
|
|
1095
|
+
$ sanity datasets embeddings enable [DATASET] [-p <id>] [--projection <value>] [--wait]
|
|
1096
1096
|
|
|
1097
1097
|
ARGUMENTS
|
|
1098
1098
|
[DATASET] Dataset name to enable embeddings for
|
|
@@ -1110,26 +1110,26 @@ DESCRIPTION
|
|
|
1110
1110
|
EXAMPLES
|
|
1111
1111
|
Enable embeddings for the production dataset
|
|
1112
1112
|
|
|
1113
|
-
$ sanity
|
|
1113
|
+
$ sanity datasets embeddings enable production
|
|
1114
1114
|
|
|
1115
1115
|
Enable embeddings with a specific projection
|
|
1116
1116
|
|
|
1117
|
-
$ sanity
|
|
1117
|
+
$ sanity datasets embeddings enable production --projection "{ title, body }"
|
|
1118
1118
|
|
|
1119
1119
|
Enable embeddings and wait for processing to complete
|
|
1120
1120
|
|
|
1121
|
-
$ sanity
|
|
1121
|
+
$ sanity datasets embeddings enable production --wait
|
|
1122
1122
|
```
|
|
1123
1123
|
|
|
1124
|
-
_See code: [src/commands/
|
|
1124
|
+
_See code: [src/commands/datasets/embeddings/enable.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/datasets/embeddings/enable.ts)_
|
|
1125
1125
|
|
|
1126
|
-
## `sanity
|
|
1126
|
+
## `sanity datasets embeddings status [DATASET]`
|
|
1127
1127
|
|
|
1128
1128
|
Show embeddings settings and status for a dataset
|
|
1129
1129
|
|
|
1130
1130
|
```
|
|
1131
1131
|
USAGE
|
|
1132
|
-
$ sanity
|
|
1132
|
+
$ sanity datasets embeddings status [DATASET] [-p <id>]
|
|
1133
1133
|
|
|
1134
1134
|
ARGUMENTS
|
|
1135
1135
|
[DATASET] The name of the dataset to check embeddings status for
|
|
@@ -1143,18 +1143,18 @@ DESCRIPTION
|
|
|
1143
1143
|
EXAMPLES
|
|
1144
1144
|
Show embeddings status for the production dataset
|
|
1145
1145
|
|
|
1146
|
-
$ sanity
|
|
1146
|
+
$ sanity datasets embeddings status production
|
|
1147
1147
|
```
|
|
1148
1148
|
|
|
1149
|
-
_See code: [src/commands/
|
|
1149
|
+
_See code: [src/commands/datasets/embeddings/status.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/datasets/embeddings/status.ts)_
|
|
1150
1150
|
|
|
1151
|
-
## `sanity
|
|
1151
|
+
## `sanity datasets export [NAME] [DESTINATION]`
|
|
1152
1152
|
|
|
1153
1153
|
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
1154
|
|
|
1155
1155
|
```
|
|
1156
1156
|
USAGE
|
|
1157
|
-
$ sanity
|
|
1157
|
+
$ sanity datasets export [NAME] [DESTINATION] [-p <id>] [--asset-concurrency <value>] [--mode stream|cursor]
|
|
1158
1158
|
[--no-assets] [--no-compress] [--no-drafts] [--overwrite] [--raw] [--types <value>]
|
|
1159
1159
|
|
|
1160
1160
|
ARGUMENTS
|
|
@@ -1184,30 +1184,30 @@ DESCRIPTION
|
|
|
1184
1184
|
EXAMPLES
|
|
1185
1185
|
Export dataset "moviedb" to localPath.tar.gz
|
|
1186
1186
|
|
|
1187
|
-
$ sanity
|
|
1187
|
+
$ sanity datasets export moviedb localPath.tar.gz
|
|
1188
1188
|
|
|
1189
1189
|
Export dataset without assets
|
|
1190
1190
|
|
|
1191
|
-
$ sanity
|
|
1191
|
+
$ sanity datasets export moviedb assetless.tar.gz --no-assets
|
|
1192
1192
|
|
|
1193
1193
|
Export raw documents without asset reference rewriting
|
|
1194
1194
|
|
|
1195
|
-
$ sanity
|
|
1195
|
+
$ sanity datasets export staging staging.tar.gz --raw
|
|
1196
1196
|
|
|
1197
1197
|
Export specific document types
|
|
1198
1198
|
|
|
1199
|
-
$ sanity
|
|
1199
|
+
$ sanity datasets export staging staging.tar.gz --types products,shops
|
|
1200
1200
|
```
|
|
1201
1201
|
|
|
1202
|
-
_See code: [src/commands/
|
|
1202
|
+
_See code: [src/commands/datasets/export.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/datasets/export.ts)_
|
|
1203
1203
|
|
|
1204
|
-
## `sanity
|
|
1204
|
+
## `sanity datasets import SOURCE [TARGETDATASET]`
|
|
1205
1205
|
|
|
1206
1206
|
Import documents to a Sanity dataset
|
|
1207
1207
|
|
|
1208
1208
|
```
|
|
1209
1209
|
USAGE
|
|
1210
|
-
$ sanity
|
|
1210
|
+
$ sanity datasets import SOURCE [TARGETDATASET] [--allow-assets-in-different-dataset] [--allow-failing-assets]
|
|
1211
1211
|
[--allow-replacement-characters] [--allow-system-documents] [--asset-concurrency <value>] [-d <name>] [--missing |
|
|
1212
1212
|
--replace] [-p <id>] [--replace-assets] [--skip-cross-dataset-references] [-t <value>]
|
|
1213
1213
|
|
|
@@ -1237,26 +1237,30 @@ DESCRIPTION
|
|
|
1237
1237
|
EXAMPLES
|
|
1238
1238
|
Import "./my-dataset.ndjson" into dataset "staging"
|
|
1239
1239
|
|
|
1240
|
-
$ sanity
|
|
1240
|
+
$ sanity datasets import -d staging my-dataset.ndjson
|
|
1241
1241
|
|
|
1242
1242
|
Import into dataset "test" from stdin
|
|
1243
1243
|
|
|
1244
|
-
cat my-dataset.ndjson | sanity
|
|
1244
|
+
cat my-dataset.ndjson | sanity datasets import -d test -
|
|
1245
1245
|
|
|
1246
1246
|
Import with explicit project ID (overrides CLI configuration)
|
|
1247
1247
|
|
|
1248
|
-
$ sanity
|
|
1248
|
+
$ sanity datasets import -p projectId -d staging my-dataset.ndjson
|
|
1249
|
+
|
|
1250
|
+
Import with an explicit token (e.g. for CI/CD)
|
|
1251
|
+
|
|
1252
|
+
$ sanity datasets import -d staging -t someSecretToken my-dataset.ndjson
|
|
1249
1253
|
```
|
|
1250
1254
|
|
|
1251
|
-
_See code: [src/commands/
|
|
1255
|
+
_See code: [src/commands/datasets/import.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/datasets/import.ts)_
|
|
1252
1256
|
|
|
1253
|
-
## `sanity
|
|
1257
|
+
## `sanity datasets list`
|
|
1254
1258
|
|
|
1255
1259
|
List datasets of your project
|
|
1256
1260
|
|
|
1257
1261
|
```
|
|
1258
1262
|
USAGE
|
|
1259
|
-
$ sanity
|
|
1263
|
+
$ sanity datasets list [-p <id>]
|
|
1260
1264
|
|
|
1261
1265
|
OVERRIDE FLAGS
|
|
1262
1266
|
-p, --project-id=<id> Project ID to list datasets for (overrides CLI configuration)
|
|
@@ -1267,22 +1271,22 @@ DESCRIPTION
|
|
|
1267
1271
|
EXAMPLES
|
|
1268
1272
|
List datasets of your project
|
|
1269
1273
|
|
|
1270
|
-
$ sanity
|
|
1274
|
+
$ sanity datasets list
|
|
1271
1275
|
|
|
1272
1276
|
List datasets for a specific project
|
|
1273
1277
|
|
|
1274
|
-
$ sanity
|
|
1278
|
+
$ sanity datasets list --project-id abc123
|
|
1275
1279
|
```
|
|
1276
1280
|
|
|
1277
|
-
_See code: [src/commands/
|
|
1281
|
+
_See code: [src/commands/datasets/list.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/datasets/list.ts)_
|
|
1278
1282
|
|
|
1279
|
-
## `sanity
|
|
1283
|
+
## `sanity datasets visibility get DATASET`
|
|
1280
1284
|
|
|
1281
1285
|
Get the visibility of a dataset
|
|
1282
1286
|
|
|
1283
1287
|
```
|
|
1284
1288
|
USAGE
|
|
1285
|
-
$ sanity
|
|
1289
|
+
$ sanity datasets visibility get DATASET [-p <id>]
|
|
1286
1290
|
|
|
1287
1291
|
ARGUMENTS
|
|
1288
1292
|
DATASET The name of the dataset to get visibility for
|
|
@@ -1296,18 +1300,18 @@ DESCRIPTION
|
|
|
1296
1300
|
EXAMPLES
|
|
1297
1301
|
Check the visibility of a dataset
|
|
1298
1302
|
|
|
1299
|
-
$ sanity
|
|
1303
|
+
$ sanity datasets visibility get my-dataset
|
|
1300
1304
|
```
|
|
1301
1305
|
|
|
1302
|
-
_See code: [src/commands/
|
|
1306
|
+
_See code: [src/commands/datasets/visibility/get.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/datasets/visibility/get.ts)_
|
|
1303
1307
|
|
|
1304
|
-
## `sanity
|
|
1308
|
+
## `sanity datasets visibility set DATASET MODE`
|
|
1305
1309
|
|
|
1306
1310
|
Set the visibility of a dataset
|
|
1307
1311
|
|
|
1308
1312
|
```
|
|
1309
1313
|
USAGE
|
|
1310
|
-
$ sanity
|
|
1314
|
+
$ sanity datasets visibility set DATASET MODE [-p <id>]
|
|
1311
1315
|
|
|
1312
1316
|
ARGUMENTS
|
|
1313
1317
|
DATASET The name of the dataset to set visibility for
|
|
@@ -1322,14 +1326,14 @@ DESCRIPTION
|
|
|
1322
1326
|
EXAMPLES
|
|
1323
1327
|
Make a dataset private
|
|
1324
1328
|
|
|
1325
|
-
$ sanity
|
|
1329
|
+
$ sanity datasets visibility set my-dataset private
|
|
1326
1330
|
|
|
1327
1331
|
Make a dataset public
|
|
1328
1332
|
|
|
1329
|
-
$ sanity
|
|
1333
|
+
$ sanity datasets visibility set my-dataset public
|
|
1330
1334
|
```
|
|
1331
1335
|
|
|
1332
|
-
_See code: [src/commands/
|
|
1336
|
+
_See code: [src/commands/datasets/visibility/set.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/datasets/visibility/set.ts)_
|
|
1333
1337
|
|
|
1334
1338
|
## `sanity debug`
|
|
1335
1339
|
|
|
@@ -1337,10 +1341,11 @@ Provides diagnostic info for Sanity Studio troubleshooting
|
|
|
1337
1341
|
|
|
1338
1342
|
```
|
|
1339
1343
|
USAGE
|
|
1340
|
-
$ sanity debug [--secrets]
|
|
1344
|
+
$ sanity debug [--secrets] [--verbose]
|
|
1341
1345
|
|
|
1342
1346
|
FLAGS
|
|
1343
1347
|
--secrets Include API keys in output
|
|
1348
|
+
--verbose Show full error details including stack traces
|
|
1344
1349
|
|
|
1345
1350
|
DESCRIPTION
|
|
1346
1351
|
Provides diagnostic info for Sanity Studio troubleshooting
|
|
@@ -1351,7 +1356,7 @@ EXAMPLES
|
|
|
1351
1356
|
$ sanity debug --secrets
|
|
1352
1357
|
```
|
|
1353
1358
|
|
|
1354
|
-
_See code: [src/commands/debug.ts](https://github.com/sanity-io/cli/blob/v6.
|
|
1359
|
+
_See code: [src/commands/debug.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/debug.ts)_
|
|
1355
1360
|
|
|
1356
1361
|
## `sanity deploy [SOURCEDIR]`
|
|
1357
1362
|
|
|
@@ -1396,7 +1401,7 @@ EXAMPLES
|
|
|
1396
1401
|
$ sanity deploy --external
|
|
1397
1402
|
```
|
|
1398
1403
|
|
|
1399
|
-
_See code: [src/commands/deploy.ts](https://github.com/sanity-io/cli/blob/v6.
|
|
1404
|
+
_See code: [src/commands/deploy.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/deploy.ts)_
|
|
1400
1405
|
|
|
1401
1406
|
## `sanity dev`
|
|
1402
1407
|
|
|
@@ -1423,7 +1428,7 @@ EXAMPLES
|
|
|
1423
1428
|
$ sanity dev --load-in-dashboard
|
|
1424
1429
|
```
|
|
1425
1430
|
|
|
1426
|
-
_See code: [src/commands/dev.ts](https://github.com/sanity-io/cli/blob/v6.
|
|
1431
|
+
_See code: [src/commands/dev.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/dev.ts)_
|
|
1427
1432
|
|
|
1428
1433
|
## `sanity docs browse`
|
|
1429
1434
|
|
|
@@ -1437,7 +1442,7 @@ DESCRIPTION
|
|
|
1437
1442
|
Open Sanity docs in a web browser
|
|
1438
1443
|
```
|
|
1439
1444
|
|
|
1440
|
-
_See code: [src/commands/docs/browse.ts](https://github.com/sanity-io/cli/blob/v6.
|
|
1445
|
+
_See code: [src/commands/docs/browse.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/docs/browse.ts)_
|
|
1441
1446
|
|
|
1442
1447
|
## `sanity docs read PATH`
|
|
1443
1448
|
|
|
@@ -1474,7 +1479,7 @@ EXAMPLES
|
|
|
1474
1479
|
$ sanity docs read https://www.sanity.io/docs/studio/installation -w
|
|
1475
1480
|
```
|
|
1476
1481
|
|
|
1477
|
-
_See code: [src/commands/docs/read.ts](https://github.com/sanity-io/cli/blob/v6.
|
|
1482
|
+
_See code: [src/commands/docs/read.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/docs/read.ts)_
|
|
1478
1483
|
|
|
1479
1484
|
## `sanity docs search QUERY`
|
|
1480
1485
|
|
|
@@ -1507,7 +1512,7 @@ EXAMPLES
|
|
|
1507
1512
|
$ sanity docs search "deployment" --limit=5
|
|
1508
1513
|
```
|
|
1509
1514
|
|
|
1510
|
-
_See code: [src/commands/docs/search.ts](https://github.com/sanity-io/cli/blob/v6.
|
|
1515
|
+
_See code: [src/commands/docs/search.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/docs/search.ts)_
|
|
1511
1516
|
|
|
1512
1517
|
## `sanity doctor [CHECKS]`
|
|
1513
1518
|
|
|
@@ -1538,7 +1543,7 @@ EXAMPLES
|
|
|
1538
1543
|
$ sanity doctor cli
|
|
1539
1544
|
```
|
|
1540
1545
|
|
|
1541
|
-
_See code: [src/commands/doctor.ts](https://github.com/sanity-io/cli/blob/v6.
|
|
1546
|
+
_See code: [src/commands/doctor.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/doctor.ts)_
|
|
1542
1547
|
|
|
1543
1548
|
## `sanity documents create [FILE]`
|
|
1544
1549
|
|
|
@@ -1589,7 +1594,7 @@ EXAMPLES
|
|
|
1589
1594
|
$ sanity documents create myDocument.json --project-id abc123
|
|
1590
1595
|
```
|
|
1591
1596
|
|
|
1592
|
-
_See code: [src/commands/documents/create.ts](https://github.com/sanity-io/cli/blob/v6.
|
|
1597
|
+
_See code: [src/commands/documents/create.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/documents/create.ts)_
|
|
1593
1598
|
|
|
1594
1599
|
## `sanity documents delete ID [IDS]`
|
|
1595
1600
|
|
|
@@ -1632,7 +1637,7 @@ EXAMPLES
|
|
|
1632
1637
|
$ sanity documents delete myDocId --project-id abc123
|
|
1633
1638
|
```
|
|
1634
1639
|
|
|
1635
|
-
_See code: [src/commands/documents/delete.ts](https://github.com/sanity-io/cli/blob/v6.
|
|
1640
|
+
_See code: [src/commands/documents/delete.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/documents/delete.ts)_
|
|
1636
1641
|
|
|
1637
1642
|
## `sanity documents get DOCUMENTID`
|
|
1638
1643
|
|
|
@@ -1673,7 +1678,7 @@ EXAMPLES
|
|
|
1673
1678
|
$ sanity documents get myDocId --project-id abc123
|
|
1674
1679
|
```
|
|
1675
1680
|
|
|
1676
|
-
_See code: [src/commands/documents/get.ts](https://github.com/sanity-io/cli/blob/v6.
|
|
1681
|
+
_See code: [src/commands/documents/get.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/documents/get.ts)_
|
|
1677
1682
|
|
|
1678
1683
|
## `sanity documents query QUERY`
|
|
1679
1684
|
|
|
@@ -1716,7 +1721,7 @@ EXAMPLES
|
|
|
1716
1721
|
$ sanity documents query '*[_type == "post"]' --project-id abc123 --dataset production
|
|
1717
1722
|
```
|
|
1718
1723
|
|
|
1719
|
-
_See code: [src/commands/documents/query.ts](https://github.com/sanity-io/cli/blob/v6.
|
|
1724
|
+
_See code: [src/commands/documents/query.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/documents/query.ts)_
|
|
1720
1725
|
|
|
1721
1726
|
## `sanity documents validate`
|
|
1722
1727
|
|
|
@@ -1770,7 +1775,7 @@ EXAMPLES
|
|
|
1770
1775
|
$ sanity documents validate --project-id abc123 --dataset production
|
|
1771
1776
|
```
|
|
1772
1777
|
|
|
1773
|
-
_See code: [src/commands/documents/validate.ts](https://github.com/sanity-io/cli/blob/v6.
|
|
1778
|
+
_See code: [src/commands/documents/validate.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/documents/validate.ts)_
|
|
1774
1779
|
|
|
1775
1780
|
## `sanity exec SCRIPT`
|
|
1776
1781
|
|
|
@@ -1811,7 +1816,7 @@ EXAMPLES
|
|
|
1811
1816
|
$ sanity exec --mock-browser-env myscript.js -- --dry-run positional-argument
|
|
1812
1817
|
```
|
|
1813
1818
|
|
|
1814
|
-
_See code: [src/commands/exec.ts](https://github.com/sanity-io/cli/blob/v6.
|
|
1819
|
+
_See code: [src/commands/exec.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/exec.ts)_
|
|
1815
1820
|
|
|
1816
1821
|
## `sanity functions add`
|
|
1817
1822
|
|
|
@@ -1860,7 +1865,7 @@ EXAMPLES
|
|
|
1860
1865
|
$ sanity functions add --name my-function --type document-create --type document-update --lang js
|
|
1861
1866
|
```
|
|
1862
1867
|
|
|
1863
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.
|
|
1868
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.6.1/src/commands/functions/add.ts)_
|
|
1864
1869
|
|
|
1865
1870
|
## `sanity functions dev`
|
|
1866
1871
|
|
|
@@ -1894,7 +1899,7 @@ EXAMPLES
|
|
|
1894
1899
|
$ sanity functions dev --timeout 60
|
|
1895
1900
|
```
|
|
1896
1901
|
|
|
1897
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.
|
|
1902
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.6.1/src/commands/functions/dev.ts)_
|
|
1898
1903
|
|
|
1899
1904
|
## `sanity functions env add NAME KEY VALUE`
|
|
1900
1905
|
|
|
@@ -1921,7 +1926,7 @@ EXAMPLES
|
|
|
1921
1926
|
$ sanity functions env add MyFunction API_URL https://api.example.com/
|
|
1922
1927
|
```
|
|
1923
1928
|
|
|
1924
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.
|
|
1929
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.6.1/src/commands/functions/env/add.ts)_
|
|
1925
1930
|
|
|
1926
1931
|
## `sanity functions env list NAME`
|
|
1927
1932
|
|
|
@@ -1945,7 +1950,7 @@ EXAMPLES
|
|
|
1945
1950
|
$ sanity functions env list MyFunction
|
|
1946
1951
|
```
|
|
1947
1952
|
|
|
1948
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.
|
|
1953
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.6.1/src/commands/functions/env/list.ts)_
|
|
1949
1954
|
|
|
1950
1955
|
## `sanity functions env remove NAME KEY`
|
|
1951
1956
|
|
|
@@ -1971,7 +1976,7 @@ EXAMPLES
|
|
|
1971
1976
|
$ sanity functions env remove MyFunction API_URL
|
|
1972
1977
|
```
|
|
1973
1978
|
|
|
1974
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.
|
|
1979
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.6.1/src/commands/functions/env/remove.ts)_
|
|
1975
1980
|
|
|
1976
1981
|
## `sanity functions logs [NAME]`
|
|
1977
1982
|
|
|
@@ -2011,7 +2016,7 @@ EXAMPLES
|
|
|
2011
2016
|
$ sanity functions logs <name> --delete
|
|
2012
2017
|
```
|
|
2013
2018
|
|
|
2014
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.
|
|
2019
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.6.1/src/commands/functions/logs.ts)_
|
|
2015
2020
|
|
|
2016
2021
|
## `sanity functions test [NAME]`
|
|
2017
2022
|
|
|
@@ -2065,7 +2070,7 @@ EXAMPLES
|
|
|
2065
2070
|
$ sanity functions test <name> --event update --data-before '{ "title": "before" }' --data-after '{ "title": "after" }'
|
|
2066
2071
|
```
|
|
2067
2072
|
|
|
2068
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.
|
|
2073
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.6.1/src/commands/functions/test.ts)_
|
|
2069
2074
|
|
|
2070
2075
|
## `sanity graphql deploy`
|
|
2071
2076
|
|
|
@@ -2110,7 +2115,7 @@ EXAMPLES
|
|
|
2110
2115
|
$ sanity graphql deploy --playground
|
|
2111
2116
|
```
|
|
2112
2117
|
|
|
2113
|
-
_See code: [src/commands/graphql/deploy.ts](https://github.com/sanity-io/cli/blob/v6.
|
|
2118
|
+
_See code: [src/commands/graphql/deploy.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/graphql/deploy.ts)_
|
|
2114
2119
|
|
|
2115
2120
|
## `sanity graphql list`
|
|
2116
2121
|
|
|
@@ -2136,7 +2141,7 @@ EXAMPLES
|
|
|
2136
2141
|
$ sanity graphql list --project-id abc123
|
|
2137
2142
|
```
|
|
2138
2143
|
|
|
2139
|
-
_See code: [src/commands/graphql/list.ts](https://github.com/sanity-io/cli/blob/v6.
|
|
2144
|
+
_See code: [src/commands/graphql/list.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/graphql/list.ts)_
|
|
2140
2145
|
|
|
2141
2146
|
## `sanity graphql undeploy`
|
|
2142
2147
|
|
|
@@ -2184,7 +2189,7 @@ EXAMPLES
|
|
|
2184
2189
|
$ sanity graphql undeploy --project-id abc123 --dataset production
|
|
2185
2190
|
```
|
|
2186
2191
|
|
|
2187
|
-
_See code: [src/commands/graphql/undeploy.ts](https://github.com/sanity-io/cli/blob/v6.
|
|
2192
|
+
_See code: [src/commands/graphql/undeploy.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/graphql/undeploy.ts)_
|
|
2188
2193
|
|
|
2189
2194
|
## `sanity help [COMMAND]`
|
|
2190
2195
|
|
|
@@ -2204,15 +2209,15 @@ DESCRIPTION
|
|
|
2204
2209
|
Display help for sanity.
|
|
2205
2210
|
```
|
|
2206
2211
|
|
|
2207
|
-
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/
|
|
2212
|
+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/6.2.39/src/commands/help.ts)_
|
|
2208
2213
|
|
|
2209
|
-
## `sanity
|
|
2214
|
+
## `sanity hooks attempt ATTEMPTID`
|
|
2210
2215
|
|
|
2211
2216
|
Print details of a given webhook delivery attempt
|
|
2212
2217
|
|
|
2213
2218
|
```
|
|
2214
2219
|
USAGE
|
|
2215
|
-
$ sanity
|
|
2220
|
+
$ sanity hooks attempt ATTEMPTID [-p <id>]
|
|
2216
2221
|
|
|
2217
2222
|
ARGUMENTS
|
|
2218
2223
|
ATTEMPTID The delivery attempt ID to get details for
|
|
@@ -2226,22 +2231,22 @@ DESCRIPTION
|
|
|
2226
2231
|
EXAMPLES
|
|
2227
2232
|
Print details of webhook delivery attempt with ID abc123
|
|
2228
2233
|
|
|
2229
|
-
$ sanity
|
|
2234
|
+
$ sanity hooks attempt abc123
|
|
2230
2235
|
|
|
2231
2236
|
Get attempt details for a specific project
|
|
2232
2237
|
|
|
2233
|
-
$ sanity
|
|
2238
|
+
$ sanity hooks attempt abc123 --project-id projectId
|
|
2234
2239
|
```
|
|
2235
2240
|
|
|
2236
|
-
_See code: [src/commands/
|
|
2241
|
+
_See code: [src/commands/hooks/attempt.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/hooks/attempt.ts)_
|
|
2237
2242
|
|
|
2238
|
-
## `sanity
|
|
2243
|
+
## `sanity hooks create`
|
|
2239
2244
|
|
|
2240
2245
|
Create a new webhook for the current project
|
|
2241
2246
|
|
|
2242
2247
|
```
|
|
2243
2248
|
USAGE
|
|
2244
|
-
$ sanity
|
|
2249
|
+
$ sanity hooks create [-p <id>]
|
|
2245
2250
|
|
|
2246
2251
|
OVERRIDE FLAGS
|
|
2247
2252
|
-p, --project-id=<id> Project ID to create webhook for (overrides CLI configuration)
|
|
@@ -2252,22 +2257,22 @@ DESCRIPTION
|
|
|
2252
2257
|
EXAMPLES
|
|
2253
2258
|
Create a new webhook for the current project
|
|
2254
2259
|
|
|
2255
|
-
$ sanity
|
|
2260
|
+
$ sanity hooks create
|
|
2256
2261
|
|
|
2257
2262
|
Create a webhook for a specific project
|
|
2258
2263
|
|
|
2259
|
-
$ sanity
|
|
2264
|
+
$ sanity hooks create --project-id abc123
|
|
2260
2265
|
```
|
|
2261
2266
|
|
|
2262
|
-
_See code: [src/commands/
|
|
2267
|
+
_See code: [src/commands/hooks/create.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/hooks/create.ts)_
|
|
2263
2268
|
|
|
2264
|
-
## `sanity
|
|
2269
|
+
## `sanity hooks delete [NAME]`
|
|
2265
2270
|
|
|
2266
2271
|
Delete a hook within your project
|
|
2267
2272
|
|
|
2268
2273
|
```
|
|
2269
2274
|
USAGE
|
|
2270
|
-
$ sanity
|
|
2275
|
+
$ sanity hooks delete [NAME] [-p <id>]
|
|
2271
2276
|
|
|
2272
2277
|
ARGUMENTS
|
|
2273
2278
|
[NAME] Name of hook to delete (will prompt if not provided)
|
|
@@ -2281,26 +2286,26 @@ DESCRIPTION
|
|
|
2281
2286
|
EXAMPLES
|
|
2282
2287
|
Interactively select and delete a hook
|
|
2283
2288
|
|
|
2284
|
-
$ sanity
|
|
2289
|
+
$ sanity hooks delete
|
|
2285
2290
|
|
|
2286
2291
|
Delete a specific hook by name
|
|
2287
2292
|
|
|
2288
|
-
$ sanity
|
|
2293
|
+
$ sanity hooks delete my-hook
|
|
2289
2294
|
|
|
2290
2295
|
Delete a hook from a specific project
|
|
2291
2296
|
|
|
2292
|
-
$ sanity
|
|
2297
|
+
$ sanity hooks delete --project-id abc123
|
|
2293
2298
|
```
|
|
2294
2299
|
|
|
2295
|
-
_See code: [src/commands/
|
|
2300
|
+
_See code: [src/commands/hooks/delete.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/hooks/delete.ts)_
|
|
2296
2301
|
|
|
2297
|
-
## `sanity
|
|
2302
|
+
## `sanity hooks list`
|
|
2298
2303
|
|
|
2299
2304
|
List hooks for a given project
|
|
2300
2305
|
|
|
2301
2306
|
```
|
|
2302
2307
|
USAGE
|
|
2303
|
-
$ sanity
|
|
2308
|
+
$ sanity hooks list [-p <id>]
|
|
2304
2309
|
|
|
2305
2310
|
OVERRIDE FLAGS
|
|
2306
2311
|
-p, --project-id=<id> Project ID to list webhooks for (overrides CLI configuration)
|
|
@@ -2311,22 +2316,22 @@ DESCRIPTION
|
|
|
2311
2316
|
EXAMPLES
|
|
2312
2317
|
List hooks for a given project
|
|
2313
2318
|
|
|
2314
|
-
$ sanity
|
|
2319
|
+
$ sanity hooks list
|
|
2315
2320
|
|
|
2316
2321
|
List hooks for a specific project
|
|
2317
2322
|
|
|
2318
|
-
$ sanity
|
|
2323
|
+
$ sanity hooks list --project-id abc123
|
|
2319
2324
|
```
|
|
2320
2325
|
|
|
2321
|
-
_See code: [src/commands/
|
|
2326
|
+
_See code: [src/commands/hooks/list.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/hooks/list.ts)_
|
|
2322
2327
|
|
|
2323
|
-
## `sanity
|
|
2328
|
+
## `sanity hooks logs [NAME]`
|
|
2324
2329
|
|
|
2325
2330
|
List latest log entries for a given hook
|
|
2326
2331
|
|
|
2327
2332
|
```
|
|
2328
2333
|
USAGE
|
|
2329
|
-
$ sanity
|
|
2334
|
+
$ sanity hooks logs [NAME] [-p <id>] [--detailed]
|
|
2330
2335
|
|
|
2331
2336
|
ARGUMENTS
|
|
2332
2337
|
[NAME] Name of the hook to show logs for
|
|
@@ -2343,18 +2348,18 @@ DESCRIPTION
|
|
|
2343
2348
|
EXAMPLES
|
|
2344
2349
|
List latest log entries for a given hook
|
|
2345
2350
|
|
|
2346
|
-
$ sanity
|
|
2351
|
+
$ sanity hooks logs
|
|
2347
2352
|
|
|
2348
2353
|
List latest log entries for a specific hook by name
|
|
2349
2354
|
|
|
2350
|
-
$ sanity
|
|
2355
|
+
$ sanity hooks logs [NAME]
|
|
2351
2356
|
|
|
2352
2357
|
List hook logs for a specific project
|
|
2353
2358
|
|
|
2354
|
-
$ sanity
|
|
2359
|
+
$ sanity hooks logs --project-id abc123
|
|
2355
2360
|
```
|
|
2356
2361
|
|
|
2357
|
-
_See code: [src/commands/
|
|
2362
|
+
_See code: [src/commands/hooks/logs.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/hooks/logs.ts)_
|
|
2358
2363
|
|
|
2359
2364
|
## `sanity init`
|
|
2360
2365
|
|
|
@@ -2363,10 +2368,10 @@ Initialize a new Sanity Studio, project and/or app
|
|
|
2363
2368
|
```
|
|
2364
2369
|
USAGE
|
|
2365
2370
|
$ sanity init [--json] [--auto-updates | --bare] [--coupon <code> | --project-plan <name>] [--dataset
|
|
2366
|
-
<name> | --dataset-default] [--env <filename> | ] [--git <message> | ] [--
|
|
2367
|
-
[--nextjs-append-env] [--nextjs-embed-studio] [--organization <id>] [--output-path
|
|
2368
|
-
[--package-manager <manager> | ] [--project <id> | --
|
|
2369
|
-
<template> | ] [--typescript | ] [--visibility <mode>] [-y]
|
|
2371
|
+
<name> | --dataset-default] [--env <filename> | ] [--git <message> | ] [--import-dataset] [--mcp]
|
|
2372
|
+
[--nextjs-add-config-files] [--nextjs-append-env] [--nextjs-embed-studio] [--organization <id>] [--output-path
|
|
2373
|
+
<path> | ] [--overwrite-files] [--package-manager <manager> | ] [--project <id> | | --project-name <name>]
|
|
2374
|
+
[--provider <provider>] [--template <template> | ] [--typescript | ] [--visibility <mode>] [-y]
|
|
2370
2375
|
|
|
2371
2376
|
FLAGS
|
|
2372
2377
|
-y, --yes Unattended mode, answers "yes" to any "yes/no" prompt and otherwise uses defaults
|
|
@@ -2374,17 +2379,18 @@ FLAGS
|
|
|
2374
2379
|
--bare Skip the Studio initialization and only print the selected project ID and dataset
|
|
2375
2380
|
name to stdout
|
|
2376
2381
|
--coupon=<code> Optionally select a coupon for a new project (cannot be used with --project-plan)
|
|
2377
|
-
--create-project=<name> Create a new project with the given name
|
|
2378
2382
|
--dataset=<name> Dataset name for the studio
|
|
2379
2383
|
--dataset-default Set up a project with a public dataset named "production"
|
|
2380
2384
|
--env=<filename> Write environment variables to file
|
|
2381
2385
|
--[no-]git=<message> Specify a commit message for initial commit, or disable git init
|
|
2386
|
+
--[no-]import-dataset Import template sample dataset
|
|
2382
2387
|
--[no-]mcp Enable AI editor integration (MCP) setup
|
|
2383
2388
|
--organization=<id> Organization ID to use for the project
|
|
2384
2389
|
--output-path=<path> Path to write studio project to
|
|
2385
2390
|
--[no-]overwrite-files Overwrite existing files
|
|
2386
2391
|
--package-manager=<manager> Specify which package manager to use [allowed: npm, yarn, pnpm]
|
|
2387
2392
|
--project=<id> Project ID to use for the studio
|
|
2393
|
+
--project-name=<name> Create a new project with the given name
|
|
2388
2394
|
--project-plan=<name> Optionally select a plan for a new project
|
|
2389
2395
|
--provider=<provider> Login provider to use
|
|
2390
2396
|
--template=<template> Project template to use [default: "clean"]
|
|
@@ -2419,11 +2425,11 @@ EXAMPLES
|
|
|
2419
2425
|
|
|
2420
2426
|
Create a brand new project with name "Movies Unlimited"
|
|
2421
2427
|
|
|
2422
|
-
$ sanity init -y --
|
|
2428
|
+
$ sanity init -y --project-name "Movies Unlimited" --dataset moviedb --visibility private --template moviedb \
|
|
2423
2429
|
--output-path /Users/espenh/movies-unlimited
|
|
2424
2430
|
```
|
|
2425
2431
|
|
|
2426
|
-
_See code: [src/commands/init.ts](https://github.com/sanity-io/cli/blob/v6.
|
|
2432
|
+
_See code: [src/commands/init.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/init.ts)_
|
|
2427
2433
|
|
|
2428
2434
|
## `sanity install [PACKAGES]`
|
|
2429
2435
|
|
|
@@ -2447,7 +2453,7 @@ EXAMPLES
|
|
|
2447
2453
|
$ sanity install some-package another-package
|
|
2448
2454
|
```
|
|
2449
2455
|
|
|
2450
|
-
_See code: [src/commands/install.ts](https://github.com/sanity-io/cli/blob/v6.
|
|
2456
|
+
_See code: [src/commands/install.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/install.ts)_
|
|
2451
2457
|
|
|
2452
2458
|
## `sanity learn`
|
|
2453
2459
|
|
|
@@ -2461,7 +2467,7 @@ DESCRIPTION
|
|
|
2461
2467
|
Opens Sanity Learn in your web browser
|
|
2462
2468
|
```
|
|
2463
2469
|
|
|
2464
|
-
_See code: [src/commands/learn.ts](https://github.com/sanity-io/cli/blob/v6.
|
|
2470
|
+
_See code: [src/commands/learn.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/learn.ts)_
|
|
2465
2471
|
|
|
2466
2472
|
## `sanity login`
|
|
2467
2473
|
|
|
@@ -2493,7 +2499,7 @@ EXAMPLES
|
|
|
2493
2499
|
$ sanity login --provider github --no-open
|
|
2494
2500
|
```
|
|
2495
2501
|
|
|
2496
|
-
_See code: [src/commands/login.ts](https://github.com/sanity-io/cli/blob/v6.
|
|
2502
|
+
_See code: [src/commands/login.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/login.ts)_
|
|
2497
2503
|
|
|
2498
2504
|
## `sanity logout`
|
|
2499
2505
|
|
|
@@ -2507,7 +2513,7 @@ DESCRIPTION
|
|
|
2507
2513
|
Logs out the CLI from the current user session
|
|
2508
2514
|
```
|
|
2509
2515
|
|
|
2510
|
-
_See code: [src/commands/logout.ts](https://github.com/sanity-io/cli/blob/v6.
|
|
2516
|
+
_See code: [src/commands/logout.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/logout.ts)_
|
|
2511
2517
|
|
|
2512
2518
|
## `sanity manage`
|
|
2513
2519
|
|
|
@@ -2521,7 +2527,7 @@ DESCRIPTION
|
|
|
2521
2527
|
Opens project management interface in your web browser
|
|
2522
2528
|
```
|
|
2523
2529
|
|
|
2524
|
-
_See code: [src/commands/manage.ts](https://github.com/sanity-io/cli/blob/v6.
|
|
2530
|
+
_See code: [src/commands/manage.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/manage.ts)_
|
|
2525
2531
|
|
|
2526
2532
|
## `sanity manifest extract`
|
|
2527
2533
|
|
|
@@ -2549,7 +2555,7 @@ EXAMPLES
|
|
|
2549
2555
|
$ sanity manifest extract --path /public/static
|
|
2550
2556
|
```
|
|
2551
2557
|
|
|
2552
|
-
_See code: [src/commands/manifest/extract.ts](https://github.com/sanity-io/cli/blob/v6.
|
|
2558
|
+
_See code: [src/commands/manifest/extract.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/manifest/extract.ts)_
|
|
2553
2559
|
|
|
2554
2560
|
## `sanity mcp configure`
|
|
2555
2561
|
|
|
@@ -2568,7 +2574,7 @@ EXAMPLES
|
|
|
2568
2574
|
$ sanity mcp configure
|
|
2569
2575
|
```
|
|
2570
2576
|
|
|
2571
|
-
_See code: [src/commands/mcp/configure.ts](https://github.com/sanity-io/cli/blob/v6.
|
|
2577
|
+
_See code: [src/commands/mcp/configure.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/mcp/configure.ts)_
|
|
2572
2578
|
|
|
2573
2579
|
## `sanity media create-aspect`
|
|
2574
2580
|
|
|
@@ -2587,7 +2593,7 @@ EXAMPLES
|
|
|
2587
2593
|
$ sanity media create-aspect
|
|
2588
2594
|
```
|
|
2589
2595
|
|
|
2590
|
-
_See code: [src/commands/media/create-aspect.ts](https://github.com/sanity-io/cli/blob/v6.
|
|
2596
|
+
_See code: [src/commands/media/create-aspect.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/media/create-aspect.ts)_
|
|
2591
2597
|
|
|
2592
2598
|
## `sanity media delete-aspect ASPECTNAME`
|
|
2593
2599
|
|
|
@@ -2616,7 +2622,7 @@ EXAMPLES
|
|
|
2616
2622
|
$ sanity media delete-aspect someAspect
|
|
2617
2623
|
```
|
|
2618
2624
|
|
|
2619
|
-
_See code: [src/commands/media/delete-aspect.ts](https://github.com/sanity-io/cli/blob/v6.
|
|
2625
|
+
_See code: [src/commands/media/delete-aspect.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/media/delete-aspect.ts)_
|
|
2620
2626
|
|
|
2621
2627
|
## `sanity media deploy-aspect [ASPECTNAME]`
|
|
2622
2628
|
|
|
@@ -2649,7 +2655,7 @@ EXAMPLES
|
|
|
2649
2655
|
$ sanity media deploy-aspect --all
|
|
2650
2656
|
```
|
|
2651
2657
|
|
|
2652
|
-
_See code: [src/commands/media/deploy-aspect.ts](https://github.com/sanity-io/cli/blob/v6.
|
|
2658
|
+
_See code: [src/commands/media/deploy-aspect.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/media/deploy-aspect.ts)_
|
|
2653
2659
|
|
|
2654
2660
|
## `sanity media export [DESTINATION]`
|
|
2655
2661
|
|
|
@@ -2690,7 +2696,7 @@ EXAMPLES
|
|
|
2690
2696
|
$ sanity media export --media-library-id my-library-id
|
|
2691
2697
|
```
|
|
2692
2698
|
|
|
2693
|
-
_See code: [src/commands/media/export.ts](https://github.com/sanity-io/cli/blob/v6.
|
|
2699
|
+
_See code: [src/commands/media/export.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/media/export.ts)_
|
|
2694
2700
|
|
|
2695
2701
|
## `sanity media import SOURCE`
|
|
2696
2702
|
|
|
@@ -2728,15 +2734,15 @@ EXAMPLES
|
|
|
2728
2734
|
$ sanity media import products --replace-aspects
|
|
2729
2735
|
```
|
|
2730
2736
|
|
|
2731
|
-
_See code: [src/commands/media/import.ts](https://github.com/sanity-io/cli/blob/v6.
|
|
2737
|
+
_See code: [src/commands/media/import.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/media/import.ts)_
|
|
2732
2738
|
|
|
2733
|
-
## `sanity
|
|
2739
|
+
## `sanity migrations create [TITLE]`
|
|
2734
2740
|
|
|
2735
2741
|
Create a new migration within your project
|
|
2736
2742
|
|
|
2737
2743
|
```
|
|
2738
2744
|
USAGE
|
|
2739
|
-
$ sanity
|
|
2745
|
+
$ sanity migrations create [TITLE]
|
|
2740
2746
|
|
|
2741
2747
|
ARGUMENTS
|
|
2742
2748
|
[TITLE] Title of migration
|
|
@@ -2747,22 +2753,22 @@ DESCRIPTION
|
|
|
2747
2753
|
EXAMPLES
|
|
2748
2754
|
Create a new migration, prompting for title and options
|
|
2749
2755
|
|
|
2750
|
-
$ sanity
|
|
2756
|
+
$ sanity migrations create
|
|
2751
2757
|
|
|
2752
2758
|
Create a new migration with the provided title, prompting for options
|
|
2753
2759
|
|
|
2754
|
-
$ sanity
|
|
2760
|
+
$ sanity migrations create "Rename field from location to address"
|
|
2755
2761
|
```
|
|
2756
2762
|
|
|
2757
|
-
_See code: [@sanity/migrate](https://github.com/sanity-io/migrate/blob/v6.
|
|
2763
|
+
_See code: [@sanity/migrate](https://github.com/sanity-io/migrate/blob/v6.1.0/src/commands/migrations/create.ts)_
|
|
2758
2764
|
|
|
2759
|
-
## `sanity
|
|
2765
|
+
## `sanity migrations list`
|
|
2760
2766
|
|
|
2761
2767
|
List available migrations
|
|
2762
2768
|
|
|
2763
2769
|
```
|
|
2764
2770
|
USAGE
|
|
2765
|
-
$ sanity
|
|
2771
|
+
$ sanity migrations list
|
|
2766
2772
|
|
|
2767
2773
|
DESCRIPTION
|
|
2768
2774
|
List available migrations
|
|
@@ -2770,18 +2776,18 @@ DESCRIPTION
|
|
|
2770
2776
|
EXAMPLES
|
|
2771
2777
|
List all available migrations in the project
|
|
2772
2778
|
|
|
2773
|
-
$ sanity
|
|
2779
|
+
$ sanity migrations list
|
|
2774
2780
|
```
|
|
2775
2781
|
|
|
2776
|
-
_See code: [@sanity/migrate](https://github.com/sanity-io/migrate/blob/v6.
|
|
2782
|
+
_See code: [@sanity/migrate](https://github.com/sanity-io/migrate/blob/v6.1.0/src/commands/migrations/list.ts)_
|
|
2777
2783
|
|
|
2778
|
-
## `sanity
|
|
2784
|
+
## `sanity migrations run [ID]`
|
|
2779
2785
|
|
|
2780
2786
|
Run a migration against a dataset
|
|
2781
2787
|
|
|
2782
2788
|
```
|
|
2783
2789
|
USAGE
|
|
2784
|
-
$ sanity
|
|
2790
|
+
$ sanity migrations run [ID] [--api-version <value>] [--concurrency <value>] [--confirm] [--dataset <value>]
|
|
2785
2791
|
[--dry-run] [--from-export <value>] [--progress] [--project <value>]
|
|
2786
2792
|
|
|
2787
2793
|
ARGUMENTS
|
|
@@ -2806,18 +2812,18 @@ DESCRIPTION
|
|
|
2806
2812
|
EXAMPLES
|
|
2807
2813
|
dry run the migration
|
|
2808
2814
|
|
|
2809
|
-
$ sanity
|
|
2815
|
+
$ sanity migrations run <id>
|
|
2810
2816
|
|
|
2811
2817
|
execute the migration against a dataset
|
|
2812
2818
|
|
|
2813
|
-
$ sanity
|
|
2819
|
+
$ sanity migrations run <id> --no-dry-run --project xyz --dataset staging
|
|
2814
2820
|
|
|
2815
2821
|
execute the migration using a dataset export as the source
|
|
2816
2822
|
|
|
2817
|
-
$ sanity
|
|
2823
|
+
$ sanity migrations run <id> --from-export=production.tar.gz --no-dry-run --project xyz --dataset staging
|
|
2818
2824
|
```
|
|
2819
2825
|
|
|
2820
|
-
_See code: [@sanity/migrate](https://github.com/sanity-io/migrate/blob/v6.
|
|
2826
|
+
_See code: [@sanity/migrate](https://github.com/sanity-io/migrate/blob/v6.1.0/src/commands/migrations/run.ts)_
|
|
2821
2827
|
|
|
2822
2828
|
## `sanity openapi get SLUG`
|
|
2823
2829
|
|
|
@@ -2856,7 +2862,7 @@ EXAMPLES
|
|
|
2856
2862
|
$ sanity openapi get query > query-api.yaml
|
|
2857
2863
|
```
|
|
2858
2864
|
|
|
2859
|
-
_See code: [src/commands/openapi/get.ts](https://github.com/sanity-io/cli/blob/v6.
|
|
2865
|
+
_See code: [src/commands/openapi/get.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/openapi/get.ts)_
|
|
2860
2866
|
|
|
2861
2867
|
## `sanity openapi list`
|
|
2862
2868
|
|
|
@@ -2887,7 +2893,7 @@ EXAMPLES
|
|
|
2887
2893
|
$ sanity openapi list --web
|
|
2888
2894
|
```
|
|
2889
2895
|
|
|
2890
|
-
_See code: [src/commands/openapi/list.ts](https://github.com/sanity-io/cli/blob/v6.
|
|
2896
|
+
_See code: [src/commands/openapi/list.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/openapi/list.ts)_
|
|
2891
2897
|
|
|
2892
2898
|
## `sanity preview [OUTPUTDIR]`
|
|
2893
2899
|
|
|
@@ -2915,7 +2921,7 @@ EXAMPLES
|
|
|
2915
2921
|
$ sanity preview some/build-output-dir
|
|
2916
2922
|
```
|
|
2917
2923
|
|
|
2918
|
-
_See code: [src/commands/preview.ts](https://github.com/sanity-io/cli/blob/v6.
|
|
2924
|
+
_See code: [src/commands/preview.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/preview.ts)_
|
|
2919
2925
|
|
|
2920
2926
|
## `sanity projects create [PROJECTNAME]`
|
|
2921
2927
|
|
|
@@ -2963,7 +2969,7 @@ EXAMPLES
|
|
|
2963
2969
|
$ sanity projects create "CI Project" --yes --json
|
|
2964
2970
|
```
|
|
2965
2971
|
|
|
2966
|
-
_See code: [src/commands/projects/create.ts](https://github.com/sanity-io/cli/blob/v6.
|
|
2972
|
+
_See code: [src/commands/projects/create.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/projects/create.ts)_
|
|
2967
2973
|
|
|
2968
2974
|
## `sanity projects list`
|
|
2969
2975
|
|
|
@@ -2992,15 +2998,15 @@ EXAMPLES
|
|
|
2992
2998
|
$ sanity projects list --sort=members --order=asc
|
|
2993
2999
|
```
|
|
2994
3000
|
|
|
2995
|
-
_See code: [src/commands/projects/list.ts](https://github.com/sanity-io/cli/blob/v6.
|
|
3001
|
+
_See code: [src/commands/projects/list.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/projects/list.ts)_
|
|
2996
3002
|
|
|
2997
|
-
## `sanity
|
|
3003
|
+
## `sanity schemas delete`
|
|
2998
3004
|
|
|
2999
3005
|
Delete schema documents by id
|
|
3000
3006
|
|
|
3001
3007
|
```
|
|
3002
3008
|
USAGE
|
|
3003
|
-
$ sanity
|
|
3009
|
+
$ sanity schemas delete --ids <value> [-p <id>] [-d <name>] [--verbose]
|
|
3004
3010
|
|
|
3005
3011
|
FLAGS
|
|
3006
3012
|
-d, --dataset=<name> Delete schemas from a specific dataset
|
|
@@ -3016,22 +3022,23 @@ DESCRIPTION
|
|
|
3016
3022
|
EXAMPLES
|
|
3017
3023
|
Delete a single schema
|
|
3018
3024
|
|
|
3019
|
-
$ sanity
|
|
3025
|
+
$ sanity schemas delete --ids sanity.workspace.schema.workspaceName
|
|
3020
3026
|
|
|
3021
3027
|
Delete multiple schemas
|
|
3022
3028
|
|
|
3023
|
-
$ sanity
|
|
3029
|
+
$ sanity schemas delete --ids \
|
|
3030
|
+
sanity.workspace.schema.workspaceName,prefix.sanity.workspace.schema.otherWorkspace
|
|
3024
3031
|
```
|
|
3025
3032
|
|
|
3026
|
-
_See code: [src/commands/
|
|
3033
|
+
_See code: [src/commands/schemas/delete.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/schemas/delete.ts)_
|
|
3027
3034
|
|
|
3028
|
-
## `sanity
|
|
3035
|
+
## `sanity schemas deploy`
|
|
3029
3036
|
|
|
3030
3037
|
Deploy schema documents into workspace datasets.
|
|
3031
3038
|
|
|
3032
3039
|
```
|
|
3033
3040
|
USAGE
|
|
3034
|
-
$ sanity
|
|
3041
|
+
$ sanity schemas deploy [--extract-manifest] [--manifest-dir <directory>] [--tag <tag>] [--verbose] [--workspace
|
|
3035
3042
|
<name>]
|
|
3036
3043
|
|
|
3037
3044
|
FLAGS
|
|
@@ -3052,22 +3059,22 @@ DESCRIPTION
|
|
|
3052
3059
|
EXAMPLES
|
|
3053
3060
|
Deploy all workspace schemas
|
|
3054
3061
|
|
|
3055
|
-
$ sanity
|
|
3062
|
+
$ sanity schemas deploy
|
|
3056
3063
|
|
|
3057
3064
|
Deploy the schema for only the workspace "default"
|
|
3058
3065
|
|
|
3059
|
-
$ sanity
|
|
3066
|
+
$ sanity schemas deploy --workspace default
|
|
3060
3067
|
```
|
|
3061
3068
|
|
|
3062
|
-
_See code: [src/commands/
|
|
3069
|
+
_See code: [src/commands/schemas/deploy.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/schemas/deploy.ts)_
|
|
3063
3070
|
|
|
3064
|
-
## `sanity
|
|
3071
|
+
## `sanity schemas extract`
|
|
3065
3072
|
|
|
3066
3073
|
Extracts a JSON representation of a Sanity schema within a Studio context.
|
|
3067
3074
|
|
|
3068
3075
|
```
|
|
3069
3076
|
USAGE
|
|
3070
|
-
$ sanity
|
|
3077
|
+
$ sanity schemas extract [--enforce-required-fields] [--format <format>] [--path <value>] [--watch]
|
|
3071
3078
|
[--watch-patterns <glob>...] [--workspace <name>]
|
|
3072
3079
|
|
|
3073
3080
|
FLAGS
|
|
@@ -3087,26 +3094,26 @@ DESCRIPTION
|
|
|
3087
3094
|
EXAMPLES
|
|
3088
3095
|
Extracts schema types in a Sanity project with more than one workspace
|
|
3089
3096
|
|
|
3090
|
-
$ sanity
|
|
3097
|
+
$ sanity schemas extract --workspace default
|
|
3091
3098
|
|
|
3092
3099
|
Watch mode - re-extract on changes
|
|
3093
3100
|
|
|
3094
|
-
$ sanity
|
|
3101
|
+
$ sanity schemas extract --watch
|
|
3095
3102
|
|
|
3096
3103
|
Watch with custom glob patterns
|
|
3097
3104
|
|
|
3098
|
-
$ sanity
|
|
3105
|
+
$ sanity schemas extract --watch --watch-patterns "lib/**/*.ts"
|
|
3099
3106
|
```
|
|
3100
3107
|
|
|
3101
|
-
_See code: [src/commands/
|
|
3108
|
+
_See code: [src/commands/schemas/extract.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/schemas/extract.ts)_
|
|
3102
3109
|
|
|
3103
|
-
## `sanity
|
|
3110
|
+
## `sanity schemas list`
|
|
3104
3111
|
|
|
3105
3112
|
Lists all schemas in the current dataset.
|
|
3106
3113
|
|
|
3107
3114
|
```
|
|
3108
3115
|
USAGE
|
|
3109
|
-
$ sanity
|
|
3116
|
+
$ sanity schemas list [--id <schema_id>] [--json]
|
|
3110
3117
|
|
|
3111
3118
|
FLAGS
|
|
3112
3119
|
--id=<schema_id> Fetch a single schema by id
|
|
@@ -3123,30 +3130,30 @@ DESCRIPTION
|
|
|
3123
3130
|
EXAMPLES
|
|
3124
3131
|
List all schemas found in any workspace dataset in a table
|
|
3125
3132
|
|
|
3126
|
-
$ sanity
|
|
3133
|
+
$ sanity schemas list
|
|
3127
3134
|
|
|
3128
3135
|
Get a schema for a given id
|
|
3129
3136
|
|
|
3130
|
-
$ sanity
|
|
3137
|
+
$ sanity schemas list --id _.schemas.workspaceName
|
|
3131
3138
|
|
|
3132
3139
|
Get stored schemas as pretty-printed json-array
|
|
3133
3140
|
|
|
3134
|
-
$ sanity
|
|
3141
|
+
$ sanity schemas list --json
|
|
3135
3142
|
|
|
3136
3143
|
Get singular stored schema as pretty-printed json-object
|
|
3137
3144
|
|
|
3138
|
-
$ sanity
|
|
3145
|
+
$ sanity schemas list --json --id _.schemas.workspaceName
|
|
3139
3146
|
```
|
|
3140
3147
|
|
|
3141
|
-
_See code: [src/commands/
|
|
3148
|
+
_See code: [src/commands/schemas/list.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/schemas/list.ts)_
|
|
3142
3149
|
|
|
3143
|
-
## `sanity
|
|
3150
|
+
## `sanity schemas validate`
|
|
3144
3151
|
|
|
3145
3152
|
Validates all schema types specified in a workspace
|
|
3146
3153
|
|
|
3147
3154
|
```
|
|
3148
3155
|
USAGE
|
|
3149
|
-
$ sanity
|
|
3156
|
+
$ sanity schemas validate [--debug-metafile-path <value>] [--format pretty|ndjson|json] [--level error|warning]
|
|
3150
3157
|
[--workspace <value>]
|
|
3151
3158
|
|
|
3152
3159
|
FLAGS
|
|
@@ -3166,22 +3173,22 @@ DESCRIPTION
|
|
|
3166
3173
|
EXAMPLES
|
|
3167
3174
|
Validates all schema types in a Sanity project with more than one workspace
|
|
3168
3175
|
|
|
3169
|
-
$ sanity
|
|
3176
|
+
$ sanity schemas validate --workspace default
|
|
3170
3177
|
|
|
3171
3178
|
Save the results of the report into a file
|
|
3172
3179
|
|
|
3173
|
-
$ sanity
|
|
3180
|
+
$ sanity schemas validate > report.txt
|
|
3174
3181
|
|
|
3175
3182
|
Report out only errors
|
|
3176
3183
|
|
|
3177
|
-
$ sanity
|
|
3184
|
+
$ sanity schemas validate --level error
|
|
3178
3185
|
|
|
3179
3186
|
Generate a report which can be analyzed with https://esbuild.github.io/analyze/
|
|
3180
3187
|
|
|
3181
|
-
$ sanity
|
|
3188
|
+
$ sanity schemas validate --debug-metafile-path metafile.json
|
|
3182
3189
|
```
|
|
3183
3190
|
|
|
3184
|
-
_See code: [src/commands/
|
|
3191
|
+
_See code: [src/commands/schemas/validate.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/schemas/validate.ts)_
|
|
3185
3192
|
|
|
3186
3193
|
## `sanity telemetry disable`
|
|
3187
3194
|
|
|
@@ -3200,7 +3207,7 @@ EXAMPLES
|
|
|
3200
3207
|
$ sanity telemetry telemetry disable
|
|
3201
3208
|
```
|
|
3202
3209
|
|
|
3203
|
-
_See code: [src/commands/telemetry/disable.ts](https://github.com/sanity-io/cli/blob/v6.
|
|
3210
|
+
_See code: [src/commands/telemetry/disable.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/telemetry/disable.ts)_
|
|
3204
3211
|
|
|
3205
3212
|
## `sanity telemetry enable`
|
|
3206
3213
|
|
|
@@ -3219,7 +3226,7 @@ EXAMPLES
|
|
|
3219
3226
|
$ sanity telemetry telemetry enable
|
|
3220
3227
|
```
|
|
3221
3228
|
|
|
3222
|
-
_See code: [src/commands/telemetry/enable.ts](https://github.com/sanity-io/cli/blob/v6.
|
|
3229
|
+
_See code: [src/commands/telemetry/enable.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/telemetry/enable.ts)_
|
|
3223
3230
|
|
|
3224
3231
|
## `sanity telemetry status`
|
|
3225
3232
|
|
|
@@ -3238,7 +3245,7 @@ EXAMPLES
|
|
|
3238
3245
|
$ sanity telemetry telemetry status
|
|
3239
3246
|
```
|
|
3240
3247
|
|
|
3241
|
-
_See code: [src/commands/telemetry/status.ts](https://github.com/sanity-io/cli/blob/v6.
|
|
3248
|
+
_See code: [src/commands/telemetry/status.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/telemetry/status.ts)_
|
|
3242
3249
|
|
|
3243
3250
|
## `sanity tokens add [LABEL]`
|
|
3244
3251
|
|
|
@@ -3284,7 +3291,7 @@ EXAMPLES
|
|
|
3284
3291
|
$ sanity tokens add "My Token" --project-id abc123 --role=editor
|
|
3285
3292
|
```
|
|
3286
3293
|
|
|
3287
|
-
_See code: [src/commands/tokens/add.ts](https://github.com/sanity-io/cli/blob/v6.
|
|
3294
|
+
_See code: [src/commands/tokens/add.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/tokens/add.ts)_
|
|
3288
3295
|
|
|
3289
3296
|
## `sanity tokens delete [TOKENID]`
|
|
3290
3297
|
|
|
@@ -3324,7 +3331,7 @@ EXAMPLES
|
|
|
3324
3331
|
$ sanity tokens delete --project-id abc123
|
|
3325
3332
|
```
|
|
3326
3333
|
|
|
3327
|
-
_See code: [src/commands/tokens/delete.ts](https://github.com/sanity-io/cli/blob/v6.
|
|
3334
|
+
_See code: [src/commands/tokens/delete.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/tokens/delete.ts)_
|
|
3328
3335
|
|
|
3329
3336
|
## `sanity tokens list`
|
|
3330
3337
|
|
|
@@ -3357,7 +3364,7 @@ EXAMPLES
|
|
|
3357
3364
|
$ sanity tokens list --project-id abc123
|
|
3358
3365
|
```
|
|
3359
3366
|
|
|
3360
|
-
_See code: [src/commands/tokens/list.ts](https://github.com/sanity-io/cli/blob/v6.
|
|
3367
|
+
_See code: [src/commands/tokens/list.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/tokens/list.ts)_
|
|
3361
3368
|
|
|
3362
3369
|
## `sanity typegen generate`
|
|
3363
3370
|
|
|
@@ -3420,7 +3427,7 @@ DESCRIPTION
|
|
|
3420
3427
|
Removes the deployed Sanity Studio/App from Sanity hosting
|
|
3421
3428
|
```
|
|
3422
3429
|
|
|
3423
|
-
_See code: [src/commands/undeploy.ts](https://github.com/sanity-io/cli/blob/v6.
|
|
3430
|
+
_See code: [src/commands/undeploy.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/undeploy.ts)_
|
|
3424
3431
|
|
|
3425
3432
|
## `sanity users invite [EMAIL]`
|
|
3426
3433
|
|
|
@@ -3460,7 +3467,7 @@ EXAMPLES
|
|
|
3460
3467
|
$ sanity users invite pippi@sanity.io --project-id abc123
|
|
3461
3468
|
```
|
|
3462
3469
|
|
|
3463
|
-
_See code: [src/commands/users/invite.ts](https://github.com/sanity-io/cli/blob/v6.
|
|
3470
|
+
_See code: [src/commands/users/invite.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/users/invite.ts)_
|
|
3464
3471
|
|
|
3465
3472
|
## `sanity users list`
|
|
3466
3473
|
|
|
@@ -3502,7 +3509,7 @@ EXAMPLES
|
|
|
3502
3509
|
$ sanity users list --project-id abc123
|
|
3503
3510
|
```
|
|
3504
3511
|
|
|
3505
|
-
_See code: [src/commands/users/list.ts](https://github.com/sanity-io/cli/blob/v6.
|
|
3512
|
+
_See code: [src/commands/users/list.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/users/list.ts)_
|
|
3506
3513
|
|
|
3507
3514
|
## `sanity versions`
|
|
3508
3515
|
|
|
@@ -3519,6 +3526,6 @@ EXAMPLES
|
|
|
3519
3526
|
$ sanity versions
|
|
3520
3527
|
```
|
|
3521
3528
|
|
|
3522
|
-
_See code: [src/commands/versions.ts](https://github.com/sanity-io/cli/blob/v6.
|
|
3529
|
+
_See code: [src/commands/versions.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/versions.ts)_
|
|
3523
3530
|
|
|
3524
3531
|
<!-- commandsstop -->
|