@sanity/cli 6.0.0-alpha.18 → 6.0.0-alpha.20
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 +446 -446
- package/dist/actions/build/getViteConfig.js +47 -4
- package/dist/actions/build/getViteConfig.js.map +1 -1
- package/dist/actions/build/renderDocumentWorker/components/GlobalErrorHandler.js +1 -0
- package/dist/actions/build/renderDocumentWorker/components/GlobalErrorHandler.js.map +1 -1
- package/dist/actions/build/writeSanityRuntime.js +4 -3
- package/dist/actions/build/writeSanityRuntime.js.map +1 -1
- package/dist/actions/dev/getDashboardAppUrl.js +48 -0
- package/dist/actions/dev/getDashboardAppUrl.js.map +1 -0
- package/dist/actions/dev/getDevServerConfig.js +2 -1
- package/dist/actions/dev/getDevServerConfig.js.map +1 -1
- package/dist/actions/dev/startAppDevServer.js +3 -3
- package/dist/actions/dev/startAppDevServer.js.map +1 -1
- package/dist/actions/dev/startStudioDevServer.js +5 -10
- package/dist/actions/dev/startStudioDevServer.js.map +1 -1
- package/dist/actions/schema/extractSchemaWatcher.js +8 -6
- package/dist/actions/schema/extractSchemaWatcher.js.map +1 -1
- package/dist/actions/schema/matchSchemaPattern.js +22 -0
- package/dist/actions/schema/matchSchemaPattern.js.map +1 -0
- package/dist/actions/schema/runSchemaExtraction.js.map +1 -1
- package/dist/commands/backup/disable.js +0 -6
- package/dist/commands/backup/disable.js.map +1 -1
- package/dist/commands/backup/download.js +0 -6
- package/dist/commands/backup/download.js.map +1 -1
- package/dist/commands/backup/enable.js +0 -6
- package/dist/commands/backup/enable.js.map +1 -1
- package/dist/commands/backup/list.js +0 -6
- package/dist/commands/backup/list.js.map +1 -1
- package/dist/commands/cors/add.js +0 -6
- package/dist/commands/cors/add.js.map +1 -1
- package/dist/commands/cors/delete.js +0 -6
- package/dist/commands/cors/delete.js.map +1 -1
- package/dist/commands/cors/list.js +0 -6
- package/dist/commands/cors/list.js.map +1 -1
- package/dist/commands/dataset/alias/create.js +23 -7
- package/dist/commands/dataset/alias/create.js.map +1 -1
- package/dist/commands/dataset/alias/delete.js +17 -7
- package/dist/commands/dataset/alias/delete.js.map +1 -1
- package/dist/commands/dataset/alias/link.js +17 -7
- package/dist/commands/dataset/alias/link.js.map +1 -1
- package/dist/commands/dataset/alias/unlink.js +17 -7
- package/dist/commands/dataset/alias/unlink.js.map +1 -1
- package/dist/commands/dataset/copy.js +39 -29
- package/dist/commands/dataset/copy.js.map +1 -1
- package/dist/commands/dataset/create.js +17 -7
- package/dist/commands/dataset/create.js.map +1 -1
- package/dist/commands/dataset/delete.js +13 -7
- package/dist/commands/dataset/delete.js.map +1 -1
- package/dist/commands/dataset/embeddings/disable.js +19 -7
- package/dist/commands/dataset/embeddings/disable.js.map +1 -1
- package/dist/commands/dataset/embeddings/enable.js +17 -7
- package/dist/commands/dataset/embeddings/enable.js.map +1 -1
- package/dist/commands/dataset/embeddings/status.js +15 -7
- package/dist/commands/dataset/embeddings/status.js.map +1 -1
- package/dist/commands/dataset/export.js +30 -18
- package/dist/commands/dataset/export.js.map +1 -1
- package/dist/commands/dataset/list.js +19 -7
- package/dist/commands/dataset/list.js.map +1 -1
- package/dist/commands/dataset/visibility/get.js +15 -7
- package/dist/commands/dataset/visibility/get.js.map +1 -1
- package/dist/commands/dataset/visibility/set.js +19 -7
- package/dist/commands/dataset/visibility/set.js.map +1 -1
- package/dist/commands/documents/create.js +0 -6
- package/dist/commands/documents/create.js.map +1 -1
- package/dist/commands/documents/delete.js +0 -6
- package/dist/commands/documents/delete.js.map +1 -1
- package/dist/commands/documents/get.js +0 -6
- package/dist/commands/documents/get.js.map +1 -1
- package/dist/commands/documents/query.js +0 -6
- package/dist/commands/documents/query.js.map +1 -1
- package/dist/commands/graphql/list.js +0 -6
- package/dist/commands/graphql/list.js.map +1 -1
- package/dist/commands/graphql/undeploy.js +0 -6
- package/dist/commands/graphql/undeploy.js.map +1 -1
- package/dist/commands/hook/attempt.js +0 -6
- package/dist/commands/hook/attempt.js.map +1 -1
- package/dist/commands/hook/create.js +0 -6
- package/dist/commands/hook/create.js.map +1 -1
- package/dist/commands/hook/delete.js +0 -6
- package/dist/commands/hook/delete.js.map +1 -1
- package/dist/commands/hook/list.js +0 -6
- package/dist/commands/hook/list.js.map +1 -1
- package/dist/commands/hook/logs.js +0 -6
- package/dist/commands/hook/logs.js.map +1 -1
- package/dist/commands/media/delete-aspect.js +0 -6
- package/dist/commands/media/delete-aspect.js.map +1 -1
- package/dist/commands/media/deploy-aspect.js +1 -6
- package/dist/commands/media/deploy-aspect.js.map +1 -1
- package/dist/commands/media/export.js +0 -6
- package/dist/commands/media/export.js.map +1 -1
- package/dist/commands/media/import.js +0 -6
- package/dist/commands/media/import.js.map +1 -1
- package/dist/commands/schema/delete.js +0 -6
- package/dist/commands/schema/delete.js.map +1 -1
- package/dist/commands/tokens/add.js +0 -6
- package/dist/commands/tokens/add.js.map +1 -1
- package/dist/commands/tokens/delete.js +0 -6
- package/dist/commands/tokens/delete.js.map +1 -1
- package/dist/commands/tokens/list.js +0 -6
- package/dist/commands/tokens/list.js.map +1 -1
- package/dist/commands/users/invite.js +0 -6
- package/dist/commands/users/invite.js.map +1 -1
- package/dist/commands/users/list.js +0 -6
- package/dist/commands/users/list.js.map +1 -1
- package/dist/hooks/prerun/injectEnvVariables.js +9 -1
- package/dist/hooks/prerun/injectEnvVariables.js.map +1 -1
- package/dist/prompts/promptForProject.js +64 -0
- package/dist/prompts/promptForProject.js.map +1 -0
- package/dist/server/devServer.js +4 -2
- package/dist/server/devServer.js.map +1 -1
- package/dist/server/vite/plugin-schema-extraction.js +201 -0
- package/dist/server/vite/plugin-schema-extraction.js.map +1 -0
- package/dist/server/vite/plugin-typegen.js +217 -0
- package/dist/server/vite/plugin-typegen.js.map +1 -0
- package/dist/services/grants.js +13 -0
- package/dist/services/grants.js.map +1 -0
- package/dist/types/grants.js +3 -0
- package/dist/types/grants.js.map +1 -0
- package/dist/util/checkProjectPermissions.js +21 -0
- package/dist/util/checkProjectPermissions.js.map +1 -0
- package/dist/util/getSharedServerConfig.js +1 -0
- package/dist/util/getSharedServerConfig.js.map +1 -1
- package/dist/util/sharedFlags.js +19 -0
- package/dist/util/sharedFlags.js.map +1 -0
- package/dist/util/toForwardSlashes.js +8 -0
- package/dist/util/toForwardSlashes.js.map +1 -0
- package/oclif.manifest.json +362 -236
- package/package.json +18 -16
- package/dist/actions/dev/getCoreAppUrl.js +0 -10
- package/dist/actions/dev/getCoreAppUrl.js.map +0 -1
package/README.md
CHANGED
|
@@ -119,7 +119,7 @@ Disable backup for a dataset.
|
|
|
119
119
|
|
|
120
120
|
```
|
|
121
121
|
USAGE
|
|
122
|
-
$
|
|
122
|
+
$ sanity backup disable [DATASET]
|
|
123
123
|
|
|
124
124
|
ARGUMENTS
|
|
125
125
|
[DATASET] Dataset name to disable backup for
|
|
@@ -130,14 +130,14 @@ DESCRIPTION
|
|
|
130
130
|
EXAMPLES
|
|
131
131
|
Interactively disable backup for a dataset
|
|
132
132
|
|
|
133
|
-
$
|
|
133
|
+
$ sanity backup disable
|
|
134
134
|
|
|
135
135
|
Disable backup for the production dataset
|
|
136
136
|
|
|
137
|
-
$
|
|
137
|
+
$ sanity backup disable production
|
|
138
138
|
```
|
|
139
139
|
|
|
140
|
-
_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.19/src/commands/backup/disable.ts)_
|
|
141
141
|
|
|
142
142
|
## `sanity backup download [DATASET]`
|
|
143
143
|
|
|
@@ -145,7 +145,7 @@ Download a dataset backup to a local file.
|
|
|
145
145
|
|
|
146
146
|
```
|
|
147
147
|
USAGE
|
|
148
|
-
$
|
|
148
|
+
$ sanity backup download [DATASET] [--backup-id <value>] [--concurrency <value>] [--out <value>] [--overwrite]
|
|
149
149
|
|
|
150
150
|
ARGUMENTS
|
|
151
151
|
[DATASET] Dataset name to download backup from
|
|
@@ -162,22 +162,22 @@ DESCRIPTION
|
|
|
162
162
|
EXAMPLES
|
|
163
163
|
Interactively download a backup
|
|
164
164
|
|
|
165
|
-
$
|
|
165
|
+
$ sanity backup download
|
|
166
166
|
|
|
167
167
|
Download a specific backup for the production dataset
|
|
168
168
|
|
|
169
|
-
$
|
|
169
|
+
$ sanity backup download production --backup-id 2024-01-01-backup-1
|
|
170
170
|
|
|
171
171
|
Download backup to a specific file
|
|
172
172
|
|
|
173
|
-
$
|
|
173
|
+
$ sanity backup download production --backup-id 2024-01-01-backup-2 --out /path/to/file
|
|
174
174
|
|
|
175
175
|
Download backup and overwrite existing file
|
|
176
176
|
|
|
177
|
-
$
|
|
177
|
+
$ sanity backup download production --backup-id 2024-01-01-backup-3 --out /path/to/file --overwrite
|
|
178
178
|
```
|
|
179
179
|
|
|
180
|
-
_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.19/src/commands/backup/download.ts)_
|
|
181
181
|
|
|
182
182
|
## `sanity backup enable [DATASET]`
|
|
183
183
|
|
|
@@ -185,7 +185,7 @@ Enable backup for a dataset.
|
|
|
185
185
|
|
|
186
186
|
```
|
|
187
187
|
USAGE
|
|
188
|
-
$
|
|
188
|
+
$ sanity backup enable [DATASET]
|
|
189
189
|
|
|
190
190
|
ARGUMENTS
|
|
191
191
|
[DATASET] Dataset name to enable backup for
|
|
@@ -196,14 +196,14 @@ DESCRIPTION
|
|
|
196
196
|
EXAMPLES
|
|
197
197
|
Interactively enable backup for a dataset
|
|
198
198
|
|
|
199
|
-
$
|
|
199
|
+
$ sanity backup enable
|
|
200
200
|
|
|
201
201
|
Enable backup for the production dataset
|
|
202
202
|
|
|
203
|
-
$
|
|
203
|
+
$ sanity backup enable production
|
|
204
204
|
```
|
|
205
205
|
|
|
206
|
-
_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.19/src/commands/backup/enable.ts)_
|
|
207
207
|
|
|
208
208
|
## `sanity backup list [DATASET]`
|
|
209
209
|
|
|
@@ -211,7 +211,7 @@ List available backups for a dataset.
|
|
|
211
211
|
|
|
212
212
|
```
|
|
213
213
|
USAGE
|
|
214
|
-
$
|
|
214
|
+
$ sanity backup list [DATASET] [--after <value>] [--before <value>] [-l <value>]
|
|
215
215
|
|
|
216
216
|
ARGUMENTS
|
|
217
217
|
[DATASET] Dataset name to list backups for
|
|
@@ -227,22 +227,22 @@ DESCRIPTION
|
|
|
227
227
|
EXAMPLES
|
|
228
228
|
List backups for a dataset interactively
|
|
229
229
|
|
|
230
|
-
$
|
|
230
|
+
$ sanity backup list
|
|
231
231
|
|
|
232
232
|
List backups for the production dataset
|
|
233
233
|
|
|
234
|
-
$
|
|
234
|
+
$ sanity backup list production
|
|
235
235
|
|
|
236
236
|
List up to 50 backups for the production dataset
|
|
237
237
|
|
|
238
|
-
$
|
|
238
|
+
$ sanity backup list production --limit 50
|
|
239
239
|
|
|
240
240
|
List up to 10 backups created after 2024-01-31
|
|
241
241
|
|
|
242
|
-
$
|
|
242
|
+
$ sanity backup list production --after 2024-01-31 --limit 10
|
|
243
243
|
```
|
|
244
244
|
|
|
245
|
-
_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.19/src/commands/backup/list.ts)_
|
|
246
246
|
|
|
247
247
|
## `sanity blueprints add TYPE`
|
|
248
248
|
|
|
@@ -250,7 +250,7 @@ Add a function resource to a Blueprint
|
|
|
250
250
|
|
|
251
251
|
```
|
|
252
252
|
USAGE
|
|
253
|
-
$
|
|
253
|
+
$ sanity blueprints add TYPE [--example <value> | -n <value> | --fn-type
|
|
254
254
|
document-create|document-delete|document-update|document-publish|media-library-asset-create|media-library-asset-upda
|
|
255
255
|
te|media-library-asset-delete... | --language ts|js | --javascript | --fn-helpers | --fn-installer
|
|
256
256
|
skip|npm|pnpm|yarn] [-i | ]
|
|
@@ -283,18 +283,18 @@ DESCRIPTION
|
|
|
283
283
|
After adding a function, use 'functions dev' to test locally, then 'blueprints deploy' to publish it.
|
|
284
284
|
|
|
285
285
|
EXAMPLES
|
|
286
|
-
$
|
|
286
|
+
$ sanity blueprints add function
|
|
287
287
|
|
|
288
|
-
$
|
|
288
|
+
$ sanity blueprints add function --helpers
|
|
289
289
|
|
|
290
|
-
$
|
|
290
|
+
$ sanity blueprints add function --name my-function
|
|
291
291
|
|
|
292
|
-
$
|
|
292
|
+
$ sanity blueprints add function --name my-function --fn-type document-create
|
|
293
293
|
|
|
294
|
-
$
|
|
294
|
+
$ sanity blueprints add function --name my-function --fn-type document-create --fn-type document-update --lang js
|
|
295
295
|
```
|
|
296
296
|
|
|
297
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.
|
|
297
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.2.0/src/commands/blueprints/add.ts)_
|
|
298
298
|
|
|
299
299
|
## `sanity blueprints config`
|
|
300
300
|
|
|
@@ -302,7 +302,7 @@ View or edit the local Blueprint configuration
|
|
|
302
302
|
|
|
303
303
|
```
|
|
304
304
|
USAGE
|
|
305
|
-
$
|
|
305
|
+
$ sanity blueprints config [--project-id <value> -e] [--stack <value> ]
|
|
306
306
|
|
|
307
307
|
FLAGS
|
|
308
308
|
-e, --edit Modify the configuration interactively, or directly when combined with ID flags.
|
|
@@ -320,16 +320,16 @@ DESCRIPTION
|
|
|
320
320
|
If you need to switch your Blueprint to a different Stack, use --edit --stack.
|
|
321
321
|
|
|
322
322
|
EXAMPLES
|
|
323
|
-
$
|
|
323
|
+
$ sanity blueprints config
|
|
324
324
|
|
|
325
|
-
$
|
|
325
|
+
$ sanity blueprints config --edit
|
|
326
326
|
|
|
327
|
-
$
|
|
327
|
+
$ sanity blueprints config --edit --project-id <projectId>
|
|
328
328
|
|
|
329
|
-
$
|
|
329
|
+
$ sanity blueprints config --edit --project-id <projectId> --stack <name-or-id>
|
|
330
330
|
```
|
|
331
331
|
|
|
332
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.
|
|
332
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.2.0/src/commands/blueprints/config.ts)_
|
|
333
333
|
|
|
334
334
|
## `sanity blueprints deploy`
|
|
335
335
|
|
|
@@ -337,7 +337,7 @@ Deploy the local Blueprint to the remote Stack
|
|
|
337
337
|
|
|
338
338
|
```
|
|
339
339
|
USAGE
|
|
340
|
-
$
|
|
340
|
+
$ sanity blueprints deploy [--stack <value>] [--no-wait]
|
|
341
341
|
|
|
342
342
|
FLAGS
|
|
343
343
|
--no-wait Do not wait for Stack deployment to complete
|
|
@@ -357,12 +357,12 @@ DESCRIPTION
|
|
|
357
357
|
Set SANITY_ASSET_TIMEOUT (seconds) to override the 60-second timeout for processing resource assets.
|
|
358
358
|
|
|
359
359
|
EXAMPLES
|
|
360
|
-
$
|
|
360
|
+
$ sanity blueprints deploy
|
|
361
361
|
|
|
362
|
-
$
|
|
362
|
+
$ sanity blueprints deploy --no-wait
|
|
363
363
|
```
|
|
364
364
|
|
|
365
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.
|
|
365
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.2.0/src/commands/blueprints/deploy.ts)_
|
|
366
366
|
|
|
367
367
|
## `sanity blueprints destroy`
|
|
368
368
|
|
|
@@ -370,7 +370,7 @@ Destroy the remote Stack deployment and its resources (will not delete local fil
|
|
|
370
370
|
|
|
371
371
|
```
|
|
372
372
|
USAGE
|
|
373
|
-
$
|
|
373
|
+
$ sanity blueprints destroy [--project-id <value> --stack <value> --force] [--no-wait]
|
|
374
374
|
|
|
375
375
|
FLAGS
|
|
376
376
|
--force Force Stack destruction (skip confirmation)
|
|
@@ -389,12 +389,12 @@ DESCRIPTION
|
|
|
389
389
|
Use this to clean up test environments or decommission a Stack you no longer need.
|
|
390
390
|
|
|
391
391
|
EXAMPLES
|
|
392
|
-
$
|
|
392
|
+
$ sanity blueprints destroy
|
|
393
393
|
|
|
394
|
-
$
|
|
394
|
+
$ sanity blueprints destroy --stack <name-or-id> --project-id <projectId> --force --no-wait
|
|
395
395
|
```
|
|
396
396
|
|
|
397
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.
|
|
397
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.2.0/src/commands/blueprints/destroy.ts)_
|
|
398
398
|
|
|
399
399
|
## `sanity blueprints doctor`
|
|
400
400
|
|
|
@@ -402,7 +402,7 @@ Diagnose potential issues with local Blueprint and remote Stack configuration
|
|
|
402
402
|
|
|
403
403
|
```
|
|
404
404
|
USAGE
|
|
405
|
-
$
|
|
405
|
+
$ sanity blueprints doctor [--json] [-p <value>] [--verbose] [--fix]
|
|
406
406
|
|
|
407
407
|
FLAGS
|
|
408
408
|
-p, --path=<value> [env: SANITY_BLUEPRINT_PATH] Path to a Blueprint file or directory containing one
|
|
@@ -420,7 +420,7 @@ DESCRIPTION
|
|
|
420
420
|
issues.
|
|
421
421
|
```
|
|
422
422
|
|
|
423
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.
|
|
423
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.2.0/src/commands/blueprints/doctor.ts)_
|
|
424
424
|
|
|
425
425
|
## `sanity blueprints info`
|
|
426
426
|
|
|
@@ -428,7 +428,7 @@ Show information about the local Blueprint's remote Stack deployment
|
|
|
428
428
|
|
|
429
429
|
```
|
|
430
430
|
USAGE
|
|
431
|
-
$
|
|
431
|
+
$ sanity blueprints info [--stack <value>]
|
|
432
432
|
|
|
433
433
|
FLAGS
|
|
434
434
|
--stack=<value> Stack name or ID to use instead of the locally configured Stack
|
|
@@ -445,12 +445,12 @@ DESCRIPTION
|
|
|
445
445
|
Run 'blueprints stacks' to see all available Stacks in your project or organization.
|
|
446
446
|
|
|
447
447
|
EXAMPLES
|
|
448
|
-
$
|
|
448
|
+
$ sanity blueprints info
|
|
449
449
|
|
|
450
|
-
$
|
|
450
|
+
$ sanity blueprints info --stack <name-or-id>
|
|
451
451
|
```
|
|
452
452
|
|
|
453
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.
|
|
453
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.2.0/src/commands/blueprints/info.ts)_
|
|
454
454
|
|
|
455
455
|
## `sanity blueprints init [DIR]`
|
|
456
456
|
|
|
@@ -458,7 +458,7 @@ Initialize a local Blueprint and optionally provision a remote Stack deployment
|
|
|
458
458
|
|
|
459
459
|
```
|
|
460
460
|
USAGE
|
|
461
|
-
$
|
|
461
|
+
$ sanity blueprints init [DIR] [--verbose] [--dir <value>] [--example <value> | --blueprint-type json|js|ts |
|
|
462
462
|
--stack-id <value> | --stack-name <value>] [--project-id <value>]
|
|
463
463
|
|
|
464
464
|
ARGUMENTS
|
|
@@ -489,18 +489,18 @@ DESCRIPTION
|
|
|
489
489
|
After initialization, use 'blueprints plan' to preview changes, then 'blueprints deploy' to apply them.
|
|
490
490
|
|
|
491
491
|
EXAMPLES
|
|
492
|
-
$
|
|
492
|
+
$ sanity blueprints init
|
|
493
493
|
|
|
494
|
-
$
|
|
494
|
+
$ sanity blueprints init [directory]
|
|
495
495
|
|
|
496
|
-
$
|
|
496
|
+
$ sanity blueprints init --blueprint-type <json|js|ts>
|
|
497
497
|
|
|
498
|
-
$
|
|
498
|
+
$ sanity blueprints init --blueprint-type <json|js|ts> --project-id <projectId> --stack-id <stackId>
|
|
499
499
|
|
|
500
|
-
$
|
|
500
|
+
$ sanity blueprints init --blueprint-type <json|js|ts> --stack-name <stackName>
|
|
501
501
|
```
|
|
502
502
|
|
|
503
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.
|
|
503
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.2.0/src/commands/blueprints/init.ts)_
|
|
504
504
|
|
|
505
505
|
## `sanity blueprints logs`
|
|
506
506
|
|
|
@@ -508,7 +508,7 @@ Display logs for the current Blueprint's Stack deployment
|
|
|
508
508
|
|
|
509
509
|
```
|
|
510
510
|
USAGE
|
|
511
|
-
$
|
|
511
|
+
$ sanity blueprints logs [--stack <value>] [-w]
|
|
512
512
|
|
|
513
513
|
FLAGS
|
|
514
514
|
-w, --watch Watch for new Stack logs (streaming mode)
|
|
@@ -524,12 +524,12 @@ DESCRIPTION
|
|
|
524
524
|
If you're not seeing expected logs, verify your Stack is deployed with 'blueprints info'.
|
|
525
525
|
|
|
526
526
|
EXAMPLES
|
|
527
|
-
$
|
|
527
|
+
$ sanity blueprints logs
|
|
528
528
|
|
|
529
|
-
$
|
|
529
|
+
$ sanity blueprints logs --watch
|
|
530
530
|
```
|
|
531
531
|
|
|
532
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.
|
|
532
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.2.0/src/commands/blueprints/logs.ts)_
|
|
533
533
|
|
|
534
534
|
## `sanity blueprints plan`
|
|
535
535
|
|
|
@@ -537,7 +537,7 @@ Enumerate resources to be deployed to the remote Stack - will not modify any res
|
|
|
537
537
|
|
|
538
538
|
```
|
|
539
539
|
USAGE
|
|
540
|
-
$
|
|
540
|
+
$ sanity blueprints plan [--stack <value>]
|
|
541
541
|
|
|
542
542
|
FLAGS
|
|
543
543
|
--stack=<value> Stack name or ID to use instead of the locally configured Stack
|
|
@@ -552,10 +552,10 @@ DESCRIPTION
|
|
|
552
552
|
run 'blueprints deploy' to apply changes.
|
|
553
553
|
|
|
554
554
|
EXAMPLES
|
|
555
|
-
$
|
|
555
|
+
$ sanity blueprints plan
|
|
556
556
|
```
|
|
557
557
|
|
|
558
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.
|
|
558
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.2.0/src/commands/blueprints/plan.ts)_
|
|
559
559
|
|
|
560
560
|
## `sanity blueprints stacks`
|
|
561
561
|
|
|
@@ -563,7 +563,7 @@ List all remote Stack deployments (defaults to the current Blueprint's project s
|
|
|
563
563
|
|
|
564
564
|
```
|
|
565
565
|
USAGE
|
|
566
|
-
$
|
|
566
|
+
$ sanity blueprints stacks [--project-id <value> | ]
|
|
567
567
|
|
|
568
568
|
FLAGS
|
|
569
569
|
--project-id=<value> Project ID to show Stack deployments for
|
|
@@ -577,14 +577,14 @@ DESCRIPTION
|
|
|
577
577
|
audit what's deployed across your project.
|
|
578
578
|
|
|
579
579
|
EXAMPLES
|
|
580
|
-
$
|
|
580
|
+
$ sanity blueprints stacks
|
|
581
581
|
|
|
582
|
-
$
|
|
582
|
+
$ sanity blueprints stacks --project-id <projectId>
|
|
583
583
|
|
|
584
|
-
$
|
|
584
|
+
$ sanity blueprints stacks --organization-id <organizationId>
|
|
585
585
|
```
|
|
586
586
|
|
|
587
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.
|
|
587
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.2.0/src/commands/blueprints/stacks.ts)_
|
|
588
588
|
|
|
589
589
|
## `sanity build [OUTPUTDIR]`
|
|
590
590
|
|
|
@@ -592,7 +592,7 @@ Builds the Sanity Studio configuration into a static bundle
|
|
|
592
592
|
|
|
593
593
|
```
|
|
594
594
|
USAGE
|
|
595
|
-
$
|
|
595
|
+
$ sanity build [OUTPUTDIR] [--auto-updates] [--minify] [--source-maps] [--stats] [-y]
|
|
596
596
|
|
|
597
597
|
ARGUMENTS
|
|
598
598
|
[OUTPUTDIR] Output directory
|
|
@@ -608,12 +608,12 @@ DESCRIPTION
|
|
|
608
608
|
Builds the Sanity Studio configuration into a static bundle
|
|
609
609
|
|
|
610
610
|
EXAMPLES
|
|
611
|
-
$
|
|
611
|
+
$ sanity build
|
|
612
612
|
|
|
613
|
-
$
|
|
613
|
+
$ sanity build --no-minify --source-maps
|
|
614
614
|
```
|
|
615
615
|
|
|
616
|
-
_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.19/src/commands/build.ts)_
|
|
617
617
|
|
|
618
618
|
## `sanity codemod [CODEMODNAME]`
|
|
619
619
|
|
|
@@ -621,7 +621,7 @@ Updates Sanity Studio codebase with a code modification script
|
|
|
621
621
|
|
|
622
622
|
```
|
|
623
623
|
USAGE
|
|
624
|
-
$
|
|
624
|
+
$ sanity codemod [CODEMODNAME] [--dry] [--extensions <value>] [--no-verify]
|
|
625
625
|
|
|
626
626
|
ARGUMENTS
|
|
627
627
|
[CODEMODNAME] Name of the codemod to run
|
|
@@ -637,14 +637,14 @@ DESCRIPTION
|
|
|
637
637
|
EXAMPLES
|
|
638
638
|
Show available code mods
|
|
639
639
|
|
|
640
|
-
$
|
|
640
|
+
$ sanity codemod
|
|
641
641
|
|
|
642
642
|
Run codemod to transform react-icons imports (dry run)
|
|
643
643
|
|
|
644
|
-
$
|
|
644
|
+
$ sanity codemod reactIconsV3 --dry
|
|
645
645
|
```
|
|
646
646
|
|
|
647
|
-
_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.19/src/commands/codemod.ts)_
|
|
648
648
|
|
|
649
649
|
## `sanity cors add ORIGIN`
|
|
650
650
|
|
|
@@ -652,7 +652,7 @@ Allow a new origin to use your project API through CORS
|
|
|
652
652
|
|
|
653
653
|
```
|
|
654
654
|
USAGE
|
|
655
|
-
$
|
|
655
|
+
$ sanity cors add ORIGIN [--credentials]
|
|
656
656
|
|
|
657
657
|
ARGUMENTS
|
|
658
658
|
ORIGIN Origin to allow (e.g., https://example.com)
|
|
@@ -666,18 +666,18 @@ DESCRIPTION
|
|
|
666
666
|
EXAMPLES
|
|
667
667
|
Interactively add a CORS origin
|
|
668
668
|
|
|
669
|
-
$
|
|
669
|
+
$ sanity cors add
|
|
670
670
|
|
|
671
671
|
Add a localhost origin without credentials
|
|
672
672
|
|
|
673
|
-
$
|
|
673
|
+
$ sanity cors add http://localhost:3000 --no-credentials
|
|
674
674
|
|
|
675
675
|
Add a production origin with credentials allowed
|
|
676
676
|
|
|
677
|
-
$
|
|
677
|
+
$ sanity cors add https://myapp.com --credentials
|
|
678
678
|
```
|
|
679
679
|
|
|
680
|
-
_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.19/src/commands/cors/add.ts)_
|
|
681
681
|
|
|
682
682
|
## `sanity cors delete [ORIGIN]`
|
|
683
683
|
|
|
@@ -685,7 +685,7 @@ Delete an existing CORS origin from your project
|
|
|
685
685
|
|
|
686
686
|
```
|
|
687
687
|
USAGE
|
|
688
|
-
$
|
|
688
|
+
$ sanity cors delete [ORIGIN]
|
|
689
689
|
|
|
690
690
|
ARGUMENTS
|
|
691
691
|
[ORIGIN] Origin to delete (will prompt if not provided)
|
|
@@ -696,14 +696,14 @@ DESCRIPTION
|
|
|
696
696
|
EXAMPLES
|
|
697
697
|
Interactively select and delete a CORS origin
|
|
698
698
|
|
|
699
|
-
$
|
|
699
|
+
$ sanity cors delete
|
|
700
700
|
|
|
701
701
|
Delete a specific CORS origin
|
|
702
702
|
|
|
703
|
-
$
|
|
703
|
+
$ sanity cors delete https://example.com
|
|
704
704
|
```
|
|
705
705
|
|
|
706
|
-
_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.19/src/commands/cors/delete.ts)_
|
|
707
707
|
|
|
708
708
|
## `sanity cors list`
|
|
709
709
|
|
|
@@ -711,7 +711,7 @@ List all origins allowed to access the API for this project
|
|
|
711
711
|
|
|
712
712
|
```
|
|
713
713
|
USAGE
|
|
714
|
-
$
|
|
714
|
+
$ sanity cors list
|
|
715
715
|
|
|
716
716
|
DESCRIPTION
|
|
717
717
|
List all origins allowed to access the API for this project
|
|
@@ -719,10 +719,10 @@ DESCRIPTION
|
|
|
719
719
|
EXAMPLES
|
|
720
720
|
List CORS origins for the current project
|
|
721
721
|
|
|
722
|
-
$
|
|
722
|
+
$ sanity cors list
|
|
723
723
|
```
|
|
724
724
|
|
|
725
|
-
_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.19/src/commands/cors/list.ts)_
|
|
726
726
|
|
|
727
727
|
## `sanity dataset alias create [ALIASNAME] [TARGETDATASET]`
|
|
728
728
|
|
|
@@ -730,7 +730,7 @@ Create a dataset alias within your project
|
|
|
730
730
|
|
|
731
731
|
```
|
|
732
732
|
USAGE
|
|
733
|
-
$
|
|
733
|
+
$ sanity dataset alias create [ALIASNAME] [TARGETDATASET] [-p <value>]
|
|
734
734
|
|
|
735
735
|
ARGUMENTS
|
|
736
736
|
[ALIASNAME] Dataset alias name to create
|
|
@@ -745,26 +745,26 @@ DESCRIPTION
|
|
|
745
745
|
EXAMPLES
|
|
746
746
|
Create alias in a specific project
|
|
747
747
|
|
|
748
|
-
$
|
|
748
|
+
$ sanity dataset alias create --project-id abc123 conference conf-2025
|
|
749
749
|
|
|
750
750
|
Create an alias with interactive prompts
|
|
751
751
|
|
|
752
|
-
$
|
|
752
|
+
$ sanity dataset alias create
|
|
753
753
|
|
|
754
754
|
Create alias named "conference" with interactive dataset selection
|
|
755
755
|
|
|
756
|
-
$
|
|
756
|
+
$ sanity dataset alias create conference
|
|
757
757
|
|
|
758
758
|
Create alias "conference" linked to "conf-2025" dataset
|
|
759
759
|
|
|
760
|
-
$
|
|
760
|
+
$ sanity dataset alias create conference conf-2025
|
|
761
761
|
|
|
762
762
|
Create alias with explicit ~ prefix
|
|
763
763
|
|
|
764
|
-
$
|
|
764
|
+
$ sanity dataset alias create ~conference conf-2025
|
|
765
765
|
```
|
|
766
766
|
|
|
767
|
-
_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.19/src/commands/dataset/alias/create.ts)_
|
|
768
768
|
|
|
769
769
|
## `sanity dataset alias delete ALIASNAME`
|
|
770
770
|
|
|
@@ -772,7 +772,7 @@ Delete a dataset alias within your project
|
|
|
772
772
|
|
|
773
773
|
```
|
|
774
774
|
USAGE
|
|
775
|
-
$
|
|
775
|
+
$ sanity dataset alias delete ALIASNAME [-p <value>] [--force]
|
|
776
776
|
|
|
777
777
|
ARGUMENTS
|
|
778
778
|
ALIASNAME Dataset alias name to delete
|
|
@@ -787,18 +787,18 @@ DESCRIPTION
|
|
|
787
787
|
EXAMPLES
|
|
788
788
|
Delete alias named "conference" with confirmation prompt
|
|
789
789
|
|
|
790
|
-
$
|
|
790
|
+
$ sanity dataset alias delete conference
|
|
791
791
|
|
|
792
792
|
Delete alias with explicit ~ prefix
|
|
793
793
|
|
|
794
|
-
$
|
|
794
|
+
$ sanity dataset alias delete ~conference
|
|
795
795
|
|
|
796
796
|
Delete alias named "conference" without confirmation prompt
|
|
797
797
|
|
|
798
|
-
$
|
|
798
|
+
$ sanity dataset alias delete conference --force
|
|
799
799
|
```
|
|
800
800
|
|
|
801
|
-
_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.19/src/commands/dataset/alias/delete.ts)_
|
|
802
802
|
|
|
803
803
|
## `sanity dataset alias link [ALIASNAME] [TARGETDATASET]`
|
|
804
804
|
|
|
@@ -806,7 +806,7 @@ Link a dataset alias to a dataset within your project
|
|
|
806
806
|
|
|
807
807
|
```
|
|
808
808
|
USAGE
|
|
809
|
-
$
|
|
809
|
+
$ sanity dataset alias link [ALIASNAME] [TARGETDATASET] [-p <value>] [--force]
|
|
810
810
|
|
|
811
811
|
ARGUMENTS
|
|
812
812
|
[ALIASNAME] Dataset alias name to link
|
|
@@ -822,26 +822,26 @@ DESCRIPTION
|
|
|
822
822
|
EXAMPLES
|
|
823
823
|
Link an alias with interactive prompts
|
|
824
824
|
|
|
825
|
-
$
|
|
825
|
+
$ sanity dataset alias link
|
|
826
826
|
|
|
827
827
|
Link alias named "conference" with interactive dataset selection
|
|
828
828
|
|
|
829
|
-
$
|
|
829
|
+
$ sanity dataset alias link conference
|
|
830
830
|
|
|
831
831
|
Link alias "conference" to "conf-2025" dataset
|
|
832
832
|
|
|
833
|
-
$
|
|
833
|
+
$ sanity dataset alias link conference conf-2025
|
|
834
834
|
|
|
835
835
|
Link alias with explicit ~ prefix
|
|
836
836
|
|
|
837
|
-
$
|
|
837
|
+
$ sanity dataset alias link ~conference conf-2025
|
|
838
838
|
|
|
839
839
|
Force link without confirmation (skip relink prompt)
|
|
840
840
|
|
|
841
|
-
$
|
|
841
|
+
$ sanity dataset alias link conference conf-2025 --force
|
|
842
842
|
```
|
|
843
843
|
|
|
844
|
-
_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.19/src/commands/dataset/alias/link.ts)_
|
|
845
845
|
|
|
846
846
|
## `sanity dataset alias unlink [ALIASNAME]`
|
|
847
847
|
|
|
@@ -849,7 +849,7 @@ Unlink a dataset alias from its dataset within your project
|
|
|
849
849
|
|
|
850
850
|
```
|
|
851
851
|
USAGE
|
|
852
|
-
$
|
|
852
|
+
$ sanity dataset alias unlink [ALIASNAME] [-p <value>] [--force]
|
|
853
853
|
|
|
854
854
|
ARGUMENTS
|
|
855
855
|
[ALIASNAME] Dataset alias name to unlink
|
|
@@ -864,22 +864,22 @@ DESCRIPTION
|
|
|
864
864
|
EXAMPLES
|
|
865
865
|
Unlink an alias with interactive selection
|
|
866
866
|
|
|
867
|
-
$
|
|
867
|
+
$ sanity dataset alias unlink
|
|
868
868
|
|
|
869
869
|
Unlink alias "conference" with confirmation prompt
|
|
870
870
|
|
|
871
|
-
$
|
|
871
|
+
$ sanity dataset alias unlink conference
|
|
872
872
|
|
|
873
873
|
Unlink alias with explicit ~ prefix
|
|
874
874
|
|
|
875
|
-
$
|
|
875
|
+
$ sanity dataset alias unlink ~conference
|
|
876
876
|
|
|
877
877
|
Unlink alias "conference" without confirmation prompt
|
|
878
878
|
|
|
879
|
-
$
|
|
879
|
+
$ sanity dataset alias unlink conference --force
|
|
880
880
|
```
|
|
881
881
|
|
|
882
|
-
_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.19/src/commands/dataset/alias/unlink.ts)_
|
|
883
883
|
|
|
884
884
|
## `sanity dataset copy [SOURCE] [TARGET]`
|
|
885
885
|
|
|
@@ -887,7 +887,7 @@ Manages dataset copying, including starting a new copy job, listing copy jobs an
|
|
|
887
887
|
|
|
888
888
|
```
|
|
889
889
|
USAGE
|
|
890
|
-
$
|
|
890
|
+
$ sanity dataset copy [SOURCE] [TARGET] [-p <value>] [--attach <value> | --list | --detach | --skip-history]
|
|
891
891
|
[--limit <value> ] [--offset <value> ]
|
|
892
892
|
|
|
893
893
|
ARGUMENTS
|
|
@@ -910,38 +910,38 @@ DESCRIPTION
|
|
|
910
910
|
EXAMPLES
|
|
911
911
|
Interactively copy a dataset
|
|
912
912
|
|
|
913
|
-
$
|
|
913
|
+
$ sanity dataset copy
|
|
914
914
|
|
|
915
915
|
Copy from source-dataset (prompts for target)
|
|
916
916
|
|
|
917
|
-
$
|
|
917
|
+
$ sanity dataset copy source-dataset
|
|
918
918
|
|
|
919
919
|
Copy from source-dataset to target-dataset
|
|
920
920
|
|
|
921
|
-
$
|
|
921
|
+
$ sanity dataset copy source-dataset target-dataset
|
|
922
922
|
|
|
923
923
|
Copy without preserving document history (faster for large datasets)
|
|
924
924
|
|
|
925
|
-
$
|
|
925
|
+
$ sanity dataset copy --skip-history source target
|
|
926
926
|
|
|
927
927
|
Start copy job without waiting for completion
|
|
928
928
|
|
|
929
|
-
$
|
|
929
|
+
$ sanity dataset copy --detach source target
|
|
930
930
|
|
|
931
931
|
Attach to a running copy job to follow progress
|
|
932
932
|
|
|
933
|
-
$
|
|
933
|
+
$ sanity dataset copy --attach <job-id>
|
|
934
934
|
|
|
935
935
|
List all dataset copy jobs
|
|
936
936
|
|
|
937
|
-
$
|
|
937
|
+
$ sanity dataset copy --list
|
|
938
938
|
|
|
939
939
|
List copy jobs with pagination
|
|
940
940
|
|
|
941
|
-
$
|
|
941
|
+
$ sanity dataset copy --list --offset 2 --limit 10
|
|
942
942
|
```
|
|
943
943
|
|
|
944
|
-
_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.19/src/commands/dataset/copy.ts)_
|
|
945
945
|
|
|
946
946
|
## `sanity dataset create [NAME]`
|
|
947
947
|
|
|
@@ -949,7 +949,7 @@ Create a new dataset within your project
|
|
|
949
949
|
|
|
950
950
|
```
|
|
951
951
|
USAGE
|
|
952
|
-
$
|
|
952
|
+
$ sanity dataset create [NAME] [-p <value>] [--embeddings-projection <value> --embeddings] [--visibility
|
|
953
953
|
custom|private|public]
|
|
954
954
|
|
|
955
955
|
ARGUMENTS
|
|
@@ -968,18 +968,18 @@ DESCRIPTION
|
|
|
968
968
|
EXAMPLES
|
|
969
969
|
Interactively create a dataset
|
|
970
970
|
|
|
971
|
-
$
|
|
971
|
+
$ sanity dataset create
|
|
972
972
|
|
|
973
973
|
Create a dataset named "my-dataset"
|
|
974
974
|
|
|
975
|
-
$
|
|
975
|
+
$ sanity dataset create my-dataset
|
|
976
976
|
|
|
977
977
|
Create a private dataset named "my-dataset"
|
|
978
978
|
|
|
979
|
-
$
|
|
979
|
+
$ sanity dataset create my-dataset --visibility private
|
|
980
980
|
```
|
|
981
981
|
|
|
982
|
-
_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.19/src/commands/dataset/create.ts)_
|
|
983
983
|
|
|
984
984
|
## `sanity dataset delete DATASETNAME`
|
|
985
985
|
|
|
@@ -987,7 +987,7 @@ Delete a dataset within your project
|
|
|
987
987
|
|
|
988
988
|
```
|
|
989
989
|
USAGE
|
|
990
|
-
$
|
|
990
|
+
$ sanity dataset delete DATASETNAME [-p <value>] [--force]
|
|
991
991
|
|
|
992
992
|
ARGUMENTS
|
|
993
993
|
DATASETNAME Dataset name to delete
|
|
@@ -1002,14 +1002,14 @@ DESCRIPTION
|
|
|
1002
1002
|
EXAMPLES
|
|
1003
1003
|
Delete a specific dataset
|
|
1004
1004
|
|
|
1005
|
-
$
|
|
1005
|
+
$ sanity dataset delete my-dataset
|
|
1006
1006
|
|
|
1007
1007
|
Delete a specific dataset without confirmation
|
|
1008
1008
|
|
|
1009
|
-
$
|
|
1009
|
+
$ sanity dataset delete my-dataset --force
|
|
1010
1010
|
```
|
|
1011
1011
|
|
|
1012
|
-
_See code: [src/commands/dataset/delete.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
1012
|
+
_See code: [src/commands/dataset/delete.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.19/src/commands/dataset/delete.ts)_
|
|
1013
1013
|
|
|
1014
1014
|
## `sanity dataset embeddings disable [DATASET]`
|
|
1015
1015
|
|
|
@@ -1017,7 +1017,7 @@ Disable embeddings for a dataset
|
|
|
1017
1017
|
|
|
1018
1018
|
```
|
|
1019
1019
|
USAGE
|
|
1020
|
-
$
|
|
1020
|
+
$ sanity dataset embeddings disable [DATASET] [-p <value>]
|
|
1021
1021
|
|
|
1022
1022
|
ARGUMENTS
|
|
1023
1023
|
[DATASET] Dataset name to disable embeddings for
|
|
@@ -1031,10 +1031,10 @@ DESCRIPTION
|
|
|
1031
1031
|
EXAMPLES
|
|
1032
1032
|
Disable embeddings for the production dataset
|
|
1033
1033
|
|
|
1034
|
-
$
|
|
1034
|
+
$ sanity dataset embeddings disable production
|
|
1035
1035
|
```
|
|
1036
1036
|
|
|
1037
|
-
_See code: [src/commands/dataset/embeddings/disable.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
1037
|
+
_See code: [src/commands/dataset/embeddings/disable.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.19/src/commands/dataset/embeddings/disable.ts)_
|
|
1038
1038
|
|
|
1039
1039
|
## `sanity dataset embeddings enable [DATASET]`
|
|
1040
1040
|
|
|
@@ -1042,7 +1042,7 @@ Enable embeddings for a dataset
|
|
|
1042
1042
|
|
|
1043
1043
|
```
|
|
1044
1044
|
USAGE
|
|
1045
|
-
$
|
|
1045
|
+
$ sanity dataset embeddings enable [DATASET] [-p <value>] [--projection <value>] [--wait]
|
|
1046
1046
|
|
|
1047
1047
|
ARGUMENTS
|
|
1048
1048
|
[DATASET] Dataset name to enable embeddings for
|
|
@@ -1058,18 +1058,18 @@ DESCRIPTION
|
|
|
1058
1058
|
EXAMPLES
|
|
1059
1059
|
Enable embeddings for the production dataset
|
|
1060
1060
|
|
|
1061
|
-
$
|
|
1061
|
+
$ sanity dataset embeddings enable production
|
|
1062
1062
|
|
|
1063
1063
|
Enable embeddings with a specific projection
|
|
1064
1064
|
|
|
1065
|
-
$
|
|
1065
|
+
$ sanity dataset embeddings enable production --projection "{ title, body }"
|
|
1066
1066
|
|
|
1067
1067
|
Enable embeddings and wait for processing to complete
|
|
1068
1068
|
|
|
1069
|
-
$
|
|
1069
|
+
$ sanity dataset embeddings enable production --wait
|
|
1070
1070
|
```
|
|
1071
1071
|
|
|
1072
|
-
_See code: [src/commands/dataset/embeddings/enable.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
1072
|
+
_See code: [src/commands/dataset/embeddings/enable.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.19/src/commands/dataset/embeddings/enable.ts)_
|
|
1073
1073
|
|
|
1074
1074
|
## `sanity dataset embeddings status [DATASET]`
|
|
1075
1075
|
|
|
@@ -1077,7 +1077,7 @@ Show embeddings settings and status for a dataset
|
|
|
1077
1077
|
|
|
1078
1078
|
```
|
|
1079
1079
|
USAGE
|
|
1080
|
-
$
|
|
1080
|
+
$ sanity dataset embeddings status [DATASET] [-p <value>]
|
|
1081
1081
|
|
|
1082
1082
|
ARGUMENTS
|
|
1083
1083
|
[DATASET] The name of the dataset to check embeddings status for
|
|
@@ -1091,10 +1091,10 @@ DESCRIPTION
|
|
|
1091
1091
|
EXAMPLES
|
|
1092
1092
|
Show embeddings status for the production dataset
|
|
1093
1093
|
|
|
1094
|
-
$
|
|
1094
|
+
$ sanity dataset embeddings status production
|
|
1095
1095
|
```
|
|
1096
1096
|
|
|
1097
|
-
_See code: [src/commands/dataset/embeddings/status.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.
|
|
1097
|
+
_See code: [src/commands/dataset/embeddings/status.ts](https://github.com/sanity-io/cli/blob/v6.0.0-alpha.19/src/commands/dataset/embeddings/status.ts)_
|
|
1098
1098
|
|
|
1099
1099
|
## `sanity dataset export [NAME] [DESTINATION]`
|
|
1100
1100
|
|
|
@@ -1102,7 +1102,7 @@ Export dataset to local filesystem as a gzipped tarball. Assets failing with HTT
|
|
|
1102
1102
|
|
|
1103
1103
|
```
|
|
1104
1104
|
USAGE
|
|
1105
|
-
$
|
|
1105
|
+
$ sanity dataset export [NAME] [DESTINATION] [-p <value>] [--asset-concurrency <value>] [--mode stream|cursor]
|
|
1106
1106
|
[--no-assets] [--no-compress] [--no-drafts] [--overwrite] [--raw] [--types <value>]
|
|
1107
1107
|
|
|
1108
1108
|
ARGUMENTS
|
|
@@ -1130,22 +1130,22 @@ DESCRIPTION
|
|
|
1130
1130
|
EXAMPLES
|
|
1131
1131
|
Export dataset "moviedb" to localPath.tar.gz
|
|
1132
1132
|
|
|
1133
|
-
$
|
|
1133
|
+
$ sanity dataset export moviedb localPath.tar.gz
|
|
1134
1134
|
|
|
1135
1135
|
Export dataset without assets
|
|
1136
1136
|
|
|
1137
|
-
$
|
|
1137
|
+
$ sanity dataset export moviedb assetless.tar.gz --no-assets
|
|
1138
1138
|
|
|
1139
1139
|
Export raw documents without asset reference rewriting
|
|
1140
1140
|
|
|
1141
|
-
$
|
|
1141
|
+
$ sanity dataset export staging staging.tar.gz --raw
|
|
1142
1142
|
|
|
1143
1143
|
Export specific document types
|
|
1144
1144
|
|
|
1145
|
-
$
|
|
1145
|
+
$ sanity dataset export staging staging.tar.gz --types products,shops
|
|
1146
1146
|
```
|
|
1147
1147
|
|
|
1148
|
-
_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.19/src/commands/dataset/export.ts)_
|
|
1149
1149
|
|
|
1150
1150
|
## `sanity dataset import SOURCE`
|
|
1151
1151
|
|
|
@@ -1153,7 +1153,7 @@ Import documents to a Sanity dataset
|
|
|
1153
1153
|
|
|
1154
1154
|
```
|
|
1155
1155
|
USAGE
|
|
1156
|
-
$
|
|
1156
|
+
$ sanity dataset import SOURCE -p <value> -d <value> [-t <value>] [--replace | --missing] [--allow-failing-assets]
|
|
1157
1157
|
[--allow-assets-in-different-dataset] [--replace-assets] [--skip-cross-dataset-references]
|
|
1158
1158
|
[--allow-replacement-characters] [--allow-system-documents] [--asset-concurrency <value>]
|
|
1159
1159
|
|
|
@@ -1180,14 +1180,14 @@ DESCRIPTION
|
|
|
1180
1180
|
EXAMPLES
|
|
1181
1181
|
Import "./my-dataset.ndjson" into dataset "staging"
|
|
1182
1182
|
|
|
1183
|
-
$
|
|
1183
|
+
$ sanity dataset import -p myPrOj -d staging -t someSecretToken my-dataset.ndjson
|
|
1184
1184
|
|
|
1185
1185
|
Import into dataset "test" from stdin, read token from env var
|
|
1186
1186
|
|
|
1187
1187
|
cat my-dataset.ndjson | sanity dataset import -p myPrOj -d test -
|
|
1188
1188
|
```
|
|
1189
1189
|
|
|
1190
|
-
_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.19/src/commands/dataset/import.ts)_
|
|
1191
1191
|
|
|
1192
1192
|
## `sanity dataset list`
|
|
1193
1193
|
|
|
@@ -1195,7 +1195,7 @@ List datasets of your project
|
|
|
1195
1195
|
|
|
1196
1196
|
```
|
|
1197
1197
|
USAGE
|
|
1198
|
-
$
|
|
1198
|
+
$ sanity dataset list [-p <value>]
|
|
1199
1199
|
|
|
1200
1200
|
FLAGS
|
|
1201
1201
|
-p, --project-id=<value> Project ID to use. Overrides the project ID from the Sanity config.
|
|
@@ -1206,14 +1206,14 @@ DESCRIPTION
|
|
|
1206
1206
|
EXAMPLES
|
|
1207
1207
|
List datasets of your project
|
|
1208
1208
|
|
|
1209
|
-
$
|
|
1209
|
+
$ sanity dataset list
|
|
1210
1210
|
|
|
1211
1211
|
List datasets for a specific project
|
|
1212
1212
|
|
|
1213
|
-
$
|
|
1213
|
+
$ sanity dataset list --project-id abc123
|
|
1214
1214
|
```
|
|
1215
1215
|
|
|
1216
|
-
_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.19/src/commands/dataset/list.ts)_
|
|
1217
1217
|
|
|
1218
1218
|
## `sanity dataset visibility get DATASET`
|
|
1219
1219
|
|
|
@@ -1221,7 +1221,7 @@ Get the visibility of a dataset
|
|
|
1221
1221
|
|
|
1222
1222
|
```
|
|
1223
1223
|
USAGE
|
|
1224
|
-
$
|
|
1224
|
+
$ sanity dataset visibility get DATASET [-p <value>]
|
|
1225
1225
|
|
|
1226
1226
|
ARGUMENTS
|
|
1227
1227
|
DATASET The name of the dataset to get visibility for
|
|
@@ -1235,10 +1235,10 @@ DESCRIPTION
|
|
|
1235
1235
|
EXAMPLES
|
|
1236
1236
|
Check the visibility of a dataset
|
|
1237
1237
|
|
|
1238
|
-
$
|
|
1238
|
+
$ sanity dataset visibility get my-dataset
|
|
1239
1239
|
```
|
|
1240
1240
|
|
|
1241
|
-
_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.19/src/commands/dataset/visibility/get.ts)_
|
|
1242
1242
|
|
|
1243
1243
|
## `sanity dataset visibility set DATASET MODE`
|
|
1244
1244
|
|
|
@@ -1246,7 +1246,7 @@ Set the visibility of a dataset
|
|
|
1246
1246
|
|
|
1247
1247
|
```
|
|
1248
1248
|
USAGE
|
|
1249
|
-
$
|
|
1249
|
+
$ sanity dataset visibility set DATASET MODE [-p <value>]
|
|
1250
1250
|
|
|
1251
1251
|
ARGUMENTS
|
|
1252
1252
|
DATASET The name of the dataset to set visibility for
|
|
@@ -1261,14 +1261,14 @@ DESCRIPTION
|
|
|
1261
1261
|
EXAMPLES
|
|
1262
1262
|
Make a dataset private
|
|
1263
1263
|
|
|
1264
|
-
$
|
|
1264
|
+
$ sanity dataset visibility set my-dataset private
|
|
1265
1265
|
|
|
1266
1266
|
Make a dataset public
|
|
1267
1267
|
|
|
1268
|
-
$
|
|
1268
|
+
$ sanity dataset visibility set my-dataset public
|
|
1269
1269
|
```
|
|
1270
1270
|
|
|
1271
|
-
_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.19/src/commands/dataset/visibility/set.ts)_
|
|
1272
1272
|
|
|
1273
1273
|
## `sanity debug`
|
|
1274
1274
|
|
|
@@ -1276,7 +1276,7 @@ Provides diagnostic info for Sanity Studio troubleshooting
|
|
|
1276
1276
|
|
|
1277
1277
|
```
|
|
1278
1278
|
USAGE
|
|
1279
|
-
$
|
|
1279
|
+
$ sanity debug [--secrets]
|
|
1280
1280
|
|
|
1281
1281
|
FLAGS
|
|
1282
1282
|
--secrets Include API keys in output
|
|
@@ -1285,12 +1285,12 @@ DESCRIPTION
|
|
|
1285
1285
|
Provides diagnostic info for Sanity Studio troubleshooting
|
|
1286
1286
|
|
|
1287
1287
|
EXAMPLES
|
|
1288
|
-
$
|
|
1288
|
+
$ sanity debug
|
|
1289
1289
|
|
|
1290
|
-
$
|
|
1290
|
+
$ sanity debug --secrets
|
|
1291
1291
|
```
|
|
1292
1292
|
|
|
1293
|
-
_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.19/src/commands/debug.ts)_
|
|
1294
1294
|
|
|
1295
1295
|
## `sanity deploy [SOURCEDIR]`
|
|
1296
1296
|
|
|
@@ -1298,7 +1298,7 @@ Builds and deploys Sanity Studio or application to Sanity hosting
|
|
|
1298
1298
|
|
|
1299
1299
|
```
|
|
1300
1300
|
USAGE
|
|
1301
|
-
$
|
|
1301
|
+
$ sanity deploy [SOURCEDIR] [--auto-updates] [--build] [--minify] [--schema-required] [--source-maps]
|
|
1302
1302
|
[--verbose] [-y]
|
|
1303
1303
|
|
|
1304
1304
|
ARGUMENTS
|
|
@@ -1319,18 +1319,18 @@ DESCRIPTION
|
|
|
1319
1319
|
EXAMPLES
|
|
1320
1320
|
Build and deploy the studio to Sanity hosting
|
|
1321
1321
|
|
|
1322
|
-
$
|
|
1322
|
+
$ sanity deploy
|
|
1323
1323
|
|
|
1324
1324
|
Deploys non-minified build with source maps
|
|
1325
1325
|
|
|
1326
|
-
$
|
|
1326
|
+
$ sanity deploy --no-minify --source-maps
|
|
1327
1327
|
|
|
1328
1328
|
Fail fast on schema store fails - for when other services rely on the stored schema
|
|
1329
1329
|
|
|
1330
|
-
$
|
|
1330
|
+
$ sanity deploy --schema-required
|
|
1331
1331
|
```
|
|
1332
1332
|
|
|
1333
|
-
_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.19/src/commands/deploy.ts)_
|
|
1334
1334
|
|
|
1335
1335
|
## `sanity dev`
|
|
1336
1336
|
|
|
@@ -1338,7 +1338,7 @@ Starts a local development server for Sanity Studio with live reloading
|
|
|
1338
1338
|
|
|
1339
1339
|
```
|
|
1340
1340
|
USAGE
|
|
1341
|
-
$
|
|
1341
|
+
$ sanity dev [--auto-updates] [--host <value>] [--load-in-dashboard] [--port <value>]
|
|
1342
1342
|
|
|
1343
1343
|
FLAGS
|
|
1344
1344
|
--[no-]auto-updates Automatically update Sanity Studio dependencies.
|
|
@@ -1350,14 +1350,14 @@ DESCRIPTION
|
|
|
1350
1350
|
Starts a local development server for Sanity Studio with live reloading
|
|
1351
1351
|
|
|
1352
1352
|
EXAMPLES
|
|
1353
|
-
$
|
|
1353
|
+
$ sanity dev --host=0.0.0.0
|
|
1354
1354
|
|
|
1355
|
-
$
|
|
1355
|
+
$ sanity dev --port=1942
|
|
1356
1356
|
|
|
1357
|
-
$
|
|
1357
|
+
$ sanity dev --load-in-dashboard
|
|
1358
1358
|
```
|
|
1359
1359
|
|
|
1360
|
-
_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.19/src/commands/dev.ts)_
|
|
1361
1361
|
|
|
1362
1362
|
## `sanity docs browse`
|
|
1363
1363
|
|
|
@@ -1365,13 +1365,13 @@ Open Sanity docs in a web browser
|
|
|
1365
1365
|
|
|
1366
1366
|
```
|
|
1367
1367
|
USAGE
|
|
1368
|
-
$
|
|
1368
|
+
$ sanity docs browse
|
|
1369
1369
|
|
|
1370
1370
|
DESCRIPTION
|
|
1371
1371
|
Open Sanity docs in a web browser
|
|
1372
1372
|
```
|
|
1373
1373
|
|
|
1374
|
-
_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.19/src/commands/docs/browse.ts)_
|
|
1375
1375
|
|
|
1376
1376
|
## `sanity docs read PATH`
|
|
1377
1377
|
|
|
@@ -1379,7 +1379,7 @@ Read an article in terminal
|
|
|
1379
1379
|
|
|
1380
1380
|
```
|
|
1381
1381
|
USAGE
|
|
1382
|
-
$
|
|
1382
|
+
$ sanity docs read PATH [--web]
|
|
1383
1383
|
|
|
1384
1384
|
ARGUMENTS
|
|
1385
1385
|
PATH Path or URL to article, found in search results and docs content as links
|
|
@@ -1393,22 +1393,22 @@ DESCRIPTION
|
|
|
1393
1393
|
EXAMPLES
|
|
1394
1394
|
Read as markdown in terminal
|
|
1395
1395
|
|
|
1396
|
-
$
|
|
1396
|
+
$ sanity docs read /docs/studio/installation
|
|
1397
1397
|
|
|
1398
1398
|
Read using full URL
|
|
1399
1399
|
|
|
1400
|
-
$
|
|
1400
|
+
$ sanity docs read https://www.sanity.io/docs/studio/installation
|
|
1401
1401
|
|
|
1402
1402
|
Open in web browser
|
|
1403
1403
|
|
|
1404
|
-
$
|
|
1404
|
+
$ sanity docs read /docs/studio/installation --web
|
|
1405
1405
|
|
|
1406
1406
|
Open using full URL in web browser
|
|
1407
1407
|
|
|
1408
|
-
$
|
|
1408
|
+
$ sanity docs read https://www.sanity.io/docs/studio/installation -w
|
|
1409
1409
|
```
|
|
1410
1410
|
|
|
1411
|
-
_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.19/src/commands/docs/read.ts)_
|
|
1412
1412
|
|
|
1413
1413
|
## `sanity docs search QUERY`
|
|
1414
1414
|
|
|
@@ -1416,7 +1416,7 @@ Search Sanity docs
|
|
|
1416
1416
|
|
|
1417
1417
|
```
|
|
1418
1418
|
USAGE
|
|
1419
|
-
$
|
|
1419
|
+
$ sanity docs search QUERY [--limit <value>]
|
|
1420
1420
|
|
|
1421
1421
|
ARGUMENTS
|
|
1422
1422
|
QUERY Search query for documentation
|
|
@@ -1430,18 +1430,18 @@ DESCRIPTION
|
|
|
1430
1430
|
EXAMPLES
|
|
1431
1431
|
Search for documentation about schemas
|
|
1432
1432
|
|
|
1433
|
-
$
|
|
1433
|
+
$ sanity docs search schema
|
|
1434
1434
|
|
|
1435
1435
|
Search with phrase
|
|
1436
1436
|
|
|
1437
|
-
$
|
|
1437
|
+
$ sanity docs search "groq functions"
|
|
1438
1438
|
|
|
1439
1439
|
Limit search results
|
|
1440
1440
|
|
|
1441
|
-
$
|
|
1441
|
+
$ sanity docs search "deployment" --limit=5
|
|
1442
1442
|
```
|
|
1443
1443
|
|
|
1444
|
-
_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.19/src/commands/docs/search.ts)_
|
|
1445
1445
|
|
|
1446
1446
|
## `sanity documents create [FILE]`
|
|
1447
1447
|
|
|
@@ -1449,7 +1449,7 @@ Create one or more documents
|
|
|
1449
1449
|
|
|
1450
1450
|
```
|
|
1451
1451
|
USAGE
|
|
1452
|
-
$
|
|
1452
|
+
$ sanity documents create [FILE] [-d <value>] [--id <value>] [--json5] [--missing] [--replace] [--watch]
|
|
1453
1453
|
|
|
1454
1454
|
ARGUMENTS
|
|
1455
1455
|
[FILE] JSON file to create document(s) from
|
|
@@ -1468,24 +1468,24 @@ DESCRIPTION
|
|
|
1468
1468
|
EXAMPLES
|
|
1469
1469
|
Create the document specified in "myDocument.json"
|
|
1470
1470
|
|
|
1471
|
-
$
|
|
1471
|
+
$ sanity documents create myDocument.json
|
|
1472
1472
|
|
|
1473
1473
|
Open configured $EDITOR and create the specified document(s)
|
|
1474
1474
|
|
|
1475
|
-
$
|
|
1475
|
+
$ sanity documents create
|
|
1476
1476
|
|
|
1477
1477
|
Fetch document with the ID "myDocId" and open configured $EDITOR with the current document content (if any). Replace
|
|
1478
1478
|
document with the edited version when the editor closes
|
|
1479
1479
|
|
|
1480
|
-
$
|
|
1480
|
+
$ sanity documents create --id myDocId --replace
|
|
1481
1481
|
|
|
1482
1482
|
Open configured $EDITOR and replace the document with the given content on each save. Use JSON5 file extension and
|
|
1483
1483
|
parser for simplified syntax.
|
|
1484
1484
|
|
|
1485
|
-
$
|
|
1485
|
+
$ sanity documents create --id myDocId --watch --replace --json5
|
|
1486
1486
|
```
|
|
1487
1487
|
|
|
1488
|
-
_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.19/src/commands/documents/create.ts)_
|
|
1489
1489
|
|
|
1490
1490
|
## `sanity documents delete ID [IDS]`
|
|
1491
1491
|
|
|
@@ -1493,7 +1493,7 @@ Delete one or more documents from the projects configured dataset
|
|
|
1493
1493
|
|
|
1494
1494
|
```
|
|
1495
1495
|
USAGE
|
|
1496
|
-
$
|
|
1496
|
+
$ sanity documents delete ID... [IDS...] [--dataset <value>]
|
|
1497
1497
|
|
|
1498
1498
|
ARGUMENTS
|
|
1499
1499
|
ID... Document ID to delete
|
|
@@ -1508,22 +1508,22 @@ DESCRIPTION
|
|
|
1508
1508
|
EXAMPLES
|
|
1509
1509
|
Delete the document with the ID "myDocId"
|
|
1510
1510
|
|
|
1511
|
-
$
|
|
1511
|
+
$ sanity documents delete myDocId
|
|
1512
1512
|
|
|
1513
1513
|
ID wrapped in double or single quote works equally well
|
|
1514
1514
|
|
|
1515
|
-
$
|
|
1515
|
+
$ sanity documents delete 'myDocId'
|
|
1516
1516
|
|
|
1517
1517
|
Delete document with ID "someDocId" from dataset "blog"
|
|
1518
1518
|
|
|
1519
|
-
$
|
|
1519
|
+
$ sanity documents delete --dataset=blog someDocId
|
|
1520
1520
|
|
|
1521
1521
|
Delete the document with ID "doc1" and "doc2"
|
|
1522
1522
|
|
|
1523
|
-
$
|
|
1523
|
+
$ sanity documents delete doc1 doc2
|
|
1524
1524
|
```
|
|
1525
1525
|
|
|
1526
|
-
_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.19/src/commands/documents/delete.ts)_
|
|
1527
1527
|
|
|
1528
1528
|
## `sanity documents get DOCUMENTID`
|
|
1529
1529
|
|
|
@@ -1531,7 +1531,7 @@ Get and print a document by ID
|
|
|
1531
1531
|
|
|
1532
1532
|
```
|
|
1533
1533
|
USAGE
|
|
1534
|
-
$
|
|
1534
|
+
$ sanity documents get DOCUMENTID [-d <value>] [--pretty]
|
|
1535
1535
|
|
|
1536
1536
|
ARGUMENTS
|
|
1537
1537
|
DOCUMENTID Document ID to retrieve
|
|
@@ -1546,18 +1546,18 @@ DESCRIPTION
|
|
|
1546
1546
|
EXAMPLES
|
|
1547
1547
|
Get the document with ID "myDocId"
|
|
1548
1548
|
|
|
1549
|
-
$
|
|
1549
|
+
$ sanity documents get myDocId
|
|
1550
1550
|
|
|
1551
1551
|
Get document with colorized JSON output
|
|
1552
1552
|
|
|
1553
|
-
$
|
|
1553
|
+
$ sanity documents get myDocId --pretty
|
|
1554
1554
|
|
|
1555
1555
|
Get document from a specific dataset
|
|
1556
1556
|
|
|
1557
|
-
$
|
|
1557
|
+
$ sanity documents get myDocId --dataset production
|
|
1558
1558
|
```
|
|
1559
1559
|
|
|
1560
|
-
_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.19/src/commands/documents/get.ts)_
|
|
1561
1561
|
|
|
1562
1562
|
## `sanity documents query QUERY`
|
|
1563
1563
|
|
|
@@ -1565,7 +1565,7 @@ Query for documents
|
|
|
1565
1565
|
|
|
1566
1566
|
```
|
|
1567
1567
|
USAGE
|
|
1568
|
-
$
|
|
1568
|
+
$ sanity documents query QUERY [--anonymous] [--api-version <value>] [-d <value>] [--pretty] [-p <value>]
|
|
1569
1569
|
|
|
1570
1570
|
ARGUMENTS
|
|
1571
1571
|
QUERY GROQ query to run against the dataset
|
|
@@ -1583,18 +1583,18 @@ DESCRIPTION
|
|
|
1583
1583
|
EXAMPLES
|
|
1584
1584
|
Fetch 5 documents of type "movie"
|
|
1585
1585
|
|
|
1586
|
-
$
|
|
1586
|
+
$ sanity documents query '*[_type == "movie"][0..4]'
|
|
1587
1587
|
|
|
1588
1588
|
Fetch title of the oldest movie in the dataset named "staging"
|
|
1589
1589
|
|
|
1590
|
-
$
|
|
1590
|
+
$ sanity documents query '*[_type == "movie"]|order(releaseDate asc)[0]{title}' --dataset staging
|
|
1591
1591
|
|
|
1592
1592
|
Use API version v2021-06-07 and do a query
|
|
1593
1593
|
|
|
1594
|
-
$
|
|
1594
|
+
$ sanity documents query '*[_id == "header"] { "headerText": pt::text(body) }' --api-version v2021-06-07
|
|
1595
1595
|
```
|
|
1596
1596
|
|
|
1597
|
-
_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.19/src/commands/documents/query.ts)_
|
|
1598
1598
|
|
|
1599
1599
|
## `sanity documents validate`
|
|
1600
1600
|
|
|
@@ -1602,7 +1602,7 @@ Validate documents in a dataset against the studio schema
|
|
|
1602
1602
|
|
|
1603
1603
|
```
|
|
1604
1604
|
USAGE
|
|
1605
|
-
$
|
|
1605
|
+
$ sanity documents validate [-d <value>] [--file <value>] [--format <value>] [--level error|warning|info]
|
|
1606
1606
|
[--max-custom-validation-concurrency <value>] [--max-fetch-concurrency <value>] [--workspace <value>] [-y]
|
|
1607
1607
|
|
|
1608
1608
|
FLAGS
|
|
@@ -1628,22 +1628,22 @@ DESCRIPTION
|
|
|
1628
1628
|
EXAMPLES
|
|
1629
1629
|
Validates all documents in a Sanity project with more than one workspace
|
|
1630
1630
|
|
|
1631
|
-
$
|
|
1631
|
+
$ sanity documents validate --workspace default
|
|
1632
1632
|
|
|
1633
1633
|
Override the dataset specified in the workspace
|
|
1634
1634
|
|
|
1635
|
-
$
|
|
1635
|
+
$ sanity documents validate --workspace default --dataset staging
|
|
1636
1636
|
|
|
1637
1637
|
Save the results of the report into a file
|
|
1638
1638
|
|
|
1639
|
-
$
|
|
1639
|
+
$ sanity documents validate --yes > report.txt
|
|
1640
1640
|
|
|
1641
1641
|
Report out info level validation markers too
|
|
1642
1642
|
|
|
1643
|
-
$
|
|
1643
|
+
$ sanity documents validate --level info
|
|
1644
1644
|
```
|
|
1645
1645
|
|
|
1646
|
-
_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.19/src/commands/documents/validate.ts)_
|
|
1647
1647
|
|
|
1648
1648
|
## `sanity exec SCRIPT`
|
|
1649
1649
|
|
|
@@ -1651,7 +1651,7 @@ Executes a script within the Sanity Studio context
|
|
|
1651
1651
|
|
|
1652
1652
|
```
|
|
1653
1653
|
USAGE
|
|
1654
|
-
$
|
|
1654
|
+
$ sanity exec SCRIPT... [--mock-browser-env] [--with-user-token]
|
|
1655
1655
|
|
|
1656
1656
|
ARGUMENTS
|
|
1657
1657
|
SCRIPT... Path to the script to execute
|
|
@@ -1666,25 +1666,25 @@ DESCRIPTION
|
|
|
1666
1666
|
EXAMPLES
|
|
1667
1667
|
Run the script at some/script.js in Sanity context
|
|
1668
1668
|
|
|
1669
|
-
$
|
|
1669
|
+
$ sanity exec some/script.js
|
|
1670
1670
|
|
|
1671
1671
|
Run the script at migrations/fullname.ts and configure `getCliClient()` from `sanity/cli` to include the current
|
|
1672
1672
|
user's token
|
|
1673
1673
|
|
|
1674
|
-
$
|
|
1674
|
+
$ sanity exec migrations/fullname.ts --with-user-token
|
|
1675
1675
|
|
|
1676
1676
|
Run the script at scripts/browserScript.js in a mock browser environment
|
|
1677
1677
|
|
|
1678
|
-
$
|
|
1678
|
+
$ sanity exec scripts/browserScript.js --mock-browser-env
|
|
1679
1679
|
|
|
1680
1680
|
Pass arbitrary arguments to scripts by separating them with a `--`. Arguments are available in `process.argv` as
|
|
1681
1681
|
they would in regular node scripts (eg the following command would yield a `process.argv` of: `['/path/to/node',
|
|
1682
1682
|
'/path/to/myscript.js', '--dry-run', 'positional-argument']`)
|
|
1683
1683
|
|
|
1684
|
-
$
|
|
1684
|
+
$ sanity exec --mock-browser-env myscript.js -- --dry-run positional-argument
|
|
1685
1685
|
```
|
|
1686
1686
|
|
|
1687
|
-
_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.19/src/commands/exec.ts)_
|
|
1688
1688
|
|
|
1689
1689
|
## `sanity functions add`
|
|
1690
1690
|
|
|
@@ -1692,7 +1692,7 @@ Add a Function to your Blueprint
|
|
|
1692
1692
|
|
|
1693
1693
|
```
|
|
1694
1694
|
USAGE
|
|
1695
|
-
$
|
|
1695
|
+
$ sanity functions add [--example <value> | -n <value> | | --language ts|js | --javascript | | ] [--type
|
|
1696
1696
|
document-create|document-delete|document-update|document-publish|media-library-asset-create|media-library-asset-upda
|
|
1697
1697
|
te|media-library-asset-delete... ] [--helpers] [--installer skip|npm|pnpm|yarn] [-i | ]
|
|
1698
1698
|
|
|
@@ -1722,18 +1722,18 @@ DESCRIPTION
|
|
|
1722
1722
|
After adding, use 'functions dev' to test locally, then 'blueprints deploy' to publish.
|
|
1723
1723
|
|
|
1724
1724
|
EXAMPLES
|
|
1725
|
-
$
|
|
1725
|
+
$ sanity functions add
|
|
1726
1726
|
|
|
1727
|
-
$
|
|
1727
|
+
$ sanity functions add --helpers
|
|
1728
1728
|
|
|
1729
|
-
$
|
|
1729
|
+
$ sanity functions add --name my-function
|
|
1730
1730
|
|
|
1731
|
-
$
|
|
1731
|
+
$ sanity functions add --name my-function --type document-create
|
|
1732
1732
|
|
|
1733
|
-
$
|
|
1733
|
+
$ sanity functions add --name my-function --type document-create --type document-update --lang js
|
|
1734
1734
|
```
|
|
1735
1735
|
|
|
1736
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.
|
|
1736
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.2.0/src/commands/functions/add.ts)_
|
|
1737
1737
|
|
|
1738
1738
|
## `sanity functions dev`
|
|
1739
1739
|
|
|
@@ -1741,7 +1741,7 @@ Start the Sanity Function emulator
|
|
|
1741
1741
|
|
|
1742
1742
|
```
|
|
1743
1743
|
USAGE
|
|
1744
|
-
$
|
|
1744
|
+
$ sanity functions dev [-h <value>] [-p <value>] [-t <value>]
|
|
1745
1745
|
|
|
1746
1746
|
FLAGS
|
|
1747
1747
|
-h, --host=<value> The local network interface at which to listen. [default: "localhost"]
|
|
@@ -1762,12 +1762,12 @@ DESCRIPTION
|
|
|
1762
1762
|
To invoke a function with the CLI, use 'functions test'.
|
|
1763
1763
|
|
|
1764
1764
|
EXAMPLES
|
|
1765
|
-
$
|
|
1765
|
+
$ sanity functions dev --host 127.0.0.1 --port 8974
|
|
1766
1766
|
|
|
1767
|
-
$
|
|
1767
|
+
$ sanity functions dev --timeout 60
|
|
1768
1768
|
```
|
|
1769
1769
|
|
|
1770
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.
|
|
1770
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.2.0/src/commands/functions/dev.ts)_
|
|
1771
1771
|
|
|
1772
1772
|
## `sanity functions env add NAME KEY VALUE`
|
|
1773
1773
|
|
|
@@ -1775,7 +1775,7 @@ Add or set an environment variable for a deployed function
|
|
|
1775
1775
|
|
|
1776
1776
|
```
|
|
1777
1777
|
USAGE
|
|
1778
|
-
$
|
|
1778
|
+
$ sanity functions env add NAME KEY VALUE
|
|
1779
1779
|
|
|
1780
1780
|
ARGUMENTS
|
|
1781
1781
|
NAME The name of the Sanity Function
|
|
@@ -1791,10 +1791,10 @@ DESCRIPTION
|
|
|
1791
1791
|
Changes take effect on the next function invocation.
|
|
1792
1792
|
|
|
1793
1793
|
EXAMPLES
|
|
1794
|
-
$
|
|
1794
|
+
$ sanity functions env add MyFunction API_URL https://api.example.com/
|
|
1795
1795
|
```
|
|
1796
1796
|
|
|
1797
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.
|
|
1797
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.2.0/src/commands/functions/env/add.ts)_
|
|
1798
1798
|
|
|
1799
1799
|
## `sanity functions env list NAME`
|
|
1800
1800
|
|
|
@@ -1802,7 +1802,7 @@ List environment variables for a deployed function
|
|
|
1802
1802
|
|
|
1803
1803
|
```
|
|
1804
1804
|
USAGE
|
|
1805
|
-
$
|
|
1805
|
+
$ sanity functions env list NAME
|
|
1806
1806
|
|
|
1807
1807
|
ARGUMENTS
|
|
1808
1808
|
NAME The name of the Sanity Function
|
|
@@ -1815,10 +1815,10 @@ DESCRIPTION
|
|
|
1815
1815
|
Use 'functions env add' to set variables or 'functions env remove' to delete them.
|
|
1816
1816
|
|
|
1817
1817
|
EXAMPLES
|
|
1818
|
-
$
|
|
1818
|
+
$ sanity functions env list MyFunction
|
|
1819
1819
|
```
|
|
1820
1820
|
|
|
1821
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.
|
|
1821
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.2.0/src/commands/functions/env/list.ts)_
|
|
1822
1822
|
|
|
1823
1823
|
## `sanity functions env remove NAME KEY`
|
|
1824
1824
|
|
|
@@ -1826,7 +1826,7 @@ Remove an environment variable from a deployed function
|
|
|
1826
1826
|
|
|
1827
1827
|
```
|
|
1828
1828
|
USAGE
|
|
1829
|
-
$
|
|
1829
|
+
$ sanity functions env remove NAME KEY
|
|
1830
1830
|
|
|
1831
1831
|
ARGUMENTS
|
|
1832
1832
|
NAME The name of the Sanity Function
|
|
@@ -1841,10 +1841,10 @@ DESCRIPTION
|
|
|
1841
1841
|
Use 'functions env list' to see current variables before removing.
|
|
1842
1842
|
|
|
1843
1843
|
EXAMPLES
|
|
1844
|
-
$
|
|
1844
|
+
$ sanity functions env remove MyFunction API_URL
|
|
1845
1845
|
```
|
|
1846
1846
|
|
|
1847
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.
|
|
1847
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.2.0/src/commands/functions/env/remove.ts)_
|
|
1848
1848
|
|
|
1849
1849
|
## `sanity functions logs [NAME]`
|
|
1850
1850
|
|
|
@@ -1852,7 +1852,7 @@ Retrieve or delete logs for a Sanity Function
|
|
|
1852
1852
|
|
|
1853
1853
|
```
|
|
1854
1854
|
USAGE
|
|
1855
|
-
$
|
|
1855
|
+
$ sanity functions logs [NAME] [--stack <value>] [-u] [-f [-d | -l <value> | -j]] [-w]
|
|
1856
1856
|
|
|
1857
1857
|
ARGUMENTS
|
|
1858
1858
|
[NAME] The name of the Sanity Function
|
|
@@ -1875,16 +1875,16 @@ DESCRIPTION
|
|
|
1875
1875
|
unless --force is specified).
|
|
1876
1876
|
|
|
1877
1877
|
EXAMPLES
|
|
1878
|
-
$
|
|
1878
|
+
$ sanity functions logs <name>
|
|
1879
1879
|
|
|
1880
|
-
$
|
|
1880
|
+
$ sanity functions logs <name> --json
|
|
1881
1881
|
|
|
1882
|
-
$
|
|
1882
|
+
$ sanity functions logs <name> --limit 100
|
|
1883
1883
|
|
|
1884
|
-
$
|
|
1884
|
+
$ sanity functions logs <name> --delete
|
|
1885
1885
|
```
|
|
1886
1886
|
|
|
1887
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.
|
|
1887
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.2.0/src/commands/functions/logs.ts)_
|
|
1888
1888
|
|
|
1889
1889
|
## `sanity functions test [NAME]`
|
|
1890
1890
|
|
|
@@ -1892,7 +1892,7 @@ Invoke a local Sanity Function
|
|
|
1892
1892
|
|
|
1893
1893
|
```
|
|
1894
1894
|
USAGE
|
|
1895
|
-
$
|
|
1895
|
+
$ sanity functions test [NAME] [--data-before <value> | [-d <value> | -f <value> | --document-id <value>] | | |
|
|
1896
1896
|
--file-before <value> | --file-after <value> | --document-id-before <value> | --document-id-after <value>]
|
|
1897
1897
|
[--data-after <value> | | | | | | | ] [-e create|update|delete] [-t <value>] [-a <value>] [--with-user-token]
|
|
1898
1898
|
[--media-library-id <value> | --project-id <value> | --dataset <value>]
|
|
@@ -1929,16 +1929,16 @@ DESCRIPTION
|
|
|
1929
1929
|
events, use the before/after flag pairs to simulate document changes.
|
|
1930
1930
|
|
|
1931
1931
|
EXAMPLES
|
|
1932
|
-
$
|
|
1932
|
+
$ sanity functions test <name> --data '{ "id": 1 }'
|
|
1933
1933
|
|
|
1934
|
-
$
|
|
1934
|
+
$ sanity functions test <name> --file 'payload.json'
|
|
1935
1935
|
|
|
1936
|
-
$
|
|
1936
|
+
$ sanity functions test <name> --data '{ "id": 1 }' --timeout 60
|
|
1937
1937
|
|
|
1938
|
-
$
|
|
1938
|
+
$ sanity functions test <name> --event update --data-before '{ "title": "before" }' --data-after '{ "title": "after" }'
|
|
1939
1939
|
```
|
|
1940
1940
|
|
|
1941
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.
|
|
1941
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.2.0/src/commands/functions/test.ts)_
|
|
1942
1942
|
|
|
1943
1943
|
## `sanity graphql deploy`
|
|
1944
1944
|
|
|
@@ -1946,7 +1946,7 @@ Deploy a GraphQL API from the current Sanity schema
|
|
|
1946
1946
|
|
|
1947
1947
|
```
|
|
1948
1948
|
USAGE
|
|
1949
|
-
$
|
|
1949
|
+
$ sanity graphql deploy [--api <value>...] [--dataset <value>] [--dry-run] [--force] [--generation gen1|gen2|gen3]
|
|
1950
1950
|
[--non-null-document-fields] [--playground] [--tag <value>] [--with-union-cache]
|
|
1951
1951
|
|
|
1952
1952
|
FLAGS
|
|
@@ -1968,22 +1968,22 @@ DESCRIPTION
|
|
|
1968
1968
|
EXAMPLES
|
|
1969
1969
|
Deploy all defined GraphQL APIs
|
|
1970
1970
|
|
|
1971
|
-
$
|
|
1971
|
+
$ sanity graphql deploy
|
|
1972
1972
|
|
|
1973
1973
|
Validate defined GraphQL APIs, check for breaking changes, skip deploy
|
|
1974
1974
|
|
|
1975
|
-
$
|
|
1975
|
+
$ sanity graphql deploy --dry-run
|
|
1976
1976
|
|
|
1977
1977
|
Deploy only the GraphQL APIs with the IDs "staging" and "ios"
|
|
1978
1978
|
|
|
1979
|
-
$
|
|
1979
|
+
$ sanity graphql deploy --api staging --api ios
|
|
1980
1980
|
|
|
1981
1981
|
Deploy all defined GraphQL APIs, overriding any playground setting
|
|
1982
1982
|
|
|
1983
|
-
$
|
|
1983
|
+
$ sanity graphql deploy --playground
|
|
1984
1984
|
```
|
|
1985
1985
|
|
|
1986
|
-
_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.19/src/commands/graphql/deploy.ts)_
|
|
1987
1987
|
|
|
1988
1988
|
## `sanity graphql list`
|
|
1989
1989
|
|
|
@@ -1991,7 +1991,7 @@ List all GraphQL endpoints deployed for this project
|
|
|
1991
1991
|
|
|
1992
1992
|
```
|
|
1993
1993
|
USAGE
|
|
1994
|
-
$
|
|
1994
|
+
$ sanity graphql list
|
|
1995
1995
|
|
|
1996
1996
|
DESCRIPTION
|
|
1997
1997
|
List all GraphQL endpoints deployed for this project
|
|
@@ -1999,10 +1999,10 @@ DESCRIPTION
|
|
|
1999
1999
|
EXAMPLES
|
|
2000
2000
|
List GraphQL endpoints for the current project
|
|
2001
2001
|
|
|
2002
|
-
$
|
|
2002
|
+
$ sanity graphql list
|
|
2003
2003
|
```
|
|
2004
2004
|
|
|
2005
|
-
_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.19/src/commands/graphql/list.ts)_
|
|
2006
2006
|
|
|
2007
2007
|
## `sanity graphql undeploy`
|
|
2008
2008
|
|
|
@@ -2010,7 +2010,7 @@ Remove a deployed GraphQL API
|
|
|
2010
2010
|
|
|
2011
2011
|
```
|
|
2012
2012
|
USAGE
|
|
2013
|
-
$
|
|
2013
|
+
$ sanity graphql undeploy [--api <value>] [--dataset <value>] [--force] [--project <value>] [--tag <value>]
|
|
2014
2014
|
|
|
2015
2015
|
FLAGS
|
|
2016
2016
|
--api=<value> Undeploy API with this ID (project, dataset and tag flags take precedence)
|
|
@@ -2025,26 +2025,26 @@ DESCRIPTION
|
|
|
2025
2025
|
EXAMPLES
|
|
2026
2026
|
Undeploy GraphQL API for current project and dataset
|
|
2027
2027
|
|
|
2028
|
-
$
|
|
2028
|
+
$ sanity graphql undeploy
|
|
2029
2029
|
|
|
2030
2030
|
Undeploy API with ID "ios"
|
|
2031
2031
|
|
|
2032
|
-
$
|
|
2032
|
+
$ sanity graphql undeploy --api ios
|
|
2033
2033
|
|
|
2034
2034
|
Undeploy GraphQL API for staging dataset
|
|
2035
2035
|
|
|
2036
|
-
$
|
|
2036
|
+
$ sanity graphql undeploy --dataset staging
|
|
2037
2037
|
|
|
2038
2038
|
Undeploy GraphQL API for staging dataset with "next" tag
|
|
2039
2039
|
|
|
2040
|
-
$
|
|
2040
|
+
$ sanity graphql undeploy --dataset staging --tag next
|
|
2041
2041
|
|
|
2042
2042
|
Undeploy GraphQL API without confirmation prompt
|
|
2043
2043
|
|
|
2044
|
-
$
|
|
2044
|
+
$ sanity graphql undeploy --force
|
|
2045
2045
|
```
|
|
2046
2046
|
|
|
2047
|
-
_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.19/src/commands/graphql/undeploy.ts)_
|
|
2048
2048
|
|
|
2049
2049
|
## `sanity help [COMMAND]`
|
|
2050
2050
|
|
|
@@ -2052,7 +2052,7 @@ Display help for sanity.
|
|
|
2052
2052
|
|
|
2053
2053
|
```
|
|
2054
2054
|
USAGE
|
|
2055
|
-
$
|
|
2055
|
+
$ sanity help [COMMAND...] [-n]
|
|
2056
2056
|
|
|
2057
2057
|
ARGUMENTS
|
|
2058
2058
|
[COMMAND...] Command to show help for.
|
|
@@ -2072,7 +2072,7 @@ Print details of a given webhook delivery attempt
|
|
|
2072
2072
|
|
|
2073
2073
|
```
|
|
2074
2074
|
USAGE
|
|
2075
|
-
$
|
|
2075
|
+
$ sanity hook attempt ATTEMPTID
|
|
2076
2076
|
|
|
2077
2077
|
ARGUMENTS
|
|
2078
2078
|
ATTEMPTID The delivery attempt ID to get details for
|
|
@@ -2083,10 +2083,10 @@ DESCRIPTION
|
|
|
2083
2083
|
EXAMPLES
|
|
2084
2084
|
Print details of webhook delivery attempt with ID abc123
|
|
2085
2085
|
|
|
2086
|
-
$
|
|
2086
|
+
$ sanity hook attempt abc123
|
|
2087
2087
|
```
|
|
2088
2088
|
|
|
2089
|
-
_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.19/src/commands/hook/attempt.ts)_
|
|
2090
2090
|
|
|
2091
2091
|
## `sanity hook create`
|
|
2092
2092
|
|
|
@@ -2094,7 +2094,7 @@ Create a new webhook for the current project
|
|
|
2094
2094
|
|
|
2095
2095
|
```
|
|
2096
2096
|
USAGE
|
|
2097
|
-
$
|
|
2097
|
+
$ sanity hook create
|
|
2098
2098
|
|
|
2099
2099
|
DESCRIPTION
|
|
2100
2100
|
Create a new webhook for the current project
|
|
@@ -2102,10 +2102,10 @@ DESCRIPTION
|
|
|
2102
2102
|
EXAMPLES
|
|
2103
2103
|
Create a new webhook for the current project
|
|
2104
2104
|
|
|
2105
|
-
$
|
|
2105
|
+
$ sanity hook create
|
|
2106
2106
|
```
|
|
2107
2107
|
|
|
2108
|
-
_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.19/src/commands/hook/create.ts)_
|
|
2109
2109
|
|
|
2110
2110
|
## `sanity hook delete [NAME]`
|
|
2111
2111
|
|
|
@@ -2113,7 +2113,7 @@ Delete a hook within your project
|
|
|
2113
2113
|
|
|
2114
2114
|
```
|
|
2115
2115
|
USAGE
|
|
2116
|
-
$
|
|
2116
|
+
$ sanity hook delete [NAME]
|
|
2117
2117
|
|
|
2118
2118
|
ARGUMENTS
|
|
2119
2119
|
[NAME] Name of hook to delete (will prompt if not provided)
|
|
@@ -2124,14 +2124,14 @@ DESCRIPTION
|
|
|
2124
2124
|
EXAMPLES
|
|
2125
2125
|
Interactively select and delete a hook
|
|
2126
2126
|
|
|
2127
|
-
$
|
|
2127
|
+
$ sanity hook delete
|
|
2128
2128
|
|
|
2129
2129
|
Delete a specific hook by name
|
|
2130
2130
|
|
|
2131
|
-
$
|
|
2131
|
+
$ sanity hook delete my-hook
|
|
2132
2132
|
```
|
|
2133
2133
|
|
|
2134
|
-
_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.19/src/commands/hook/delete.ts)_
|
|
2135
2135
|
|
|
2136
2136
|
## `sanity hook list`
|
|
2137
2137
|
|
|
@@ -2139,7 +2139,7 @@ List hooks for a given project
|
|
|
2139
2139
|
|
|
2140
2140
|
```
|
|
2141
2141
|
USAGE
|
|
2142
|
-
$
|
|
2142
|
+
$ sanity hook list
|
|
2143
2143
|
|
|
2144
2144
|
DESCRIPTION
|
|
2145
2145
|
List hooks for a given project
|
|
@@ -2147,10 +2147,10 @@ DESCRIPTION
|
|
|
2147
2147
|
EXAMPLES
|
|
2148
2148
|
List hooks for a given project
|
|
2149
2149
|
|
|
2150
|
-
$
|
|
2150
|
+
$ sanity hook list
|
|
2151
2151
|
```
|
|
2152
2152
|
|
|
2153
|
-
_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.19/src/commands/hook/list.ts)_
|
|
2154
2154
|
|
|
2155
2155
|
## `sanity hook logs [NAME]`
|
|
2156
2156
|
|
|
@@ -2158,7 +2158,7 @@ List latest log entries for a given hook
|
|
|
2158
2158
|
|
|
2159
2159
|
```
|
|
2160
2160
|
USAGE
|
|
2161
|
-
$
|
|
2161
|
+
$ sanity hook logs [NAME] [--detailed]
|
|
2162
2162
|
|
|
2163
2163
|
ARGUMENTS
|
|
2164
2164
|
[NAME] Name of the hook to show logs for
|
|
@@ -2172,14 +2172,14 @@ DESCRIPTION
|
|
|
2172
2172
|
EXAMPLES
|
|
2173
2173
|
List latest log entries for a given hook
|
|
2174
2174
|
|
|
2175
|
-
$
|
|
2175
|
+
$ sanity hook logs
|
|
2176
2176
|
|
|
2177
2177
|
List latest log entries for a specific hook by name
|
|
2178
2178
|
|
|
2179
|
-
$
|
|
2179
|
+
$ sanity hook logs [NAME]
|
|
2180
2180
|
```
|
|
2181
2181
|
|
|
2182
|
-
_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.19/src/commands/hook/logs.ts)_
|
|
2183
2183
|
|
|
2184
2184
|
## `sanity init`
|
|
2185
2185
|
|
|
@@ -2187,7 +2187,7 @@ Initialize a new Sanity Studio, project and/or app
|
|
|
2187
2187
|
|
|
2188
2188
|
```
|
|
2189
2189
|
USAGE
|
|
2190
|
-
$
|
|
2190
|
+
$ sanity init [--json] [--auto-updates | --bare] [--coupon <code> | --project-plan <name>] [--dataset
|
|
2191
2191
|
<name> | --dataset-default] [--env <filename> | ] [--git <message> | ] [--mcp] [--nextjs-add-config-files]
|
|
2192
2192
|
[--nextjs-append-env] [--nextjs-embed-studio] [--organization <id>] [--output-path <path> | ] [--overwrite-files]
|
|
2193
2193
|
[--package-manager <manager> | ] [--project <id> | --create-project <name>] [--provider <provider>] [--template
|
|
@@ -2228,27 +2228,27 @@ DESCRIPTION
|
|
|
2228
2228
|
Initialize a new Sanity Studio, project and/or app
|
|
2229
2229
|
|
|
2230
2230
|
EXAMPLES
|
|
2231
|
-
$
|
|
2231
|
+
$ sanity init
|
|
2232
2232
|
|
|
2233
2233
|
Initialize a new project with a public dataset named "production"
|
|
2234
2234
|
|
|
2235
|
-
$
|
|
2235
|
+
$ sanity init --dataset-default
|
|
2236
2236
|
|
|
2237
2237
|
Initialize a project with the given project ID and dataset to the given path
|
|
2238
2238
|
|
|
2239
|
-
$
|
|
2239
|
+
$ sanity init -y --project abc123 --dataset production --output-path ~/myproj
|
|
2240
2240
|
|
|
2241
2241
|
Initialize a project with the given project ID and dataset using the moviedb template to the given path
|
|
2242
2242
|
|
|
2243
|
-
$
|
|
2243
|
+
$ sanity init -y --project abc123 --dataset staging --template moviedb --output-path .
|
|
2244
2244
|
|
|
2245
2245
|
Create a brand new project with name "Movies Unlimited"
|
|
2246
2246
|
|
|
2247
|
-
$
|
|
2247
|
+
$ sanity init -y --create-project "Movies Unlimited" --dataset moviedb --visibility private --template moviedb \
|
|
2248
2248
|
--output-path /Users/espenh/movies-unlimited
|
|
2249
2249
|
```
|
|
2250
2250
|
|
|
2251
|
-
_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.19/src/commands/init.ts)_
|
|
2252
2252
|
|
|
2253
2253
|
## `sanity install [PACKAGES]`
|
|
2254
2254
|
|
|
@@ -2256,7 +2256,7 @@ Installs dependencies for Sanity Studio project
|
|
|
2256
2256
|
|
|
2257
2257
|
```
|
|
2258
2258
|
USAGE
|
|
2259
|
-
$
|
|
2259
|
+
$ sanity install [PACKAGES...]
|
|
2260
2260
|
|
|
2261
2261
|
ARGUMENTS
|
|
2262
2262
|
[PACKAGES...] Packages to install
|
|
@@ -2265,14 +2265,14 @@ DESCRIPTION
|
|
|
2265
2265
|
Installs dependencies for Sanity Studio project
|
|
2266
2266
|
|
|
2267
2267
|
EXAMPLES
|
|
2268
|
-
$
|
|
2268
|
+
$ sanity install
|
|
2269
2269
|
|
|
2270
|
-
$
|
|
2270
|
+
$ sanity install @sanity/vision
|
|
2271
2271
|
|
|
2272
|
-
$
|
|
2272
|
+
$ sanity install some-package another-package
|
|
2273
2273
|
```
|
|
2274
2274
|
|
|
2275
|
-
_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.19/src/commands/install.ts)_
|
|
2276
2276
|
|
|
2277
2277
|
## `sanity learn`
|
|
2278
2278
|
|
|
@@ -2280,13 +2280,13 @@ Opens Sanity Learn in your web browser
|
|
|
2280
2280
|
|
|
2281
2281
|
```
|
|
2282
2282
|
USAGE
|
|
2283
|
-
$
|
|
2283
|
+
$ sanity learn
|
|
2284
2284
|
|
|
2285
2285
|
DESCRIPTION
|
|
2286
2286
|
Opens Sanity Learn in your web browser
|
|
2287
2287
|
```
|
|
2288
2288
|
|
|
2289
|
-
_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.19/src/commands/learn.ts)_
|
|
2290
2290
|
|
|
2291
2291
|
## `sanity login`
|
|
2292
2292
|
|
|
@@ -2294,7 +2294,7 @@ Authenticates the CLI for access to Sanity projects
|
|
|
2294
2294
|
|
|
2295
2295
|
```
|
|
2296
2296
|
USAGE
|
|
2297
|
-
$
|
|
2297
|
+
$ sanity login [--open] [--provider <providerId>] [--sso <slug>]
|
|
2298
2298
|
|
|
2299
2299
|
FLAGS
|
|
2300
2300
|
--[no-]open Open a browser window to log in (`--no-open` only prints URL)
|
|
@@ -2307,18 +2307,18 @@ DESCRIPTION
|
|
|
2307
2307
|
EXAMPLES
|
|
2308
2308
|
Log in using default settings
|
|
2309
2309
|
|
|
2310
|
-
$
|
|
2310
|
+
$ sanity login
|
|
2311
2311
|
|
|
2312
2312
|
Log in using Single Sign-On with the "my-organization" slug
|
|
2313
2313
|
|
|
2314
|
-
$
|
|
2314
|
+
$ sanity login --sso my-organization
|
|
2315
2315
|
|
|
2316
2316
|
Login with GitHub provider, but do not open a browser window automatically
|
|
2317
2317
|
|
|
2318
|
-
$
|
|
2318
|
+
$ sanity login --provider github --no-open
|
|
2319
2319
|
```
|
|
2320
2320
|
|
|
2321
|
-
_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.19/src/commands/login.ts)_
|
|
2322
2322
|
|
|
2323
2323
|
## `sanity logout`
|
|
2324
2324
|
|
|
@@ -2326,13 +2326,13 @@ Logs out the CLI from the current user session
|
|
|
2326
2326
|
|
|
2327
2327
|
```
|
|
2328
2328
|
USAGE
|
|
2329
|
-
$
|
|
2329
|
+
$ sanity logout
|
|
2330
2330
|
|
|
2331
2331
|
DESCRIPTION
|
|
2332
2332
|
Logs out the CLI from the current user session
|
|
2333
2333
|
```
|
|
2334
2334
|
|
|
2335
|
-
_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.19/src/commands/logout.ts)_
|
|
2336
2336
|
|
|
2337
2337
|
## `sanity manage`
|
|
2338
2338
|
|
|
@@ -2340,13 +2340,13 @@ Opens project management interface in your web browser
|
|
|
2340
2340
|
|
|
2341
2341
|
```
|
|
2342
2342
|
USAGE
|
|
2343
|
-
$
|
|
2343
|
+
$ sanity manage
|
|
2344
2344
|
|
|
2345
2345
|
DESCRIPTION
|
|
2346
2346
|
Opens project management interface in your web browser
|
|
2347
2347
|
```
|
|
2348
2348
|
|
|
2349
|
-
_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.19/src/commands/manage.ts)_
|
|
2350
2350
|
|
|
2351
2351
|
## `sanity manifest extract`
|
|
2352
2352
|
|
|
@@ -2354,7 +2354,7 @@ Extracts the studio configuration as one or more JSON manifest files.
|
|
|
2354
2354
|
|
|
2355
2355
|
```
|
|
2356
2356
|
USAGE
|
|
2357
|
-
$
|
|
2357
|
+
$ sanity manifest extract [--path <value>]
|
|
2358
2358
|
|
|
2359
2359
|
FLAGS
|
|
2360
2360
|
--path=<value> [default: /dist/static] Optional path to specify destination directory of the manifest files
|
|
@@ -2367,14 +2367,14 @@ DESCRIPTION
|
|
|
2367
2367
|
EXAMPLES
|
|
2368
2368
|
Extracts manifests
|
|
2369
2369
|
|
|
2370
|
-
$
|
|
2370
|
+
$ sanity manifest extract
|
|
2371
2371
|
|
|
2372
2372
|
Extracts manifests into /public/static
|
|
2373
2373
|
|
|
2374
|
-
$
|
|
2374
|
+
$ sanity manifest extract --path /public/static
|
|
2375
2375
|
```
|
|
2376
2376
|
|
|
2377
|
-
_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.19/src/commands/manifest/extract.ts)_
|
|
2378
2378
|
|
|
2379
2379
|
## `sanity mcp configure`
|
|
2380
2380
|
|
|
@@ -2382,7 +2382,7 @@ Configure Sanity MCP server for AI editors (Claude Code, Codex CLI, Cursor, Gemi
|
|
|
2382
2382
|
|
|
2383
2383
|
```
|
|
2384
2384
|
USAGE
|
|
2385
|
-
$
|
|
2385
|
+
$ sanity mcp configure
|
|
2386
2386
|
|
|
2387
2387
|
DESCRIPTION
|
|
2388
2388
|
Configure Sanity MCP server for AI editors (Claude Code, Codex CLI, Cursor, Gemini CLI, GitHub Copilot CLI, VS Code)
|
|
@@ -2390,10 +2390,10 @@ DESCRIPTION
|
|
|
2390
2390
|
EXAMPLES
|
|
2391
2391
|
Configure Sanity MCP server for detected AI editors
|
|
2392
2392
|
|
|
2393
|
-
$
|
|
2393
|
+
$ sanity mcp configure
|
|
2394
2394
|
```
|
|
2395
2395
|
|
|
2396
|
-
_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.19/src/commands/mcp/configure.ts)_
|
|
2397
2397
|
|
|
2398
2398
|
## `sanity media create-aspect`
|
|
2399
2399
|
|
|
@@ -2401,7 +2401,7 @@ Create a new aspect definition file
|
|
|
2401
2401
|
|
|
2402
2402
|
```
|
|
2403
2403
|
USAGE
|
|
2404
|
-
$
|
|
2404
|
+
$ sanity media create-aspect
|
|
2405
2405
|
|
|
2406
2406
|
DESCRIPTION
|
|
2407
2407
|
Create a new aspect definition file
|
|
@@ -2409,10 +2409,10 @@ DESCRIPTION
|
|
|
2409
2409
|
EXAMPLES
|
|
2410
2410
|
Create a new aspect definition file
|
|
2411
2411
|
|
|
2412
|
-
$
|
|
2412
|
+
$ sanity media create-aspect
|
|
2413
2413
|
```
|
|
2414
2414
|
|
|
2415
|
-
_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.19/src/commands/media/create-aspect.ts)_
|
|
2416
2416
|
|
|
2417
2417
|
## `sanity media delete-aspect ASPECTNAME`
|
|
2418
2418
|
|
|
@@ -2420,7 +2420,7 @@ Undeploy an aspect
|
|
|
2420
2420
|
|
|
2421
2421
|
```
|
|
2422
2422
|
USAGE
|
|
2423
|
-
$
|
|
2423
|
+
$ sanity media delete-aspect ASPECTNAME [--media-library-id <value>] [--yes]
|
|
2424
2424
|
|
|
2425
2425
|
ARGUMENTS
|
|
2426
2426
|
ASPECTNAME Name of the aspect to delete
|
|
@@ -2435,10 +2435,10 @@ DESCRIPTION
|
|
|
2435
2435
|
EXAMPLES
|
|
2436
2436
|
Delete the aspect named "someAspect"
|
|
2437
2437
|
|
|
2438
|
-
$
|
|
2438
|
+
$ sanity media delete-aspect someAspect
|
|
2439
2439
|
```
|
|
2440
2440
|
|
|
2441
|
-
_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.19/src/commands/media/delete-aspect.ts)_
|
|
2442
2442
|
|
|
2443
2443
|
## `sanity media deploy-aspect [ASPECTNAME]`
|
|
2444
2444
|
|
|
@@ -2446,7 +2446,7 @@ Deploy an aspect
|
|
|
2446
2446
|
|
|
2447
2447
|
```
|
|
2448
2448
|
USAGE
|
|
2449
|
-
$
|
|
2449
|
+
$ sanity media deploy-aspect [ASPECTNAME] [--all] [--media-library-id <value>]
|
|
2450
2450
|
|
|
2451
2451
|
ARGUMENTS
|
|
2452
2452
|
[ASPECTNAME] Name of the aspect to deploy
|
|
@@ -2461,14 +2461,14 @@ DESCRIPTION
|
|
|
2461
2461
|
EXAMPLES
|
|
2462
2462
|
Deploy the aspect named "someAspect"
|
|
2463
2463
|
|
|
2464
|
-
$
|
|
2464
|
+
$ sanity media deploy-aspect someAspect
|
|
2465
2465
|
|
|
2466
2466
|
Deploy all aspects
|
|
2467
2467
|
|
|
2468
|
-
$
|
|
2468
|
+
$ sanity media deploy-aspect --all
|
|
2469
2469
|
```
|
|
2470
2470
|
|
|
2471
|
-
_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.19/src/commands/media/deploy-aspect.ts)_
|
|
2472
2472
|
|
|
2473
2473
|
## `sanity media export [DESTINATION]`
|
|
2474
2474
|
|
|
@@ -2476,7 +2476,7 @@ Export an archive of all file and image assets including their aspect data from
|
|
|
2476
2476
|
|
|
2477
2477
|
```
|
|
2478
2478
|
USAGE
|
|
2479
|
-
$
|
|
2479
|
+
$ sanity media export [DESTINATION] [--asset-concurrency <value>] [--media-library-id <value>] [--no-compress]
|
|
2480
2480
|
[--overwrite]
|
|
2481
2481
|
|
|
2482
2482
|
ARGUMENTS
|
|
@@ -2495,18 +2495,18 @@ DESCRIPTION
|
|
|
2495
2495
|
EXAMPLES
|
|
2496
2496
|
Export media library interactively
|
|
2497
2497
|
|
|
2498
|
-
$
|
|
2498
|
+
$ sanity media export
|
|
2499
2499
|
|
|
2500
2500
|
Export media library to output.tar.gz
|
|
2501
2501
|
|
|
2502
|
-
$
|
|
2502
|
+
$ sanity media export output.tar.gz
|
|
2503
2503
|
|
|
2504
2504
|
Export specific media library
|
|
2505
2505
|
|
|
2506
|
-
$
|
|
2506
|
+
$ sanity media export --media-library-id my-library-id
|
|
2507
2507
|
```
|
|
2508
2508
|
|
|
2509
|
-
_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.19/src/commands/media/export.ts)_
|
|
2510
2510
|
|
|
2511
2511
|
## `sanity media import SOURCE`
|
|
2512
2512
|
|
|
@@ -2514,7 +2514,7 @@ Import a set of assets to the target media library.
|
|
|
2514
2514
|
|
|
2515
2515
|
```
|
|
2516
2516
|
USAGE
|
|
2517
|
-
$
|
|
2517
|
+
$ sanity media import SOURCE [--media-library-id <value>] [--replace-aspects]
|
|
2518
2518
|
|
|
2519
2519
|
ARGUMENTS
|
|
2520
2520
|
SOURCE Image file or folder to import from
|
|
@@ -2530,18 +2530,18 @@ DESCRIPTION
|
|
|
2530
2530
|
EXAMPLES
|
|
2531
2531
|
Import all assets from the "products" directory
|
|
2532
2532
|
|
|
2533
|
-
$
|
|
2533
|
+
$ sanity media import products
|
|
2534
2534
|
|
|
2535
2535
|
Import all assets from "gallery" archive
|
|
2536
2536
|
|
|
2537
|
-
$
|
|
2537
|
+
$ sanity media import gallery.tar.gz
|
|
2538
2538
|
|
|
2539
2539
|
Import all assets from the "products" directory and replace aspects
|
|
2540
2540
|
|
|
2541
|
-
$
|
|
2541
|
+
$ sanity media import products --replace-aspects
|
|
2542
2542
|
```
|
|
2543
2543
|
|
|
2544
|
-
_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.19/src/commands/media/import.ts)_
|
|
2545
2545
|
|
|
2546
2546
|
## `sanity migration create [TITLE]`
|
|
2547
2547
|
|
|
@@ -2549,7 +2549,7 @@ Create a new migration within your project
|
|
|
2549
2549
|
|
|
2550
2550
|
```
|
|
2551
2551
|
USAGE
|
|
2552
|
-
$
|
|
2552
|
+
$ sanity migration create [TITLE]
|
|
2553
2553
|
|
|
2554
2554
|
ARGUMENTS
|
|
2555
2555
|
[TITLE] Title of migration
|
|
@@ -2560,11 +2560,11 @@ DESCRIPTION
|
|
|
2560
2560
|
EXAMPLES
|
|
2561
2561
|
Create a new migration, prompting for title and options
|
|
2562
2562
|
|
|
2563
|
-
$
|
|
2563
|
+
$ sanity migration create
|
|
2564
2564
|
|
|
2565
2565
|
Create a new migration with the provided title, prompting for options
|
|
2566
2566
|
|
|
2567
|
-
$
|
|
2567
|
+
$ sanity migration create "Rename field from location to address"
|
|
2568
2568
|
```
|
|
2569
2569
|
|
|
2570
2570
|
_See code: [@sanity/migrate](https://github.com/sanity-io/migrate/blob/v5.2.5/src/commands/migration/create.ts)_
|
|
@@ -2575,7 +2575,7 @@ List available migrations
|
|
|
2575
2575
|
|
|
2576
2576
|
```
|
|
2577
2577
|
USAGE
|
|
2578
|
-
$
|
|
2578
|
+
$ sanity migration list
|
|
2579
2579
|
|
|
2580
2580
|
DESCRIPTION
|
|
2581
2581
|
List available migrations
|
|
@@ -2583,7 +2583,7 @@ DESCRIPTION
|
|
|
2583
2583
|
EXAMPLES
|
|
2584
2584
|
List all available migrations in the project
|
|
2585
2585
|
|
|
2586
|
-
$
|
|
2586
|
+
$ sanity migration list
|
|
2587
2587
|
```
|
|
2588
2588
|
|
|
2589
2589
|
_See code: [@sanity/migrate](https://github.com/sanity-io/migrate/blob/v5.2.5/src/commands/migration/list.ts)_
|
|
@@ -2594,7 +2594,7 @@ Run a migration against a dataset
|
|
|
2594
2594
|
|
|
2595
2595
|
```
|
|
2596
2596
|
USAGE
|
|
2597
|
-
$
|
|
2597
|
+
$ sanity migration run [ID] [--api-version <value>] [--concurrency <value>] [--confirm] [--dataset <value>]
|
|
2598
2598
|
[--dry-run] [--from-export <value>] [--progress] [--project <value>]
|
|
2599
2599
|
|
|
2600
2600
|
ARGUMENTS
|
|
@@ -2619,15 +2619,15 @@ DESCRIPTION
|
|
|
2619
2619
|
EXAMPLES
|
|
2620
2620
|
dry run the migration
|
|
2621
2621
|
|
|
2622
|
-
$
|
|
2622
|
+
$ sanity migration run <id>
|
|
2623
2623
|
|
|
2624
2624
|
execute the migration against a dataset
|
|
2625
2625
|
|
|
2626
|
-
$
|
|
2626
|
+
$ sanity migration run <id> --no-dry-run --project xyz --dataset staging
|
|
2627
2627
|
|
|
2628
2628
|
execute the migration using a dataset export as the source
|
|
2629
2629
|
|
|
2630
|
-
$
|
|
2630
|
+
$ sanity migration run <id> --from-export=production.tar.gz --no-dry-run --project xyz --dataset staging
|
|
2631
2631
|
```
|
|
2632
2632
|
|
|
2633
2633
|
_See code: [@sanity/migrate](https://github.com/sanity-io/migrate/blob/v5.2.5/src/commands/migration/run.ts)_
|
|
@@ -2638,7 +2638,7 @@ Get an OpenAPI specification by slug
|
|
|
2638
2638
|
|
|
2639
2639
|
```
|
|
2640
2640
|
USAGE
|
|
2641
|
-
$
|
|
2641
|
+
$ sanity openapi get SLUG [--format yaml|json] [-w]
|
|
2642
2642
|
|
|
2643
2643
|
ARGUMENTS
|
|
2644
2644
|
SLUG Slug of the OpenAPI specification to retrieve
|
|
@@ -2654,22 +2654,22 @@ DESCRIPTION
|
|
|
2654
2654
|
EXAMPLES
|
|
2655
2655
|
Get a specification (YAML format, default)
|
|
2656
2656
|
|
|
2657
|
-
$
|
|
2657
|
+
$ sanity openapi get query
|
|
2658
2658
|
|
|
2659
2659
|
Get specification in JSON format
|
|
2660
2660
|
|
|
2661
|
-
$
|
|
2661
|
+
$ sanity openapi get query --format=json
|
|
2662
2662
|
|
|
2663
2663
|
Open specification in browser
|
|
2664
2664
|
|
|
2665
|
-
$
|
|
2665
|
+
$ sanity openapi get query --web
|
|
2666
2666
|
|
|
2667
2667
|
Pipe to file
|
|
2668
2668
|
|
|
2669
|
-
$
|
|
2669
|
+
$ sanity openapi get query > query-api.yaml
|
|
2670
2670
|
```
|
|
2671
2671
|
|
|
2672
|
-
_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.19/src/commands/openapi/get.ts)_
|
|
2673
2673
|
|
|
2674
2674
|
## `sanity openapi list`
|
|
2675
2675
|
|
|
@@ -2677,7 +2677,7 @@ List all available OpenAPI specifications
|
|
|
2677
2677
|
|
|
2678
2678
|
```
|
|
2679
2679
|
USAGE
|
|
2680
|
-
$
|
|
2680
|
+
$ sanity openapi list [--json] [-w]
|
|
2681
2681
|
|
|
2682
2682
|
FLAGS
|
|
2683
2683
|
-w, --web Open HTTP Reference in web browser
|
|
@@ -2689,18 +2689,18 @@ DESCRIPTION
|
|
|
2689
2689
|
EXAMPLES
|
|
2690
2690
|
List all available OpenAPI specs
|
|
2691
2691
|
|
|
2692
|
-
$
|
|
2692
|
+
$ sanity openapi list
|
|
2693
2693
|
|
|
2694
2694
|
List with JSON output
|
|
2695
2695
|
|
|
2696
|
-
$
|
|
2696
|
+
$ sanity openapi list --json
|
|
2697
2697
|
|
|
2698
2698
|
Open HTTP Reference in browser
|
|
2699
2699
|
|
|
2700
|
-
$
|
|
2700
|
+
$ sanity openapi list --web
|
|
2701
2701
|
```
|
|
2702
2702
|
|
|
2703
|
-
_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.19/src/commands/openapi/list.ts)_
|
|
2704
2704
|
|
|
2705
2705
|
## `sanity preview [OUTPUTDIR]`
|
|
2706
2706
|
|
|
@@ -2708,7 +2708,7 @@ Starts a server to preview a production build
|
|
|
2708
2708
|
|
|
2709
2709
|
```
|
|
2710
2710
|
USAGE
|
|
2711
|
-
$
|
|
2711
|
+
$ sanity preview [OUTPUTDIR] [--host <value>] [--port <value>]
|
|
2712
2712
|
|
|
2713
2713
|
ARGUMENTS
|
|
2714
2714
|
[OUTPUTDIR] Output directory
|
|
@@ -2721,17 +2721,17 @@ DESCRIPTION
|
|
|
2721
2721
|
Starts a server to preview a production build
|
|
2722
2722
|
|
|
2723
2723
|
ALIASES
|
|
2724
|
-
$
|
|
2724
|
+
$ sanity start
|
|
2725
2725
|
|
|
2726
2726
|
EXAMPLES
|
|
2727
|
-
$
|
|
2727
|
+
$ sanity preview --host=0.0.0.0
|
|
2728
2728
|
|
|
2729
|
-
$
|
|
2729
|
+
$ sanity preview --port=1942
|
|
2730
2730
|
|
|
2731
|
-
$
|
|
2731
|
+
$ sanity preview some/build-output-dir
|
|
2732
2732
|
```
|
|
2733
2733
|
|
|
2734
|
-
_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.19/src/commands/preview.ts)_
|
|
2735
2735
|
|
|
2736
2736
|
## `sanity projects create [PROJECTNAME]`
|
|
2737
2737
|
|
|
@@ -2739,7 +2739,7 @@ Create a new Sanity project
|
|
|
2739
2739
|
|
|
2740
2740
|
```
|
|
2741
2741
|
USAGE
|
|
2742
|
-
$
|
|
2742
|
+
$ sanity projects create [PROJECTNAME] [--dataset <value>] [--dataset-visibility private|public] [--json]
|
|
2743
2743
|
[--organization <slug|id>] [-y]
|
|
2744
2744
|
|
|
2745
2745
|
ARGUMENTS
|
|
@@ -2760,26 +2760,26 @@ DESCRIPTION
|
|
|
2760
2760
|
EXAMPLES
|
|
2761
2761
|
Interactively create a project
|
|
2762
2762
|
|
|
2763
|
-
$
|
|
2763
|
+
$ sanity projects create
|
|
2764
2764
|
|
|
2765
2765
|
Create a project named "My New Project"
|
|
2766
2766
|
|
|
2767
|
-
$
|
|
2767
|
+
$ sanity projects create "My New Project"
|
|
2768
2768
|
|
|
2769
2769
|
Create a project in a specific organization
|
|
2770
2770
|
|
|
2771
|
-
$
|
|
2771
|
+
$ sanity projects create "My Project" --organization=my-org
|
|
2772
2772
|
|
|
2773
2773
|
Create a project with a private dataset named "staging"
|
|
2774
2774
|
|
|
2775
|
-
$
|
|
2775
|
+
$ sanity projects create "My Project" --dataset=staging --dataset-visibility=private
|
|
2776
2776
|
|
|
2777
2777
|
Create a project non-interactively with JSON output
|
|
2778
2778
|
|
|
2779
|
-
$
|
|
2779
|
+
$ sanity projects create "CI Project" --yes --json
|
|
2780
2780
|
```
|
|
2781
2781
|
|
|
2782
|
-
_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.19/src/commands/projects/create.ts)_
|
|
2783
2783
|
|
|
2784
2784
|
## `sanity projects list`
|
|
2785
2785
|
|
|
@@ -2787,7 +2787,7 @@ Lists projects connected to your user
|
|
|
2787
2787
|
|
|
2788
2788
|
```
|
|
2789
2789
|
USAGE
|
|
2790
|
-
$
|
|
2790
|
+
$ sanity projects list [--order asc|desc] [--sort id|members|name|url|created]
|
|
2791
2791
|
|
|
2792
2792
|
FLAGS
|
|
2793
2793
|
--order=<option> [default: desc]
|
|
@@ -2801,14 +2801,14 @@ DESCRIPTION
|
|
|
2801
2801
|
EXAMPLES
|
|
2802
2802
|
List projects
|
|
2803
2803
|
|
|
2804
|
-
$
|
|
2804
|
+
$ sanity projects list
|
|
2805
2805
|
|
|
2806
2806
|
List all users of the project, but exclude pending invitations and robots
|
|
2807
2807
|
|
|
2808
|
-
$
|
|
2808
|
+
$ sanity projects list --sort=members --order=asc
|
|
2809
2809
|
```
|
|
2810
2810
|
|
|
2811
|
-
_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.19/src/commands/projects/list.ts)_
|
|
2812
2812
|
|
|
2813
2813
|
## `sanity schema delete`
|
|
2814
2814
|
|
|
@@ -2816,7 +2816,7 @@ Delete schema documents by id
|
|
|
2816
2816
|
|
|
2817
2817
|
```
|
|
2818
2818
|
USAGE
|
|
2819
|
-
$
|
|
2819
|
+
$ sanity schema delete --ids <value> [--dataset <value>] [--verbose]
|
|
2820
2820
|
|
|
2821
2821
|
FLAGS
|
|
2822
2822
|
--dataset=<value> Delete schemas from a specific dataset
|
|
@@ -2829,14 +2829,14 @@ DESCRIPTION
|
|
|
2829
2829
|
EXAMPLES
|
|
2830
2830
|
Delete a single schema
|
|
2831
2831
|
|
|
2832
|
-
$
|
|
2832
|
+
$ sanity schema delete --ids sanity.workspace.schema.workspaceName
|
|
2833
2833
|
|
|
2834
2834
|
Delete multiple schemas
|
|
2835
2835
|
|
|
2836
|
-
$
|
|
2836
|
+
$ sanity schema delete --ids sanity.workspace.schema.workspaceName,prefix.sanity.workspace.schema.otherWorkspace
|
|
2837
2837
|
```
|
|
2838
2838
|
|
|
2839
|
-
_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.19/src/commands/schema/delete.ts)_
|
|
2840
2840
|
|
|
2841
2841
|
## `sanity schema deploy`
|
|
2842
2842
|
|
|
@@ -2844,7 +2844,7 @@ Deploy schema documents into workspace datasets.
|
|
|
2844
2844
|
|
|
2845
2845
|
```
|
|
2846
2846
|
USAGE
|
|
2847
|
-
$
|
|
2847
|
+
$ sanity schema deploy [--extract-manifest] [--manifest-dir <directory>] [--tag <tag>] [--verbose] [--workspace
|
|
2848
2848
|
<name>]
|
|
2849
2849
|
|
|
2850
2850
|
FLAGS
|
|
@@ -2865,14 +2865,14 @@ DESCRIPTION
|
|
|
2865
2865
|
EXAMPLES
|
|
2866
2866
|
Deploy all workspace schemas
|
|
2867
2867
|
|
|
2868
|
-
$
|
|
2868
|
+
$ sanity schema deploy
|
|
2869
2869
|
|
|
2870
2870
|
Deploy the schema for only the workspace "default"
|
|
2871
2871
|
|
|
2872
|
-
$
|
|
2872
|
+
$ sanity schema deploy --workspace default
|
|
2873
2873
|
```
|
|
2874
2874
|
|
|
2875
|
-
_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.19/src/commands/schema/deploy.ts)_
|
|
2876
2876
|
|
|
2877
2877
|
## `sanity schema extract`
|
|
2878
2878
|
|
|
@@ -2880,7 +2880,7 @@ Extracts a JSON representation of a Sanity schema within a Studio context.
|
|
|
2880
2880
|
|
|
2881
2881
|
```
|
|
2882
2882
|
USAGE
|
|
2883
|
-
$
|
|
2883
|
+
$ sanity schema extract [--enforce-required-fields] [--format <format>] [--path <value>] [--watch]
|
|
2884
2884
|
[--watch-patterns <glob>...] [--workspace <name>]
|
|
2885
2885
|
|
|
2886
2886
|
FLAGS
|
|
@@ -2900,18 +2900,18 @@ DESCRIPTION
|
|
|
2900
2900
|
EXAMPLES
|
|
2901
2901
|
Extracts schema types in a Sanity project with more than one workspace
|
|
2902
2902
|
|
|
2903
|
-
$
|
|
2903
|
+
$ sanity schema extract --workspace default
|
|
2904
2904
|
|
|
2905
2905
|
Watch mode - re-extract on changes
|
|
2906
2906
|
|
|
2907
|
-
$
|
|
2907
|
+
$ sanity schema extract --watch
|
|
2908
2908
|
|
|
2909
2909
|
Watch with custom glob patterns
|
|
2910
2910
|
|
|
2911
|
-
$
|
|
2911
|
+
$ sanity schema extract --watch --watch-patterns "lib/**/*.ts"
|
|
2912
2912
|
```
|
|
2913
2913
|
|
|
2914
|
-
_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.19/src/commands/schema/extract.ts)_
|
|
2915
2915
|
|
|
2916
2916
|
## `sanity schema list`
|
|
2917
2917
|
|
|
@@ -2919,7 +2919,7 @@ Lists all schemas in the current dataset.
|
|
|
2919
2919
|
|
|
2920
2920
|
```
|
|
2921
2921
|
USAGE
|
|
2922
|
-
$
|
|
2922
|
+
$ sanity schema list [--id <schema_id>] [--json]
|
|
2923
2923
|
|
|
2924
2924
|
FLAGS
|
|
2925
2925
|
--id=<schema_id> Fetch a single schema by id
|
|
@@ -2936,22 +2936,22 @@ DESCRIPTION
|
|
|
2936
2936
|
EXAMPLES
|
|
2937
2937
|
List all schemas found in any workspace dataset in a table
|
|
2938
2938
|
|
|
2939
|
-
$
|
|
2939
|
+
$ sanity schema list
|
|
2940
2940
|
|
|
2941
2941
|
Get a schema for a given id
|
|
2942
2942
|
|
|
2943
|
-
$
|
|
2943
|
+
$ sanity schema list --id _.schemas.workspaceName
|
|
2944
2944
|
|
|
2945
2945
|
Get stored schemas as pretty-printed json-array
|
|
2946
2946
|
|
|
2947
|
-
$
|
|
2947
|
+
$ sanity schema list --json
|
|
2948
2948
|
|
|
2949
2949
|
Get singular stored schema as pretty-printed json-object
|
|
2950
2950
|
|
|
2951
|
-
$
|
|
2951
|
+
$ sanity schema list --json --id _.schemas.workspaceName
|
|
2952
2952
|
```
|
|
2953
2953
|
|
|
2954
|
-
_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.19/src/commands/schema/list.ts)_
|
|
2955
2955
|
|
|
2956
2956
|
## `sanity schema validate`
|
|
2957
2957
|
|
|
@@ -2959,7 +2959,7 @@ Validates all schema types specified in a workspace
|
|
|
2959
2959
|
|
|
2960
2960
|
```
|
|
2961
2961
|
USAGE
|
|
2962
|
-
$
|
|
2962
|
+
$ sanity schema validate [--debug-metafile-path <value>] [--format pretty|ndjson|json] [--level error|warning]
|
|
2963
2963
|
[--workspace <value>]
|
|
2964
2964
|
|
|
2965
2965
|
FLAGS
|
|
@@ -2979,22 +2979,22 @@ DESCRIPTION
|
|
|
2979
2979
|
EXAMPLES
|
|
2980
2980
|
Validates all schema types in a Sanity project with more than one workspace
|
|
2981
2981
|
|
|
2982
|
-
$
|
|
2982
|
+
$ sanity schema validate --workspace default
|
|
2983
2983
|
|
|
2984
2984
|
Save the results of the report into a file
|
|
2985
2985
|
|
|
2986
|
-
$
|
|
2986
|
+
$ sanity schema validate > report.txt
|
|
2987
2987
|
|
|
2988
2988
|
Report out only errors
|
|
2989
2989
|
|
|
2990
|
-
$
|
|
2990
|
+
$ sanity schema validate --level error
|
|
2991
2991
|
|
|
2992
2992
|
Generate a report which can be analyzed with https://esbuild.github.io/analyze/
|
|
2993
2993
|
|
|
2994
|
-
$
|
|
2994
|
+
$ sanity schema validate --debug-metafile-path metafile.json
|
|
2995
2995
|
```
|
|
2996
2996
|
|
|
2997
|
-
_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.19/src/commands/schema/validate.ts)_
|
|
2998
2998
|
|
|
2999
2999
|
## `sanity start [OUTPUTDIR]`
|
|
3000
3000
|
|
|
@@ -3002,7 +3002,7 @@ Starts a server to preview a production build
|
|
|
3002
3002
|
|
|
3003
3003
|
```
|
|
3004
3004
|
USAGE
|
|
3005
|
-
$
|
|
3005
|
+
$ sanity start [OUTPUTDIR] [--host <value>] [--port <value>]
|
|
3006
3006
|
|
|
3007
3007
|
ARGUMENTS
|
|
3008
3008
|
[OUTPUTDIR] Output directory
|
|
@@ -3015,14 +3015,14 @@ DESCRIPTION
|
|
|
3015
3015
|
Starts a server to preview a production build
|
|
3016
3016
|
|
|
3017
3017
|
ALIASES
|
|
3018
|
-
$
|
|
3018
|
+
$ sanity start
|
|
3019
3019
|
|
|
3020
3020
|
EXAMPLES
|
|
3021
|
-
$
|
|
3021
|
+
$ sanity start --host=0.0.0.0
|
|
3022
3022
|
|
|
3023
|
-
$
|
|
3023
|
+
$ sanity start --port=1942
|
|
3024
3024
|
|
|
3025
|
-
$
|
|
3025
|
+
$ sanity start some/build-output-dir
|
|
3026
3026
|
```
|
|
3027
3027
|
|
|
3028
3028
|
## `sanity telemetry disable`
|
|
@@ -3031,7 +3031,7 @@ Disable telemetry for your logged in user
|
|
|
3031
3031
|
|
|
3032
3032
|
```
|
|
3033
3033
|
USAGE
|
|
3034
|
-
$
|
|
3034
|
+
$ sanity telemetry disable
|
|
3035
3035
|
|
|
3036
3036
|
DESCRIPTION
|
|
3037
3037
|
Disable telemetry for your logged in user
|
|
@@ -3039,10 +3039,10 @@ DESCRIPTION
|
|
|
3039
3039
|
EXAMPLES
|
|
3040
3040
|
Disable telemetry for your logged in user
|
|
3041
3041
|
|
|
3042
|
-
$
|
|
3042
|
+
$ sanity telemetry telemetry disable
|
|
3043
3043
|
```
|
|
3044
3044
|
|
|
3045
|
-
_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.19/src/commands/telemetry/disable.ts)_
|
|
3046
3046
|
|
|
3047
3047
|
## `sanity telemetry enable`
|
|
3048
3048
|
|
|
@@ -3050,7 +3050,7 @@ Enable telemetry for your logged in user
|
|
|
3050
3050
|
|
|
3051
3051
|
```
|
|
3052
3052
|
USAGE
|
|
3053
|
-
$
|
|
3053
|
+
$ sanity telemetry enable
|
|
3054
3054
|
|
|
3055
3055
|
DESCRIPTION
|
|
3056
3056
|
Enable telemetry for your logged in user
|
|
@@ -3058,10 +3058,10 @@ DESCRIPTION
|
|
|
3058
3058
|
EXAMPLES
|
|
3059
3059
|
Enable telemetry for your logged in user
|
|
3060
3060
|
|
|
3061
|
-
$
|
|
3061
|
+
$ sanity telemetry telemetry enable
|
|
3062
3062
|
```
|
|
3063
3063
|
|
|
3064
|
-
_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.19/src/commands/telemetry/enable.ts)_
|
|
3065
3065
|
|
|
3066
3066
|
## `sanity telemetry status`
|
|
3067
3067
|
|
|
@@ -3069,7 +3069,7 @@ Check telemetry consent status for your logged in user
|
|
|
3069
3069
|
|
|
3070
3070
|
```
|
|
3071
3071
|
USAGE
|
|
3072
|
-
$
|
|
3072
|
+
$ sanity telemetry status
|
|
3073
3073
|
|
|
3074
3074
|
DESCRIPTION
|
|
3075
3075
|
Check telemetry consent status for your logged in user
|
|
@@ -3077,10 +3077,10 @@ DESCRIPTION
|
|
|
3077
3077
|
EXAMPLES
|
|
3078
3078
|
Check telemetry consent status for your logged in user
|
|
3079
3079
|
|
|
3080
|
-
$
|
|
3080
|
+
$ sanity telemetry telemetry status
|
|
3081
3081
|
```
|
|
3082
3082
|
|
|
3083
|
-
_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.19/src/commands/telemetry/status.ts)_
|
|
3084
3084
|
|
|
3085
3085
|
## `sanity tokens add [LABEL]`
|
|
3086
3086
|
|
|
@@ -3088,7 +3088,7 @@ Create a new API token for this project
|
|
|
3088
3088
|
|
|
3089
3089
|
```
|
|
3090
3090
|
USAGE
|
|
3091
|
-
$
|
|
3091
|
+
$ sanity tokens add [LABEL] [--json] [--role viewer] [-y]
|
|
3092
3092
|
|
|
3093
3093
|
ARGUMENTS
|
|
3094
3094
|
[LABEL] Label for the new token
|
|
@@ -3104,22 +3104,22 @@ DESCRIPTION
|
|
|
3104
3104
|
EXAMPLES
|
|
3105
3105
|
Create a token with a label
|
|
3106
3106
|
|
|
3107
|
-
$
|
|
3107
|
+
$ sanity tokens add "My API Token"
|
|
3108
3108
|
|
|
3109
3109
|
Create a token with editor role
|
|
3110
3110
|
|
|
3111
|
-
$
|
|
3111
|
+
$ sanity tokens add "My API Token" --role=editor
|
|
3112
3112
|
|
|
3113
3113
|
Create a token in unattended mode
|
|
3114
3114
|
|
|
3115
|
-
$
|
|
3115
|
+
$ sanity tokens add "CI Token" --role=editor --yes
|
|
3116
3116
|
|
|
3117
3117
|
Output token information as JSON
|
|
3118
3118
|
|
|
3119
|
-
$
|
|
3119
|
+
$ sanity tokens add "API Token" --json
|
|
3120
3120
|
```
|
|
3121
3121
|
|
|
3122
|
-
_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.19/src/commands/tokens/add.ts)_
|
|
3123
3123
|
|
|
3124
3124
|
## `sanity tokens delete [TOKENID]`
|
|
3125
3125
|
|
|
@@ -3127,7 +3127,7 @@ Delete an API token from this project
|
|
|
3127
3127
|
|
|
3128
3128
|
```
|
|
3129
3129
|
USAGE
|
|
3130
|
-
$
|
|
3130
|
+
$ sanity tokens delete [TOKENID] [--yes]
|
|
3131
3131
|
|
|
3132
3132
|
ARGUMENTS
|
|
3133
3133
|
[TOKENID] Token ID to delete (will prompt if not provided)
|
|
@@ -3141,18 +3141,18 @@ DESCRIPTION
|
|
|
3141
3141
|
EXAMPLES
|
|
3142
3142
|
Interactively select and delete a token
|
|
3143
3143
|
|
|
3144
|
-
$
|
|
3144
|
+
$ sanity tokens delete
|
|
3145
3145
|
|
|
3146
3146
|
Delete a specific token by ID
|
|
3147
3147
|
|
|
3148
|
-
$
|
|
3148
|
+
$ sanity tokens delete silJ2lFmK6dONB
|
|
3149
3149
|
|
|
3150
3150
|
Delete a specific token without confirmation prompt
|
|
3151
3151
|
|
|
3152
|
-
$
|
|
3152
|
+
$ sanity tokens delete silJ2lFmK6dONB --yes
|
|
3153
3153
|
```
|
|
3154
3154
|
|
|
3155
|
-
_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.19/src/commands/tokens/delete.ts)_
|
|
3156
3156
|
|
|
3157
3157
|
## `sanity tokens list`
|
|
3158
3158
|
|
|
@@ -3160,7 +3160,7 @@ List API tokens for the current project
|
|
|
3160
3160
|
|
|
3161
3161
|
```
|
|
3162
3162
|
USAGE
|
|
3163
|
-
$
|
|
3163
|
+
$ sanity tokens list [--json]
|
|
3164
3164
|
|
|
3165
3165
|
FLAGS
|
|
3166
3166
|
--json Output tokens in JSON format
|
|
@@ -3171,14 +3171,14 @@ DESCRIPTION
|
|
|
3171
3171
|
EXAMPLES
|
|
3172
3172
|
List tokens for the current project
|
|
3173
3173
|
|
|
3174
|
-
$
|
|
3174
|
+
$ sanity tokens list
|
|
3175
3175
|
|
|
3176
3176
|
List tokens in JSON format
|
|
3177
3177
|
|
|
3178
|
-
$
|
|
3178
|
+
$ sanity tokens list --json
|
|
3179
3179
|
```
|
|
3180
3180
|
|
|
3181
|
-
_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.19/src/commands/tokens/list.ts)_
|
|
3182
3182
|
|
|
3183
3183
|
## `sanity typegen generate`
|
|
3184
3184
|
|
|
@@ -3186,7 +3186,7 @@ Sanity TypeGen
|
|
|
3186
3186
|
|
|
3187
3187
|
```
|
|
3188
3188
|
USAGE
|
|
3189
|
-
$
|
|
3189
|
+
$ sanity typegen generate [--config-path <value>] [--watch]
|
|
3190
3190
|
|
|
3191
3191
|
FLAGS
|
|
3192
3192
|
--config-path=<value> [Default: sanity-typegen.json] Specifies the path to the typegen configuration file. This file
|
|
@@ -3221,7 +3221,7 @@ EXAMPLES
|
|
|
3221
3221
|
Generate TypeScript type definitions from a Sanity Studio schema extracted using the `sanity schema extract`
|
|
3222
3222
|
command.
|
|
3223
3223
|
|
|
3224
|
-
$
|
|
3224
|
+
$ sanity typegen generate
|
|
3225
3225
|
```
|
|
3226
3226
|
|
|
3227
3227
|
_See code: [@sanity/codegen](https://github.com/sanity-io/codegen/blob/v5.10.1/src/commands/typegen/generate.ts)_
|
|
@@ -3232,7 +3232,7 @@ Removes the deployed Sanity Studio/App from Sanity hosting
|
|
|
3232
3232
|
|
|
3233
3233
|
```
|
|
3234
3234
|
USAGE
|
|
3235
|
-
$
|
|
3235
|
+
$ sanity undeploy [-y]
|
|
3236
3236
|
|
|
3237
3237
|
FLAGS
|
|
3238
3238
|
-y, --yes Unattended mode, answers "yes" to any "yes/no" prompt and otherwise uses defaults
|
|
@@ -3241,7 +3241,7 @@ DESCRIPTION
|
|
|
3241
3241
|
Removes the deployed Sanity Studio/App from Sanity hosting
|
|
3242
3242
|
```
|
|
3243
3243
|
|
|
3244
|
-
_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.19/src/commands/undeploy.ts)_
|
|
3245
3245
|
|
|
3246
3246
|
## `sanity users invite [EMAIL]`
|
|
3247
3247
|
|
|
@@ -3249,7 +3249,7 @@ Invite a new user to the project
|
|
|
3249
3249
|
|
|
3250
3250
|
```
|
|
3251
3251
|
USAGE
|
|
3252
|
-
$
|
|
3252
|
+
$ sanity users invite [EMAIL] [--role <value>]
|
|
3253
3253
|
|
|
3254
3254
|
ARGUMENTS
|
|
3255
3255
|
[EMAIL] Email address to invite
|
|
@@ -3263,18 +3263,18 @@ DESCRIPTION
|
|
|
3263
3263
|
EXAMPLES
|
|
3264
3264
|
Invite a new user to the project (prompt for details)
|
|
3265
3265
|
|
|
3266
|
-
$
|
|
3266
|
+
$ sanity users invite
|
|
3267
3267
|
|
|
3268
3268
|
Send a new user invite to the email "pippi@sanity.io", prompt for role
|
|
3269
3269
|
|
|
3270
|
-
$
|
|
3270
|
+
$ sanity users invite pippi@sanity.io
|
|
3271
3271
|
|
|
3272
3272
|
Send a new user invite to the email "pippi@sanity.io", as administrator
|
|
3273
3273
|
|
|
3274
|
-
$
|
|
3274
|
+
$ sanity users invite pippi@sanity.io --role administrator
|
|
3275
3275
|
```
|
|
3276
3276
|
|
|
3277
|
-
_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.19/src/commands/users/invite.ts)_
|
|
3278
3278
|
|
|
3279
3279
|
## `sanity users list`
|
|
3280
3280
|
|
|
@@ -3282,7 +3282,7 @@ List all users of the project
|
|
|
3282
3282
|
|
|
3283
3283
|
```
|
|
3284
3284
|
USAGE
|
|
3285
|
-
$
|
|
3285
|
+
$ sanity users list [--invitations] [--order asc|desc] [--robots] [--sort id|name|role|date]
|
|
3286
3286
|
|
|
3287
3287
|
FLAGS
|
|
3288
3288
|
--[no-]invitations Includes or excludes pending invitations
|
|
@@ -3298,18 +3298,18 @@ DESCRIPTION
|
|
|
3298
3298
|
EXAMPLES
|
|
3299
3299
|
List all users of the project
|
|
3300
3300
|
|
|
3301
|
-
$
|
|
3301
|
+
$ sanity users list
|
|
3302
3302
|
|
|
3303
3303
|
List all users of the project, but exclude pending invitations and robots
|
|
3304
3304
|
|
|
3305
|
-
$
|
|
3305
|
+
$ sanity users list --no-invitations --no-robots
|
|
3306
3306
|
|
|
3307
3307
|
List all users, sorted by role
|
|
3308
3308
|
|
|
3309
|
-
$
|
|
3309
|
+
$ sanity users list --sort role
|
|
3310
3310
|
```
|
|
3311
3311
|
|
|
3312
|
-
_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.19/src/commands/users/list.ts)_
|
|
3313
3313
|
|
|
3314
3314
|
## `sanity versions`
|
|
3315
3315
|
|
|
@@ -3317,15 +3317,15 @@ Shows installed versions of Sanity Studio and components
|
|
|
3317
3317
|
|
|
3318
3318
|
```
|
|
3319
3319
|
USAGE
|
|
3320
|
-
$
|
|
3320
|
+
$ sanity versions
|
|
3321
3321
|
|
|
3322
3322
|
DESCRIPTION
|
|
3323
3323
|
Shows installed versions of Sanity Studio and components
|
|
3324
3324
|
|
|
3325
3325
|
EXAMPLES
|
|
3326
|
-
$
|
|
3326
|
+
$ sanity versions
|
|
3327
3327
|
```
|
|
3328
3328
|
|
|
3329
|
-
_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.19/src/commands/versions.ts)_
|
|
3330
3330
|
|
|
3331
3331
|
<!-- commandsstop -->
|