@sanity/cli 6.0.0-alpha.16 → 6.0.0-alpha.18
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 +592 -470
- package/dist/SanityHelp.js +74 -21
- package/dist/SanityHelp.js.map +1 -1
- package/dist/actions/build/buildApp.js +42 -15
- package/dist/actions/build/buildApp.js.map +1 -1
- package/dist/actions/build/buildStudio.js +64 -45
- package/dist/actions/build/buildStudio.js.map +1 -1
- package/dist/actions/build/buildVendorDependencies.js +3 -16
- package/dist/actions/build/buildVendorDependencies.js.map +1 -1
- package/dist/actions/build/checkStudioDependencyVersions.js +7 -7
- package/dist/actions/build/checkStudioDependencyVersions.js.map +1 -1
- package/dist/actions/build/createExternalFromImportMap.js +1 -1
- package/dist/actions/build/createExternalFromImportMap.js.map +1 -1
- package/dist/actions/build/determineBasePath.js +5 -2
- package/dist/actions/build/determineBasePath.js.map +1 -1
- package/dist/actions/build/handlePrereleaseVersions.js +44 -0
- package/dist/actions/build/handlePrereleaseVersions.js.map +1 -0
- package/dist/actions/build/types.js.map +1 -1
- package/dist/actions/dataset/create.js +7 -1
- package/dist/actions/dataset/create.js.map +1 -1
- package/dist/actions/dataset/resolveDataset.js +26 -0
- package/dist/actions/dataset/resolveDataset.js.map +1 -0
- package/dist/actions/deploy/deployApp.js +1 -8
- package/dist/actions/deploy/deployApp.js.map +1 -1
- package/dist/actions/deploy/deployStudio.js +1 -0
- package/dist/actions/deploy/deployStudio.js.map +1 -1
- package/dist/actions/dev/getDevServerConfig.js +5 -2
- package/dist/actions/dev/getDevServerConfig.js.map +1 -1
- package/dist/actions/dev/startStudioDevServer.js +8 -3
- package/dist/actions/dev/startStudioDevServer.js.map +1 -1
- package/dist/actions/documents/types.js.map +1 -1
- package/dist/actions/documents/validate.js +11 -2
- package/dist/actions/documents/validate.js.map +1 -1
- package/dist/actions/documents/validateDocuments.worker.js +2 -2
- package/dist/actions/documents/validateDocuments.worker.js.map +1 -1
- package/dist/actions/documents/validation/reporters/jsonReporter.js +1 -1
- package/dist/actions/documents/validation/reporters/jsonReporter.js.map +1 -1
- package/dist/actions/documents/validation/reporters/ndjsonReporter.js +1 -1
- package/dist/actions/documents/validation/reporters/ndjsonReporter.js.map +1 -1
- package/dist/actions/graphql/SchemaError.js +1 -1
- package/dist/actions/graphql/SchemaError.js.map +1 -1
- package/dist/actions/graphql/__tests__/fixtures/many-self-refs.js +540 -0
- package/dist/actions/graphql/__tests__/fixtures/many-self-refs.js.map +1 -0
- package/dist/actions/graphql/__tests__/fixtures/test-studio.js +1143 -0
- package/dist/actions/graphql/__tests__/fixtures/test-studio.js.map +1 -0
- package/dist/actions/graphql/__tests__/fixtures/union-refs.js +591 -0
- package/dist/actions/graphql/__tests__/fixtures/union-refs.js.map +1 -0
- package/dist/actions/graphql/__tests__/helpers.js +23 -0
- package/dist/actions/graphql/__tests__/helpers.js.map +1 -0
- package/dist/actions/graphql/extractFromSanitySchema.js +2 -1
- package/dist/actions/graphql/extractFromSanitySchema.js.map +1 -1
- package/dist/actions/graphql/gen1/generateTypeFilters.js +1 -1
- package/dist/actions/graphql/gen1/generateTypeFilters.js.map +1 -1
- package/dist/actions/graphql/gen1/generateTypeQueries.js +2 -1
- package/dist/actions/graphql/gen1/generateTypeQueries.js.map +1 -1
- package/dist/actions/graphql/gen2/generateTypeQueries.js +1 -1
- package/dist/actions/graphql/gen2/generateTypeQueries.js.map +1 -1
- package/dist/actions/graphql/gen3/generateTypeQueries.js +1 -1
- package/dist/actions/graphql/gen3/generateTypeQueries.js.map +1 -1
- package/dist/actions/graphql/getGraphQLAPIs.js +2 -10
- package/dist/actions/graphql/getGraphQLAPIs.js.map +1 -1
- package/dist/actions/graphql/getGraphQLAPIs.worker.js +1 -1
- package/dist/actions/graphql/getGraphQLAPIs.worker.js.map +1 -1
- package/dist/actions/graphql/types.js.map +1 -1
- package/dist/actions/init/bootstrapLocalTemplate.js +1 -1
- package/dist/actions/init/bootstrapLocalTemplate.js.map +1 -1
- package/dist/actions/manifest/extractAppManifest.js.map +1 -1
- package/dist/actions/manifest/extractManifest.js +3 -22
- package/dist/actions/manifest/extractManifest.js.map +1 -1
- package/dist/actions/manifest/extractManifest.worker.js +5 -1
- package/dist/actions/manifest/extractManifest.worker.js.map +1 -1
- package/dist/actions/manifest/types.js.map +1 -1
- package/dist/actions/schema/deploySchemas.js +57 -80
- package/dist/actions/schema/deploySchemas.js.map +1 -1
- package/dist/actions/schema/extractSanityWorkspace.worker.js +24 -0
- package/dist/actions/schema/extractSanityWorkspace.worker.js.map +1 -0
- package/dist/actions/schema/extractSchemaWatcher.js +1 -1
- package/dist/actions/schema/extractSchemaWatcher.js.map +1 -1
- package/dist/actions/schema/types.js +4 -0
- package/dist/actions/schema/types.js.map +1 -1
- package/dist/actions/schema/uniqueWorkspaces.worker.js +3 -1
- package/dist/actions/schema/uniqueWorkspaces.worker.js.map +1 -1
- package/dist/actions/schema/utils/schemaStoreValidation.js +1 -7
- package/dist/actions/schema/utils/schemaStoreValidation.js.map +1 -1
- package/dist/actions/schema/utils/uniqByProjectIdDataset.js +1 -1
- package/dist/actions/schema/utils/uniqByProjectIdDataset.js.map +1 -1
- package/dist/actions/schema/watchExtractSchema.js +2 -1
- package/dist/actions/schema/watchExtractSchema.js.map +1 -1
- package/dist/actions/versions/getFormatters.js +1 -1
- package/dist/actions/versions/getFormatters.js.map +1 -1
- package/dist/commands/backup/list.js +4 -1
- package/dist/commands/backup/list.js.map +1 -1
- package/dist/commands/dataset/copy.js +3 -1
- package/dist/commands/dataset/copy.js.map +1 -1
- package/dist/commands/dataset/create.js +12 -0
- package/dist/commands/dataset/create.js.map +1 -1
- package/dist/commands/dataset/embeddings/disable.js +62 -0
- package/dist/commands/dataset/embeddings/disable.js.map +1 -0
- package/dist/commands/dataset/embeddings/enable.js +128 -0
- package/dist/commands/dataset/embeddings/enable.js.map +1 -0
- package/dist/commands/dataset/embeddings/status.js +61 -0
- package/dist/commands/dataset/embeddings/status.js.map +1 -0
- package/dist/commands/debug.js +2 -1
- package/dist/commands/debug.js.map +1 -1
- package/dist/commands/documents/create.js +2 -1
- package/dist/commands/documents/create.js.map +1 -1
- package/dist/commands/graphql/deploy.js +1 -1
- package/dist/commands/graphql/deploy.js.map +1 -1
- package/dist/commands/hook/logs.js +1 -1
- package/dist/commands/hook/logs.js.map +1 -1
- package/dist/commands/init.js +13 -7
- package/dist/commands/init.js.map +1 -1
- package/dist/commands/manage.js +0 -1
- package/dist/commands/manage.js.map +1 -1
- package/dist/commands/media/create-aspect.js +1 -1
- package/dist/commands/media/create-aspect.js.map +1 -1
- package/dist/commands/projects/list.js +2 -1
- package/dist/commands/projects/list.js.map +1 -1
- package/dist/commands/schema/deploy.js +11 -27
- package/dist/commands/schema/deploy.js.map +1 -1
- package/dist/commands/users/list.js +1 -1
- package/dist/commands/users/list.js.map +1 -1
- package/dist/commands/versions.js +1 -1
- package/dist/commands/versions.js.map +1 -1
- package/dist/exports/index.d.ts +62 -2
- package/dist/exports/index.js.map +1 -1
- package/dist/prompts/selectMediaLibrary.js +1 -1
- package/dist/prompts/selectMediaLibrary.js.map +1 -1
- package/dist/services/datasets.js +7 -5
- package/dist/services/datasets.js.map +1 -1
- package/dist/services/embeddings.js +25 -0
- package/dist/services/embeddings.js.map +1 -0
- package/dist/services/graphql.js.map +1 -1
- package/dist/services/schemas.js +1 -1
- package/dist/services/schemas.js.map +1 -1
- package/dist/types.js.map +1 -1
- package/dist/util/compareDependencyVersions.js +28 -7
- package/dist/util/compareDependencyVersions.js.map +1 -1
- package/dist/util/errorMessages.js +0 -1
- package/dist/util/errorMessages.js.map +1 -1
- package/dist/util/packageManager/getPeerDependencies.js +44 -0
- package/dist/util/packageManager/getPeerDependencies.js.map +1 -0
- package/oclif.manifest.json +325 -191
- package/package.json +19 -20
- package/dist/actions/schema/schemaStoreTypes.js +0 -19
- package/dist/actions/schema/schemaStoreTypes.js.map +0 -1
- package/dist/actions/schema/utils/manifestExtractor.js +0 -29
- package/dist/actions/schema/utils/manifestExtractor.js.map +0 -1
- package/dist/actions/schema/utils/manifestReader.js +0 -71
- package/dist/actions/schema/utils/manifestReader.js.map +0 -1
- package/dist/util/workerChannels.js +0 -172
- package/dist/util/workerChannels.js.map +0 -1
package/README.md
CHANGED
|
@@ -38,6 +38,9 @@ Code for sanity cli
|
|
|
38
38
|
- [`sanity dataset copy [SOURCE] [TARGET]`](#sanity-dataset-copy-source-target)
|
|
39
39
|
- [`sanity dataset create [NAME]`](#sanity-dataset-create-name)
|
|
40
40
|
- [`sanity dataset delete DATASETNAME`](#sanity-dataset-delete-datasetname)
|
|
41
|
+
- [`sanity dataset embeddings disable [DATASET]`](#sanity-dataset-embeddings-disable-dataset)
|
|
42
|
+
- [`sanity dataset embeddings enable [DATASET]`](#sanity-dataset-embeddings-enable-dataset)
|
|
43
|
+
- [`sanity dataset embeddings status [DATASET]`](#sanity-dataset-embeddings-status-dataset)
|
|
41
44
|
- [`sanity dataset export [NAME] [DESTINATION]`](#sanity-dataset-export-name-destination)
|
|
42
45
|
- [`sanity dataset import SOURCE`](#sanity-dataset-import-source)
|
|
43
46
|
- [`sanity dataset list`](#sanity-dataset-list)
|
|
@@ -116,7 +119,7 @@ Disable backup for a dataset.
|
|
|
116
119
|
|
|
117
120
|
```
|
|
118
121
|
USAGE
|
|
119
|
-
$ sanity backup disable [DATASET]
|
|
122
|
+
$ pnpm exec sanity backup disable [DATASET]
|
|
120
123
|
|
|
121
124
|
ARGUMENTS
|
|
122
125
|
[DATASET] Dataset name to disable backup for
|
|
@@ -127,14 +130,14 @@ DESCRIPTION
|
|
|
127
130
|
EXAMPLES
|
|
128
131
|
Interactively disable backup for a dataset
|
|
129
132
|
|
|
130
|
-
$ sanity backup disable
|
|
133
|
+
$ pnpm exec sanity backup disable
|
|
131
134
|
|
|
132
135
|
Disable backup for the production dataset
|
|
133
136
|
|
|
134
|
-
$ sanity backup disable production
|
|
137
|
+
$ pnpm exec sanity backup disable production
|
|
135
138
|
```
|
|
136
139
|
|
|
137
|
-
_See code: [src/commands/backup/disable.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
140
|
+
_See code: [src/commands/backup/disable.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/backup/disable.ts)_
|
|
138
141
|
|
|
139
142
|
## `sanity backup download [DATASET]`
|
|
140
143
|
|
|
@@ -142,7 +145,7 @@ Download a dataset backup to a local file.
|
|
|
142
145
|
|
|
143
146
|
```
|
|
144
147
|
USAGE
|
|
145
|
-
$ sanity backup download [DATASET] [--backup-id <value>] [--concurrency <value>] [--out <value>] [--overwrite]
|
|
148
|
+
$ pnpm exec sanity backup download [DATASET] [--backup-id <value>] [--concurrency <value>] [--out <value>] [--overwrite]
|
|
146
149
|
|
|
147
150
|
ARGUMENTS
|
|
148
151
|
[DATASET] Dataset name to download backup from
|
|
@@ -159,22 +162,22 @@ DESCRIPTION
|
|
|
159
162
|
EXAMPLES
|
|
160
163
|
Interactively download a backup
|
|
161
164
|
|
|
162
|
-
$ sanity backup download
|
|
165
|
+
$ pnpm exec sanity backup download
|
|
163
166
|
|
|
164
167
|
Download a specific backup for the production dataset
|
|
165
168
|
|
|
166
|
-
$ sanity backup download production --backup-id 2024-01-01-backup-1
|
|
169
|
+
$ pnpm exec sanity backup download production --backup-id 2024-01-01-backup-1
|
|
167
170
|
|
|
168
171
|
Download backup to a specific file
|
|
169
172
|
|
|
170
|
-
$ sanity backup download production --backup-id 2024-01-01-backup-2 --out /path/to/file
|
|
173
|
+
$ pnpm exec sanity backup download production --backup-id 2024-01-01-backup-2 --out /path/to/file
|
|
171
174
|
|
|
172
175
|
Download backup and overwrite existing file
|
|
173
176
|
|
|
174
|
-
$ sanity backup download production --backup-id 2024-01-01-backup-3 --out /path/to/file --overwrite
|
|
177
|
+
$ pnpm exec sanity backup download production --backup-id 2024-01-01-backup-3 --out /path/to/file --overwrite
|
|
175
178
|
```
|
|
176
179
|
|
|
177
|
-
_See code: [src/commands/backup/download.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
180
|
+
_See code: [src/commands/backup/download.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/backup/download.ts)_
|
|
178
181
|
|
|
179
182
|
## `sanity backup enable [DATASET]`
|
|
180
183
|
|
|
@@ -182,7 +185,7 @@ Enable backup for a dataset.
|
|
|
182
185
|
|
|
183
186
|
```
|
|
184
187
|
USAGE
|
|
185
|
-
$ sanity backup enable [DATASET]
|
|
188
|
+
$ pnpm exec sanity backup enable [DATASET]
|
|
186
189
|
|
|
187
190
|
ARGUMENTS
|
|
188
191
|
[DATASET] Dataset name to enable backup for
|
|
@@ -193,14 +196,14 @@ DESCRIPTION
|
|
|
193
196
|
EXAMPLES
|
|
194
197
|
Interactively enable backup for a dataset
|
|
195
198
|
|
|
196
|
-
$ sanity backup enable
|
|
199
|
+
$ pnpm exec sanity backup enable
|
|
197
200
|
|
|
198
201
|
Enable backup for the production dataset
|
|
199
202
|
|
|
200
|
-
$ sanity backup enable production
|
|
203
|
+
$ pnpm exec sanity backup enable production
|
|
201
204
|
```
|
|
202
205
|
|
|
203
|
-
_See code: [src/commands/backup/enable.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
206
|
+
_See code: [src/commands/backup/enable.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/backup/enable.ts)_
|
|
204
207
|
|
|
205
208
|
## `sanity backup list [DATASET]`
|
|
206
209
|
|
|
@@ -208,7 +211,7 @@ List available backups for a dataset.
|
|
|
208
211
|
|
|
209
212
|
```
|
|
210
213
|
USAGE
|
|
211
|
-
$ sanity backup list [DATASET] [--after <value>] [--before <value>] [-l <value>]
|
|
214
|
+
$ pnpm exec sanity backup list [DATASET] [--after <value>] [--before <value>] [-l <value>]
|
|
212
215
|
|
|
213
216
|
ARGUMENTS
|
|
214
217
|
[DATASET] Dataset name to list backups for
|
|
@@ -224,22 +227,22 @@ DESCRIPTION
|
|
|
224
227
|
EXAMPLES
|
|
225
228
|
List backups for a dataset interactively
|
|
226
229
|
|
|
227
|
-
$ sanity backup list
|
|
230
|
+
$ pnpm exec sanity backup list
|
|
228
231
|
|
|
229
232
|
List backups for the production dataset
|
|
230
233
|
|
|
231
|
-
$ sanity backup list production
|
|
234
|
+
$ pnpm exec sanity backup list production
|
|
232
235
|
|
|
233
236
|
List up to 50 backups for the production dataset
|
|
234
237
|
|
|
235
|
-
$ sanity backup list production --limit 50
|
|
238
|
+
$ pnpm exec sanity backup list production --limit 50
|
|
236
239
|
|
|
237
240
|
List up to 10 backups created after 2024-01-31
|
|
238
241
|
|
|
239
|
-
$ sanity backup list production --after 2024-01-31 --limit 10
|
|
242
|
+
$ pnpm exec sanity backup list production --after 2024-01-31 --limit 10
|
|
240
243
|
```
|
|
241
244
|
|
|
242
|
-
_See code: [src/commands/backup/list.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
245
|
+
_See code: [src/commands/backup/list.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/backup/list.ts)_
|
|
243
246
|
|
|
244
247
|
## `sanity blueprints add TYPE`
|
|
245
248
|
|
|
@@ -247,7 +250,7 @@ Add a function resource to a Blueprint
|
|
|
247
250
|
|
|
248
251
|
```
|
|
249
252
|
USAGE
|
|
250
|
-
$ sanity blueprints add TYPE [--example <value> | -n <value> | --fn-type
|
|
253
|
+
$ pnpm exec sanity blueprints add TYPE [--example <value> | -n <value> | --fn-type
|
|
251
254
|
document-create|document-delete|document-update|document-publish|media-library-asset-create|media-library-asset-upda
|
|
252
255
|
te|media-library-asset-delete... | --language ts|js | --javascript | --fn-helpers | --fn-installer
|
|
253
256
|
skip|npm|pnpm|yarn] [-i | ]
|
|
@@ -280,18 +283,18 @@ DESCRIPTION
|
|
|
280
283
|
After adding a function, use 'functions dev' to test locally, then 'blueprints deploy' to publish it.
|
|
281
284
|
|
|
282
285
|
EXAMPLES
|
|
283
|
-
$ sanity blueprints add function
|
|
286
|
+
$ pnpm exec sanity blueprints add function
|
|
284
287
|
|
|
285
|
-
$ sanity blueprints add function --helpers
|
|
288
|
+
$ pnpm exec sanity blueprints add function --helpers
|
|
286
289
|
|
|
287
|
-
$ sanity blueprints add function --name my-function
|
|
290
|
+
$ pnpm exec sanity blueprints add function --name my-function
|
|
288
291
|
|
|
289
|
-
$ sanity blueprints add function --name my-function --fn-type document-create
|
|
292
|
+
$ pnpm exec sanity blueprints add function --name my-function --fn-type document-create
|
|
290
293
|
|
|
291
|
-
$ sanity blueprints add function --name my-function --fn-type document-create --fn-type document-update --lang js
|
|
294
|
+
$ pnpm exec sanity blueprints add function --name my-function --fn-type document-create --fn-type document-update --lang js
|
|
292
295
|
```
|
|
293
296
|
|
|
294
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/
|
|
297
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.1.0/src/commands/blueprints/add.ts)_
|
|
295
298
|
|
|
296
299
|
## `sanity blueprints config`
|
|
297
300
|
|
|
@@ -299,12 +302,12 @@ View or edit the local Blueprint configuration
|
|
|
299
302
|
|
|
300
303
|
```
|
|
301
304
|
USAGE
|
|
302
|
-
$ sanity blueprints config [--project-id <value> -e] [--stack
|
|
305
|
+
$ pnpm exec sanity blueprints config [--project-id <value> -e] [--stack <value> ]
|
|
303
306
|
|
|
304
307
|
FLAGS
|
|
305
308
|
-e, --edit Modify the configuration interactively, or directly when combined with ID flags.
|
|
306
309
|
--project-id=<value> Directly set the project ID in the configuration. Requires --edit flag
|
|
307
|
-
--stack
|
|
310
|
+
--stack=<value> Stack name or ID to set in the configuration. Requires --edit flag
|
|
308
311
|
|
|
309
312
|
DESCRIPTION
|
|
310
313
|
View or edit the local Blueprint configuration
|
|
@@ -314,19 +317,19 @@ DESCRIPTION
|
|
|
314
317
|
Without flags, displays the current configuration. Use --edit to interactively modify settings, or combine --edit with
|
|
315
318
|
ID flags to update values directly (useful for scripting and automation).
|
|
316
319
|
|
|
317
|
-
If you need to switch your Blueprint to a different Stack, use --edit --stack
|
|
320
|
+
If you need to switch your Blueprint to a different Stack, use --edit --stack.
|
|
318
321
|
|
|
319
322
|
EXAMPLES
|
|
320
|
-
$ sanity blueprints config
|
|
323
|
+
$ pnpm exec sanity blueprints config
|
|
321
324
|
|
|
322
|
-
$ sanity blueprints config --edit
|
|
325
|
+
$ pnpm exec sanity blueprints config --edit
|
|
323
326
|
|
|
324
|
-
$ sanity blueprints config --edit --project-id <projectId>
|
|
327
|
+
$ pnpm exec sanity blueprints config --edit --project-id <projectId>
|
|
325
328
|
|
|
326
|
-
$ sanity blueprints config --edit --project-id <projectId> --stack-id
|
|
329
|
+
$ pnpm exec sanity blueprints config --edit --project-id <projectId> --stack <name-or-id>
|
|
327
330
|
```
|
|
328
331
|
|
|
329
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/
|
|
332
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.1.0/src/commands/blueprints/config.ts)_
|
|
330
333
|
|
|
331
334
|
## `sanity blueprints deploy`
|
|
332
335
|
|
|
@@ -334,10 +337,11 @@ Deploy the local Blueprint to the remote Stack
|
|
|
334
337
|
|
|
335
338
|
```
|
|
336
339
|
USAGE
|
|
337
|
-
$ sanity blueprints deploy [--no-wait]
|
|
340
|
+
$ pnpm exec sanity blueprints deploy [--stack <value>] [--no-wait]
|
|
338
341
|
|
|
339
342
|
FLAGS
|
|
340
|
-
--no-wait
|
|
343
|
+
--no-wait Do not wait for Stack deployment to complete
|
|
344
|
+
--stack=<value> Stack name or ID to use instead of the locally configured Stack
|
|
341
345
|
|
|
342
346
|
DESCRIPTION
|
|
343
347
|
Deploy the local Blueprint to the remote Stack
|
|
@@ -350,13 +354,15 @@ DESCRIPTION
|
|
|
350
354
|
|
|
351
355
|
Use --no-wait to queue the deployment and return immediately without waiting for completion.
|
|
352
356
|
|
|
357
|
+
Set SANITY_ASSET_TIMEOUT (seconds) to override the 60-second timeout for processing resource assets.
|
|
358
|
+
|
|
353
359
|
EXAMPLES
|
|
354
|
-
$ sanity blueprints deploy
|
|
360
|
+
$ pnpm exec sanity blueprints deploy
|
|
355
361
|
|
|
356
|
-
$ sanity blueprints deploy --no-wait
|
|
362
|
+
$ pnpm exec sanity blueprints deploy --no-wait
|
|
357
363
|
```
|
|
358
364
|
|
|
359
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/
|
|
365
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.1.0/src/commands/blueprints/deploy.ts)_
|
|
360
366
|
|
|
361
367
|
## `sanity blueprints destroy`
|
|
362
368
|
|
|
@@ -364,13 +370,13 @@ Destroy the remote Stack deployment and its resources (will not delete local fil
|
|
|
364
370
|
|
|
365
371
|
```
|
|
366
372
|
USAGE
|
|
367
|
-
$ sanity blueprints destroy [--project-id <value> --stack
|
|
373
|
+
$ pnpm exec sanity blueprints destroy [--project-id <value> --stack <value> --force] [--no-wait]
|
|
368
374
|
|
|
369
375
|
FLAGS
|
|
370
376
|
--force Force Stack destruction (skip confirmation)
|
|
371
377
|
--no-wait Do not wait for Stack destruction to complete
|
|
372
378
|
--project-id=<value> Project associated with the Stack
|
|
373
|
-
--stack
|
|
379
|
+
--stack=<value> Stack name or ID to destroy (defaults to the locally configured Stack)
|
|
374
380
|
|
|
375
381
|
DESCRIPTION
|
|
376
382
|
Destroy the remote Stack deployment and its resources (will not delete local files)
|
|
@@ -383,12 +389,12 @@ DESCRIPTION
|
|
|
383
389
|
Use this to clean up test environments or decommission a Stack you no longer need.
|
|
384
390
|
|
|
385
391
|
EXAMPLES
|
|
386
|
-
$ sanity blueprints destroy
|
|
392
|
+
$ pnpm exec sanity blueprints destroy
|
|
387
393
|
|
|
388
|
-
$ sanity blueprints destroy --stack-id
|
|
394
|
+
$ pnpm exec sanity blueprints destroy --stack <name-or-id> --project-id <projectId> --force --no-wait
|
|
389
395
|
```
|
|
390
396
|
|
|
391
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/
|
|
397
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.1.0/src/commands/blueprints/destroy.ts)_
|
|
392
398
|
|
|
393
399
|
## `sanity blueprints doctor`
|
|
394
400
|
|
|
@@ -396,13 +402,13 @@ Diagnose potential issues with local Blueprint and remote Stack configuration
|
|
|
396
402
|
|
|
397
403
|
```
|
|
398
404
|
USAGE
|
|
399
|
-
$ sanity blueprints doctor [--json] [-p <value>] [--verbose] [--fix]
|
|
405
|
+
$ pnpm exec sanity blueprints doctor [--json] [-p <value>] [--verbose] [--fix]
|
|
400
406
|
|
|
401
407
|
FLAGS
|
|
402
408
|
-p, --path=<value> [env: SANITY_BLUEPRINT_PATH] Path to a Blueprint file or directory containing one
|
|
403
409
|
--fix Interactively fix configuration issues
|
|
404
410
|
--json Format output as json.
|
|
405
|
-
--verbose
|
|
411
|
+
--[no-]verbose Verbose output; defaults to true
|
|
406
412
|
|
|
407
413
|
DESCRIPTION
|
|
408
414
|
Diagnose potential issues with local Blueprint and remote Stack configuration
|
|
@@ -414,7 +420,7 @@ DESCRIPTION
|
|
|
414
420
|
issues.
|
|
415
421
|
```
|
|
416
422
|
|
|
417
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/
|
|
423
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.1.0/src/commands/blueprints/doctor.ts)_
|
|
418
424
|
|
|
419
425
|
## `sanity blueprints info`
|
|
420
426
|
|
|
@@ -422,10 +428,10 @@ Show information about the local Blueprint's remote Stack deployment
|
|
|
422
428
|
|
|
423
429
|
```
|
|
424
430
|
USAGE
|
|
425
|
-
$ sanity blueprints info [--
|
|
431
|
+
$ pnpm exec sanity blueprints info [--stack <value>]
|
|
426
432
|
|
|
427
433
|
FLAGS
|
|
428
|
-
--
|
|
434
|
+
--stack=<value> Stack name or ID to use instead of the locally configured Stack
|
|
429
435
|
|
|
430
436
|
DESCRIPTION
|
|
431
437
|
Show information about the local Blueprint's remote Stack deployment
|
|
@@ -439,12 +445,12 @@ DESCRIPTION
|
|
|
439
445
|
Run 'blueprints stacks' to see all available Stacks in your project or organization.
|
|
440
446
|
|
|
441
447
|
EXAMPLES
|
|
442
|
-
$ sanity blueprints info
|
|
448
|
+
$ pnpm exec sanity blueprints info
|
|
443
449
|
|
|
444
|
-
$ sanity blueprints info --
|
|
450
|
+
$ pnpm exec sanity blueprints info --stack <name-or-id>
|
|
445
451
|
```
|
|
446
452
|
|
|
447
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/
|
|
453
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.1.0/src/commands/blueprints/info.ts)_
|
|
448
454
|
|
|
449
455
|
## `sanity blueprints init [DIR]`
|
|
450
456
|
|
|
@@ -452,7 +458,7 @@ Initialize a local Blueprint and optionally provision a remote Stack deployment
|
|
|
452
458
|
|
|
453
459
|
```
|
|
454
460
|
USAGE
|
|
455
|
-
$ sanity blueprints init [DIR] [--verbose] [--dir <value>] [--example <value> | --blueprint-type json|js|ts |
|
|
461
|
+
$ pnpm exec sanity blueprints init [DIR] [--verbose] [--dir <value>] [--example <value> | --blueprint-type json|js|ts |
|
|
456
462
|
--stack-id <value> | --stack-name <value>] [--project-id <value>]
|
|
457
463
|
|
|
458
464
|
ARGUMENTS
|
|
@@ -483,18 +489,18 @@ DESCRIPTION
|
|
|
483
489
|
After initialization, use 'blueprints plan' to preview changes, then 'blueprints deploy' to apply them.
|
|
484
490
|
|
|
485
491
|
EXAMPLES
|
|
486
|
-
$ sanity blueprints init
|
|
492
|
+
$ pnpm exec sanity blueprints init
|
|
487
493
|
|
|
488
|
-
$ sanity blueprints init [directory]
|
|
494
|
+
$ pnpm exec sanity blueprints init [directory]
|
|
489
495
|
|
|
490
|
-
$ sanity blueprints init --blueprint-type <json|js|ts>
|
|
496
|
+
$ pnpm exec sanity blueprints init --blueprint-type <json|js|ts>
|
|
491
497
|
|
|
492
|
-
$ sanity blueprints init --blueprint-type <json|js|ts> --project-id <projectId> --stack-id <stackId>
|
|
498
|
+
$ pnpm exec sanity blueprints init --blueprint-type <json|js|ts> --project-id <projectId> --stack-id <stackId>
|
|
493
499
|
|
|
494
|
-
$ sanity blueprints init --blueprint-type <json|js|ts> --stack-name <stackName>
|
|
500
|
+
$ pnpm exec sanity blueprints init --blueprint-type <json|js|ts> --stack-name <stackName>
|
|
495
501
|
```
|
|
496
502
|
|
|
497
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/
|
|
503
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.1.0/src/commands/blueprints/init.ts)_
|
|
498
504
|
|
|
499
505
|
## `sanity blueprints logs`
|
|
500
506
|
|
|
@@ -502,10 +508,11 @@ Display logs for the current Blueprint's Stack deployment
|
|
|
502
508
|
|
|
503
509
|
```
|
|
504
510
|
USAGE
|
|
505
|
-
$ sanity blueprints logs [-w]
|
|
511
|
+
$ pnpm exec sanity blueprints logs [--stack <value>] [-w]
|
|
506
512
|
|
|
507
513
|
FLAGS
|
|
508
|
-
-w, --watch
|
|
514
|
+
-w, --watch Watch for new Stack logs (streaming mode)
|
|
515
|
+
--stack=<value> Stack name or ID to use instead of the locally configured Stack
|
|
509
516
|
|
|
510
517
|
DESCRIPTION
|
|
511
518
|
Display logs for the current Blueprint's Stack deployment
|
|
@@ -517,12 +524,12 @@ DESCRIPTION
|
|
|
517
524
|
If you're not seeing expected logs, verify your Stack is deployed with 'blueprints info'.
|
|
518
525
|
|
|
519
526
|
EXAMPLES
|
|
520
|
-
$ sanity blueprints logs
|
|
527
|
+
$ pnpm exec sanity blueprints logs
|
|
521
528
|
|
|
522
|
-
$ sanity blueprints logs --watch
|
|
529
|
+
$ pnpm exec sanity blueprints logs --watch
|
|
523
530
|
```
|
|
524
531
|
|
|
525
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/
|
|
532
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.1.0/src/commands/blueprints/logs.ts)_
|
|
526
533
|
|
|
527
534
|
## `sanity blueprints plan`
|
|
528
535
|
|
|
@@ -530,7 +537,10 @@ Enumerate resources to be deployed to the remote Stack - will not modify any res
|
|
|
530
537
|
|
|
531
538
|
```
|
|
532
539
|
USAGE
|
|
533
|
-
$ sanity blueprints plan
|
|
540
|
+
$ pnpm exec sanity blueprints plan [--stack <value>]
|
|
541
|
+
|
|
542
|
+
FLAGS
|
|
543
|
+
--stack=<value> Stack name or ID to use instead of the locally configured Stack
|
|
534
544
|
|
|
535
545
|
DESCRIPTION
|
|
536
546
|
Enumerate resources to be deployed to the remote Stack - will not modify any resources
|
|
@@ -542,10 +552,10 @@ DESCRIPTION
|
|
|
542
552
|
run 'blueprints deploy' to apply changes.
|
|
543
553
|
|
|
544
554
|
EXAMPLES
|
|
545
|
-
$ sanity blueprints plan
|
|
555
|
+
$ pnpm exec sanity blueprints plan
|
|
546
556
|
```
|
|
547
557
|
|
|
548
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/
|
|
558
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.1.0/src/commands/blueprints/plan.ts)_
|
|
549
559
|
|
|
550
560
|
## `sanity blueprints stacks`
|
|
551
561
|
|
|
@@ -553,7 +563,7 @@ List all remote Stack deployments (defaults to the current Blueprint's project s
|
|
|
553
563
|
|
|
554
564
|
```
|
|
555
565
|
USAGE
|
|
556
|
-
$ sanity blueprints stacks [--project-id <value> | ]
|
|
566
|
+
$ pnpm exec sanity blueprints stacks [--project-id <value> | ]
|
|
557
567
|
|
|
558
568
|
FLAGS
|
|
559
569
|
--project-id=<value> Project ID to show Stack deployments for
|
|
@@ -567,14 +577,14 @@ DESCRIPTION
|
|
|
567
577
|
audit what's deployed across your project.
|
|
568
578
|
|
|
569
579
|
EXAMPLES
|
|
570
|
-
$ sanity blueprints stacks
|
|
580
|
+
$ pnpm exec sanity blueprints stacks
|
|
571
581
|
|
|
572
|
-
$ sanity blueprints stacks --project-id <projectId>
|
|
582
|
+
$ pnpm exec sanity blueprints stacks --project-id <projectId>
|
|
573
583
|
|
|
574
|
-
$ sanity blueprints stacks --organization-id <organizationId>
|
|
584
|
+
$ pnpm exec sanity blueprints stacks --organization-id <organizationId>
|
|
575
585
|
```
|
|
576
586
|
|
|
577
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/
|
|
587
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.1.0/src/commands/blueprints/stacks.ts)_
|
|
578
588
|
|
|
579
589
|
## `sanity build [OUTPUTDIR]`
|
|
580
590
|
|
|
@@ -582,7 +592,7 @@ Builds the Sanity Studio configuration into a static bundle
|
|
|
582
592
|
|
|
583
593
|
```
|
|
584
594
|
USAGE
|
|
585
|
-
$ sanity build [OUTPUTDIR] [--auto-updates] [--minify] [--source-maps] [--stats] [-y]
|
|
595
|
+
$ pnpm exec sanity build [OUTPUTDIR] [--auto-updates] [--minify] [--source-maps] [--stats] [-y]
|
|
586
596
|
|
|
587
597
|
ARGUMENTS
|
|
588
598
|
[OUTPUTDIR] Output directory
|
|
@@ -598,12 +608,12 @@ DESCRIPTION
|
|
|
598
608
|
Builds the Sanity Studio configuration into a static bundle
|
|
599
609
|
|
|
600
610
|
EXAMPLES
|
|
601
|
-
$ sanity build
|
|
611
|
+
$ pnpm exec sanity build
|
|
602
612
|
|
|
603
|
-
$ sanity build --no-minify --source-maps
|
|
613
|
+
$ pnpm exec sanity build --no-minify --source-maps
|
|
604
614
|
```
|
|
605
615
|
|
|
606
|
-
_See code: [src/commands/build.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
616
|
+
_See code: [src/commands/build.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/build.ts)_
|
|
607
617
|
|
|
608
618
|
## `sanity codemod [CODEMODNAME]`
|
|
609
619
|
|
|
@@ -611,7 +621,7 @@ Updates Sanity Studio codebase with a code modification script
|
|
|
611
621
|
|
|
612
622
|
```
|
|
613
623
|
USAGE
|
|
614
|
-
$ sanity codemod [CODEMODNAME] [--dry] [--extensions <value>] [--no-verify]
|
|
624
|
+
$ pnpm exec sanity codemod [CODEMODNAME] [--dry] [--extensions <value>] [--no-verify]
|
|
615
625
|
|
|
616
626
|
ARGUMENTS
|
|
617
627
|
[CODEMODNAME] Name of the codemod to run
|
|
@@ -627,14 +637,14 @@ DESCRIPTION
|
|
|
627
637
|
EXAMPLES
|
|
628
638
|
Show available code mods
|
|
629
639
|
|
|
630
|
-
$ sanity codemod
|
|
640
|
+
$ pnpm exec sanity codemod
|
|
631
641
|
|
|
632
642
|
Run codemod to transform react-icons imports (dry run)
|
|
633
643
|
|
|
634
|
-
$ sanity codemod reactIconsV3 --dry
|
|
644
|
+
$ pnpm exec sanity codemod reactIconsV3 --dry
|
|
635
645
|
```
|
|
636
646
|
|
|
637
|
-
_See code: [src/commands/codemod.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
647
|
+
_See code: [src/commands/codemod.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/codemod.ts)_
|
|
638
648
|
|
|
639
649
|
## `sanity cors add ORIGIN`
|
|
640
650
|
|
|
@@ -642,7 +652,7 @@ Allow a new origin to use your project API through CORS
|
|
|
642
652
|
|
|
643
653
|
```
|
|
644
654
|
USAGE
|
|
645
|
-
$ sanity cors add ORIGIN [--credentials]
|
|
655
|
+
$ pnpm exec sanity cors add ORIGIN [--credentials]
|
|
646
656
|
|
|
647
657
|
ARGUMENTS
|
|
648
658
|
ORIGIN Origin to allow (e.g., https://example.com)
|
|
@@ -656,18 +666,18 @@ DESCRIPTION
|
|
|
656
666
|
EXAMPLES
|
|
657
667
|
Interactively add a CORS origin
|
|
658
668
|
|
|
659
|
-
$ sanity cors add
|
|
669
|
+
$ pnpm exec sanity cors add
|
|
660
670
|
|
|
661
671
|
Add a localhost origin without credentials
|
|
662
672
|
|
|
663
|
-
$ sanity cors add http://localhost:3000 --no-credentials
|
|
673
|
+
$ pnpm exec sanity cors add http://localhost:3000 --no-credentials
|
|
664
674
|
|
|
665
675
|
Add a production origin with credentials allowed
|
|
666
676
|
|
|
667
|
-
$ sanity cors add https://myapp.com --credentials
|
|
677
|
+
$ pnpm exec sanity cors add https://myapp.com --credentials
|
|
668
678
|
```
|
|
669
679
|
|
|
670
|
-
_See code: [src/commands/cors/add.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
680
|
+
_See code: [src/commands/cors/add.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/cors/add.ts)_
|
|
671
681
|
|
|
672
682
|
## `sanity cors delete [ORIGIN]`
|
|
673
683
|
|
|
@@ -675,7 +685,7 @@ Delete an existing CORS origin from your project
|
|
|
675
685
|
|
|
676
686
|
```
|
|
677
687
|
USAGE
|
|
678
|
-
$ sanity cors delete [ORIGIN]
|
|
688
|
+
$ pnpm exec sanity cors delete [ORIGIN]
|
|
679
689
|
|
|
680
690
|
ARGUMENTS
|
|
681
691
|
[ORIGIN] Origin to delete (will prompt if not provided)
|
|
@@ -686,14 +696,14 @@ DESCRIPTION
|
|
|
686
696
|
EXAMPLES
|
|
687
697
|
Interactively select and delete a CORS origin
|
|
688
698
|
|
|
689
|
-
$ sanity cors delete
|
|
699
|
+
$ pnpm exec sanity cors delete
|
|
690
700
|
|
|
691
701
|
Delete a specific CORS origin
|
|
692
702
|
|
|
693
|
-
$ sanity cors delete https://example.com
|
|
703
|
+
$ pnpm exec sanity cors delete https://example.com
|
|
694
704
|
```
|
|
695
705
|
|
|
696
|
-
_See code: [src/commands/cors/delete.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
706
|
+
_See code: [src/commands/cors/delete.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/cors/delete.ts)_
|
|
697
707
|
|
|
698
708
|
## `sanity cors list`
|
|
699
709
|
|
|
@@ -701,7 +711,7 @@ List all origins allowed to access the API for this project
|
|
|
701
711
|
|
|
702
712
|
```
|
|
703
713
|
USAGE
|
|
704
|
-
$ sanity cors list
|
|
714
|
+
$ pnpm exec sanity cors list
|
|
705
715
|
|
|
706
716
|
DESCRIPTION
|
|
707
717
|
List all origins allowed to access the API for this project
|
|
@@ -709,10 +719,10 @@ DESCRIPTION
|
|
|
709
719
|
EXAMPLES
|
|
710
720
|
List CORS origins for the current project
|
|
711
721
|
|
|
712
|
-
$ sanity cors list
|
|
722
|
+
$ pnpm exec sanity cors list
|
|
713
723
|
```
|
|
714
724
|
|
|
715
|
-
_See code: [src/commands/cors/list.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
725
|
+
_See code: [src/commands/cors/list.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/cors/list.ts)_
|
|
716
726
|
|
|
717
727
|
## `sanity dataset alias create [ALIASNAME] [TARGETDATASET]`
|
|
718
728
|
|
|
@@ -720,34 +730,41 @@ Create a dataset alias within your project
|
|
|
720
730
|
|
|
721
731
|
```
|
|
722
732
|
USAGE
|
|
723
|
-
$ sanity dataset alias create [ALIASNAME] [TARGETDATASET]
|
|
733
|
+
$ pnpm exec sanity dataset alias create [ALIASNAME] [TARGETDATASET] [-p <value>]
|
|
724
734
|
|
|
725
735
|
ARGUMENTS
|
|
726
736
|
[ALIASNAME] Dataset alias name to create
|
|
727
737
|
[TARGETDATASET] Target dataset name to link the alias to
|
|
728
738
|
|
|
739
|
+
FLAGS
|
|
740
|
+
-p, --project-id=<value> Project ID to use. Overrides the project ID from the Sanity config.
|
|
741
|
+
|
|
729
742
|
DESCRIPTION
|
|
730
743
|
Create a dataset alias within your project
|
|
731
744
|
|
|
732
745
|
EXAMPLES
|
|
746
|
+
Create alias in a specific project
|
|
747
|
+
|
|
748
|
+
$ pnpm exec sanity dataset alias create --project-id abc123 conference conf-2025
|
|
749
|
+
|
|
733
750
|
Create an alias with interactive prompts
|
|
734
751
|
|
|
735
|
-
$ sanity dataset alias create
|
|
752
|
+
$ pnpm exec sanity dataset alias create
|
|
736
753
|
|
|
737
754
|
Create alias named "conference" with interactive dataset selection
|
|
738
755
|
|
|
739
|
-
$ sanity dataset alias create conference
|
|
756
|
+
$ pnpm exec sanity dataset alias create conference
|
|
740
757
|
|
|
741
758
|
Create alias "conference" linked to "conf-2025" dataset
|
|
742
759
|
|
|
743
|
-
$ sanity dataset alias create conference conf-2025
|
|
760
|
+
$ pnpm exec sanity dataset alias create conference conf-2025
|
|
744
761
|
|
|
745
762
|
Create alias with explicit ~ prefix
|
|
746
763
|
|
|
747
|
-
$ sanity dataset alias create ~conference conf-2025
|
|
764
|
+
$ pnpm exec sanity dataset alias create ~conference conf-2025
|
|
748
765
|
```
|
|
749
766
|
|
|
750
|
-
_See code: [src/commands/dataset/alias/create.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
767
|
+
_See code: [src/commands/dataset/alias/create.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/dataset/alias/create.ts)_
|
|
751
768
|
|
|
752
769
|
## `sanity dataset alias delete ALIASNAME`
|
|
753
770
|
|
|
@@ -755,13 +772,14 @@ Delete a dataset alias within your project
|
|
|
755
772
|
|
|
756
773
|
```
|
|
757
774
|
USAGE
|
|
758
|
-
$ sanity dataset alias delete ALIASNAME [--force]
|
|
775
|
+
$ pnpm exec sanity dataset alias delete ALIASNAME [-p <value>] [--force]
|
|
759
776
|
|
|
760
777
|
ARGUMENTS
|
|
761
778
|
ALIASNAME Dataset alias name to delete
|
|
762
779
|
|
|
763
780
|
FLAGS
|
|
764
|
-
--
|
|
781
|
+
-p, --project-id=<value> Project ID to use. Overrides the project ID from the Sanity config.
|
|
782
|
+
--force Skip confirmation prompt and delete immediately
|
|
765
783
|
|
|
766
784
|
DESCRIPTION
|
|
767
785
|
Delete a dataset alias within your project
|
|
@@ -769,18 +787,18 @@ DESCRIPTION
|
|
|
769
787
|
EXAMPLES
|
|
770
788
|
Delete alias named "conference" with confirmation prompt
|
|
771
789
|
|
|
772
|
-
$ sanity dataset alias delete conference
|
|
790
|
+
$ pnpm exec sanity dataset alias delete conference
|
|
773
791
|
|
|
774
792
|
Delete alias with explicit ~ prefix
|
|
775
793
|
|
|
776
|
-
$ sanity dataset alias delete ~conference
|
|
794
|
+
$ pnpm exec sanity dataset alias delete ~conference
|
|
777
795
|
|
|
778
796
|
Delete alias named "conference" without confirmation prompt
|
|
779
797
|
|
|
780
|
-
$ sanity dataset alias delete conference --force
|
|
798
|
+
$ pnpm exec sanity dataset alias delete conference --force
|
|
781
799
|
```
|
|
782
800
|
|
|
783
|
-
_See code: [src/commands/dataset/alias/delete.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
801
|
+
_See code: [src/commands/dataset/alias/delete.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/dataset/alias/delete.ts)_
|
|
784
802
|
|
|
785
803
|
## `sanity dataset alias link [ALIASNAME] [TARGETDATASET]`
|
|
786
804
|
|
|
@@ -788,14 +806,15 @@ Link a dataset alias to a dataset within your project
|
|
|
788
806
|
|
|
789
807
|
```
|
|
790
808
|
USAGE
|
|
791
|
-
$ sanity dataset alias link [ALIASNAME] [TARGETDATASET] [--force]
|
|
809
|
+
$ pnpm exec sanity dataset alias link [ALIASNAME] [TARGETDATASET] [-p <value>] [--force]
|
|
792
810
|
|
|
793
811
|
ARGUMENTS
|
|
794
812
|
[ALIASNAME] Dataset alias name to link
|
|
795
813
|
[TARGETDATASET] Target dataset name to link the alias to
|
|
796
814
|
|
|
797
815
|
FLAGS
|
|
798
|
-
--
|
|
816
|
+
-p, --project-id=<value> Project ID to use. Overrides the project ID from the Sanity config.
|
|
817
|
+
--force Skip confirmation prompt when relinking existing alias
|
|
799
818
|
|
|
800
819
|
DESCRIPTION
|
|
801
820
|
Link a dataset alias to a dataset within your project
|
|
@@ -803,26 +822,26 @@ DESCRIPTION
|
|
|
803
822
|
EXAMPLES
|
|
804
823
|
Link an alias with interactive prompts
|
|
805
824
|
|
|
806
|
-
$ sanity dataset alias link
|
|
825
|
+
$ pnpm exec sanity dataset alias link
|
|
807
826
|
|
|
808
827
|
Link alias named "conference" with interactive dataset selection
|
|
809
828
|
|
|
810
|
-
$ sanity dataset alias link conference
|
|
829
|
+
$ pnpm exec sanity dataset alias link conference
|
|
811
830
|
|
|
812
831
|
Link alias "conference" to "conf-2025" dataset
|
|
813
832
|
|
|
814
|
-
$ sanity dataset alias link conference conf-2025
|
|
833
|
+
$ pnpm exec sanity dataset alias link conference conf-2025
|
|
815
834
|
|
|
816
835
|
Link alias with explicit ~ prefix
|
|
817
836
|
|
|
818
|
-
$ sanity dataset alias link ~conference conf-2025
|
|
837
|
+
$ pnpm exec sanity dataset alias link ~conference conf-2025
|
|
819
838
|
|
|
820
839
|
Force link without confirmation (skip relink prompt)
|
|
821
840
|
|
|
822
|
-
$ sanity dataset alias link conference conf-2025 --force
|
|
841
|
+
$ pnpm exec sanity dataset alias link conference conf-2025 --force
|
|
823
842
|
```
|
|
824
843
|
|
|
825
|
-
_See code: [src/commands/dataset/alias/link.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
844
|
+
_See code: [src/commands/dataset/alias/link.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/dataset/alias/link.ts)_
|
|
826
845
|
|
|
827
846
|
## `sanity dataset alias unlink [ALIASNAME]`
|
|
828
847
|
|
|
@@ -830,13 +849,14 @@ Unlink a dataset alias from its dataset within your project
|
|
|
830
849
|
|
|
831
850
|
```
|
|
832
851
|
USAGE
|
|
833
|
-
$ sanity dataset alias unlink [ALIASNAME] [--force]
|
|
852
|
+
$ pnpm exec sanity dataset alias unlink [ALIASNAME] [-p <value>] [--force]
|
|
834
853
|
|
|
835
854
|
ARGUMENTS
|
|
836
855
|
[ALIASNAME] Dataset alias name to unlink
|
|
837
856
|
|
|
838
857
|
FLAGS
|
|
839
|
-
--
|
|
858
|
+
-p, --project-id=<value> Project ID to use. Overrides the project ID from the Sanity config.
|
|
859
|
+
--force Skip confirmation prompt and unlink immediately
|
|
840
860
|
|
|
841
861
|
DESCRIPTION
|
|
842
862
|
Unlink a dataset alias from its dataset within your project
|
|
@@ -844,22 +864,22 @@ DESCRIPTION
|
|
|
844
864
|
EXAMPLES
|
|
845
865
|
Unlink an alias with interactive selection
|
|
846
866
|
|
|
847
|
-
$ sanity dataset alias unlink
|
|
867
|
+
$ pnpm exec sanity dataset alias unlink
|
|
848
868
|
|
|
849
869
|
Unlink alias "conference" with confirmation prompt
|
|
850
870
|
|
|
851
|
-
$ sanity dataset alias unlink conference
|
|
871
|
+
$ pnpm exec sanity dataset alias unlink conference
|
|
852
872
|
|
|
853
873
|
Unlink alias with explicit ~ prefix
|
|
854
874
|
|
|
855
|
-
$ sanity dataset alias unlink ~conference
|
|
875
|
+
$ pnpm exec sanity dataset alias unlink ~conference
|
|
856
876
|
|
|
857
877
|
Unlink alias "conference" without confirmation prompt
|
|
858
878
|
|
|
859
|
-
$ sanity dataset alias unlink conference --force
|
|
879
|
+
$ pnpm exec sanity dataset alias unlink conference --force
|
|
860
880
|
```
|
|
861
881
|
|
|
862
|
-
_See code: [src/commands/dataset/alias/unlink.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
882
|
+
_See code: [src/commands/dataset/alias/unlink.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/dataset/alias/unlink.ts)_
|
|
863
883
|
|
|
864
884
|
## `sanity dataset copy [SOURCE] [TARGET]`
|
|
865
885
|
|
|
@@ -867,20 +887,21 @@ Manages dataset copying, including starting a new copy job, listing copy jobs an
|
|
|
867
887
|
|
|
868
888
|
```
|
|
869
889
|
USAGE
|
|
870
|
-
$ sanity dataset copy [SOURCE] [TARGET] [--attach <value> | --list | --detach | --skip-history]
|
|
871
|
-
] [--offset <value> ]
|
|
890
|
+
$ pnpm exec sanity dataset copy [SOURCE] [TARGET] [-p <value>] [--attach <value> | --list | --detach | --skip-history]
|
|
891
|
+
[--limit <value> ] [--offset <value> ]
|
|
872
892
|
|
|
873
893
|
ARGUMENTS
|
|
874
894
|
[SOURCE] Name of the dataset to copy from
|
|
875
895
|
[TARGET] Name of the dataset to copy to
|
|
876
896
|
|
|
877
897
|
FLAGS
|
|
878
|
-
--
|
|
879
|
-
|
|
880
|
-
|
|
881
|
-
|
|
882
|
-
|
|
883
|
-
|
|
898
|
+
-p, --project-id=<value> Project ID to use. Overrides the project ID from the Sanity config.
|
|
899
|
+
--attach=<value> Attach to the running copy process to show progress
|
|
900
|
+
--detach Start the copy without waiting for it to finish
|
|
901
|
+
--limit=<value> Maximum number of jobs returned (default 10, max 1000)
|
|
902
|
+
--list Lists all dataset copy jobs
|
|
903
|
+
--offset=<value> Start position in the list of jobs (default 0)
|
|
904
|
+
--skip-history Don't preserve document history on copy
|
|
884
905
|
|
|
885
906
|
DESCRIPTION
|
|
886
907
|
Manages dataset copying, including starting a new copy job, listing copy jobs and following the progress of a running
|
|
@@ -889,38 +910,38 @@ DESCRIPTION
|
|
|
889
910
|
EXAMPLES
|
|
890
911
|
Interactively copy a dataset
|
|
891
912
|
|
|
892
|
-
$ sanity dataset copy
|
|
913
|
+
$ pnpm exec sanity dataset copy
|
|
893
914
|
|
|
894
915
|
Copy from source-dataset (prompts for target)
|
|
895
916
|
|
|
896
|
-
$ sanity dataset copy source-dataset
|
|
917
|
+
$ pnpm exec sanity dataset copy source-dataset
|
|
897
918
|
|
|
898
919
|
Copy from source-dataset to target-dataset
|
|
899
920
|
|
|
900
|
-
$ sanity dataset copy source-dataset target-dataset
|
|
921
|
+
$ pnpm exec sanity dataset copy source-dataset target-dataset
|
|
901
922
|
|
|
902
923
|
Copy without preserving document history (faster for large datasets)
|
|
903
924
|
|
|
904
|
-
$ sanity dataset copy --skip-history source target
|
|
925
|
+
$ pnpm exec sanity dataset copy --skip-history source target
|
|
905
926
|
|
|
906
927
|
Start copy job without waiting for completion
|
|
907
928
|
|
|
908
|
-
$ sanity dataset copy --detach source target
|
|
929
|
+
$ pnpm exec sanity dataset copy --detach source target
|
|
909
930
|
|
|
910
931
|
Attach to a running copy job to follow progress
|
|
911
932
|
|
|
912
|
-
$ sanity dataset copy --attach <job-id>
|
|
933
|
+
$ pnpm exec sanity dataset copy --attach <job-id>
|
|
913
934
|
|
|
914
935
|
List all dataset copy jobs
|
|
915
936
|
|
|
916
|
-
$ sanity dataset copy --list
|
|
937
|
+
$ pnpm exec sanity dataset copy --list
|
|
917
938
|
|
|
918
939
|
List copy jobs with pagination
|
|
919
940
|
|
|
920
|
-
$ sanity dataset copy --list --offset 2 --limit 10
|
|
941
|
+
$ pnpm exec sanity dataset copy --list --offset 2 --limit 10
|
|
921
942
|
```
|
|
922
943
|
|
|
923
|
-
_See code: [src/commands/dataset/copy.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
944
|
+
_See code: [src/commands/dataset/copy.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/dataset/copy.ts)_
|
|
924
945
|
|
|
925
946
|
## `sanity dataset create [NAME]`
|
|
926
947
|
|
|
@@ -928,14 +949,18 @@ Create a new dataset within your project
|
|
|
928
949
|
|
|
929
950
|
```
|
|
930
951
|
USAGE
|
|
931
|
-
$ sanity dataset create [NAME] [--
|
|
952
|
+
$ pnpm exec sanity dataset create [NAME] [-p <value>] [--embeddings-projection <value> --embeddings] [--visibility
|
|
953
|
+
custom|private|public]
|
|
932
954
|
|
|
933
955
|
ARGUMENTS
|
|
934
956
|
[NAME] Name of the dataset to create
|
|
935
957
|
|
|
936
958
|
FLAGS
|
|
937
|
-
--
|
|
938
|
-
|
|
959
|
+
-p, --project-id=<value> Project ID to use. Overrides the project ID from the Sanity config.
|
|
960
|
+
--embeddings Enable embeddings for this dataset
|
|
961
|
+
--embeddings-projection=<value> GROQ projection for embeddings indexing (e.g. "{ title, body }")
|
|
962
|
+
--visibility=<option> Set visibility for this dataset (custom/private/public)
|
|
963
|
+
<options: custom|private|public>
|
|
939
964
|
|
|
940
965
|
DESCRIPTION
|
|
941
966
|
Create a new dataset within your project
|
|
@@ -943,18 +968,18 @@ DESCRIPTION
|
|
|
943
968
|
EXAMPLES
|
|
944
969
|
Interactively create a dataset
|
|
945
970
|
|
|
946
|
-
$ sanity dataset create
|
|
971
|
+
$ pnpm exec sanity dataset create
|
|
947
972
|
|
|
948
973
|
Create a dataset named "my-dataset"
|
|
949
974
|
|
|
950
|
-
$ sanity dataset create my-dataset
|
|
975
|
+
$ pnpm exec sanity dataset create my-dataset
|
|
951
976
|
|
|
952
977
|
Create a private dataset named "my-dataset"
|
|
953
978
|
|
|
954
|
-
$ sanity dataset create my-dataset --visibility private
|
|
979
|
+
$ pnpm exec sanity dataset create my-dataset --visibility private
|
|
955
980
|
```
|
|
956
981
|
|
|
957
|
-
_See code: [src/commands/dataset/create.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
982
|
+
_See code: [src/commands/dataset/create.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/dataset/create.ts)_
|
|
958
983
|
|
|
959
984
|
## `sanity dataset delete DATASETNAME`
|
|
960
985
|
|
|
@@ -962,13 +987,14 @@ Delete a dataset within your project
|
|
|
962
987
|
|
|
963
988
|
```
|
|
964
989
|
USAGE
|
|
965
|
-
$ sanity dataset delete DATASETNAME [--force]
|
|
990
|
+
$ pnpm exec sanity dataset delete DATASETNAME [-p <value>] [--force]
|
|
966
991
|
|
|
967
992
|
ARGUMENTS
|
|
968
993
|
DATASETNAME Dataset name to delete
|
|
969
994
|
|
|
970
995
|
FLAGS
|
|
971
|
-
--
|
|
996
|
+
-p, --project-id=<value> Project ID to use. Overrides the project ID from the Sanity config.
|
|
997
|
+
--force Do not prompt for delete confirmation - forcefully delete
|
|
972
998
|
|
|
973
999
|
DESCRIPTION
|
|
974
1000
|
Delete a dataset within your project
|
|
@@ -976,14 +1002,99 @@ DESCRIPTION
|
|
|
976
1002
|
EXAMPLES
|
|
977
1003
|
Delete a specific dataset
|
|
978
1004
|
|
|
979
|
-
$ sanity dataset delete my-dataset
|
|
1005
|
+
$ pnpm exec sanity dataset delete my-dataset
|
|
980
1006
|
|
|
981
1007
|
Delete a specific dataset without confirmation
|
|
982
1008
|
|
|
983
|
-
$ sanity dataset delete my-dataset --force
|
|
1009
|
+
$ pnpm exec sanity dataset delete my-dataset --force
|
|
1010
|
+
```
|
|
1011
|
+
|
|
1012
|
+
_See code: [src/commands/dataset/delete.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/dataset/delete.ts)_
|
|
1013
|
+
|
|
1014
|
+
## `sanity dataset embeddings disable [DATASET]`
|
|
1015
|
+
|
|
1016
|
+
Disable embeddings for a dataset
|
|
1017
|
+
|
|
1018
|
+
```
|
|
1019
|
+
USAGE
|
|
1020
|
+
$ pnpm exec sanity dataset embeddings disable [DATASET] [-p <value>]
|
|
1021
|
+
|
|
1022
|
+
ARGUMENTS
|
|
1023
|
+
[DATASET] Dataset name to disable embeddings for
|
|
1024
|
+
|
|
1025
|
+
FLAGS
|
|
1026
|
+
-p, --project-id=<value> Project ID to use. Overrides the project ID from the Sanity config.
|
|
1027
|
+
|
|
1028
|
+
DESCRIPTION
|
|
1029
|
+
Disable embeddings for a dataset
|
|
1030
|
+
|
|
1031
|
+
EXAMPLES
|
|
1032
|
+
Disable embeddings for the production dataset
|
|
1033
|
+
|
|
1034
|
+
$ pnpm exec sanity dataset embeddings disable production
|
|
1035
|
+
```
|
|
1036
|
+
|
|
1037
|
+
_See code: [src/commands/dataset/embeddings/disable.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/dataset/embeddings/disable.ts)_
|
|
1038
|
+
|
|
1039
|
+
## `sanity dataset embeddings enable [DATASET]`
|
|
1040
|
+
|
|
1041
|
+
Enable embeddings for a dataset
|
|
1042
|
+
|
|
1043
|
+
```
|
|
1044
|
+
USAGE
|
|
1045
|
+
$ pnpm exec sanity dataset embeddings enable [DATASET] [-p <value>] [--projection <value>] [--wait]
|
|
1046
|
+
|
|
1047
|
+
ARGUMENTS
|
|
1048
|
+
[DATASET] Dataset name to enable embeddings for
|
|
1049
|
+
|
|
1050
|
+
FLAGS
|
|
1051
|
+
-p, --project-id=<value> Project ID to use. Overrides the project ID from the Sanity config.
|
|
1052
|
+
--projection=<value> GROQ projection defining which fields to embed (e.g. "{ title, body }")
|
|
1053
|
+
--wait Wait for embeddings processing to complete before returning
|
|
1054
|
+
|
|
1055
|
+
DESCRIPTION
|
|
1056
|
+
Enable embeddings for a dataset
|
|
1057
|
+
|
|
1058
|
+
EXAMPLES
|
|
1059
|
+
Enable embeddings for the production dataset
|
|
1060
|
+
|
|
1061
|
+
$ pnpm exec sanity dataset embeddings enable production
|
|
1062
|
+
|
|
1063
|
+
Enable embeddings with a specific projection
|
|
1064
|
+
|
|
1065
|
+
$ pnpm exec sanity dataset embeddings enable production --projection "{ title, body }"
|
|
1066
|
+
|
|
1067
|
+
Enable embeddings and wait for processing to complete
|
|
1068
|
+
|
|
1069
|
+
$ pnpm exec sanity dataset embeddings enable production --wait
|
|
1070
|
+
```
|
|
1071
|
+
|
|
1072
|
+
_See code: [src/commands/dataset/embeddings/enable.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/dataset/embeddings/enable.ts)_
|
|
1073
|
+
|
|
1074
|
+
## `sanity dataset embeddings status [DATASET]`
|
|
1075
|
+
|
|
1076
|
+
Show embeddings settings and status for a dataset
|
|
1077
|
+
|
|
1078
|
+
```
|
|
1079
|
+
USAGE
|
|
1080
|
+
$ pnpm exec sanity dataset embeddings status [DATASET] [-p <value>]
|
|
1081
|
+
|
|
1082
|
+
ARGUMENTS
|
|
1083
|
+
[DATASET] The name of the dataset to check embeddings status for
|
|
1084
|
+
|
|
1085
|
+
FLAGS
|
|
1086
|
+
-p, --project-id=<value> Project ID to use. Overrides the project ID from the Sanity config.
|
|
1087
|
+
|
|
1088
|
+
DESCRIPTION
|
|
1089
|
+
Show embeddings settings and status for a dataset
|
|
1090
|
+
|
|
1091
|
+
EXAMPLES
|
|
1092
|
+
Show embeddings status for the production dataset
|
|
1093
|
+
|
|
1094
|
+
$ pnpm exec sanity dataset embeddings status production
|
|
984
1095
|
```
|
|
985
1096
|
|
|
986
|
-
_See code: [src/commands/dataset/
|
|
1097
|
+
_See code: [src/commands/dataset/embeddings/status.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/dataset/embeddings/status.ts)_
|
|
987
1098
|
|
|
988
1099
|
## `sanity dataset export [NAME] [DESTINATION]`
|
|
989
1100
|
|
|
@@ -991,25 +1102,26 @@ Export dataset to local filesystem as a gzipped tarball. Assets failing with HTT
|
|
|
991
1102
|
|
|
992
1103
|
```
|
|
993
1104
|
USAGE
|
|
994
|
-
$ sanity dataset export [NAME] [DESTINATION] [--asset-concurrency <value>] [--mode stream|cursor]
|
|
995
|
-
[--no-compress] [--no-drafts] [--overwrite] [--raw] [--types <value>]
|
|
1105
|
+
$ pnpm exec sanity dataset export [NAME] [DESTINATION] [-p <value>] [--asset-concurrency <value>] [--mode stream|cursor]
|
|
1106
|
+
[--no-assets] [--no-compress] [--no-drafts] [--overwrite] [--raw] [--types <value>]
|
|
996
1107
|
|
|
997
1108
|
ARGUMENTS
|
|
998
1109
|
[NAME] Name of the dataset to export
|
|
999
1110
|
[DESTINATION] Output destination file path
|
|
1000
1111
|
|
|
1001
1112
|
FLAGS
|
|
1002
|
-
--
|
|
1003
|
-
|
|
1004
|
-
|
|
1005
|
-
|
|
1006
|
-
|
|
1007
|
-
|
|
1008
|
-
|
|
1009
|
-
|
|
1010
|
-
|
|
1011
|
-
|
|
1012
|
-
|
|
1113
|
+
-p, --project-id=<value> Project ID to use. Overrides the project ID from the Sanity config.
|
|
1114
|
+
--asset-concurrency=<value> [default: 8] Concurrent number of asset downloads
|
|
1115
|
+
--mode=<option> [default: stream] Mode to export documents with `cursor` might be more performant for
|
|
1116
|
+
larger datasets, but might not be as accurate if the dataset is being modified during
|
|
1117
|
+
export
|
|
1118
|
+
<options: stream|cursor>
|
|
1119
|
+
--no-assets Export only non-asset documents and remove references to image assets
|
|
1120
|
+
--no-compress Skips compressing tarball entries (still generates a gzip file)
|
|
1121
|
+
--no-drafts Export only published versions of documents
|
|
1122
|
+
--overwrite Overwrite any file with the same name
|
|
1123
|
+
--raw Extract only documents, without rewriting asset references
|
|
1124
|
+
--types=<value> Defines which document types to export (comma-separated)
|
|
1013
1125
|
|
|
1014
1126
|
DESCRIPTION
|
|
1015
1127
|
Export dataset to local filesystem as a gzipped tarball. Assets failing with HTTP status codes 401, 403 and 404 upon
|
|
@@ -1018,22 +1130,22 @@ DESCRIPTION
|
|
|
1018
1130
|
EXAMPLES
|
|
1019
1131
|
Export dataset "moviedb" to localPath.tar.gz
|
|
1020
1132
|
|
|
1021
|
-
$ sanity dataset export moviedb localPath.tar.gz
|
|
1133
|
+
$ pnpm exec sanity dataset export moviedb localPath.tar.gz
|
|
1022
1134
|
|
|
1023
1135
|
Export dataset without assets
|
|
1024
1136
|
|
|
1025
|
-
$ sanity dataset export moviedb assetless.tar.gz --no-assets
|
|
1137
|
+
$ pnpm exec sanity dataset export moviedb assetless.tar.gz --no-assets
|
|
1026
1138
|
|
|
1027
1139
|
Export raw documents without asset reference rewriting
|
|
1028
1140
|
|
|
1029
|
-
$ sanity dataset export staging staging.tar.gz --raw
|
|
1141
|
+
$ pnpm exec sanity dataset export staging staging.tar.gz --raw
|
|
1030
1142
|
|
|
1031
1143
|
Export specific document types
|
|
1032
1144
|
|
|
1033
|
-
$ sanity dataset export staging staging.tar.gz --types products,shops
|
|
1145
|
+
$ pnpm exec sanity dataset export staging staging.tar.gz --types products,shops
|
|
1034
1146
|
```
|
|
1035
1147
|
|
|
1036
|
-
_See code: [src/commands/dataset/export.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
1148
|
+
_See code: [src/commands/dataset/export.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/dataset/export.ts)_
|
|
1037
1149
|
|
|
1038
1150
|
## `sanity dataset import SOURCE`
|
|
1039
1151
|
|
|
@@ -1041,7 +1153,7 @@ Import documents to a Sanity dataset
|
|
|
1041
1153
|
|
|
1042
1154
|
```
|
|
1043
1155
|
USAGE
|
|
1044
|
-
$ sanity dataset import SOURCE -p <value> -d <value> [-t <value>] [--replace | --missing] [--allow-failing-assets]
|
|
1156
|
+
$ pnpm exec sanity dataset import SOURCE -p <value> -d <value> [-t <value>] [--replace | --missing] [--allow-failing-assets]
|
|
1045
1157
|
[--allow-assets-in-different-dataset] [--replace-assets] [--skip-cross-dataset-references]
|
|
1046
1158
|
[--allow-replacement-characters] [--allow-system-documents] [--asset-concurrency <value>]
|
|
1047
1159
|
|
|
@@ -1068,14 +1180,14 @@ DESCRIPTION
|
|
|
1068
1180
|
EXAMPLES
|
|
1069
1181
|
Import "./my-dataset.ndjson" into dataset "staging"
|
|
1070
1182
|
|
|
1071
|
-
$ sanity dataset import -p myPrOj -d staging -t someSecretToken my-dataset.ndjson
|
|
1183
|
+
$ pnpm exec sanity dataset import -p myPrOj -d staging -t someSecretToken my-dataset.ndjson
|
|
1072
1184
|
|
|
1073
1185
|
Import into dataset "test" from stdin, read token from env var
|
|
1074
1186
|
|
|
1075
1187
|
cat my-dataset.ndjson | sanity dataset import -p myPrOj -d test -
|
|
1076
1188
|
```
|
|
1077
1189
|
|
|
1078
|
-
_See code: [src/commands/dataset/import.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
1190
|
+
_See code: [src/commands/dataset/import.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/dataset/import.ts)_
|
|
1079
1191
|
|
|
1080
1192
|
## `sanity dataset list`
|
|
1081
1193
|
|
|
@@ -1083,7 +1195,10 @@ List datasets of your project
|
|
|
1083
1195
|
|
|
1084
1196
|
```
|
|
1085
1197
|
USAGE
|
|
1086
|
-
$ sanity dataset list
|
|
1198
|
+
$ pnpm exec sanity dataset list [-p <value>]
|
|
1199
|
+
|
|
1200
|
+
FLAGS
|
|
1201
|
+
-p, --project-id=<value> Project ID to use. Overrides the project ID from the Sanity config.
|
|
1087
1202
|
|
|
1088
1203
|
DESCRIPTION
|
|
1089
1204
|
List datasets of your project
|
|
@@ -1091,10 +1206,14 @@ DESCRIPTION
|
|
|
1091
1206
|
EXAMPLES
|
|
1092
1207
|
List datasets of your project
|
|
1093
1208
|
|
|
1094
|
-
$ sanity dataset list
|
|
1209
|
+
$ pnpm exec sanity dataset list
|
|
1210
|
+
|
|
1211
|
+
List datasets for a specific project
|
|
1212
|
+
|
|
1213
|
+
$ pnpm exec sanity dataset list --project-id abc123
|
|
1095
1214
|
```
|
|
1096
1215
|
|
|
1097
|
-
_See code: [src/commands/dataset/list.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
1216
|
+
_See code: [src/commands/dataset/list.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/dataset/list.ts)_
|
|
1098
1217
|
|
|
1099
1218
|
## `sanity dataset visibility get DATASET`
|
|
1100
1219
|
|
|
@@ -1102,21 +1221,24 @@ Get the visibility of a dataset
|
|
|
1102
1221
|
|
|
1103
1222
|
```
|
|
1104
1223
|
USAGE
|
|
1105
|
-
$ sanity dataset visibility get DATASET
|
|
1224
|
+
$ pnpm exec sanity dataset visibility get DATASET [-p <value>]
|
|
1106
1225
|
|
|
1107
1226
|
ARGUMENTS
|
|
1108
1227
|
DATASET The name of the dataset to get visibility for
|
|
1109
1228
|
|
|
1229
|
+
FLAGS
|
|
1230
|
+
-p, --project-id=<value> Project ID to use. Overrides the project ID from the Sanity config.
|
|
1231
|
+
|
|
1110
1232
|
DESCRIPTION
|
|
1111
1233
|
Get the visibility of a dataset
|
|
1112
1234
|
|
|
1113
1235
|
EXAMPLES
|
|
1114
1236
|
Check the visibility of a dataset
|
|
1115
1237
|
|
|
1116
|
-
$ sanity dataset visibility get my-dataset
|
|
1238
|
+
$ pnpm exec sanity dataset visibility get my-dataset
|
|
1117
1239
|
```
|
|
1118
1240
|
|
|
1119
|
-
_See code: [src/commands/dataset/visibility/get.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
1241
|
+
_See code: [src/commands/dataset/visibility/get.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/dataset/visibility/get.ts)_
|
|
1120
1242
|
|
|
1121
1243
|
## `sanity dataset visibility set DATASET MODE`
|
|
1122
1244
|
|
|
@@ -1124,26 +1246,29 @@ Set the visibility of a dataset
|
|
|
1124
1246
|
|
|
1125
1247
|
```
|
|
1126
1248
|
USAGE
|
|
1127
|
-
$ sanity dataset visibility set DATASET MODE
|
|
1249
|
+
$ pnpm exec sanity dataset visibility set DATASET MODE [-p <value>]
|
|
1128
1250
|
|
|
1129
1251
|
ARGUMENTS
|
|
1130
1252
|
DATASET The name of the dataset to set visibility for
|
|
1131
1253
|
MODE (public|private) The visibility mode to set
|
|
1132
1254
|
|
|
1255
|
+
FLAGS
|
|
1256
|
+
-p, --project-id=<value> Project ID to use. Overrides the project ID from the Sanity config.
|
|
1257
|
+
|
|
1133
1258
|
DESCRIPTION
|
|
1134
1259
|
Set the visibility of a dataset
|
|
1135
1260
|
|
|
1136
1261
|
EXAMPLES
|
|
1137
1262
|
Make a dataset private
|
|
1138
1263
|
|
|
1139
|
-
$ sanity dataset visibility set my-dataset private
|
|
1264
|
+
$ pnpm exec sanity dataset visibility set my-dataset private
|
|
1140
1265
|
|
|
1141
1266
|
Make a dataset public
|
|
1142
1267
|
|
|
1143
|
-
$ sanity dataset visibility set my-dataset public
|
|
1268
|
+
$ pnpm exec sanity dataset visibility set my-dataset public
|
|
1144
1269
|
```
|
|
1145
1270
|
|
|
1146
|
-
_See code: [src/commands/dataset/visibility/set.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
1271
|
+
_See code: [src/commands/dataset/visibility/set.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/dataset/visibility/set.ts)_
|
|
1147
1272
|
|
|
1148
1273
|
## `sanity debug`
|
|
1149
1274
|
|
|
@@ -1151,7 +1276,7 @@ Provides diagnostic info for Sanity Studio troubleshooting
|
|
|
1151
1276
|
|
|
1152
1277
|
```
|
|
1153
1278
|
USAGE
|
|
1154
|
-
$ sanity debug [--secrets]
|
|
1279
|
+
$ pnpm exec sanity debug [--secrets]
|
|
1155
1280
|
|
|
1156
1281
|
FLAGS
|
|
1157
1282
|
--secrets Include API keys in output
|
|
@@ -1160,12 +1285,12 @@ DESCRIPTION
|
|
|
1160
1285
|
Provides diagnostic info for Sanity Studio troubleshooting
|
|
1161
1286
|
|
|
1162
1287
|
EXAMPLES
|
|
1163
|
-
$ sanity debug
|
|
1288
|
+
$ pnpm exec sanity debug
|
|
1164
1289
|
|
|
1165
|
-
$ sanity debug --secrets
|
|
1290
|
+
$ pnpm exec sanity debug --secrets
|
|
1166
1291
|
```
|
|
1167
1292
|
|
|
1168
|
-
_See code: [src/commands/debug.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
1293
|
+
_See code: [src/commands/debug.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/debug.ts)_
|
|
1169
1294
|
|
|
1170
1295
|
## `sanity deploy [SOURCEDIR]`
|
|
1171
1296
|
|
|
@@ -1173,7 +1298,7 @@ Builds and deploys Sanity Studio or application to Sanity hosting
|
|
|
1173
1298
|
|
|
1174
1299
|
```
|
|
1175
1300
|
USAGE
|
|
1176
|
-
$ sanity deploy [SOURCEDIR] [--auto-updates] [--build] [--minify] [--schema-required] [--source-maps]
|
|
1301
|
+
$ pnpm exec sanity deploy [SOURCEDIR] [--auto-updates] [--build] [--minify] [--schema-required] [--source-maps]
|
|
1177
1302
|
[--verbose] [-y]
|
|
1178
1303
|
|
|
1179
1304
|
ARGUMENTS
|
|
@@ -1194,18 +1319,18 @@ DESCRIPTION
|
|
|
1194
1319
|
EXAMPLES
|
|
1195
1320
|
Build and deploy the studio to Sanity hosting
|
|
1196
1321
|
|
|
1197
|
-
$ sanity deploy
|
|
1322
|
+
$ pnpm exec sanity deploy
|
|
1198
1323
|
|
|
1199
1324
|
Deploys non-minified build with source maps
|
|
1200
1325
|
|
|
1201
|
-
$ sanity deploy --no-minify --source-maps
|
|
1326
|
+
$ pnpm exec sanity deploy --no-minify --source-maps
|
|
1202
1327
|
|
|
1203
1328
|
Fail fast on schema store fails - for when other services rely on the stored schema
|
|
1204
1329
|
|
|
1205
|
-
$ sanity deploy --schema-required
|
|
1330
|
+
$ pnpm exec sanity deploy --schema-required
|
|
1206
1331
|
```
|
|
1207
1332
|
|
|
1208
|
-
_See code: [src/commands/deploy.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
1333
|
+
_See code: [src/commands/deploy.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/deploy.ts)_
|
|
1209
1334
|
|
|
1210
1335
|
## `sanity dev`
|
|
1211
1336
|
|
|
@@ -1213,7 +1338,7 @@ Starts a local development server for Sanity Studio with live reloading
|
|
|
1213
1338
|
|
|
1214
1339
|
```
|
|
1215
1340
|
USAGE
|
|
1216
|
-
$ sanity dev [--auto-updates] [--host <value>] [--load-in-dashboard] [--port <value>]
|
|
1341
|
+
$ pnpm exec sanity dev [--auto-updates] [--host <value>] [--load-in-dashboard] [--port <value>]
|
|
1217
1342
|
|
|
1218
1343
|
FLAGS
|
|
1219
1344
|
--[no-]auto-updates Automatically update Sanity Studio dependencies.
|
|
@@ -1225,14 +1350,14 @@ DESCRIPTION
|
|
|
1225
1350
|
Starts a local development server for Sanity Studio with live reloading
|
|
1226
1351
|
|
|
1227
1352
|
EXAMPLES
|
|
1228
|
-
$ sanity dev --host=0.0.0.0
|
|
1353
|
+
$ pnpm exec sanity dev --host=0.0.0.0
|
|
1229
1354
|
|
|
1230
|
-
$ sanity dev --port=1942
|
|
1355
|
+
$ pnpm exec sanity dev --port=1942
|
|
1231
1356
|
|
|
1232
|
-
$ sanity dev --load-in-dashboard
|
|
1357
|
+
$ pnpm exec sanity dev --load-in-dashboard
|
|
1233
1358
|
```
|
|
1234
1359
|
|
|
1235
|
-
_See code: [src/commands/dev.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
1360
|
+
_See code: [src/commands/dev.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/dev.ts)_
|
|
1236
1361
|
|
|
1237
1362
|
## `sanity docs browse`
|
|
1238
1363
|
|
|
@@ -1240,13 +1365,13 @@ Open Sanity docs in a web browser
|
|
|
1240
1365
|
|
|
1241
1366
|
```
|
|
1242
1367
|
USAGE
|
|
1243
|
-
$ sanity docs browse
|
|
1368
|
+
$ pnpm exec sanity docs browse
|
|
1244
1369
|
|
|
1245
1370
|
DESCRIPTION
|
|
1246
1371
|
Open Sanity docs in a web browser
|
|
1247
1372
|
```
|
|
1248
1373
|
|
|
1249
|
-
_See code: [src/commands/docs/browse.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
1374
|
+
_See code: [src/commands/docs/browse.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/docs/browse.ts)_
|
|
1250
1375
|
|
|
1251
1376
|
## `sanity docs read PATH`
|
|
1252
1377
|
|
|
@@ -1254,7 +1379,7 @@ Read an article in terminal
|
|
|
1254
1379
|
|
|
1255
1380
|
```
|
|
1256
1381
|
USAGE
|
|
1257
|
-
$ sanity docs read PATH [--web]
|
|
1382
|
+
$ pnpm exec sanity docs read PATH [--web]
|
|
1258
1383
|
|
|
1259
1384
|
ARGUMENTS
|
|
1260
1385
|
PATH Path or URL to article, found in search results and docs content as links
|
|
@@ -1268,22 +1393,22 @@ DESCRIPTION
|
|
|
1268
1393
|
EXAMPLES
|
|
1269
1394
|
Read as markdown in terminal
|
|
1270
1395
|
|
|
1271
|
-
$ sanity docs read /docs/studio/installation
|
|
1396
|
+
$ pnpm exec sanity docs read /docs/studio/installation
|
|
1272
1397
|
|
|
1273
1398
|
Read using full URL
|
|
1274
1399
|
|
|
1275
|
-
$ sanity docs read https://www.sanity.io/docs/studio/installation
|
|
1400
|
+
$ pnpm exec sanity docs read https://www.sanity.io/docs/studio/installation
|
|
1276
1401
|
|
|
1277
1402
|
Open in web browser
|
|
1278
1403
|
|
|
1279
|
-
$ sanity docs read /docs/studio/installation --web
|
|
1404
|
+
$ pnpm exec sanity docs read /docs/studio/installation --web
|
|
1280
1405
|
|
|
1281
1406
|
Open using full URL in web browser
|
|
1282
1407
|
|
|
1283
|
-
$ sanity docs read https://www.sanity.io/docs/studio/installation -w
|
|
1408
|
+
$ pnpm exec sanity docs read https://www.sanity.io/docs/studio/installation -w
|
|
1284
1409
|
```
|
|
1285
1410
|
|
|
1286
|
-
_See code: [src/commands/docs/read.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
1411
|
+
_See code: [src/commands/docs/read.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/docs/read.ts)_
|
|
1287
1412
|
|
|
1288
1413
|
## `sanity docs search QUERY`
|
|
1289
1414
|
|
|
@@ -1291,7 +1416,7 @@ Search Sanity docs
|
|
|
1291
1416
|
|
|
1292
1417
|
```
|
|
1293
1418
|
USAGE
|
|
1294
|
-
$ sanity docs search QUERY [--limit <value>]
|
|
1419
|
+
$ pnpm exec sanity docs search QUERY [--limit <value>]
|
|
1295
1420
|
|
|
1296
1421
|
ARGUMENTS
|
|
1297
1422
|
QUERY Search query for documentation
|
|
@@ -1305,18 +1430,18 @@ DESCRIPTION
|
|
|
1305
1430
|
EXAMPLES
|
|
1306
1431
|
Search for documentation about schemas
|
|
1307
1432
|
|
|
1308
|
-
$ sanity docs search schema
|
|
1433
|
+
$ pnpm exec sanity docs search schema
|
|
1309
1434
|
|
|
1310
1435
|
Search with phrase
|
|
1311
1436
|
|
|
1312
|
-
$ sanity docs search "groq functions"
|
|
1437
|
+
$ pnpm exec sanity docs search "groq functions"
|
|
1313
1438
|
|
|
1314
1439
|
Limit search results
|
|
1315
1440
|
|
|
1316
|
-
$ sanity docs search "deployment" --limit=5
|
|
1441
|
+
$ pnpm exec sanity docs search "deployment" --limit=5
|
|
1317
1442
|
```
|
|
1318
1443
|
|
|
1319
|
-
_See code: [src/commands/docs/search.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
1444
|
+
_See code: [src/commands/docs/search.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/docs/search.ts)_
|
|
1320
1445
|
|
|
1321
1446
|
## `sanity documents create [FILE]`
|
|
1322
1447
|
|
|
@@ -1324,7 +1449,7 @@ Create one or more documents
|
|
|
1324
1449
|
|
|
1325
1450
|
```
|
|
1326
1451
|
USAGE
|
|
1327
|
-
$ sanity documents create [FILE] [-d <value>] [--id <value>] [--json5] [--missing] [--replace] [--watch]
|
|
1452
|
+
$ pnpm exec sanity documents create [FILE] [-d <value>] [--id <value>] [--json5] [--missing] [--replace] [--watch]
|
|
1328
1453
|
|
|
1329
1454
|
ARGUMENTS
|
|
1330
1455
|
[FILE] JSON file to create document(s) from
|
|
@@ -1343,24 +1468,24 @@ DESCRIPTION
|
|
|
1343
1468
|
EXAMPLES
|
|
1344
1469
|
Create the document specified in "myDocument.json"
|
|
1345
1470
|
|
|
1346
|
-
$ sanity documents create myDocument.json
|
|
1471
|
+
$ pnpm exec sanity documents create myDocument.json
|
|
1347
1472
|
|
|
1348
1473
|
Open configured $EDITOR and create the specified document(s)
|
|
1349
1474
|
|
|
1350
|
-
$ sanity documents create
|
|
1475
|
+
$ pnpm exec sanity documents create
|
|
1351
1476
|
|
|
1352
1477
|
Fetch document with the ID "myDocId" and open configured $EDITOR with the current document content (if any). Replace
|
|
1353
1478
|
document with the edited version when the editor closes
|
|
1354
1479
|
|
|
1355
|
-
$ sanity documents create --id myDocId --replace
|
|
1480
|
+
$ pnpm exec sanity documents create --id myDocId --replace
|
|
1356
1481
|
|
|
1357
1482
|
Open configured $EDITOR and replace the document with the given content on each save. Use JSON5 file extension and
|
|
1358
1483
|
parser for simplified syntax.
|
|
1359
1484
|
|
|
1360
|
-
$ sanity documents create --id myDocId --watch --replace --json5
|
|
1485
|
+
$ pnpm exec sanity documents create --id myDocId --watch --replace --json5
|
|
1361
1486
|
```
|
|
1362
1487
|
|
|
1363
|
-
_See code: [src/commands/documents/create.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
1488
|
+
_See code: [src/commands/documents/create.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/documents/create.ts)_
|
|
1364
1489
|
|
|
1365
1490
|
## `sanity documents delete ID [IDS]`
|
|
1366
1491
|
|
|
@@ -1368,7 +1493,7 @@ Delete one or more documents from the projects configured dataset
|
|
|
1368
1493
|
|
|
1369
1494
|
```
|
|
1370
1495
|
USAGE
|
|
1371
|
-
$ sanity documents delete ID... [IDS...] [--dataset <value>]
|
|
1496
|
+
$ pnpm exec sanity documents delete ID... [IDS...] [--dataset <value>]
|
|
1372
1497
|
|
|
1373
1498
|
ARGUMENTS
|
|
1374
1499
|
ID... Document ID to delete
|
|
@@ -1383,22 +1508,22 @@ DESCRIPTION
|
|
|
1383
1508
|
EXAMPLES
|
|
1384
1509
|
Delete the document with the ID "myDocId"
|
|
1385
1510
|
|
|
1386
|
-
$ sanity documents delete myDocId
|
|
1511
|
+
$ pnpm exec sanity documents delete myDocId
|
|
1387
1512
|
|
|
1388
1513
|
ID wrapped in double or single quote works equally well
|
|
1389
1514
|
|
|
1390
|
-
$ sanity documents delete 'myDocId'
|
|
1515
|
+
$ pnpm exec sanity documents delete 'myDocId'
|
|
1391
1516
|
|
|
1392
1517
|
Delete document with ID "someDocId" from dataset "blog"
|
|
1393
1518
|
|
|
1394
|
-
$ sanity documents delete --dataset=blog someDocId
|
|
1519
|
+
$ pnpm exec sanity documents delete --dataset=blog someDocId
|
|
1395
1520
|
|
|
1396
1521
|
Delete the document with ID "doc1" and "doc2"
|
|
1397
1522
|
|
|
1398
|
-
$ sanity documents delete doc1 doc2
|
|
1523
|
+
$ pnpm exec sanity documents delete doc1 doc2
|
|
1399
1524
|
```
|
|
1400
1525
|
|
|
1401
|
-
_See code: [src/commands/documents/delete.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
1526
|
+
_See code: [src/commands/documents/delete.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/documents/delete.ts)_
|
|
1402
1527
|
|
|
1403
1528
|
## `sanity documents get DOCUMENTID`
|
|
1404
1529
|
|
|
@@ -1406,7 +1531,7 @@ Get and print a document by ID
|
|
|
1406
1531
|
|
|
1407
1532
|
```
|
|
1408
1533
|
USAGE
|
|
1409
|
-
$ sanity documents get DOCUMENTID [-d <value>] [--pretty]
|
|
1534
|
+
$ pnpm exec sanity documents get DOCUMENTID [-d <value>] [--pretty]
|
|
1410
1535
|
|
|
1411
1536
|
ARGUMENTS
|
|
1412
1537
|
DOCUMENTID Document ID to retrieve
|
|
@@ -1421,18 +1546,18 @@ DESCRIPTION
|
|
|
1421
1546
|
EXAMPLES
|
|
1422
1547
|
Get the document with ID "myDocId"
|
|
1423
1548
|
|
|
1424
|
-
$ sanity documents get myDocId
|
|
1549
|
+
$ pnpm exec sanity documents get myDocId
|
|
1425
1550
|
|
|
1426
1551
|
Get document with colorized JSON output
|
|
1427
1552
|
|
|
1428
|
-
$ sanity documents get myDocId --pretty
|
|
1553
|
+
$ pnpm exec sanity documents get myDocId --pretty
|
|
1429
1554
|
|
|
1430
1555
|
Get document from a specific dataset
|
|
1431
1556
|
|
|
1432
|
-
$ sanity documents get myDocId --dataset production
|
|
1557
|
+
$ pnpm exec sanity documents get myDocId --dataset production
|
|
1433
1558
|
```
|
|
1434
1559
|
|
|
1435
|
-
_See code: [src/commands/documents/get.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
1560
|
+
_See code: [src/commands/documents/get.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/documents/get.ts)_
|
|
1436
1561
|
|
|
1437
1562
|
## `sanity documents query QUERY`
|
|
1438
1563
|
|
|
@@ -1440,7 +1565,7 @@ Query for documents
|
|
|
1440
1565
|
|
|
1441
1566
|
```
|
|
1442
1567
|
USAGE
|
|
1443
|
-
$ sanity documents query QUERY [--anonymous] [--api-version <value>] [-d <value>] [--pretty] [-p <value>]
|
|
1568
|
+
$ pnpm exec sanity documents query QUERY [--anonymous] [--api-version <value>] [-d <value>] [--pretty] [-p <value>]
|
|
1444
1569
|
|
|
1445
1570
|
ARGUMENTS
|
|
1446
1571
|
QUERY GROQ query to run against the dataset
|
|
@@ -1458,18 +1583,18 @@ DESCRIPTION
|
|
|
1458
1583
|
EXAMPLES
|
|
1459
1584
|
Fetch 5 documents of type "movie"
|
|
1460
1585
|
|
|
1461
|
-
$ sanity documents query '*[_type == "movie"][0..4]'
|
|
1586
|
+
$ pnpm exec sanity documents query '*[_type == "movie"][0..4]'
|
|
1462
1587
|
|
|
1463
1588
|
Fetch title of the oldest movie in the dataset named "staging"
|
|
1464
1589
|
|
|
1465
|
-
$ sanity documents query '*[_type == "movie"]|order(releaseDate asc)[0]{title}' --dataset staging
|
|
1590
|
+
$ pnpm exec sanity documents query '*[_type == "movie"]|order(releaseDate asc)[0]{title}' --dataset staging
|
|
1466
1591
|
|
|
1467
1592
|
Use API version v2021-06-07 and do a query
|
|
1468
1593
|
|
|
1469
|
-
$ sanity documents query '*[_id == "header"] { "headerText": pt::text(body) }' --api-version v2021-06-07
|
|
1594
|
+
$ pnpm exec sanity documents query '*[_id == "header"] { "headerText": pt::text(body) }' --api-version v2021-06-07
|
|
1470
1595
|
```
|
|
1471
1596
|
|
|
1472
|
-
_See code: [src/commands/documents/query.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
1597
|
+
_See code: [src/commands/documents/query.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/documents/query.ts)_
|
|
1473
1598
|
|
|
1474
1599
|
## `sanity documents validate`
|
|
1475
1600
|
|
|
@@ -1477,7 +1602,7 @@ Validate documents in a dataset against the studio schema
|
|
|
1477
1602
|
|
|
1478
1603
|
```
|
|
1479
1604
|
USAGE
|
|
1480
|
-
$ sanity documents validate [-d <value>] [--file <value>] [--format <value>] [--level error|warning|info]
|
|
1605
|
+
$ pnpm exec sanity documents validate [-d <value>] [--file <value>] [--format <value>] [--level error|warning|info]
|
|
1481
1606
|
[--max-custom-validation-concurrency <value>] [--max-fetch-concurrency <value>] [--workspace <value>] [-y]
|
|
1482
1607
|
|
|
1483
1608
|
FLAGS
|
|
@@ -1503,22 +1628,22 @@ DESCRIPTION
|
|
|
1503
1628
|
EXAMPLES
|
|
1504
1629
|
Validates all documents in a Sanity project with more than one workspace
|
|
1505
1630
|
|
|
1506
|
-
$ sanity documents validate --workspace default
|
|
1631
|
+
$ pnpm exec sanity documents validate --workspace default
|
|
1507
1632
|
|
|
1508
1633
|
Override the dataset specified in the workspace
|
|
1509
1634
|
|
|
1510
|
-
$ sanity documents validate --workspace default --dataset staging
|
|
1635
|
+
$ pnpm exec sanity documents validate --workspace default --dataset staging
|
|
1511
1636
|
|
|
1512
1637
|
Save the results of the report into a file
|
|
1513
1638
|
|
|
1514
|
-
$ sanity documents validate --yes > report.txt
|
|
1639
|
+
$ pnpm exec sanity documents validate --yes > report.txt
|
|
1515
1640
|
|
|
1516
1641
|
Report out info level validation markers too
|
|
1517
1642
|
|
|
1518
|
-
$ sanity documents validate --level info
|
|
1643
|
+
$ pnpm exec sanity documents validate --level info
|
|
1519
1644
|
```
|
|
1520
1645
|
|
|
1521
|
-
_See code: [src/commands/documents/validate.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
1646
|
+
_See code: [src/commands/documents/validate.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/documents/validate.ts)_
|
|
1522
1647
|
|
|
1523
1648
|
## `sanity exec SCRIPT`
|
|
1524
1649
|
|
|
@@ -1526,7 +1651,7 @@ Executes a script within the Sanity Studio context
|
|
|
1526
1651
|
|
|
1527
1652
|
```
|
|
1528
1653
|
USAGE
|
|
1529
|
-
$ sanity exec SCRIPT... [--mock-browser-env] [--with-user-token]
|
|
1654
|
+
$ pnpm exec sanity exec SCRIPT... [--mock-browser-env] [--with-user-token]
|
|
1530
1655
|
|
|
1531
1656
|
ARGUMENTS
|
|
1532
1657
|
SCRIPT... Path to the script to execute
|
|
@@ -1541,25 +1666,25 @@ DESCRIPTION
|
|
|
1541
1666
|
EXAMPLES
|
|
1542
1667
|
Run the script at some/script.js in Sanity context
|
|
1543
1668
|
|
|
1544
|
-
$ sanity exec some/script.js
|
|
1669
|
+
$ pnpm exec sanity exec some/script.js
|
|
1545
1670
|
|
|
1546
1671
|
Run the script at migrations/fullname.ts and configure `getCliClient()` from `sanity/cli` to include the current
|
|
1547
1672
|
user's token
|
|
1548
1673
|
|
|
1549
|
-
$ sanity exec migrations/fullname.ts --with-user-token
|
|
1674
|
+
$ pnpm exec sanity exec migrations/fullname.ts --with-user-token
|
|
1550
1675
|
|
|
1551
1676
|
Run the script at scripts/browserScript.js in a mock browser environment
|
|
1552
1677
|
|
|
1553
|
-
$ sanity exec scripts/browserScript.js --mock-browser-env
|
|
1678
|
+
$ pnpm exec sanity exec scripts/browserScript.js --mock-browser-env
|
|
1554
1679
|
|
|
1555
1680
|
Pass arbitrary arguments to scripts by separating them with a `--`. Arguments are available in `process.argv` as
|
|
1556
1681
|
they would in regular node scripts (eg the following command would yield a `process.argv` of: `['/path/to/node',
|
|
1557
1682
|
'/path/to/myscript.js', '--dry-run', 'positional-argument']`)
|
|
1558
1683
|
|
|
1559
|
-
$ sanity exec --mock-browser-env myscript.js -- --dry-run positional-argument
|
|
1684
|
+
$ pnpm exec sanity exec --mock-browser-env myscript.js -- --dry-run positional-argument
|
|
1560
1685
|
```
|
|
1561
1686
|
|
|
1562
|
-
_See code: [src/commands/exec.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
1687
|
+
_See code: [src/commands/exec.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/exec.ts)_
|
|
1563
1688
|
|
|
1564
1689
|
## `sanity functions add`
|
|
1565
1690
|
|
|
@@ -1567,7 +1692,7 @@ Add a Function to your Blueprint
|
|
|
1567
1692
|
|
|
1568
1693
|
```
|
|
1569
1694
|
USAGE
|
|
1570
|
-
$ sanity functions add [--example <value> | -n <value> | | --language ts|js | --javascript | | ] [--type
|
|
1695
|
+
$ pnpm exec sanity functions add [--example <value> | -n <value> | | --language ts|js | --javascript | | ] [--type
|
|
1571
1696
|
document-create|document-delete|document-update|document-publish|media-library-asset-create|media-library-asset-upda
|
|
1572
1697
|
te|media-library-asset-delete... ] [--helpers] [--installer skip|npm|pnpm|yarn] [-i | ]
|
|
1573
1698
|
|
|
@@ -1597,18 +1722,18 @@ DESCRIPTION
|
|
|
1597
1722
|
After adding, use 'functions dev' to test locally, then 'blueprints deploy' to publish.
|
|
1598
1723
|
|
|
1599
1724
|
EXAMPLES
|
|
1600
|
-
$ sanity functions add
|
|
1725
|
+
$ pnpm exec sanity functions add
|
|
1601
1726
|
|
|
1602
|
-
$ sanity functions add --helpers
|
|
1727
|
+
$ pnpm exec sanity functions add --helpers
|
|
1603
1728
|
|
|
1604
|
-
$ sanity functions add --name my-function
|
|
1729
|
+
$ pnpm exec sanity functions add --name my-function
|
|
1605
1730
|
|
|
1606
|
-
$ sanity functions add --name my-function --type document-create
|
|
1731
|
+
$ pnpm exec sanity functions add --name my-function --type document-create
|
|
1607
1732
|
|
|
1608
|
-
$ sanity functions add --name my-function --type document-create --type document-update --lang js
|
|
1733
|
+
$ pnpm exec sanity functions add --name my-function --type document-create --type document-update --lang js
|
|
1609
1734
|
```
|
|
1610
1735
|
|
|
1611
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/
|
|
1736
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.1.0/src/commands/functions/add.ts)_
|
|
1612
1737
|
|
|
1613
1738
|
## `sanity functions dev`
|
|
1614
1739
|
|
|
@@ -1616,7 +1741,7 @@ Start the Sanity Function emulator
|
|
|
1616
1741
|
|
|
1617
1742
|
```
|
|
1618
1743
|
USAGE
|
|
1619
|
-
$ sanity functions dev [-h <value>] [-p <value>] [-t <value>]
|
|
1744
|
+
$ pnpm exec sanity functions dev [-h <value>] [-p <value>] [-t <value>]
|
|
1620
1745
|
|
|
1621
1746
|
FLAGS
|
|
1622
1747
|
-h, --host=<value> The local network interface at which to listen. [default: "localhost"]
|
|
@@ -1637,12 +1762,12 @@ DESCRIPTION
|
|
|
1637
1762
|
To invoke a function with the CLI, use 'functions test'.
|
|
1638
1763
|
|
|
1639
1764
|
EXAMPLES
|
|
1640
|
-
$ sanity functions dev --host 127.0.0.1 --port 8974
|
|
1765
|
+
$ pnpm exec sanity functions dev --host 127.0.0.1 --port 8974
|
|
1641
1766
|
|
|
1642
|
-
$ sanity functions dev --timeout 60
|
|
1767
|
+
$ pnpm exec sanity functions dev --timeout 60
|
|
1643
1768
|
```
|
|
1644
1769
|
|
|
1645
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/
|
|
1770
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.1.0/src/commands/functions/dev.ts)_
|
|
1646
1771
|
|
|
1647
1772
|
## `sanity functions env add NAME KEY VALUE`
|
|
1648
1773
|
|
|
@@ -1650,7 +1775,7 @@ Add or set an environment variable for a deployed function
|
|
|
1650
1775
|
|
|
1651
1776
|
```
|
|
1652
1777
|
USAGE
|
|
1653
|
-
$ sanity functions env add NAME KEY VALUE
|
|
1778
|
+
$ pnpm exec sanity functions env add NAME KEY VALUE
|
|
1654
1779
|
|
|
1655
1780
|
ARGUMENTS
|
|
1656
1781
|
NAME The name of the Sanity Function
|
|
@@ -1666,10 +1791,10 @@ DESCRIPTION
|
|
|
1666
1791
|
Changes take effect on the next function invocation.
|
|
1667
1792
|
|
|
1668
1793
|
EXAMPLES
|
|
1669
|
-
$ sanity functions env add MyFunction API_URL https://api.example.com/
|
|
1794
|
+
$ pnpm exec sanity functions env add MyFunction API_URL https://api.example.com/
|
|
1670
1795
|
```
|
|
1671
1796
|
|
|
1672
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/
|
|
1797
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.1.0/src/commands/functions/env/add.ts)_
|
|
1673
1798
|
|
|
1674
1799
|
## `sanity functions env list NAME`
|
|
1675
1800
|
|
|
@@ -1677,7 +1802,7 @@ List environment variables for a deployed function
|
|
|
1677
1802
|
|
|
1678
1803
|
```
|
|
1679
1804
|
USAGE
|
|
1680
|
-
$ sanity functions env list NAME
|
|
1805
|
+
$ pnpm exec sanity functions env list NAME
|
|
1681
1806
|
|
|
1682
1807
|
ARGUMENTS
|
|
1683
1808
|
NAME The name of the Sanity Function
|
|
@@ -1690,10 +1815,10 @@ DESCRIPTION
|
|
|
1690
1815
|
Use 'functions env add' to set variables or 'functions env remove' to delete them.
|
|
1691
1816
|
|
|
1692
1817
|
EXAMPLES
|
|
1693
|
-
$ sanity functions env list MyFunction
|
|
1818
|
+
$ pnpm exec sanity functions env list MyFunction
|
|
1694
1819
|
```
|
|
1695
1820
|
|
|
1696
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/
|
|
1821
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.1.0/src/commands/functions/env/list.ts)_
|
|
1697
1822
|
|
|
1698
1823
|
## `sanity functions env remove NAME KEY`
|
|
1699
1824
|
|
|
@@ -1701,7 +1826,7 @@ Remove an environment variable from a deployed function
|
|
|
1701
1826
|
|
|
1702
1827
|
```
|
|
1703
1828
|
USAGE
|
|
1704
|
-
$ sanity functions env remove NAME KEY
|
|
1829
|
+
$ pnpm exec sanity functions env remove NAME KEY
|
|
1705
1830
|
|
|
1706
1831
|
ARGUMENTS
|
|
1707
1832
|
NAME The name of the Sanity Function
|
|
@@ -1716,10 +1841,10 @@ DESCRIPTION
|
|
|
1716
1841
|
Use 'functions env list' to see current variables before removing.
|
|
1717
1842
|
|
|
1718
1843
|
EXAMPLES
|
|
1719
|
-
$ sanity functions env remove MyFunction API_URL
|
|
1844
|
+
$ pnpm exec sanity functions env remove MyFunction API_URL
|
|
1720
1845
|
```
|
|
1721
1846
|
|
|
1722
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/
|
|
1847
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.1.0/src/commands/functions/env/remove.ts)_
|
|
1723
1848
|
|
|
1724
1849
|
## `sanity functions logs [NAME]`
|
|
1725
1850
|
|
|
@@ -1727,7 +1852,7 @@ Retrieve or delete logs for a Sanity Function
|
|
|
1727
1852
|
|
|
1728
1853
|
```
|
|
1729
1854
|
USAGE
|
|
1730
|
-
$ sanity functions logs [NAME] [-u] [-f [-d | -l <value> | -j]] [-w]
|
|
1855
|
+
$ pnpm exec sanity functions logs [NAME] [--stack <value>] [-u] [-f [-d | -l <value> | -j]] [-w]
|
|
1731
1856
|
|
|
1732
1857
|
ARGUMENTS
|
|
1733
1858
|
[NAME] The name of the Sanity Function
|
|
@@ -1739,6 +1864,7 @@ FLAGS
|
|
|
1739
1864
|
-l, --limit=<value> [default: 50] Total number of log entries to retrieve
|
|
1740
1865
|
-u, --utc Show dates in UTC time zone
|
|
1741
1866
|
-w, --watch Watch for new logs (streaming mode)
|
|
1867
|
+
--stack=<value> Stack name or ID to use instead of the locally configured Stack
|
|
1742
1868
|
|
|
1743
1869
|
DESCRIPTION
|
|
1744
1870
|
Retrieve or delete logs for a Sanity Function
|
|
@@ -1749,16 +1875,16 @@ DESCRIPTION
|
|
|
1749
1875
|
unless --force is specified).
|
|
1750
1876
|
|
|
1751
1877
|
EXAMPLES
|
|
1752
|
-
$ sanity functions logs <name>
|
|
1878
|
+
$ pnpm exec sanity functions logs <name>
|
|
1753
1879
|
|
|
1754
|
-
$ sanity functions logs <name> --json
|
|
1880
|
+
$ pnpm exec sanity functions logs <name> --json
|
|
1755
1881
|
|
|
1756
|
-
$ sanity functions logs <name> --limit 100
|
|
1882
|
+
$ pnpm exec sanity functions logs <name> --limit 100
|
|
1757
1883
|
|
|
1758
|
-
$ sanity functions logs <name> --delete
|
|
1884
|
+
$ pnpm exec sanity functions logs <name> --delete
|
|
1759
1885
|
```
|
|
1760
1886
|
|
|
1761
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/
|
|
1887
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.1.0/src/commands/functions/logs.ts)_
|
|
1762
1888
|
|
|
1763
1889
|
## `sanity functions test [NAME]`
|
|
1764
1890
|
|
|
@@ -1766,7 +1892,7 @@ Invoke a local Sanity Function
|
|
|
1766
1892
|
|
|
1767
1893
|
```
|
|
1768
1894
|
USAGE
|
|
1769
|
-
$ sanity functions test [NAME] [--data-before <value> | [-d <value> | -f <value> | --document-id <value>] | | |
|
|
1895
|
+
$ pnpm exec sanity functions test [NAME] [--data-before <value> | [-d <value> | -f <value> | --document-id <value>] | | |
|
|
1770
1896
|
--file-before <value> | --file-after <value> | --document-id-before <value> | --document-id-after <value>]
|
|
1771
1897
|
[--data-after <value> | | | | | | | ] [-e create|update|delete] [-t <value>] [-a <value>] [--with-user-token]
|
|
1772
1898
|
[--media-library-id <value> | --project-id <value> | --dataset <value>]
|
|
@@ -1803,16 +1929,16 @@ DESCRIPTION
|
|
|
1803
1929
|
events, use the before/after flag pairs to simulate document changes.
|
|
1804
1930
|
|
|
1805
1931
|
EXAMPLES
|
|
1806
|
-
$ sanity functions test <name> --data '{ "id": 1 }'
|
|
1932
|
+
$ pnpm exec sanity functions test <name> --data '{ "id": 1 }'
|
|
1807
1933
|
|
|
1808
|
-
$ sanity functions test <name> --file 'payload.json'
|
|
1934
|
+
$ pnpm exec sanity functions test <name> --file 'payload.json'
|
|
1809
1935
|
|
|
1810
|
-
$ sanity functions test <name> --data '{ "id": 1 }' --timeout 60
|
|
1936
|
+
$ pnpm exec sanity functions test <name> --data '{ "id": 1 }' --timeout 60
|
|
1811
1937
|
|
|
1812
|
-
$ sanity functions test <name> --event update --data-before '{ "title": "before" }' --data-after '{ "title": "after" }'
|
|
1938
|
+
$ pnpm exec sanity functions test <name> --event update --data-before '{ "title": "before" }' --data-after '{ "title": "after" }'
|
|
1813
1939
|
```
|
|
1814
1940
|
|
|
1815
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/
|
|
1941
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.1.0/src/commands/functions/test.ts)_
|
|
1816
1942
|
|
|
1817
1943
|
## `sanity graphql deploy`
|
|
1818
1944
|
|
|
@@ -1820,7 +1946,7 @@ Deploy a GraphQL API from the current Sanity schema
|
|
|
1820
1946
|
|
|
1821
1947
|
```
|
|
1822
1948
|
USAGE
|
|
1823
|
-
$ sanity graphql deploy [--api <value>...] [--dataset <value>] [--dry-run] [--force] [--generation gen1|gen2|gen3]
|
|
1949
|
+
$ pnpm exec sanity graphql deploy [--api <value>...] [--dataset <value>] [--dry-run] [--force] [--generation gen1|gen2|gen3]
|
|
1824
1950
|
[--non-null-document-fields] [--playground] [--tag <value>] [--with-union-cache]
|
|
1825
1951
|
|
|
1826
1952
|
FLAGS
|
|
@@ -1842,22 +1968,22 @@ DESCRIPTION
|
|
|
1842
1968
|
EXAMPLES
|
|
1843
1969
|
Deploy all defined GraphQL APIs
|
|
1844
1970
|
|
|
1845
|
-
$ sanity graphql deploy
|
|
1971
|
+
$ pnpm exec sanity graphql deploy
|
|
1846
1972
|
|
|
1847
1973
|
Validate defined GraphQL APIs, check for breaking changes, skip deploy
|
|
1848
1974
|
|
|
1849
|
-
$ sanity graphql deploy --dry-run
|
|
1975
|
+
$ pnpm exec sanity graphql deploy --dry-run
|
|
1850
1976
|
|
|
1851
1977
|
Deploy only the GraphQL APIs with the IDs "staging" and "ios"
|
|
1852
1978
|
|
|
1853
|
-
$ sanity graphql deploy --api staging --api ios
|
|
1979
|
+
$ pnpm exec sanity graphql deploy --api staging --api ios
|
|
1854
1980
|
|
|
1855
1981
|
Deploy all defined GraphQL APIs, overriding any playground setting
|
|
1856
1982
|
|
|
1857
|
-
$ sanity graphql deploy --playground
|
|
1983
|
+
$ pnpm exec sanity graphql deploy --playground
|
|
1858
1984
|
```
|
|
1859
1985
|
|
|
1860
|
-
_See code: [src/commands/graphql/deploy.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
1986
|
+
_See code: [src/commands/graphql/deploy.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/graphql/deploy.ts)_
|
|
1861
1987
|
|
|
1862
1988
|
## `sanity graphql list`
|
|
1863
1989
|
|
|
@@ -1865,7 +1991,7 @@ List all GraphQL endpoints deployed for this project
|
|
|
1865
1991
|
|
|
1866
1992
|
```
|
|
1867
1993
|
USAGE
|
|
1868
|
-
$ sanity graphql list
|
|
1994
|
+
$ pnpm exec sanity graphql list
|
|
1869
1995
|
|
|
1870
1996
|
DESCRIPTION
|
|
1871
1997
|
List all GraphQL endpoints deployed for this project
|
|
@@ -1873,10 +1999,10 @@ DESCRIPTION
|
|
|
1873
1999
|
EXAMPLES
|
|
1874
2000
|
List GraphQL endpoints for the current project
|
|
1875
2001
|
|
|
1876
|
-
$ sanity graphql list
|
|
2002
|
+
$ pnpm exec sanity graphql list
|
|
1877
2003
|
```
|
|
1878
2004
|
|
|
1879
|
-
_See code: [src/commands/graphql/list.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
2005
|
+
_See code: [src/commands/graphql/list.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/graphql/list.ts)_
|
|
1880
2006
|
|
|
1881
2007
|
## `sanity graphql undeploy`
|
|
1882
2008
|
|
|
@@ -1884,7 +2010,7 @@ Remove a deployed GraphQL API
|
|
|
1884
2010
|
|
|
1885
2011
|
```
|
|
1886
2012
|
USAGE
|
|
1887
|
-
$ sanity graphql undeploy [--api <value>] [--dataset <value>] [--force] [--project <value>] [--tag <value>]
|
|
2013
|
+
$ pnpm exec sanity graphql undeploy [--api <value>] [--dataset <value>] [--force] [--project <value>] [--tag <value>]
|
|
1888
2014
|
|
|
1889
2015
|
FLAGS
|
|
1890
2016
|
--api=<value> Undeploy API with this ID (project, dataset and tag flags take precedence)
|
|
@@ -1899,26 +2025,26 @@ DESCRIPTION
|
|
|
1899
2025
|
EXAMPLES
|
|
1900
2026
|
Undeploy GraphQL API for current project and dataset
|
|
1901
2027
|
|
|
1902
|
-
$ sanity graphql undeploy
|
|
2028
|
+
$ pnpm exec sanity graphql undeploy
|
|
1903
2029
|
|
|
1904
2030
|
Undeploy API with ID "ios"
|
|
1905
2031
|
|
|
1906
|
-
$ sanity graphql undeploy --api ios
|
|
2032
|
+
$ pnpm exec sanity graphql undeploy --api ios
|
|
1907
2033
|
|
|
1908
2034
|
Undeploy GraphQL API for staging dataset
|
|
1909
2035
|
|
|
1910
|
-
$ sanity graphql undeploy --dataset staging
|
|
2036
|
+
$ pnpm exec sanity graphql undeploy --dataset staging
|
|
1911
2037
|
|
|
1912
2038
|
Undeploy GraphQL API for staging dataset with "next" tag
|
|
1913
2039
|
|
|
1914
|
-
$ sanity graphql undeploy --dataset staging --tag next
|
|
2040
|
+
$ pnpm exec sanity graphql undeploy --dataset staging --tag next
|
|
1915
2041
|
|
|
1916
2042
|
Undeploy GraphQL API without confirmation prompt
|
|
1917
2043
|
|
|
1918
|
-
$ sanity graphql undeploy --force
|
|
2044
|
+
$ pnpm exec sanity graphql undeploy --force
|
|
1919
2045
|
```
|
|
1920
2046
|
|
|
1921
|
-
_See code: [src/commands/graphql/undeploy.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
2047
|
+
_See code: [src/commands/graphql/undeploy.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/graphql/undeploy.ts)_
|
|
1922
2048
|
|
|
1923
2049
|
## `sanity help [COMMAND]`
|
|
1924
2050
|
|
|
@@ -1926,7 +2052,7 @@ Display help for sanity.
|
|
|
1926
2052
|
|
|
1927
2053
|
```
|
|
1928
2054
|
USAGE
|
|
1929
|
-
$ sanity help [COMMAND...] [-n]
|
|
2055
|
+
$ pnpm exec sanity help [COMMAND...] [-n]
|
|
1930
2056
|
|
|
1931
2057
|
ARGUMENTS
|
|
1932
2058
|
[COMMAND...] Command to show help for.
|
|
@@ -1946,7 +2072,7 @@ Print details of a given webhook delivery attempt
|
|
|
1946
2072
|
|
|
1947
2073
|
```
|
|
1948
2074
|
USAGE
|
|
1949
|
-
$ sanity hook attempt ATTEMPTID
|
|
2075
|
+
$ pnpm exec sanity hook attempt ATTEMPTID
|
|
1950
2076
|
|
|
1951
2077
|
ARGUMENTS
|
|
1952
2078
|
ATTEMPTID The delivery attempt ID to get details for
|
|
@@ -1957,10 +2083,10 @@ DESCRIPTION
|
|
|
1957
2083
|
EXAMPLES
|
|
1958
2084
|
Print details of webhook delivery attempt with ID abc123
|
|
1959
2085
|
|
|
1960
|
-
$ sanity hook attempt abc123
|
|
2086
|
+
$ pnpm exec sanity hook attempt abc123
|
|
1961
2087
|
```
|
|
1962
2088
|
|
|
1963
|
-
_See code: [src/commands/hook/attempt.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
2089
|
+
_See code: [src/commands/hook/attempt.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/hook/attempt.ts)_
|
|
1964
2090
|
|
|
1965
2091
|
## `sanity hook create`
|
|
1966
2092
|
|
|
@@ -1968,7 +2094,7 @@ Create a new webhook for the current project
|
|
|
1968
2094
|
|
|
1969
2095
|
```
|
|
1970
2096
|
USAGE
|
|
1971
|
-
$ sanity hook create
|
|
2097
|
+
$ pnpm exec sanity hook create
|
|
1972
2098
|
|
|
1973
2099
|
DESCRIPTION
|
|
1974
2100
|
Create a new webhook for the current project
|
|
@@ -1976,10 +2102,10 @@ DESCRIPTION
|
|
|
1976
2102
|
EXAMPLES
|
|
1977
2103
|
Create a new webhook for the current project
|
|
1978
2104
|
|
|
1979
|
-
$ sanity hook create
|
|
2105
|
+
$ pnpm exec sanity hook create
|
|
1980
2106
|
```
|
|
1981
2107
|
|
|
1982
|
-
_See code: [src/commands/hook/create.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
2108
|
+
_See code: [src/commands/hook/create.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/hook/create.ts)_
|
|
1983
2109
|
|
|
1984
2110
|
## `sanity hook delete [NAME]`
|
|
1985
2111
|
|
|
@@ -1987,7 +2113,7 @@ Delete a hook within your project
|
|
|
1987
2113
|
|
|
1988
2114
|
```
|
|
1989
2115
|
USAGE
|
|
1990
|
-
$ sanity hook delete [NAME]
|
|
2116
|
+
$ pnpm exec sanity hook delete [NAME]
|
|
1991
2117
|
|
|
1992
2118
|
ARGUMENTS
|
|
1993
2119
|
[NAME] Name of hook to delete (will prompt if not provided)
|
|
@@ -1998,14 +2124,14 @@ DESCRIPTION
|
|
|
1998
2124
|
EXAMPLES
|
|
1999
2125
|
Interactively select and delete a hook
|
|
2000
2126
|
|
|
2001
|
-
$ sanity hook delete
|
|
2127
|
+
$ pnpm exec sanity hook delete
|
|
2002
2128
|
|
|
2003
2129
|
Delete a specific hook by name
|
|
2004
2130
|
|
|
2005
|
-
$ sanity hook delete my-hook
|
|
2131
|
+
$ pnpm exec sanity hook delete my-hook
|
|
2006
2132
|
```
|
|
2007
2133
|
|
|
2008
|
-
_See code: [src/commands/hook/delete.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
2134
|
+
_See code: [src/commands/hook/delete.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/hook/delete.ts)_
|
|
2009
2135
|
|
|
2010
2136
|
## `sanity hook list`
|
|
2011
2137
|
|
|
@@ -2013,7 +2139,7 @@ List hooks for a given project
|
|
|
2013
2139
|
|
|
2014
2140
|
```
|
|
2015
2141
|
USAGE
|
|
2016
|
-
$ sanity hook list
|
|
2142
|
+
$ pnpm exec sanity hook list
|
|
2017
2143
|
|
|
2018
2144
|
DESCRIPTION
|
|
2019
2145
|
List hooks for a given project
|
|
@@ -2021,10 +2147,10 @@ DESCRIPTION
|
|
|
2021
2147
|
EXAMPLES
|
|
2022
2148
|
List hooks for a given project
|
|
2023
2149
|
|
|
2024
|
-
$ sanity hook list
|
|
2150
|
+
$ pnpm exec sanity hook list
|
|
2025
2151
|
```
|
|
2026
2152
|
|
|
2027
|
-
_See code: [src/commands/hook/list.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
2153
|
+
_See code: [src/commands/hook/list.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/hook/list.ts)_
|
|
2028
2154
|
|
|
2029
2155
|
## `sanity hook logs [NAME]`
|
|
2030
2156
|
|
|
@@ -2032,7 +2158,7 @@ List latest log entries for a given hook
|
|
|
2032
2158
|
|
|
2033
2159
|
```
|
|
2034
2160
|
USAGE
|
|
2035
|
-
$ sanity hook logs [NAME] [--detailed]
|
|
2161
|
+
$ pnpm exec sanity hook logs [NAME] [--detailed]
|
|
2036
2162
|
|
|
2037
2163
|
ARGUMENTS
|
|
2038
2164
|
[NAME] Name of the hook to show logs for
|
|
@@ -2046,14 +2172,14 @@ DESCRIPTION
|
|
|
2046
2172
|
EXAMPLES
|
|
2047
2173
|
List latest log entries for a given hook
|
|
2048
2174
|
|
|
2049
|
-
$ sanity hook logs
|
|
2175
|
+
$ pnpm exec sanity hook logs
|
|
2050
2176
|
|
|
2051
2177
|
List latest log entries for a specific hook by name
|
|
2052
2178
|
|
|
2053
|
-
$ sanity hook logs [NAME]
|
|
2179
|
+
$ pnpm exec sanity hook logs [NAME]
|
|
2054
2180
|
```
|
|
2055
2181
|
|
|
2056
|
-
_See code: [src/commands/hook/logs.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
2182
|
+
_See code: [src/commands/hook/logs.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/hook/logs.ts)_
|
|
2057
2183
|
|
|
2058
2184
|
## `sanity init`
|
|
2059
2185
|
|
|
@@ -2061,7 +2187,7 @@ Initialize a new Sanity Studio, project and/or app
|
|
|
2061
2187
|
|
|
2062
2188
|
```
|
|
2063
2189
|
USAGE
|
|
2064
|
-
$ sanity init [--json] [--auto-updates | --bare] [--coupon <code> | --project-plan <name>] [--dataset
|
|
2190
|
+
$ pnpm exec sanity init [--json] [--auto-updates | --bare] [--coupon <code> | --project-plan <name>] [--dataset
|
|
2065
2191
|
<name> | --dataset-default] [--env <filename> | ] [--git <message> | ] [--mcp] [--nextjs-add-config-files]
|
|
2066
2192
|
[--nextjs-append-env] [--nextjs-embed-studio] [--organization <id>] [--output-path <path> | ] [--overwrite-files]
|
|
2067
2193
|
[--package-manager <manager> | ] [--project <id> | --create-project <name>] [--provider <provider>] [--template
|
|
@@ -2102,27 +2228,27 @@ DESCRIPTION
|
|
|
2102
2228
|
Initialize a new Sanity Studio, project and/or app
|
|
2103
2229
|
|
|
2104
2230
|
EXAMPLES
|
|
2105
|
-
$ sanity init
|
|
2231
|
+
$ pnpm exec sanity init
|
|
2106
2232
|
|
|
2107
2233
|
Initialize a new project with a public dataset named "production"
|
|
2108
2234
|
|
|
2109
|
-
$ sanity init --dataset-default
|
|
2235
|
+
$ pnpm exec sanity init --dataset-default
|
|
2110
2236
|
|
|
2111
2237
|
Initialize a project with the given project ID and dataset to the given path
|
|
2112
2238
|
|
|
2113
|
-
$ sanity init -y --project abc123 --dataset production --output-path ~/myproj
|
|
2239
|
+
$ pnpm exec sanity init -y --project abc123 --dataset production --output-path ~/myproj
|
|
2114
2240
|
|
|
2115
2241
|
Initialize a project with the given project ID and dataset using the moviedb template to the given path
|
|
2116
2242
|
|
|
2117
|
-
$ sanity init -y --project abc123 --dataset staging --template moviedb --output-path .
|
|
2243
|
+
$ pnpm exec sanity init -y --project abc123 --dataset staging --template moviedb --output-path .
|
|
2118
2244
|
|
|
2119
2245
|
Create a brand new project with name "Movies Unlimited"
|
|
2120
2246
|
|
|
2121
|
-
$ sanity init -y --create-project "Movies Unlimited" --dataset moviedb --visibility private --template moviedb \
|
|
2247
|
+
$ pnpm exec sanity init -y --create-project "Movies Unlimited" --dataset moviedb --visibility private --template moviedb \
|
|
2122
2248
|
--output-path /Users/espenh/movies-unlimited
|
|
2123
2249
|
```
|
|
2124
2250
|
|
|
2125
|
-
_See code: [src/commands/init.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
2251
|
+
_See code: [src/commands/init.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/init.ts)_
|
|
2126
2252
|
|
|
2127
2253
|
## `sanity install [PACKAGES]`
|
|
2128
2254
|
|
|
@@ -2130,7 +2256,7 @@ Installs dependencies for Sanity Studio project
|
|
|
2130
2256
|
|
|
2131
2257
|
```
|
|
2132
2258
|
USAGE
|
|
2133
|
-
$ sanity install [PACKAGES...]
|
|
2259
|
+
$ pnpm exec sanity install [PACKAGES...]
|
|
2134
2260
|
|
|
2135
2261
|
ARGUMENTS
|
|
2136
2262
|
[PACKAGES...] Packages to install
|
|
@@ -2139,14 +2265,14 @@ DESCRIPTION
|
|
|
2139
2265
|
Installs dependencies for Sanity Studio project
|
|
2140
2266
|
|
|
2141
2267
|
EXAMPLES
|
|
2142
|
-
$ sanity install
|
|
2268
|
+
$ pnpm exec sanity install
|
|
2143
2269
|
|
|
2144
|
-
$ sanity install @sanity/vision
|
|
2270
|
+
$ pnpm exec sanity install @sanity/vision
|
|
2145
2271
|
|
|
2146
|
-
$ sanity install some-package another-package
|
|
2272
|
+
$ pnpm exec sanity install some-package another-package
|
|
2147
2273
|
```
|
|
2148
2274
|
|
|
2149
|
-
_See code: [src/commands/install.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
2275
|
+
_See code: [src/commands/install.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/install.ts)_
|
|
2150
2276
|
|
|
2151
2277
|
## `sanity learn`
|
|
2152
2278
|
|
|
@@ -2154,13 +2280,13 @@ Opens Sanity Learn in your web browser
|
|
|
2154
2280
|
|
|
2155
2281
|
```
|
|
2156
2282
|
USAGE
|
|
2157
|
-
$ sanity learn
|
|
2283
|
+
$ pnpm exec sanity learn
|
|
2158
2284
|
|
|
2159
2285
|
DESCRIPTION
|
|
2160
2286
|
Opens Sanity Learn in your web browser
|
|
2161
2287
|
```
|
|
2162
2288
|
|
|
2163
|
-
_See code: [src/commands/learn.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
2289
|
+
_See code: [src/commands/learn.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/learn.ts)_
|
|
2164
2290
|
|
|
2165
2291
|
## `sanity login`
|
|
2166
2292
|
|
|
@@ -2168,7 +2294,7 @@ Authenticates the CLI for access to Sanity projects
|
|
|
2168
2294
|
|
|
2169
2295
|
```
|
|
2170
2296
|
USAGE
|
|
2171
|
-
$ sanity login [--open] [--provider <providerId>] [--sso <slug>]
|
|
2297
|
+
$ pnpm exec sanity login [--open] [--provider <providerId>] [--sso <slug>]
|
|
2172
2298
|
|
|
2173
2299
|
FLAGS
|
|
2174
2300
|
--[no-]open Open a browser window to log in (`--no-open` only prints URL)
|
|
@@ -2181,18 +2307,18 @@ DESCRIPTION
|
|
|
2181
2307
|
EXAMPLES
|
|
2182
2308
|
Log in using default settings
|
|
2183
2309
|
|
|
2184
|
-
$ sanity login
|
|
2310
|
+
$ pnpm exec sanity login
|
|
2185
2311
|
|
|
2186
2312
|
Log in using Single Sign-On with the "my-organization" slug
|
|
2187
2313
|
|
|
2188
|
-
$ sanity login --sso my-organization
|
|
2314
|
+
$ pnpm exec sanity login --sso my-organization
|
|
2189
2315
|
|
|
2190
2316
|
Login with GitHub provider, but do not open a browser window automatically
|
|
2191
2317
|
|
|
2192
|
-
$ sanity login --provider github --no-open
|
|
2318
|
+
$ pnpm exec sanity login --provider github --no-open
|
|
2193
2319
|
```
|
|
2194
2320
|
|
|
2195
|
-
_See code: [src/commands/login.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
2321
|
+
_See code: [src/commands/login.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/login.ts)_
|
|
2196
2322
|
|
|
2197
2323
|
## `sanity logout`
|
|
2198
2324
|
|
|
@@ -2200,13 +2326,13 @@ Logs out the CLI from the current user session
|
|
|
2200
2326
|
|
|
2201
2327
|
```
|
|
2202
2328
|
USAGE
|
|
2203
|
-
$ sanity logout
|
|
2329
|
+
$ pnpm exec sanity logout
|
|
2204
2330
|
|
|
2205
2331
|
DESCRIPTION
|
|
2206
2332
|
Logs out the CLI from the current user session
|
|
2207
2333
|
```
|
|
2208
2334
|
|
|
2209
|
-
_See code: [src/commands/logout.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
2335
|
+
_See code: [src/commands/logout.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/logout.ts)_
|
|
2210
2336
|
|
|
2211
2337
|
## `sanity manage`
|
|
2212
2338
|
|
|
@@ -2214,13 +2340,13 @@ Opens project management interface in your web browser
|
|
|
2214
2340
|
|
|
2215
2341
|
```
|
|
2216
2342
|
USAGE
|
|
2217
|
-
$ sanity manage
|
|
2343
|
+
$ pnpm exec sanity manage
|
|
2218
2344
|
|
|
2219
2345
|
DESCRIPTION
|
|
2220
2346
|
Opens project management interface in your web browser
|
|
2221
2347
|
```
|
|
2222
2348
|
|
|
2223
|
-
_See code: [src/commands/manage.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
2349
|
+
_See code: [src/commands/manage.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/manage.ts)_
|
|
2224
2350
|
|
|
2225
2351
|
## `sanity manifest extract`
|
|
2226
2352
|
|
|
@@ -2228,7 +2354,7 @@ Extracts the studio configuration as one or more JSON manifest files.
|
|
|
2228
2354
|
|
|
2229
2355
|
```
|
|
2230
2356
|
USAGE
|
|
2231
|
-
$ sanity manifest extract [--path <value>]
|
|
2357
|
+
$ pnpm exec sanity manifest extract [--path <value>]
|
|
2232
2358
|
|
|
2233
2359
|
FLAGS
|
|
2234
2360
|
--path=<value> [default: /dist/static] Optional path to specify destination directory of the manifest files
|
|
@@ -2241,14 +2367,14 @@ DESCRIPTION
|
|
|
2241
2367
|
EXAMPLES
|
|
2242
2368
|
Extracts manifests
|
|
2243
2369
|
|
|
2244
|
-
$ sanity manifest extract
|
|
2370
|
+
$ pnpm exec sanity manifest extract
|
|
2245
2371
|
|
|
2246
2372
|
Extracts manifests into /public/static
|
|
2247
2373
|
|
|
2248
|
-
$ sanity manifest extract --path /public/static
|
|
2374
|
+
$ pnpm exec sanity manifest extract --path /public/static
|
|
2249
2375
|
```
|
|
2250
2376
|
|
|
2251
|
-
_See code: [src/commands/manifest/extract.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
2377
|
+
_See code: [src/commands/manifest/extract.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/manifest/extract.ts)_
|
|
2252
2378
|
|
|
2253
2379
|
## `sanity mcp configure`
|
|
2254
2380
|
|
|
@@ -2256,7 +2382,7 @@ Configure Sanity MCP server for AI editors (Claude Code, Codex CLI, Cursor, Gemi
|
|
|
2256
2382
|
|
|
2257
2383
|
```
|
|
2258
2384
|
USAGE
|
|
2259
|
-
$ sanity mcp configure
|
|
2385
|
+
$ pnpm exec sanity mcp configure
|
|
2260
2386
|
|
|
2261
2387
|
DESCRIPTION
|
|
2262
2388
|
Configure Sanity MCP server for AI editors (Claude Code, Codex CLI, Cursor, Gemini CLI, GitHub Copilot CLI, VS Code)
|
|
@@ -2264,10 +2390,10 @@ DESCRIPTION
|
|
|
2264
2390
|
EXAMPLES
|
|
2265
2391
|
Configure Sanity MCP server for detected AI editors
|
|
2266
2392
|
|
|
2267
|
-
$ sanity mcp configure
|
|
2393
|
+
$ pnpm exec sanity mcp configure
|
|
2268
2394
|
```
|
|
2269
2395
|
|
|
2270
|
-
_See code: [src/commands/mcp/configure.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
2396
|
+
_See code: [src/commands/mcp/configure.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/mcp/configure.ts)_
|
|
2271
2397
|
|
|
2272
2398
|
## `sanity media create-aspect`
|
|
2273
2399
|
|
|
@@ -2275,7 +2401,7 @@ Create a new aspect definition file
|
|
|
2275
2401
|
|
|
2276
2402
|
```
|
|
2277
2403
|
USAGE
|
|
2278
|
-
$ sanity media create-aspect
|
|
2404
|
+
$ pnpm exec sanity media create-aspect
|
|
2279
2405
|
|
|
2280
2406
|
DESCRIPTION
|
|
2281
2407
|
Create a new aspect definition file
|
|
@@ -2283,10 +2409,10 @@ DESCRIPTION
|
|
|
2283
2409
|
EXAMPLES
|
|
2284
2410
|
Create a new aspect definition file
|
|
2285
2411
|
|
|
2286
|
-
$ sanity media create-aspect
|
|
2412
|
+
$ pnpm exec sanity media create-aspect
|
|
2287
2413
|
```
|
|
2288
2414
|
|
|
2289
|
-
_See code: [src/commands/media/create-aspect.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
2415
|
+
_See code: [src/commands/media/create-aspect.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/media/create-aspect.ts)_
|
|
2290
2416
|
|
|
2291
2417
|
## `sanity media delete-aspect ASPECTNAME`
|
|
2292
2418
|
|
|
@@ -2294,7 +2420,7 @@ Undeploy an aspect
|
|
|
2294
2420
|
|
|
2295
2421
|
```
|
|
2296
2422
|
USAGE
|
|
2297
|
-
$ sanity media delete-aspect ASPECTNAME [--media-library-id <value>] [--yes]
|
|
2423
|
+
$ pnpm exec sanity media delete-aspect ASPECTNAME [--media-library-id <value>] [--yes]
|
|
2298
2424
|
|
|
2299
2425
|
ARGUMENTS
|
|
2300
2426
|
ASPECTNAME Name of the aspect to delete
|
|
@@ -2309,10 +2435,10 @@ DESCRIPTION
|
|
|
2309
2435
|
EXAMPLES
|
|
2310
2436
|
Delete the aspect named "someAspect"
|
|
2311
2437
|
|
|
2312
|
-
$ sanity media delete-aspect someAspect
|
|
2438
|
+
$ pnpm exec sanity media delete-aspect someAspect
|
|
2313
2439
|
```
|
|
2314
2440
|
|
|
2315
|
-
_See code: [src/commands/media/delete-aspect.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
2441
|
+
_See code: [src/commands/media/delete-aspect.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/media/delete-aspect.ts)_
|
|
2316
2442
|
|
|
2317
2443
|
## `sanity media deploy-aspect [ASPECTNAME]`
|
|
2318
2444
|
|
|
@@ -2320,7 +2446,7 @@ Deploy an aspect
|
|
|
2320
2446
|
|
|
2321
2447
|
```
|
|
2322
2448
|
USAGE
|
|
2323
|
-
$ sanity media deploy-aspect [ASPECTNAME] [--all] [--media-library-id <value>]
|
|
2449
|
+
$ pnpm exec sanity media deploy-aspect [ASPECTNAME] [--all] [--media-library-id <value>]
|
|
2324
2450
|
|
|
2325
2451
|
ARGUMENTS
|
|
2326
2452
|
[ASPECTNAME] Name of the aspect to deploy
|
|
@@ -2335,14 +2461,14 @@ DESCRIPTION
|
|
|
2335
2461
|
EXAMPLES
|
|
2336
2462
|
Deploy the aspect named "someAspect"
|
|
2337
2463
|
|
|
2338
|
-
$ sanity media deploy-aspect someAspect
|
|
2464
|
+
$ pnpm exec sanity media deploy-aspect someAspect
|
|
2339
2465
|
|
|
2340
2466
|
Deploy all aspects
|
|
2341
2467
|
|
|
2342
|
-
$ sanity media deploy-aspect --all
|
|
2468
|
+
$ pnpm exec sanity media deploy-aspect --all
|
|
2343
2469
|
```
|
|
2344
2470
|
|
|
2345
|
-
_See code: [src/commands/media/deploy-aspect.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
2471
|
+
_See code: [src/commands/media/deploy-aspect.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/media/deploy-aspect.ts)_
|
|
2346
2472
|
|
|
2347
2473
|
## `sanity media export [DESTINATION]`
|
|
2348
2474
|
|
|
@@ -2350,7 +2476,7 @@ Export an archive of all file and image assets including their aspect data from
|
|
|
2350
2476
|
|
|
2351
2477
|
```
|
|
2352
2478
|
USAGE
|
|
2353
|
-
$ sanity media export [DESTINATION] [--asset-concurrency <value>] [--media-library-id <value>] [--no-compress]
|
|
2479
|
+
$ pnpm exec sanity media export [DESTINATION] [--asset-concurrency <value>] [--media-library-id <value>] [--no-compress]
|
|
2354
2480
|
[--overwrite]
|
|
2355
2481
|
|
|
2356
2482
|
ARGUMENTS
|
|
@@ -2369,18 +2495,18 @@ DESCRIPTION
|
|
|
2369
2495
|
EXAMPLES
|
|
2370
2496
|
Export media library interactively
|
|
2371
2497
|
|
|
2372
|
-
$ sanity media export
|
|
2498
|
+
$ pnpm exec sanity media export
|
|
2373
2499
|
|
|
2374
2500
|
Export media library to output.tar.gz
|
|
2375
2501
|
|
|
2376
|
-
$ sanity media export output.tar.gz
|
|
2502
|
+
$ pnpm exec sanity media export output.tar.gz
|
|
2377
2503
|
|
|
2378
2504
|
Export specific media library
|
|
2379
2505
|
|
|
2380
|
-
$ sanity media export --media-library-id my-library-id
|
|
2506
|
+
$ pnpm exec sanity media export --media-library-id my-library-id
|
|
2381
2507
|
```
|
|
2382
2508
|
|
|
2383
|
-
_See code: [src/commands/media/export.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
2509
|
+
_See code: [src/commands/media/export.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/media/export.ts)_
|
|
2384
2510
|
|
|
2385
2511
|
## `sanity media import SOURCE`
|
|
2386
2512
|
|
|
@@ -2388,7 +2514,7 @@ Import a set of assets to the target media library.
|
|
|
2388
2514
|
|
|
2389
2515
|
```
|
|
2390
2516
|
USAGE
|
|
2391
|
-
$ sanity media import SOURCE [--media-library-id <value>] [--replace-aspects]
|
|
2517
|
+
$ pnpm exec sanity media import SOURCE [--media-library-id <value>] [--replace-aspects]
|
|
2392
2518
|
|
|
2393
2519
|
ARGUMENTS
|
|
2394
2520
|
SOURCE Image file or folder to import from
|
|
@@ -2404,18 +2530,18 @@ DESCRIPTION
|
|
|
2404
2530
|
EXAMPLES
|
|
2405
2531
|
Import all assets from the "products" directory
|
|
2406
2532
|
|
|
2407
|
-
$ sanity media import products
|
|
2533
|
+
$ pnpm exec sanity media import products
|
|
2408
2534
|
|
|
2409
2535
|
Import all assets from "gallery" archive
|
|
2410
2536
|
|
|
2411
|
-
$ sanity media import gallery.tar.gz
|
|
2537
|
+
$ pnpm exec sanity media import gallery.tar.gz
|
|
2412
2538
|
|
|
2413
2539
|
Import all assets from the "products" directory and replace aspects
|
|
2414
2540
|
|
|
2415
|
-
$ sanity media import products --replace-aspects
|
|
2541
|
+
$ pnpm exec sanity media import products --replace-aspects
|
|
2416
2542
|
```
|
|
2417
2543
|
|
|
2418
|
-
_See code: [src/commands/media/import.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
2544
|
+
_See code: [src/commands/media/import.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/media/import.ts)_
|
|
2419
2545
|
|
|
2420
2546
|
## `sanity migration create [TITLE]`
|
|
2421
2547
|
|
|
@@ -2423,7 +2549,7 @@ Create a new migration within your project
|
|
|
2423
2549
|
|
|
2424
2550
|
```
|
|
2425
2551
|
USAGE
|
|
2426
|
-
$ sanity migration create [TITLE]
|
|
2552
|
+
$ pnpm exec sanity migration create [TITLE]
|
|
2427
2553
|
|
|
2428
2554
|
ARGUMENTS
|
|
2429
2555
|
[TITLE] Title of migration
|
|
@@ -2434,11 +2560,11 @@ DESCRIPTION
|
|
|
2434
2560
|
EXAMPLES
|
|
2435
2561
|
Create a new migration, prompting for title and options
|
|
2436
2562
|
|
|
2437
|
-
$ sanity migration create
|
|
2563
|
+
$ pnpm exec sanity migration create
|
|
2438
2564
|
|
|
2439
2565
|
Create a new migration with the provided title, prompting for options
|
|
2440
2566
|
|
|
2441
|
-
$ sanity migration create "Rename field from location to address"
|
|
2567
|
+
$ pnpm exec sanity migration create "Rename field from location to address"
|
|
2442
2568
|
```
|
|
2443
2569
|
|
|
2444
2570
|
_See code: [@sanity/migrate](https://github.com/sanity-io/migrate/blob/v5.2.5/src/commands/migration/create.ts)_
|
|
@@ -2449,7 +2575,7 @@ List available migrations
|
|
|
2449
2575
|
|
|
2450
2576
|
```
|
|
2451
2577
|
USAGE
|
|
2452
|
-
$ sanity migration list
|
|
2578
|
+
$ pnpm exec sanity migration list
|
|
2453
2579
|
|
|
2454
2580
|
DESCRIPTION
|
|
2455
2581
|
List available migrations
|
|
@@ -2457,7 +2583,7 @@ DESCRIPTION
|
|
|
2457
2583
|
EXAMPLES
|
|
2458
2584
|
List all available migrations in the project
|
|
2459
2585
|
|
|
2460
|
-
$ sanity migration list
|
|
2586
|
+
$ pnpm exec sanity migration list
|
|
2461
2587
|
```
|
|
2462
2588
|
|
|
2463
2589
|
_See code: [@sanity/migrate](https://github.com/sanity-io/migrate/blob/v5.2.5/src/commands/migration/list.ts)_
|
|
@@ -2468,7 +2594,7 @@ Run a migration against a dataset
|
|
|
2468
2594
|
|
|
2469
2595
|
```
|
|
2470
2596
|
USAGE
|
|
2471
|
-
$ sanity migration run [ID] [--api-version <value>] [--concurrency <value>] [--confirm] [--dataset <value>]
|
|
2597
|
+
$ pnpm exec sanity migration run [ID] [--api-version <value>] [--concurrency <value>] [--confirm] [--dataset <value>]
|
|
2472
2598
|
[--dry-run] [--from-export <value>] [--progress] [--project <value>]
|
|
2473
2599
|
|
|
2474
2600
|
ARGUMENTS
|
|
@@ -2493,15 +2619,15 @@ DESCRIPTION
|
|
|
2493
2619
|
EXAMPLES
|
|
2494
2620
|
dry run the migration
|
|
2495
2621
|
|
|
2496
|
-
$ sanity migration run <id>
|
|
2622
|
+
$ pnpm exec sanity migration run <id>
|
|
2497
2623
|
|
|
2498
2624
|
execute the migration against a dataset
|
|
2499
2625
|
|
|
2500
|
-
$ sanity migration run <id> --no-dry-run --project xyz --dataset staging
|
|
2626
|
+
$ pnpm exec sanity migration run <id> --no-dry-run --project xyz --dataset staging
|
|
2501
2627
|
|
|
2502
2628
|
execute the migration using a dataset export as the source
|
|
2503
2629
|
|
|
2504
|
-
$ sanity migration run <id> --from-export=production.tar.gz --no-dry-run --project xyz --dataset staging
|
|
2630
|
+
$ pnpm exec sanity migration run <id> --from-export=production.tar.gz --no-dry-run --project xyz --dataset staging
|
|
2505
2631
|
```
|
|
2506
2632
|
|
|
2507
2633
|
_See code: [@sanity/migrate](https://github.com/sanity-io/migrate/blob/v5.2.5/src/commands/migration/run.ts)_
|
|
@@ -2512,7 +2638,7 @@ Get an OpenAPI specification by slug
|
|
|
2512
2638
|
|
|
2513
2639
|
```
|
|
2514
2640
|
USAGE
|
|
2515
|
-
$ sanity openapi get SLUG [--format yaml|json] [-w]
|
|
2641
|
+
$ pnpm exec sanity openapi get SLUG [--format yaml|json] [-w]
|
|
2516
2642
|
|
|
2517
2643
|
ARGUMENTS
|
|
2518
2644
|
SLUG Slug of the OpenAPI specification to retrieve
|
|
@@ -2528,22 +2654,22 @@ DESCRIPTION
|
|
|
2528
2654
|
EXAMPLES
|
|
2529
2655
|
Get a specification (YAML format, default)
|
|
2530
2656
|
|
|
2531
|
-
$ sanity openapi get query
|
|
2657
|
+
$ pnpm exec sanity openapi get query
|
|
2532
2658
|
|
|
2533
2659
|
Get specification in JSON format
|
|
2534
2660
|
|
|
2535
|
-
$ sanity openapi get query --format=json
|
|
2661
|
+
$ pnpm exec sanity openapi get query --format=json
|
|
2536
2662
|
|
|
2537
2663
|
Open specification in browser
|
|
2538
2664
|
|
|
2539
|
-
$ sanity openapi get query --web
|
|
2665
|
+
$ pnpm exec sanity openapi get query --web
|
|
2540
2666
|
|
|
2541
2667
|
Pipe to file
|
|
2542
2668
|
|
|
2543
|
-
$ sanity openapi get query > query-api.yaml
|
|
2669
|
+
$ pnpm exec sanity openapi get query > query-api.yaml
|
|
2544
2670
|
```
|
|
2545
2671
|
|
|
2546
|
-
_See code: [src/commands/openapi/get.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
2672
|
+
_See code: [src/commands/openapi/get.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/openapi/get.ts)_
|
|
2547
2673
|
|
|
2548
2674
|
## `sanity openapi list`
|
|
2549
2675
|
|
|
@@ -2551,7 +2677,7 @@ List all available OpenAPI specifications
|
|
|
2551
2677
|
|
|
2552
2678
|
```
|
|
2553
2679
|
USAGE
|
|
2554
|
-
$ sanity openapi list [--json] [-w]
|
|
2680
|
+
$ pnpm exec sanity openapi list [--json] [-w]
|
|
2555
2681
|
|
|
2556
2682
|
FLAGS
|
|
2557
2683
|
-w, --web Open HTTP Reference in web browser
|
|
@@ -2563,18 +2689,18 @@ DESCRIPTION
|
|
|
2563
2689
|
EXAMPLES
|
|
2564
2690
|
List all available OpenAPI specs
|
|
2565
2691
|
|
|
2566
|
-
$ sanity openapi list
|
|
2692
|
+
$ pnpm exec sanity openapi list
|
|
2567
2693
|
|
|
2568
2694
|
List with JSON output
|
|
2569
2695
|
|
|
2570
|
-
$ sanity openapi list --json
|
|
2696
|
+
$ pnpm exec sanity openapi list --json
|
|
2571
2697
|
|
|
2572
2698
|
Open HTTP Reference in browser
|
|
2573
2699
|
|
|
2574
|
-
$ sanity openapi list --web
|
|
2700
|
+
$ pnpm exec sanity openapi list --web
|
|
2575
2701
|
```
|
|
2576
2702
|
|
|
2577
|
-
_See code: [src/commands/openapi/list.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
2703
|
+
_See code: [src/commands/openapi/list.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/openapi/list.ts)_
|
|
2578
2704
|
|
|
2579
2705
|
## `sanity preview [OUTPUTDIR]`
|
|
2580
2706
|
|
|
@@ -2582,7 +2708,7 @@ Starts a server to preview a production build
|
|
|
2582
2708
|
|
|
2583
2709
|
```
|
|
2584
2710
|
USAGE
|
|
2585
|
-
$ sanity preview [OUTPUTDIR] [--host <value>] [--port <value>]
|
|
2711
|
+
$ pnpm exec sanity preview [OUTPUTDIR] [--host <value>] [--port <value>]
|
|
2586
2712
|
|
|
2587
2713
|
ARGUMENTS
|
|
2588
2714
|
[OUTPUTDIR] Output directory
|
|
@@ -2595,17 +2721,17 @@ DESCRIPTION
|
|
|
2595
2721
|
Starts a server to preview a production build
|
|
2596
2722
|
|
|
2597
2723
|
ALIASES
|
|
2598
|
-
$ sanity start
|
|
2724
|
+
$ pnpm exec sanity start
|
|
2599
2725
|
|
|
2600
2726
|
EXAMPLES
|
|
2601
|
-
$ sanity preview --host=0.0.0.0
|
|
2727
|
+
$ pnpm exec sanity preview --host=0.0.0.0
|
|
2602
2728
|
|
|
2603
|
-
$ sanity preview --port=1942
|
|
2729
|
+
$ pnpm exec sanity preview --port=1942
|
|
2604
2730
|
|
|
2605
|
-
$ sanity preview some/build-output-dir
|
|
2731
|
+
$ pnpm exec sanity preview some/build-output-dir
|
|
2606
2732
|
```
|
|
2607
2733
|
|
|
2608
|
-
_See code: [src/commands/preview.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
2734
|
+
_See code: [src/commands/preview.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/preview.ts)_
|
|
2609
2735
|
|
|
2610
2736
|
## `sanity projects create [PROJECTNAME]`
|
|
2611
2737
|
|
|
@@ -2613,7 +2739,7 @@ Create a new Sanity project
|
|
|
2613
2739
|
|
|
2614
2740
|
```
|
|
2615
2741
|
USAGE
|
|
2616
|
-
$ sanity projects create [PROJECTNAME] [--dataset <value>] [--dataset-visibility private|public] [--json]
|
|
2742
|
+
$ pnpm exec sanity projects create [PROJECTNAME] [--dataset <value>] [--dataset-visibility private|public] [--json]
|
|
2617
2743
|
[--organization <slug|id>] [-y]
|
|
2618
2744
|
|
|
2619
2745
|
ARGUMENTS
|
|
@@ -2634,26 +2760,26 @@ DESCRIPTION
|
|
|
2634
2760
|
EXAMPLES
|
|
2635
2761
|
Interactively create a project
|
|
2636
2762
|
|
|
2637
|
-
$ sanity projects create
|
|
2763
|
+
$ pnpm exec sanity projects create
|
|
2638
2764
|
|
|
2639
2765
|
Create a project named "My New Project"
|
|
2640
2766
|
|
|
2641
|
-
$ sanity projects create "My New Project"
|
|
2767
|
+
$ pnpm exec sanity projects create "My New Project"
|
|
2642
2768
|
|
|
2643
2769
|
Create a project in a specific organization
|
|
2644
2770
|
|
|
2645
|
-
$ sanity projects create "My Project" --organization=my-org
|
|
2771
|
+
$ pnpm exec sanity projects create "My Project" --organization=my-org
|
|
2646
2772
|
|
|
2647
2773
|
Create a project with a private dataset named "staging"
|
|
2648
2774
|
|
|
2649
|
-
$ sanity projects create "My Project" --dataset=staging --dataset-visibility=private
|
|
2775
|
+
$ pnpm exec sanity projects create "My Project" --dataset=staging --dataset-visibility=private
|
|
2650
2776
|
|
|
2651
2777
|
Create a project non-interactively with JSON output
|
|
2652
2778
|
|
|
2653
|
-
$ sanity projects create "CI Project" --yes --json
|
|
2779
|
+
$ pnpm exec sanity projects create "CI Project" --yes --json
|
|
2654
2780
|
```
|
|
2655
2781
|
|
|
2656
|
-
_See code: [src/commands/projects/create.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
2782
|
+
_See code: [src/commands/projects/create.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/projects/create.ts)_
|
|
2657
2783
|
|
|
2658
2784
|
## `sanity projects list`
|
|
2659
2785
|
|
|
@@ -2661,7 +2787,7 @@ Lists projects connected to your user
|
|
|
2661
2787
|
|
|
2662
2788
|
```
|
|
2663
2789
|
USAGE
|
|
2664
|
-
$ sanity projects list [--order asc|desc] [--sort id|members|name|url|created]
|
|
2790
|
+
$ pnpm exec sanity projects list [--order asc|desc] [--sort id|members|name|url|created]
|
|
2665
2791
|
|
|
2666
2792
|
FLAGS
|
|
2667
2793
|
--order=<option> [default: desc]
|
|
@@ -2675,14 +2801,14 @@ DESCRIPTION
|
|
|
2675
2801
|
EXAMPLES
|
|
2676
2802
|
List projects
|
|
2677
2803
|
|
|
2678
|
-
$ sanity projects list
|
|
2804
|
+
$ pnpm exec sanity projects list
|
|
2679
2805
|
|
|
2680
2806
|
List all users of the project, but exclude pending invitations and robots
|
|
2681
2807
|
|
|
2682
|
-
$ sanity projects list --sort=members --order=asc
|
|
2808
|
+
$ pnpm exec sanity projects list --sort=members --order=asc
|
|
2683
2809
|
```
|
|
2684
2810
|
|
|
2685
|
-
_See code: [src/commands/projects/list.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
2811
|
+
_See code: [src/commands/projects/list.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/projects/list.ts)_
|
|
2686
2812
|
|
|
2687
2813
|
## `sanity schema delete`
|
|
2688
2814
|
|
|
@@ -2690,7 +2816,7 @@ Delete schema documents by id
|
|
|
2690
2816
|
|
|
2691
2817
|
```
|
|
2692
2818
|
USAGE
|
|
2693
|
-
$ sanity schema delete --ids <value> [--dataset <value>] [--verbose]
|
|
2819
|
+
$ pnpm exec sanity schema delete --ids <value> [--dataset <value>] [--verbose]
|
|
2694
2820
|
|
|
2695
2821
|
FLAGS
|
|
2696
2822
|
--dataset=<value> Delete schemas from a specific dataset
|
|
@@ -2703,14 +2829,14 @@ DESCRIPTION
|
|
|
2703
2829
|
EXAMPLES
|
|
2704
2830
|
Delete a single schema
|
|
2705
2831
|
|
|
2706
|
-
$ sanity schema delete --ids sanity.workspace.schema.workspaceName
|
|
2832
|
+
$ pnpm exec sanity schema delete --ids sanity.workspace.schema.workspaceName
|
|
2707
2833
|
|
|
2708
2834
|
Delete multiple schemas
|
|
2709
2835
|
|
|
2710
|
-
$ sanity schema delete --ids sanity.workspace.schema.workspaceName,prefix.sanity.workspace.schema.otherWorkspace
|
|
2836
|
+
$ pnpm exec sanity schema delete --ids sanity.workspace.schema.workspaceName,prefix.sanity.workspace.schema.otherWorkspace
|
|
2711
2837
|
```
|
|
2712
2838
|
|
|
2713
|
-
_See code: [src/commands/schema/delete.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
2839
|
+
_See code: [src/commands/schema/delete.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/schema/delete.ts)_
|
|
2714
2840
|
|
|
2715
2841
|
## `sanity schema deploy`
|
|
2716
2842
|
|
|
@@ -2718,7 +2844,7 @@ Deploy schema documents into workspace datasets.
|
|
|
2718
2844
|
|
|
2719
2845
|
```
|
|
2720
2846
|
USAGE
|
|
2721
|
-
$ sanity schema deploy [--extract-manifest] [--manifest-dir <directory>] [--tag <tag>] [--verbose] [--workspace
|
|
2847
|
+
$ pnpm exec sanity schema deploy [--extract-manifest] [--manifest-dir <directory>] [--tag <tag>] [--verbose] [--workspace
|
|
2722
2848
|
<name>]
|
|
2723
2849
|
|
|
2724
2850
|
FLAGS
|
|
@@ -2739,18 +2865,14 @@ DESCRIPTION
|
|
|
2739
2865
|
EXAMPLES
|
|
2740
2866
|
Deploy all workspace schemas
|
|
2741
2867
|
|
|
2742
|
-
$ sanity schema deploy
|
|
2868
|
+
$ pnpm exec sanity schema deploy
|
|
2743
2869
|
|
|
2744
2870
|
Deploy the schema for only the workspace "default"
|
|
2745
2871
|
|
|
2746
|
-
$ sanity schema deploy --workspace default
|
|
2747
|
-
|
|
2748
|
-
Runs using a pre-existing manifest file. Config changes in sanity.config will not be picked up in this case.
|
|
2749
|
-
|
|
2750
|
-
$ sanity schema deploy --no-extract-manifest
|
|
2872
|
+
$ pnpm exec sanity schema deploy --workspace default
|
|
2751
2873
|
```
|
|
2752
2874
|
|
|
2753
|
-
_See code: [src/commands/schema/deploy.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
2875
|
+
_See code: [src/commands/schema/deploy.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/schema/deploy.ts)_
|
|
2754
2876
|
|
|
2755
2877
|
## `sanity schema extract`
|
|
2756
2878
|
|
|
@@ -2758,7 +2880,7 @@ Extracts a JSON representation of a Sanity schema within a Studio context.
|
|
|
2758
2880
|
|
|
2759
2881
|
```
|
|
2760
2882
|
USAGE
|
|
2761
|
-
$ sanity schema extract [--enforce-required-fields] [--format <format>] [--path <value>] [--watch]
|
|
2883
|
+
$ pnpm exec sanity schema extract [--enforce-required-fields] [--format <format>] [--path <value>] [--watch]
|
|
2762
2884
|
[--watch-patterns <glob>...] [--workspace <name>]
|
|
2763
2885
|
|
|
2764
2886
|
FLAGS
|
|
@@ -2778,18 +2900,18 @@ DESCRIPTION
|
|
|
2778
2900
|
EXAMPLES
|
|
2779
2901
|
Extracts schema types in a Sanity project with more than one workspace
|
|
2780
2902
|
|
|
2781
|
-
$ sanity schema extract --workspace default
|
|
2903
|
+
$ pnpm exec sanity schema extract --workspace default
|
|
2782
2904
|
|
|
2783
2905
|
Watch mode - re-extract on changes
|
|
2784
2906
|
|
|
2785
|
-
$ sanity schema extract --watch
|
|
2907
|
+
$ pnpm exec sanity schema extract --watch
|
|
2786
2908
|
|
|
2787
2909
|
Watch with custom glob patterns
|
|
2788
2910
|
|
|
2789
|
-
$ sanity schema extract --watch --watch-patterns "lib/**/*.ts"
|
|
2911
|
+
$ pnpm exec sanity schema extract --watch --watch-patterns "lib/**/*.ts"
|
|
2790
2912
|
```
|
|
2791
2913
|
|
|
2792
|
-
_See code: [src/commands/schema/extract.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
2914
|
+
_See code: [src/commands/schema/extract.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/schema/extract.ts)_
|
|
2793
2915
|
|
|
2794
2916
|
## `sanity schema list`
|
|
2795
2917
|
|
|
@@ -2797,7 +2919,7 @@ Lists all schemas in the current dataset.
|
|
|
2797
2919
|
|
|
2798
2920
|
```
|
|
2799
2921
|
USAGE
|
|
2800
|
-
$ sanity schema list [--id <schema_id>] [--json]
|
|
2922
|
+
$ pnpm exec sanity schema list [--id <schema_id>] [--json]
|
|
2801
2923
|
|
|
2802
2924
|
FLAGS
|
|
2803
2925
|
--id=<schema_id> Fetch a single schema by id
|
|
@@ -2814,22 +2936,22 @@ DESCRIPTION
|
|
|
2814
2936
|
EXAMPLES
|
|
2815
2937
|
List all schemas found in any workspace dataset in a table
|
|
2816
2938
|
|
|
2817
|
-
$ sanity schema list
|
|
2939
|
+
$ pnpm exec sanity schema list
|
|
2818
2940
|
|
|
2819
2941
|
Get a schema for a given id
|
|
2820
2942
|
|
|
2821
|
-
$ sanity schema list --id _.schemas.workspaceName
|
|
2943
|
+
$ pnpm exec sanity schema list --id _.schemas.workspaceName
|
|
2822
2944
|
|
|
2823
2945
|
Get stored schemas as pretty-printed json-array
|
|
2824
2946
|
|
|
2825
|
-
$ sanity schema list --json
|
|
2947
|
+
$ pnpm exec sanity schema list --json
|
|
2826
2948
|
|
|
2827
2949
|
Get singular stored schema as pretty-printed json-object
|
|
2828
2950
|
|
|
2829
|
-
$ sanity schema list --json --id _.schemas.workspaceName
|
|
2951
|
+
$ pnpm exec sanity schema list --json --id _.schemas.workspaceName
|
|
2830
2952
|
```
|
|
2831
2953
|
|
|
2832
|
-
_See code: [src/commands/schema/list.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
2954
|
+
_See code: [src/commands/schema/list.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/schema/list.ts)_
|
|
2833
2955
|
|
|
2834
2956
|
## `sanity schema validate`
|
|
2835
2957
|
|
|
@@ -2837,7 +2959,7 @@ Validates all schema types specified in a workspace
|
|
|
2837
2959
|
|
|
2838
2960
|
```
|
|
2839
2961
|
USAGE
|
|
2840
|
-
$ sanity schema validate [--debug-metafile-path <value>] [--format pretty|ndjson|json] [--level error|warning]
|
|
2962
|
+
$ pnpm exec sanity schema validate [--debug-metafile-path <value>] [--format pretty|ndjson|json] [--level error|warning]
|
|
2841
2963
|
[--workspace <value>]
|
|
2842
2964
|
|
|
2843
2965
|
FLAGS
|
|
@@ -2857,22 +2979,22 @@ DESCRIPTION
|
|
|
2857
2979
|
EXAMPLES
|
|
2858
2980
|
Validates all schema types in a Sanity project with more than one workspace
|
|
2859
2981
|
|
|
2860
|
-
$ sanity schema validate --workspace default
|
|
2982
|
+
$ pnpm exec sanity schema validate --workspace default
|
|
2861
2983
|
|
|
2862
2984
|
Save the results of the report into a file
|
|
2863
2985
|
|
|
2864
|
-
$ sanity schema validate > report.txt
|
|
2986
|
+
$ pnpm exec sanity schema validate > report.txt
|
|
2865
2987
|
|
|
2866
2988
|
Report out only errors
|
|
2867
2989
|
|
|
2868
|
-
$ sanity schema validate --level error
|
|
2990
|
+
$ pnpm exec sanity schema validate --level error
|
|
2869
2991
|
|
|
2870
2992
|
Generate a report which can be analyzed with https://esbuild.github.io/analyze/
|
|
2871
2993
|
|
|
2872
|
-
$ sanity schema validate --debug-metafile-path metafile.json
|
|
2994
|
+
$ pnpm exec sanity schema validate --debug-metafile-path metafile.json
|
|
2873
2995
|
```
|
|
2874
2996
|
|
|
2875
|
-
_See code: [src/commands/schema/validate.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
2997
|
+
_See code: [src/commands/schema/validate.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/schema/validate.ts)_
|
|
2876
2998
|
|
|
2877
2999
|
## `sanity start [OUTPUTDIR]`
|
|
2878
3000
|
|
|
@@ -2880,7 +3002,7 @@ Starts a server to preview a production build
|
|
|
2880
3002
|
|
|
2881
3003
|
```
|
|
2882
3004
|
USAGE
|
|
2883
|
-
$ sanity start [OUTPUTDIR] [--host <value>] [--port <value>]
|
|
3005
|
+
$ pnpm exec sanity start [OUTPUTDIR] [--host <value>] [--port <value>]
|
|
2884
3006
|
|
|
2885
3007
|
ARGUMENTS
|
|
2886
3008
|
[OUTPUTDIR] Output directory
|
|
@@ -2893,14 +3015,14 @@ DESCRIPTION
|
|
|
2893
3015
|
Starts a server to preview a production build
|
|
2894
3016
|
|
|
2895
3017
|
ALIASES
|
|
2896
|
-
$ sanity start
|
|
3018
|
+
$ pnpm exec sanity start
|
|
2897
3019
|
|
|
2898
3020
|
EXAMPLES
|
|
2899
|
-
$ sanity start --host=0.0.0.0
|
|
3021
|
+
$ pnpm exec sanity start --host=0.0.0.0
|
|
2900
3022
|
|
|
2901
|
-
$ sanity start --port=1942
|
|
3023
|
+
$ pnpm exec sanity start --port=1942
|
|
2902
3024
|
|
|
2903
|
-
$ sanity start some/build-output-dir
|
|
3025
|
+
$ pnpm exec sanity start some/build-output-dir
|
|
2904
3026
|
```
|
|
2905
3027
|
|
|
2906
3028
|
## `sanity telemetry disable`
|
|
@@ -2909,7 +3031,7 @@ Disable telemetry for your logged in user
|
|
|
2909
3031
|
|
|
2910
3032
|
```
|
|
2911
3033
|
USAGE
|
|
2912
|
-
$ sanity telemetry disable
|
|
3034
|
+
$ pnpm exec sanity telemetry disable
|
|
2913
3035
|
|
|
2914
3036
|
DESCRIPTION
|
|
2915
3037
|
Disable telemetry for your logged in user
|
|
@@ -2917,10 +3039,10 @@ DESCRIPTION
|
|
|
2917
3039
|
EXAMPLES
|
|
2918
3040
|
Disable telemetry for your logged in user
|
|
2919
3041
|
|
|
2920
|
-
$ sanity telemetry telemetry disable
|
|
3042
|
+
$ pnpm exec sanity telemetry telemetry disable
|
|
2921
3043
|
```
|
|
2922
3044
|
|
|
2923
|
-
_See code: [src/commands/telemetry/disable.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
3045
|
+
_See code: [src/commands/telemetry/disable.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/telemetry/disable.ts)_
|
|
2924
3046
|
|
|
2925
3047
|
## `sanity telemetry enable`
|
|
2926
3048
|
|
|
@@ -2928,7 +3050,7 @@ Enable telemetry for your logged in user
|
|
|
2928
3050
|
|
|
2929
3051
|
```
|
|
2930
3052
|
USAGE
|
|
2931
|
-
$ sanity telemetry enable
|
|
3053
|
+
$ pnpm exec sanity telemetry enable
|
|
2932
3054
|
|
|
2933
3055
|
DESCRIPTION
|
|
2934
3056
|
Enable telemetry for your logged in user
|
|
@@ -2936,10 +3058,10 @@ DESCRIPTION
|
|
|
2936
3058
|
EXAMPLES
|
|
2937
3059
|
Enable telemetry for your logged in user
|
|
2938
3060
|
|
|
2939
|
-
$ sanity telemetry telemetry enable
|
|
3061
|
+
$ pnpm exec sanity telemetry telemetry enable
|
|
2940
3062
|
```
|
|
2941
3063
|
|
|
2942
|
-
_See code: [src/commands/telemetry/enable.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
3064
|
+
_See code: [src/commands/telemetry/enable.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/telemetry/enable.ts)_
|
|
2943
3065
|
|
|
2944
3066
|
## `sanity telemetry status`
|
|
2945
3067
|
|
|
@@ -2947,7 +3069,7 @@ Check telemetry consent status for your logged in user
|
|
|
2947
3069
|
|
|
2948
3070
|
```
|
|
2949
3071
|
USAGE
|
|
2950
|
-
$ sanity telemetry status
|
|
3072
|
+
$ pnpm exec sanity telemetry status
|
|
2951
3073
|
|
|
2952
3074
|
DESCRIPTION
|
|
2953
3075
|
Check telemetry consent status for your logged in user
|
|
@@ -2955,10 +3077,10 @@ DESCRIPTION
|
|
|
2955
3077
|
EXAMPLES
|
|
2956
3078
|
Check telemetry consent status for your logged in user
|
|
2957
3079
|
|
|
2958
|
-
$ sanity telemetry telemetry status
|
|
3080
|
+
$ pnpm exec sanity telemetry telemetry status
|
|
2959
3081
|
```
|
|
2960
3082
|
|
|
2961
|
-
_See code: [src/commands/telemetry/status.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
3083
|
+
_See code: [src/commands/telemetry/status.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/telemetry/status.ts)_
|
|
2962
3084
|
|
|
2963
3085
|
## `sanity tokens add [LABEL]`
|
|
2964
3086
|
|
|
@@ -2966,7 +3088,7 @@ Create a new API token for this project
|
|
|
2966
3088
|
|
|
2967
3089
|
```
|
|
2968
3090
|
USAGE
|
|
2969
|
-
$ sanity tokens add [LABEL] [--json] [--role viewer] [-y]
|
|
3091
|
+
$ pnpm exec sanity tokens add [LABEL] [--json] [--role viewer] [-y]
|
|
2970
3092
|
|
|
2971
3093
|
ARGUMENTS
|
|
2972
3094
|
[LABEL] Label for the new token
|
|
@@ -2982,22 +3104,22 @@ DESCRIPTION
|
|
|
2982
3104
|
EXAMPLES
|
|
2983
3105
|
Create a token with a label
|
|
2984
3106
|
|
|
2985
|
-
$ sanity tokens add "My API Token"
|
|
3107
|
+
$ pnpm exec sanity tokens add "My API Token"
|
|
2986
3108
|
|
|
2987
3109
|
Create a token with editor role
|
|
2988
3110
|
|
|
2989
|
-
$ sanity tokens add "My API Token" --role=editor
|
|
3111
|
+
$ pnpm exec sanity tokens add "My API Token" --role=editor
|
|
2990
3112
|
|
|
2991
3113
|
Create a token in unattended mode
|
|
2992
3114
|
|
|
2993
|
-
$ sanity tokens add "CI Token" --role=editor --yes
|
|
3115
|
+
$ pnpm exec sanity tokens add "CI Token" --role=editor --yes
|
|
2994
3116
|
|
|
2995
3117
|
Output token information as JSON
|
|
2996
3118
|
|
|
2997
|
-
$ sanity tokens add "API Token" --json
|
|
3119
|
+
$ pnpm exec sanity tokens add "API Token" --json
|
|
2998
3120
|
```
|
|
2999
3121
|
|
|
3000
|
-
_See code: [src/commands/tokens/add.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
3122
|
+
_See code: [src/commands/tokens/add.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/tokens/add.ts)_
|
|
3001
3123
|
|
|
3002
3124
|
## `sanity tokens delete [TOKENID]`
|
|
3003
3125
|
|
|
@@ -3005,7 +3127,7 @@ Delete an API token from this project
|
|
|
3005
3127
|
|
|
3006
3128
|
```
|
|
3007
3129
|
USAGE
|
|
3008
|
-
$ sanity tokens delete [TOKENID] [--yes]
|
|
3130
|
+
$ pnpm exec sanity tokens delete [TOKENID] [--yes]
|
|
3009
3131
|
|
|
3010
3132
|
ARGUMENTS
|
|
3011
3133
|
[TOKENID] Token ID to delete (will prompt if not provided)
|
|
@@ -3019,18 +3141,18 @@ DESCRIPTION
|
|
|
3019
3141
|
EXAMPLES
|
|
3020
3142
|
Interactively select and delete a token
|
|
3021
3143
|
|
|
3022
|
-
$ sanity tokens delete
|
|
3144
|
+
$ pnpm exec sanity tokens delete
|
|
3023
3145
|
|
|
3024
3146
|
Delete a specific token by ID
|
|
3025
3147
|
|
|
3026
|
-
$ sanity tokens delete silJ2lFmK6dONB
|
|
3148
|
+
$ pnpm exec sanity tokens delete silJ2lFmK6dONB
|
|
3027
3149
|
|
|
3028
3150
|
Delete a specific token without confirmation prompt
|
|
3029
3151
|
|
|
3030
|
-
$ sanity tokens delete silJ2lFmK6dONB --yes
|
|
3152
|
+
$ pnpm exec sanity tokens delete silJ2lFmK6dONB --yes
|
|
3031
3153
|
```
|
|
3032
3154
|
|
|
3033
|
-
_See code: [src/commands/tokens/delete.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
3155
|
+
_See code: [src/commands/tokens/delete.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/tokens/delete.ts)_
|
|
3034
3156
|
|
|
3035
3157
|
## `sanity tokens list`
|
|
3036
3158
|
|
|
@@ -3038,7 +3160,7 @@ List API tokens for the current project
|
|
|
3038
3160
|
|
|
3039
3161
|
```
|
|
3040
3162
|
USAGE
|
|
3041
|
-
$ sanity tokens list [--json]
|
|
3163
|
+
$ pnpm exec sanity tokens list [--json]
|
|
3042
3164
|
|
|
3043
3165
|
FLAGS
|
|
3044
3166
|
--json Output tokens in JSON format
|
|
@@ -3049,14 +3171,14 @@ DESCRIPTION
|
|
|
3049
3171
|
EXAMPLES
|
|
3050
3172
|
List tokens for the current project
|
|
3051
3173
|
|
|
3052
|
-
$ sanity tokens list
|
|
3174
|
+
$ pnpm exec sanity tokens list
|
|
3053
3175
|
|
|
3054
3176
|
List tokens in JSON format
|
|
3055
3177
|
|
|
3056
|
-
$ sanity tokens list --json
|
|
3178
|
+
$ pnpm exec sanity tokens list --json
|
|
3057
3179
|
```
|
|
3058
3180
|
|
|
3059
|
-
_See code: [src/commands/tokens/list.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
3181
|
+
_See code: [src/commands/tokens/list.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/tokens/list.ts)_
|
|
3060
3182
|
|
|
3061
3183
|
## `sanity typegen generate`
|
|
3062
3184
|
|
|
@@ -3064,7 +3186,7 @@ Sanity TypeGen
|
|
|
3064
3186
|
|
|
3065
3187
|
```
|
|
3066
3188
|
USAGE
|
|
3067
|
-
$ sanity typegen generate [--config-path <value>] [--watch]
|
|
3189
|
+
$ pnpm exec sanity typegen generate [--config-path <value>] [--watch]
|
|
3068
3190
|
|
|
3069
3191
|
FLAGS
|
|
3070
3192
|
--config-path=<value> [Default: sanity-typegen.json] Specifies the path to the typegen configuration file. This file
|
|
@@ -3099,10 +3221,10 @@ EXAMPLES
|
|
|
3099
3221
|
Generate TypeScript type definitions from a Sanity Studio schema extracted using the `sanity schema extract`
|
|
3100
3222
|
command.
|
|
3101
3223
|
|
|
3102
|
-
$ sanity typegen generate
|
|
3224
|
+
$ pnpm exec sanity typegen generate
|
|
3103
3225
|
```
|
|
3104
3226
|
|
|
3105
|
-
_See code: [@sanity/codegen](https://github.com/sanity-io/codegen/blob/v5.
|
|
3227
|
+
_See code: [@sanity/codegen](https://github.com/sanity-io/codegen/blob/v5.10.1/src/commands/typegen/generate.ts)_
|
|
3106
3228
|
|
|
3107
3229
|
## `sanity undeploy`
|
|
3108
3230
|
|
|
@@ -3110,7 +3232,7 @@ Removes the deployed Sanity Studio/App from Sanity hosting
|
|
|
3110
3232
|
|
|
3111
3233
|
```
|
|
3112
3234
|
USAGE
|
|
3113
|
-
$ sanity undeploy [-y]
|
|
3235
|
+
$ pnpm exec sanity undeploy [-y]
|
|
3114
3236
|
|
|
3115
3237
|
FLAGS
|
|
3116
3238
|
-y, --yes Unattended mode, answers "yes" to any "yes/no" prompt and otherwise uses defaults
|
|
@@ -3119,7 +3241,7 @@ DESCRIPTION
|
|
|
3119
3241
|
Removes the deployed Sanity Studio/App from Sanity hosting
|
|
3120
3242
|
```
|
|
3121
3243
|
|
|
3122
|
-
_See code: [src/commands/undeploy.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
3244
|
+
_See code: [src/commands/undeploy.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/undeploy.ts)_
|
|
3123
3245
|
|
|
3124
3246
|
## `sanity users invite [EMAIL]`
|
|
3125
3247
|
|
|
@@ -3127,7 +3249,7 @@ Invite a new user to the project
|
|
|
3127
3249
|
|
|
3128
3250
|
```
|
|
3129
3251
|
USAGE
|
|
3130
|
-
$ sanity users invite [EMAIL] [--role <value>]
|
|
3252
|
+
$ pnpm exec sanity users invite [EMAIL] [--role <value>]
|
|
3131
3253
|
|
|
3132
3254
|
ARGUMENTS
|
|
3133
3255
|
[EMAIL] Email address to invite
|
|
@@ -3141,18 +3263,18 @@ DESCRIPTION
|
|
|
3141
3263
|
EXAMPLES
|
|
3142
3264
|
Invite a new user to the project (prompt for details)
|
|
3143
3265
|
|
|
3144
|
-
$ sanity users invite
|
|
3266
|
+
$ pnpm exec sanity users invite
|
|
3145
3267
|
|
|
3146
3268
|
Send a new user invite to the email "pippi@sanity.io", prompt for role
|
|
3147
3269
|
|
|
3148
|
-
$ sanity users invite pippi@sanity.io
|
|
3270
|
+
$ pnpm exec sanity users invite pippi@sanity.io
|
|
3149
3271
|
|
|
3150
3272
|
Send a new user invite to the email "pippi@sanity.io", as administrator
|
|
3151
3273
|
|
|
3152
|
-
$ sanity users invite pippi@sanity.io --role administrator
|
|
3274
|
+
$ pnpm exec sanity users invite pippi@sanity.io --role administrator
|
|
3153
3275
|
```
|
|
3154
3276
|
|
|
3155
|
-
_See code: [src/commands/users/invite.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
3277
|
+
_See code: [src/commands/users/invite.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/users/invite.ts)_
|
|
3156
3278
|
|
|
3157
3279
|
## `sanity users list`
|
|
3158
3280
|
|
|
@@ -3160,7 +3282,7 @@ List all users of the project
|
|
|
3160
3282
|
|
|
3161
3283
|
```
|
|
3162
3284
|
USAGE
|
|
3163
|
-
$ sanity users list [--invitations] [--order asc|desc] [--robots] [--sort id|name|role|date]
|
|
3285
|
+
$ pnpm exec sanity users list [--invitations] [--order asc|desc] [--robots] [--sort id|name|role|date]
|
|
3164
3286
|
|
|
3165
3287
|
FLAGS
|
|
3166
3288
|
--[no-]invitations Includes or excludes pending invitations
|
|
@@ -3176,18 +3298,18 @@ DESCRIPTION
|
|
|
3176
3298
|
EXAMPLES
|
|
3177
3299
|
List all users of the project
|
|
3178
3300
|
|
|
3179
|
-
$ sanity users list
|
|
3301
|
+
$ pnpm exec sanity users list
|
|
3180
3302
|
|
|
3181
3303
|
List all users of the project, but exclude pending invitations and robots
|
|
3182
3304
|
|
|
3183
|
-
$ sanity users list --no-invitations --no-robots
|
|
3305
|
+
$ pnpm exec sanity users list --no-invitations --no-robots
|
|
3184
3306
|
|
|
3185
3307
|
List all users, sorted by role
|
|
3186
3308
|
|
|
3187
|
-
$ sanity users list --sort role
|
|
3309
|
+
$ pnpm exec sanity users list --sort role
|
|
3188
3310
|
```
|
|
3189
3311
|
|
|
3190
|
-
_See code: [src/commands/users/list.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
3312
|
+
_See code: [src/commands/users/list.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/users/list.ts)_
|
|
3191
3313
|
|
|
3192
3314
|
## `sanity versions`
|
|
3193
3315
|
|
|
@@ -3195,15 +3317,15 @@ Shows installed versions of Sanity Studio and components
|
|
|
3195
3317
|
|
|
3196
3318
|
```
|
|
3197
3319
|
USAGE
|
|
3198
|
-
$ sanity versions
|
|
3320
|
+
$ pnpm exec sanity versions
|
|
3199
3321
|
|
|
3200
3322
|
DESCRIPTION
|
|
3201
3323
|
Shows installed versions of Sanity Studio and components
|
|
3202
3324
|
|
|
3203
3325
|
EXAMPLES
|
|
3204
|
-
$ sanity versions
|
|
3326
|
+
$ pnpm exec sanity versions
|
|
3205
3327
|
```
|
|
3206
3328
|
|
|
3207
|
-
_See code: [src/commands/versions.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
3329
|
+
_See code: [src/commands/versions.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.17/src/commands/versions.ts)_
|
|
3208
3330
|
|
|
3209
3331
|
<!-- commandsstop -->
|