@sanity/cli 6.0.0-alpha.8 → 6.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +728 -258
- package/bin/run.js +2 -0
- package/dist/SanityHelp.js +51 -23
- package/dist/SanityHelp.js.map +1 -1
- package/dist/actions/auth/authServer.js +28 -22
- package/dist/actions/auth/authServer.js.map +1 -1
- package/dist/actions/auth/login/getProvider.js +49 -38
- package/dist/actions/auth/login/getProvider.js.map +1 -1
- package/dist/actions/auth/login/getSSOProvider.js +25 -19
- package/dist/actions/auth/login/getSSOProvider.js.map +1 -1
- package/dist/actions/auth/login/login.js +24 -37
- package/dist/actions/auth/login/login.js.map +1 -1
- package/dist/actions/auth/types.js.map +1 -1
- package/dist/actions/backup/downloadAsset.js +9 -9
- package/dist/actions/backup/downloadAsset.js.map +1 -1
- package/dist/actions/backup/downloadDocument.js +8 -8
- package/dist/actions/backup/downloadDocument.js.map +1 -1
- package/dist/actions/build/buildApp.js +65 -28
- package/dist/actions/build/buildApp.js.map +1 -1
- package/dist/actions/build/buildStaticFiles.js +3 -2
- package/dist/actions/build/buildStaticFiles.js.map +1 -1
- package/dist/actions/build/buildStudio.js +82 -54
- package/dist/actions/build/buildStudio.js.map +1 -1
- package/dist/actions/build/buildVendorDependencies.js +18 -52
- package/dist/actions/build/buildVendorDependencies.js.map +1 -1
- package/dist/actions/build/checkRequiredDependencies.js +13 -8
- package/dist/actions/build/checkRequiredDependencies.js.map +1 -1
- package/dist/actions/build/checkStudioDependencyVersions.js +19 -17
- package/dist/actions/build/checkStudioDependencyVersions.js.map +1 -1
- package/dist/actions/build/createExternalFromImportMap.js +1 -1
- package/dist/actions/build/createExternalFromImportMap.js.map +1 -1
- package/dist/actions/build/determineBasePath.js +5 -2
- package/dist/actions/build/determineBasePath.js.map +1 -1
- package/dist/actions/build/getStudioEnvironmentVariables.js +1 -1
- package/dist/actions/build/getStudioEnvironmentVariables.js.map +1 -1
- package/dist/actions/build/getViteConfig.js +48 -5
- package/dist/actions/build/getViteConfig.js.map +1 -1
- package/dist/actions/build/handlePrereleaseVersions.js +44 -0
- package/dist/actions/build/handlePrereleaseVersions.js.map +1 -0
- package/dist/actions/build/renderDocument.js +6 -10
- package/dist/actions/build/renderDocument.js.map +1 -1
- package/dist/actions/build/renderDocumentWorker/components/BasicDocument.js +4 -4
- package/dist/actions/build/renderDocumentWorker/components/BasicDocument.js.map +1 -1
- package/dist/actions/build/renderDocumentWorker/components/DefaultDocument.js +3 -3
- package/dist/actions/build/renderDocumentWorker/components/DefaultDocument.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/renderDocumentWorker/getDocumentComponent.js +2 -2
- package/dist/actions/build/renderDocumentWorker/getDocumentComponent.js.map +1 -1
- package/dist/actions/build/renderDocumentWorker/renderDocumentWorker.js +1 -1
- package/dist/actions/build/renderDocumentWorker/renderDocumentWorker.js.map +1 -1
- package/dist/actions/build/shouldAutoUpdate.js +5 -3
- package/dist/actions/build/shouldAutoUpdate.js.map +1 -1
- package/dist/actions/build/types.js.map +1 -1
- package/dist/actions/build/writeFavicons.js +3 -5
- package/dist/actions/build/writeFavicons.js.map +1 -1
- package/dist/actions/build/writeSanityRuntime.js +6 -5
- package/dist/actions/build/writeSanityRuntime.js.map +1 -1
- package/dist/actions/codemods/reactIconsV3.js +2 -2
- package/dist/actions/codemods/reactIconsV3.js.map +1 -1
- package/dist/actions/dataset/create.js +10 -6
- package/dist/actions/dataset/create.js.map +1 -1
- package/dist/actions/dataset/determineDatasetAclMode.js.map +1 -1
- package/dist/actions/dataset/resolveDataset.js +26 -0
- package/dist/actions/dataset/resolveDataset.js.map +1 -0
- package/dist/actions/debug/formatters.js +22 -0
- package/dist/actions/debug/formatters.js.map +1 -0
- package/dist/actions/deploy/createStudioUserApplication.js +17 -4
- package/dist/actions/deploy/createStudioUserApplication.js.map +1 -1
- package/dist/actions/deploy/deployApp.js +52 -22
- package/dist/actions/deploy/deployApp.js.map +1 -1
- package/dist/actions/deploy/deployStudio.js +95 -46
- package/dist/actions/deploy/deployStudio.js.map +1 -1
- package/dist/actions/deploy/deployStudioSchemasAndManifests.js +55 -0
- package/dist/actions/deploy/deployStudioSchemasAndManifests.js.map +1 -0
- package/dist/actions/deploy/deployStudioSchemasAndManifests.worker.js +120 -0
- package/dist/actions/deploy/deployStudioSchemasAndManifests.worker.js.map +1 -0
- package/dist/actions/deploy/findUserApplicationForStudio.js +35 -12
- package/dist/actions/deploy/findUserApplicationForStudio.js.map +1 -1
- package/dist/actions/deploy/types.js +10 -1
- package/dist/actions/deploy/types.js.map +1 -1
- package/dist/actions/deploy/urlUtils.js +21 -0
- package/dist/actions/deploy/urlUtils.js.map +1 -0
- package/dist/actions/dev/getDashboardAppUrl.js +48 -0
- package/dist/actions/dev/getDashboardAppUrl.js.map +1 -0
- package/dist/actions/dev/getDevServerConfig.js +7 -3
- package/dist/actions/dev/getDevServerConfig.js.map +1 -1
- package/dist/actions/dev/startAppDevServer.js +7 -4
- package/dist/actions/dev/startAppDevServer.js.map +1 -1
- package/dist/actions/dev/startStudioDevServer.js +23 -19
- package/dist/actions/dev/startStudioDevServer.js.map +1 -1
- package/dist/actions/doctor/checks/cliInstallation.js +56 -0
- package/dist/actions/doctor/checks/cliInstallation.js.map +1 -0
- package/dist/actions/doctor/checks/index.js +16 -0
- package/dist/actions/doctor/checks/index.js.map +1 -0
- package/dist/actions/doctor/runDoctorChecks.js +56 -0
- package/dist/actions/doctor/runDoctorChecks.js.map +1 -0
- package/dist/actions/doctor/types.js.map +1 -0
- package/dist/actions/documents/types.js.map +1 -1
- package/dist/actions/documents/validate.js +15 -17
- package/dist/actions/documents/validate.js.map +1 -1
- package/dist/{threads/validateDocuments.js → actions/documents/validateDocuments.worker.js} +37 -37
- package/dist/actions/documents/validateDocuments.worker.js.map +1 -0
- package/dist/actions/documents/validation/reporters/jsonReporter.js +1 -1
- package/dist/actions/documents/validation/reporters/jsonReporter.js.map +1 -1
- package/dist/actions/documents/validation/reporters/ndjsonReporter.js +1 -1
- package/dist/actions/documents/validation/reporters/ndjsonReporter.js.map +1 -1
- package/dist/actions/documents/validation/reporters/prettyReporter/formatDocumentValidation.js +9 -8
- package/dist/actions/documents/validation/reporters/prettyReporter/formatDocumentValidation.js.map +1 -1
- package/dist/actions/documents/validation/reporters/prettyReporter/prettyReporter.js.map +1 -1
- package/dist/actions/documents/validation/reporters/prettyReporter/tree.js +108 -0
- package/dist/actions/documents/validation/reporters/prettyReporter/tree.js.map +1 -0
- package/dist/{threads/configClient.js → actions/exec/configClient.worker.js} +2 -2
- package/dist/actions/exec/configClient.worker.js.map +1 -0
- package/dist/actions/exec/execScript.js +29 -25
- package/dist/actions/exec/execScript.js.map +1 -1
- package/dist/{threads/registerBrowserEnv.js → actions/exec/registerBrowserEnv.worker.js} +1 -1
- package/dist/actions/exec/registerBrowserEnv.worker.js.map +1 -0
- package/dist/actions/graphql/SchemaError.js +15 -0
- package/dist/actions/graphql/SchemaError.js.map +1 -0
- package/dist/actions/graphql/__tests__/fixtures/many-self-refs.js +540 -0
- package/dist/actions/graphql/__tests__/fixtures/many-self-refs.js.map +1 -0
- package/dist/actions/graphql/__tests__/fixtures/test-studio.js +1143 -0
- package/dist/actions/graphql/__tests__/fixtures/test-studio.js.map +1 -0
- package/dist/actions/graphql/__tests__/fixtures/union-refs.js +591 -0
- package/dist/actions/graphql/__tests__/fixtures/union-refs.js.map +1 -0
- package/dist/actions/graphql/__tests__/helpers.js +23 -0
- package/dist/actions/graphql/__tests__/helpers.js.map +1 -0
- package/dist/actions/graphql/extractFromSanitySchema.js +659 -0
- package/dist/actions/graphql/extractFromSanitySchema.js.map +1 -0
- package/dist/actions/graphql/extractGraphQLAPIs.js +150 -0
- package/dist/actions/graphql/extractGraphQLAPIs.js.map +1 -0
- package/dist/actions/graphql/extractGraphQLAPIs.worker.js +12 -0
- package/dist/actions/graphql/extractGraphQLAPIs.worker.js.map +1 -0
- package/dist/actions/graphql/gen1/generateTypeFilters.js +226 -0
- package/dist/actions/graphql/gen1/generateTypeFilters.js.map +1 -0
- package/dist/actions/graphql/gen1/generateTypeQueries.js +86 -0
- package/dist/actions/graphql/gen1/generateTypeQueries.js.map +1 -0
- package/dist/actions/graphql/gen1/index.js +19 -0
- package/dist/actions/graphql/gen1/index.js.map +1 -0
- package/dist/actions/graphql/gen2/filters/booleanFilters.js +26 -0
- package/dist/actions/graphql/gen2/filters/booleanFilters.js.map +1 -0
- package/dist/actions/graphql/gen2/filters/dateFilters.js +46 -0
- package/dist/actions/graphql/gen2/filters/dateFilters.js.map +1 -0
- package/dist/actions/graphql/gen2/filters/dateTimeFilters.js +46 -0
- package/dist/actions/graphql/gen2/filters/dateTimeFilters.js.map +1 -0
- package/dist/actions/graphql/gen2/filters/documentFilters.js +21 -0
- package/dist/actions/graphql/gen2/filters/documentFilters.js.map +1 -0
- package/dist/actions/graphql/gen2/filters/floatFilters.js +46 -0
- package/dist/actions/graphql/gen2/filters/floatFilters.js.map +1 -0
- package/dist/actions/graphql/gen2/filters/idFilters.js +44 -0
- package/dist/actions/graphql/gen2/filters/idFilters.js.map +1 -0
- package/dist/actions/graphql/gen2/filters/integerFilters.js +46 -0
- package/dist/actions/graphql/gen2/filters/integerFilters.js.map +1 -0
- package/dist/actions/graphql/gen2/filters/stringFilters.js +49 -0
- package/dist/actions/graphql/gen2/filters/stringFilters.js.map +1 -0
- package/dist/actions/graphql/gen2/generateTypeFilters.js +85 -0
- package/dist/actions/graphql/gen2/generateTypeFilters.js.map +1 -0
- package/dist/actions/graphql/gen2/generateTypeQueries.js +107 -0
- package/dist/actions/graphql/gen2/generateTypeQueries.js.map +1 -0
- package/dist/actions/graphql/gen2/generateTypeSortings.js +70 -0
- package/dist/actions/graphql/gen2/generateTypeSortings.js.map +1 -0
- package/dist/actions/graphql/gen2/index.js +22 -0
- package/dist/actions/graphql/gen2/index.js.map +1 -0
- package/dist/actions/graphql/gen3/filters/documentFilters.js +21 -0
- package/dist/actions/graphql/gen3/filters/documentFilters.js.map +1 -0
- package/dist/actions/graphql/gen3/generateTypeFilters.js +101 -0
- package/dist/actions/graphql/gen3/generateTypeFilters.js.map +1 -0
- package/dist/actions/graphql/gen3/generateTypeQueries.js +103 -0
- package/dist/actions/graphql/gen3/generateTypeQueries.js.map +1 -0
- package/dist/actions/graphql/gen3/generateTypeSortings.js +70 -0
- package/dist/actions/graphql/gen3/generateTypeSortings.js.map +1 -0
- package/dist/actions/graphql/gen3/index.js +30 -0
- package/dist/actions/graphql/gen3/index.js.map +1 -0
- package/dist/actions/graphql/gen3/utils.js +12 -0
- package/dist/actions/graphql/gen3/utils.js.map +1 -0
- package/dist/actions/graphql/getGraphQLAPIs.js +15 -57
- package/dist/actions/graphql/getGraphQLAPIs.js.map +1 -1
- package/dist/actions/graphql/getGraphQLAPIs.worker.js +75 -106
- package/dist/actions/graphql/getGraphQLAPIs.worker.js.map +1 -1
- package/dist/actions/graphql/graphqlDebug.js +4 -0
- package/dist/actions/graphql/graphqlDebug.js.map +1 -0
- package/dist/actions/graphql/helpUrls.js +3 -0
- package/dist/actions/graphql/helpUrls.js.map +1 -0
- package/dist/actions/graphql/helpers.js +24 -0
- package/dist/actions/graphql/helpers.js.map +1 -0
- package/dist/actions/graphql/resolveApiGeneration.js +43 -0
- package/dist/actions/graphql/resolveApiGeneration.js.map +1 -0
- package/dist/actions/graphql/resolveGraphQLApisFromWorkspaces.js +187 -0
- package/dist/actions/graphql/resolveGraphQLApisFromWorkspaces.js.map +1 -0
- package/dist/actions/graphql/types.js.map +1 -1
- package/dist/actions/init/bootstrapLocalTemplate.js +13 -10
- package/dist/actions/init/bootstrapLocalTemplate.js.map +1 -1
- package/dist/actions/init/bootstrapRemoteTemplate.js +6 -5
- package/dist/actions/init/bootstrapRemoteTemplate.js.map +1 -1
- package/dist/actions/init/bootstrapTemplate.js.map +1 -1
- package/dist/actions/init/checkNextJsReactCompatibility.js +1 -1
- package/dist/actions/init/checkNextJsReactCompatibility.js.map +1 -1
- package/dist/actions/init/createAppCliConfig.js.map +1 -1
- package/dist/actions/init/createCliConfig.js.map +1 -1
- package/dist/actions/init/createPackageManifest.js +21 -9
- package/dist/actions/init/createPackageManifest.js.map +1 -1
- package/dist/actions/init/env/createOrAppendEnvVars.js +2 -2
- package/dist/actions/init/env/createOrAppendEnvVars.js.map +1 -1
- package/dist/actions/init/env/writeEnvVarsToFile.js +2 -2
- package/dist/actions/init/env/writeEnvVarsToFile.js.map +1 -1
- package/dist/actions/init/fetchPostInitPrompt.js +2 -2
- package/dist/actions/init/fetchPostInitPrompt.js.map +1 -1
- package/dist/actions/init/remoteTemplate.js +1 -2
- package/dist/actions/init/remoteTemplate.js.map +1 -1
- package/dist/actions/init/resolvePackageManager.js +2 -2
- package/dist/actions/init/resolvePackageManager.js.map +1 -1
- package/dist/actions/init/sdkAppDependencies.js +19 -0
- package/dist/actions/init/sdkAppDependencies.js.map +1 -0
- package/dist/actions/init/studioDependencies.js.map +1 -0
- package/dist/actions/init/templates/appQuickstart.js +1 -22
- package/dist/actions/init/templates/appQuickstart.js.map +1 -1
- package/dist/actions/init/templates/appSanityUi.js +3 -22
- package/dist/actions/init/templates/appSanityUi.js.map +1 -1
- package/dist/actions/init/types.js.map +1 -1
- package/dist/actions/manifest/SchemaIcon.js +6 -4
- package/dist/actions/manifest/SchemaIcon.js.map +1 -1
- package/dist/actions/manifest/blockTypeTransformer.js +67 -0
- package/dist/actions/manifest/blockTypeTransformer.js.map +1 -0
- package/dist/actions/manifest/debug.js +4 -0
- package/dist/actions/manifest/debug.js.map +1 -0
- package/dist/actions/manifest/extractAppManifest.js +39 -22
- package/dist/actions/manifest/extractAppManifest.js.map +1 -1
- package/dist/actions/manifest/extractManifest.js +27 -78
- package/dist/actions/manifest/extractManifest.js.map +1 -1
- package/dist/actions/manifest/extractManifest.worker.js +30 -0
- package/dist/actions/manifest/extractManifest.worker.js.map +1 -0
- package/dist/actions/manifest/extractWorkspaceManifest.js +31 -372
- package/dist/actions/manifest/extractWorkspaceManifest.js.map +1 -1
- package/dist/actions/manifest/iconResolver.js +30 -0
- package/dist/actions/manifest/iconResolver.js.map +1 -0
- package/dist/actions/manifest/referenceTransformer.js +51 -0
- package/dist/actions/manifest/referenceTransformer.js.map +1 -0
- package/dist/actions/manifest/schemaTypeHelpers.js +2 -2
- package/dist/actions/manifest/schemaTypeHelpers.js.map +1 -1
- package/dist/actions/manifest/schemaTypeTransformer.js +168 -0
- package/dist/actions/manifest/schemaTypeTransformer.js.map +1 -0
- package/dist/actions/manifest/transformerUtils.js +40 -0
- package/dist/actions/manifest/transformerUtils.js.map +1 -0
- package/dist/actions/manifest/types.js +5 -0
- package/dist/actions/manifest/types.js.map +1 -1
- package/dist/actions/manifest/validationTransformer.js +84 -0
- package/dist/actions/manifest/validationTransformer.js.map +1 -0
- package/dist/actions/manifest/writeManifestFile.js +30 -0
- package/dist/actions/manifest/writeManifestFile.js.map +1 -0
- package/dist/actions/manifest/writeWorkspaceFiles.js +30 -0
- package/dist/actions/manifest/writeWorkspaceFiles.js.map +1 -0
- package/dist/actions/mcp/detectAvailableEditors.js +75 -58
- package/dist/actions/mcp/detectAvailableEditors.js.map +1 -1
- package/dist/actions/mcp/editorConfigs.js +205 -0
- package/dist/actions/mcp/editorConfigs.js.map +1 -0
- package/dist/actions/mcp/promptForMCPSetup.js +24 -0
- package/dist/actions/mcp/promptForMCPSetup.js.map +1 -0
- package/dist/actions/mcp/setupMCP.js +88 -0
- package/dist/actions/mcp/setupMCP.js.map +1 -0
- package/dist/actions/mcp/types.js +3 -0
- package/dist/actions/mcp/types.js.map +1 -0
- package/dist/actions/mcp/writeMCPConfig.js +35 -28
- package/dist/actions/mcp/writeMCPConfig.js.map +1 -1
- package/dist/actions/media/buildNdjsonIndex.js +32 -0
- package/dist/actions/media/buildNdjsonIndex.js.map +1 -0
- package/dist/actions/media/importAspects.js +2 -11
- package/dist/actions/media/importAspects.js.map +1 -1
- package/dist/actions/media/importMedia.js +24 -20
- package/dist/actions/media/importMedia.js.map +1 -1
- package/dist/actions/organizations/findOrganizationByUserName.js +5 -0
- package/dist/actions/organizations/findOrganizationByUserName.js.map +1 -0
- package/dist/actions/organizations/getOrganization.js +68 -0
- package/dist/actions/organizations/getOrganization.js.map +1 -0
- package/dist/actions/organizations/getOrganizationChoices.js +27 -19
- package/dist/actions/organizations/getOrganizationChoices.js.map +1 -1
- package/dist/actions/organizations/hasProjectAttachGrant.js +1 -1
- package/dist/actions/organizations/hasProjectAttachGrant.js.map +1 -1
- package/dist/actions/organizations/types.js +3 -0
- package/dist/actions/organizations/types.js.map +1 -0
- package/dist/actions/organizations/validateOrganizationName.js +10 -0
- package/dist/actions/organizations/validateOrganizationName.js.map +1 -0
- package/dist/actions/preview/previewAction.js +2 -1
- package/dist/actions/preview/previewAction.js.map +1 -1
- package/dist/actions/projects/getManageUrl.js +6 -0
- package/dist/actions/projects/getManageUrl.js.map +1 -0
- package/dist/actions/projects/validateProjectName.js +11 -0
- package/dist/actions/projects/validateProjectName.js.map +1 -0
- package/dist/actions/schema/deleteSchemaAction.js +16 -32
- package/dist/actions/schema/deleteSchemaAction.js.map +1 -1
- package/dist/actions/schema/deploySchemas.js +22 -91
- package/dist/actions/schema/deploySchemas.js.map +1 -1
- package/dist/actions/schema/extractSanitySchema.worker.js +33 -0
- package/dist/actions/schema/extractSanitySchema.worker.js.map +1 -0
- package/dist/actions/schema/extractSanityWorkspace.worker.js +24 -0
- package/dist/actions/schema/extractSanityWorkspace.worker.js.map +1 -0
- package/dist/actions/schema/extractSchema.js +45 -0
- package/dist/actions/schema/extractSchema.js.map +1 -0
- package/dist/actions/schema/extractSchemaWatcher.js +128 -0
- package/dist/actions/schema/extractSchemaWatcher.js.map +1 -0
- package/dist/actions/schema/formatSchemaValidation.js +22 -6
- package/dist/actions/schema/formatSchemaValidation.js.map +1 -1
- package/dist/actions/schema/getExtractOptions.js +16 -0
- package/dist/actions/schema/getExtractOptions.js.map +1 -0
- package/dist/actions/schema/listSchemas.js +54 -57
- package/dist/actions/schema/listSchemas.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/metafile.js.map +1 -1
- package/dist/actions/schema/runSchemaExtraction.js +39 -0
- package/dist/actions/schema/runSchemaExtraction.js.map +1 -0
- package/dist/actions/schema/types.js +17 -0
- package/dist/actions/schema/types.js.map +1 -0
- package/dist/actions/schema/uniqueWorkspaces.worker.js +24 -0
- package/dist/actions/schema/uniqueWorkspaces.worker.js.map +1 -0
- package/dist/actions/schema/updateWorkspaceSchema.js +63 -0
- package/dist/actions/schema/updateWorkspaceSchema.js.map +1 -0
- package/dist/actions/schema/uploadSchemaToLexicon.js +87 -0
- package/dist/actions/schema/uploadSchemaToLexicon.js.map +1 -0
- package/dist/actions/schema/utils/SchemaExtractionError.js +10 -0
- package/dist/actions/schema/utils/SchemaExtractionError.js.map +1 -0
- package/dist/actions/schema/utils/debug.js +1 -0
- package/dist/actions/schema/utils/debug.js.map +1 -1
- package/dist/actions/schema/utils/extractValidationFromSchemaError.js +12 -0
- package/dist/actions/schema/utils/extractValidationFromSchemaError.js.map +1 -0
- package/dist/actions/schema/utils/schemaStoreValidation.js +1 -15
- package/dist/actions/schema/utils/schemaStoreValidation.js.map +1 -1
- package/dist/actions/schema/utils/uniqByProjectIdDataset.js +1 -1
- package/dist/actions/schema/utils/uniqByProjectIdDataset.js.map +1 -1
- package/dist/actions/schema/validateAction.js +7 -17
- package/dist/actions/schema/validateAction.js.map +1 -1
- package/dist/{threads/validateSchema.js → actions/schema/validateSchema.worker.js} +28 -26
- package/dist/actions/schema/validateSchema.worker.js.map +1 -0
- package/dist/actions/schema/watchExtractSchema.js +72 -0
- package/dist/actions/schema/watchExtractSchema.js.map +1 -0
- package/dist/actions/telemetry/getLearnMoreMessage.js.map +1 -1
- package/dist/actions/telemetry/getStatusDisplay.js.map +1 -1
- package/dist/actions/telemetry/getStatusMessage.js.map +1 -1
- package/dist/actions/telemetry/isTrueish.js +10 -0
- package/dist/actions/telemetry/isTrueish.js.map +1 -0
- package/dist/actions/telemetry/resolveConsent.js +3 -3
- package/dist/actions/telemetry/resolveConsent.js.map +1 -1
- package/dist/actions/telemetry/setConsent.js +3 -2
- package/dist/actions/telemetry/setConsent.js.map +1 -1
- package/dist/actions/telemetry/telemetryDisclosure.js +3 -3
- package/dist/actions/telemetry/telemetryDisclosure.js.map +1 -1
- package/dist/actions/users/getMembersForProject.js.map +1 -1
- package/dist/actions/users/getPendingInvitations.js +1 -1
- package/dist/actions/users/getPendingInvitations.js.map +1 -1
- package/dist/actions/users/types.js.map +1 -1
- package/dist/actions/versions/filterSanityModules.js.map +1 -1
- package/dist/actions/versions/findSanityModulesVersions.js +2 -3
- package/dist/actions/versions/findSanityModulesVersions.js.map +1 -1
- package/dist/actions/versions/getFormatters.js +3 -3
- package/dist/actions/versions/getFormatters.js.map +1 -1
- package/dist/actions/versions/tryFindLatestVersion.js +1 -1
- package/dist/actions/versions/tryFindLatestVersion.js.map +1 -1
- package/dist/commands/backup/disable.js +26 -10
- package/dist/commands/backup/disable.js.map +1 -1
- package/dist/commands/backup/download.js +26 -17
- package/dist/commands/backup/download.js.map +1 -1
- package/dist/commands/backup/enable.js +25 -10
- package/dist/commands/backup/enable.js.map +1 -1
- package/dist/commands/backup/list.js +20 -8
- package/dist/commands/backup/list.js.map +1 -1
- package/dist/commands/build.js +2 -5
- package/dist/commands/build.js.map +1 -1
- package/dist/commands/cors/add.js +33 -16
- package/dist/commands/cors/add.js.map +1 -1
- package/dist/commands/cors/delete.js +22 -7
- package/dist/commands/cors/delete.js.map +1 -1
- package/dist/commands/cors/list.js +22 -7
- package/dist/commands/cors/list.js.map +1 -1
- package/dist/commands/dataset/alias/create.js +26 -7
- package/dist/commands/dataset/alias/create.js.map +1 -1
- package/dist/commands/dataset/alias/delete.js +20 -7
- package/dist/commands/dataset/alias/delete.js.map +1 -1
- package/dist/commands/dataset/alias/link.js +20 -7
- package/dist/commands/dataset/alias/link.js.map +1 -1
- package/dist/commands/dataset/alias/unlink.js +20 -7
- package/dist/commands/dataset/alias/unlink.js.map +1 -1
- package/dist/commands/dataset/copy.js +51 -35
- package/dist/commands/dataset/copy.js.map +1 -1
- package/dist/commands/dataset/create.js +46 -14
- package/dist/commands/dataset/create.js.map +1 -1
- package/dist/commands/dataset/delete.js +28 -9
- package/dist/commands/dataset/delete.js.map +1 -1
- package/dist/commands/dataset/embeddings/disable.js +77 -0
- package/dist/commands/dataset/embeddings/disable.js.map +1 -0
- package/dist/commands/dataset/embeddings/enable.js +141 -0
- package/dist/commands/dataset/embeddings/enable.js.map +1 -0
- package/dist/commands/dataset/embeddings/status.js +72 -0
- package/dist/commands/dataset/embeddings/status.js.map +1 -0
- package/dist/commands/dataset/export.js +26 -18
- package/dist/commands/dataset/export.js.map +1 -1
- package/dist/commands/dataset/import.js +306 -1
- package/dist/commands/dataset/import.js.map +1 -1
- package/dist/commands/dataset/list.js +22 -7
- package/dist/commands/dataset/list.js.map +1 -1
- package/dist/commands/dataset/visibility/get.js +18 -7
- package/dist/commands/dataset/visibility/get.js.map +1 -1
- package/dist/commands/dataset/visibility/set.js +22 -7
- package/dist/commands/dataset/visibility/set.js.map +1 -1
- package/dist/commands/debug.js +9 -7
- package/dist/commands/debug.js.map +1 -1
- package/dist/commands/deploy.js +22 -11
- package/dist/commands/deploy.js.map +1 -1
- package/dist/commands/dev.js +7 -6
- package/dist/commands/dev.js.map +1 -1
- package/dist/commands/docs/search.js +3 -2
- package/dist/commands/docs/search.js.map +1 -1
- package/dist/commands/doctor.js +125 -0
- package/dist/commands/doctor.js.map +1 -0
- package/dist/commands/documents/create.js +19 -12
- package/dist/commands/documents/create.js.map +1 -1
- package/dist/commands/documents/delete.js +19 -12
- package/dist/commands/documents/delete.js.map +1 -1
- package/dist/commands/documents/get.js +17 -12
- package/dist/commands/documents/get.js.map +1 -1
- package/dist/commands/documents/query.js +26 -18
- package/dist/commands/documents/query.js.map +1 -1
- package/dist/commands/documents/validate.js +74 -48
- package/dist/commands/documents/validate.js.map +1 -1
- package/dist/commands/graphql/deploy.js +457 -0
- package/dist/commands/graphql/deploy.js.map +1 -0
- package/dist/commands/graphql/list.js +21 -13
- package/dist/commands/graphql/list.js.map +1 -1
- package/dist/commands/graphql/undeploy.js +37 -19
- package/dist/commands/graphql/undeploy.js.map +1 -1
- package/dist/commands/hook/attempt.js +22 -7
- package/dist/commands/hook/attempt.js.map +1 -1
- package/dist/commands/hook/create.js +23 -8
- package/dist/commands/hook/create.js.map +1 -1
- package/dist/commands/hook/delete.js +22 -7
- package/dist/commands/hook/delete.js.map +1 -1
- package/dist/commands/hook/list.js +22 -7
- package/dist/commands/hook/list.js.map +1 -1
- package/dist/commands/hook/logs.js +25 -12
- package/dist/commands/hook/logs.js.map +1 -1
- package/dist/commands/init.js +164 -143
- package/dist/commands/init.js.map +1 -1
- package/dist/commands/login.js +19 -6
- package/dist/commands/login.js.map +1 -1
- package/dist/commands/logout.js +8 -6
- package/dist/commands/logout.js.map +1 -1
- package/dist/commands/manage.js +2 -2
- package/dist/commands/manage.js.map +1 -1
- package/dist/commands/manifest/extract.js +14 -10
- package/dist/commands/manifest/extract.js.map +1 -1
- package/dist/commands/mcp/configure.js +14 -75
- package/dist/commands/mcp/configure.js.map +1 -1
- package/dist/commands/media/create-aspect.js +11 -10
- package/dist/commands/media/create-aspect.js.map +1 -1
- package/dist/commands/media/delete-aspect.js +14 -11
- package/dist/commands/media/delete-aspect.js.map +1 -1
- package/dist/commands/media/deploy-aspect.js +31 -17
- package/dist/commands/media/deploy-aspect.js.map +1 -1
- package/dist/commands/media/export.js +10 -9
- package/dist/commands/media/export.js.map +1 -1
- package/dist/commands/media/import.js +14 -12
- package/dist/commands/media/import.js.map +1 -1
- package/dist/commands/preview.js +12 -28
- package/dist/commands/preview.js.map +1 -1
- package/dist/commands/projects/create.js +181 -0
- package/dist/commands/projects/create.js.map +1 -0
- package/dist/commands/projects/list.js +4 -3
- package/dist/commands/projects/list.js.map +1 -1
- package/dist/commands/schema/delete.js +33 -34
- package/dist/commands/schema/delete.js.map +1 -1
- package/dist/commands/schema/deploy.js +19 -30
- package/dist/commands/schema/deploy.js.map +1 -1
- package/dist/commands/schema/extract.js +34 -11
- package/dist/commands/schema/extract.js.map +1 -1
- package/dist/commands/schema/list.js +10 -31
- package/dist/commands/schema/list.js.map +1 -1
- package/dist/commands/schema/validate.js +10 -2
- package/dist/commands/schema/validate.js.map +1 -1
- package/dist/commands/tokens/add.js +24 -7
- package/dist/commands/tokens/add.js.map +1 -1
- package/dist/commands/tokens/delete.js +20 -7
- package/dist/commands/tokens/delete.js.map +1 -1
- package/dist/commands/tokens/list.js +20 -7
- package/dist/commands/tokens/list.js.map +1 -1
- package/dist/commands/undeploy.js +9 -8
- package/dist/commands/undeploy.js.map +1 -1
- package/dist/commands/users/invite.js +24 -7
- package/dist/commands/users/invite.js.map +1 -1
- package/dist/commands/users/list.js +77 -34
- package/dist/commands/users/list.js.map +1 -1
- package/dist/commands/versions.js +3 -3
- package/dist/commands/versions.js.map +1 -1
- package/dist/config/createCliConfig.js +2 -2
- package/dist/config/createCliConfig.js.map +1 -1
- package/dist/exports/_internal.d.ts +132 -0
- package/dist/exports/_internal.js +4 -0
- package/dist/exports/_internal.js.map +1 -0
- package/dist/exports/index.d.ts +113 -0
- package/dist/exports/index.js +6 -0
- package/dist/exports/index.js.map +1 -0
- package/dist/hooks/init/checkForUpdates.js +14 -0
- package/dist/hooks/init/checkForUpdates.js.map +1 -0
- package/dist/hooks/prerun/flushTelemetry.worker.js +1 -1
- package/dist/hooks/prerun/flushTelemetry.worker.js.map +1 -1
- package/dist/hooks/prerun/injectEnvVariables.js +39 -0
- package/dist/hooks/prerun/injectEnvVariables.js.map +1 -0
- package/dist/hooks/prerun/setupTelemetry.js +14 -7
- package/dist/hooks/prerun/setupTelemetry.js.map +1 -1
- package/dist/hooks/prerun/warnings.js +6 -0
- package/dist/hooks/prerun/warnings.js.map +1 -0
- package/dist/prompts/promptForDefaultConfig.js +12 -0
- package/dist/prompts/promptForDefaultConfig.js.map +1 -0
- package/dist/prompts/promptForOrganizationName.js +11 -0
- package/dist/prompts/promptForOrganizationName.js.map +1 -0
- package/dist/prompts/promptForProject.js +64 -0
- package/dist/prompts/promptForProject.js.map +1 -0
- package/dist/prompts/promptForProjectName.js +11 -0
- package/dist/prompts/promptForProjectName.js.map +1 -0
- package/dist/{actions/auth/login/promptProviders.js → prompts/promptForProviders.js} +3 -3
- package/dist/prompts/promptForProviders.js.map +1 -0
- package/dist/prompts/selectMediaLibrary.js +1 -1
- package/dist/prompts/selectMediaLibrary.js.map +1 -1
- package/dist/server/devServer.js +4 -2
- package/dist/server/devServer.js.map +1 -1
- package/dist/server/previewServer.js +17 -11
- package/dist/server/previewServer.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/auth.js +42 -3
- package/dist/services/auth.js.map +1 -1
- package/dist/services/datasets.js +7 -5
- package/dist/services/datasets.js.map +1 -1
- package/dist/services/docs.js +2 -2
- package/dist/services/docs.js.map +1 -1
- package/dist/services/documents.js +56 -0
- package/dist/services/documents.js.map +1 -0
- package/dist/services/embeddings.js +25 -0
- package/dist/services/embeddings.js.map +1 -0
- package/dist/services/getUrlHeaders.js +25 -0
- package/dist/services/getUrlHeaders.js.map +1 -0
- package/dist/services/grants.js +13 -0
- package/dist/services/grants.js.map +1 -0
- package/dist/services/graphql.js +64 -0
- package/dist/services/graphql.js.map +1 -1
- package/dist/services/mcp.js.map +1 -1
- package/dist/services/organizations.js +1 -1
- package/dist/services/organizations.js.map +1 -1
- package/dist/services/projects.js +4 -2
- package/dist/services/projects.js.map +1 -1
- package/dist/services/schemas.js +1 -1
- package/dist/services/schemas.js.map +1 -1
- package/dist/services/telemetry.js +63 -2
- package/dist/services/telemetry.js.map +1 -1
- package/dist/services/userApplications.js +21 -6
- package/dist/services/userApplications.js.map +1 -1
- package/dist/telemetry/build.telemetry.js +13 -0
- package/dist/telemetry/build.telemetry.js.map +1 -0
- package/dist/telemetry/extractSchema.telemetry.js +18 -0
- package/dist/telemetry/extractSchema.telemetry.js.map +1 -0
- package/dist/telemetry/init.telemetry.js +8 -0
- package/dist/telemetry/init.telemetry.js.map +1 -0
- package/dist/telemetry/login.telemetry.js +8 -0
- package/dist/telemetry/login.telemetry.js.map +1 -0
- package/dist/telemetry/mcp.telemetry.js +8 -0
- package/dist/telemetry/mcp.telemetry.js.map +1 -0
- package/dist/types/grants.js +3 -0
- package/dist/types/grants.js.map +1 -0
- package/dist/types.js +6 -1
- package/dist/types.js.map +1 -1
- package/dist/util/appId.js +5 -5
- package/dist/util/appId.js.map +1 -1
- package/dist/util/checkProjectPermissions.js +21 -0
- package/dist/util/checkProjectPermissions.js.map +1 -0
- package/dist/util/cliClient.js +13 -10
- package/dist/util/cliClient.js.map +1 -1
- package/dist/util/compareDependencyVersions.js +74 -38
- package/dist/util/compareDependencyVersions.js.map +1 -1
- package/dist/util/createExpiringConfig.js +64 -0
- package/dist/util/createExpiringConfig.js.map +1 -0
- package/dist/util/detectFramework.js +135 -0
- package/dist/util/detectFramework.js.map +1 -0
- package/dist/util/errorMessages.js +0 -1
- package/dist/util/errorMessages.js.map +1 -1
- package/dist/util/extractDocumentsFromNdjsonOrTarball.js +1 -2
- package/dist/util/extractDocumentsFromNdjsonOrTarball.js.map +1 -1
- package/dist/util/formatSize.js +2 -2
- package/dist/util/formatSize.js.map +1 -1
- package/dist/util/getCliVersion.js +1 -1
- package/dist/util/getCliVersion.js.map +1 -1
- package/dist/util/getLocalPackageVersion.js +31 -23
- package/dist/util/getLocalPackageVersion.js.map +1 -1
- package/dist/util/getProjectDefaults.js.map +1 -1
- package/dist/util/getSanityEnv.js +3 -0
- package/dist/util/getSanityEnv.js.map +1 -0
- package/dist/util/getSharedServerConfig.js +1 -0
- package/dist/util/getSharedServerConfig.js.map +1 -1
- package/dist/util/getWorkspace.js +1 -1
- package/dist/util/getWorkspace.js.map +1 -1
- package/dist/util/isSchemaError.js +11 -0
- package/dist/util/isSchemaError.js.map +1 -0
- package/dist/util/isTar.js +8 -0
- package/dist/util/isTar.js.map +1 -0
- package/dist/util/loadEnv.js +1 -6
- package/dist/util/loadEnv.js.map +1 -1
- package/dist/util/packageManager/getPeerDependencies.js +44 -0
- package/dist/util/packageManager/getPeerDependencies.js.map +1 -0
- package/dist/util/packageManager/installationInfo/analyzeIssues.js +225 -0
- package/dist/util/packageManager/installationInfo/analyzeIssues.js.map +1 -0
- package/dist/util/packageManager/installationInfo/commands.js +73 -0
- package/dist/util/packageManager/installationInfo/commands.js.map +1 -0
- package/dist/util/packageManager/installationInfo/detectCliInstallation.js +66 -0
- package/dist/util/packageManager/installationInfo/detectCliInstallation.js.map +1 -0
- package/dist/util/packageManager/installationInfo/detectGlobals.js +295 -0
- package/dist/util/packageManager/installationInfo/detectGlobals.js.map +1 -0
- package/dist/util/packageManager/installationInfo/detectPackages.js +190 -0
- package/dist/util/packageManager/installationInfo/detectPackages.js.map +1 -0
- package/dist/util/packageManager/installationInfo/detectWorkspace.js +192 -0
- package/dist/util/packageManager/installationInfo/detectWorkspace.js.map +1 -0
- package/dist/util/packageManager/installationInfo/index.js +4 -0
- package/dist/util/packageManager/installationInfo/index.js.map +1 -0
- package/dist/util/packageManager/installationInfo/readJsonFile.js +14 -0
- package/dist/util/packageManager/installationInfo/readJsonFile.js.map +1 -0
- package/dist/util/packageManager/installationInfo/resolveVersionRange.js +42 -0
- package/dist/util/packageManager/installationInfo/resolveVersionRange.js.map +1 -0
- package/dist/util/packageManager/installationInfo/types.js +3 -0
- package/dist/util/packageManager/installationInfo/types.js.map +1 -0
- package/dist/util/packageManager/packageManagerChoice.js +1 -20
- package/dist/util/packageManager/packageManagerChoice.js.map +1 -1
- package/dist/util/packageManager/upgradePackages.js +4 -1
- package/dist/util/packageManager/upgradePackages.js.map +1 -1
- package/dist/util/promiseRaceWithTimeout.js +28 -0
- package/dist/util/promiseRaceWithTimeout.js.map +1 -0
- package/dist/util/readdirRecursive.js.map +1 -1
- package/dist/util/resolveLatestVersions.js +2 -2
- package/dist/util/resolveLatestVersions.js.map +1 -1
- package/dist/util/sharedFlags.js +54 -0
- package/dist/util/sharedFlags.js.map +1 -0
- package/dist/{telemetry/store → util/telemetry}/cleanupOldTelemetryFiles.js +1 -1
- package/dist/util/telemetry/cleanupOldTelemetryFiles.js.map +1 -0
- package/dist/{telemetry/store → util/telemetry}/createTelemetryStore.js +4 -4
- package/dist/util/telemetry/createTelemetryStore.js.map +1 -0
- package/dist/util/telemetry/createTraceId.js.map +1 -0
- package/dist/{telemetry/store → util/telemetry}/findTelemetryFiles.js +4 -3
- package/dist/util/telemetry/findTelemetryFiles.js.map +1 -0
- package/dist/{telemetry/store → util/telemetry}/flushTelemetryFiles.js +29 -18
- package/dist/util/telemetry/flushTelemetryFiles.js.map +1 -0
- package/dist/{telemetry/store → util/telemetry}/generateTelemetryFilePath.js +2 -2
- package/dist/util/telemetry/generateTelemetryFilePath.js.map +1 -0
- package/dist/{telemetry/store → util/telemetry}/logger.js +7 -2
- package/dist/util/telemetry/logger.js.map +1 -0
- package/dist/util/telemetry/readNDJSON.js +28 -0
- package/dist/util/telemetry/readNDJSON.js.map +1 -0
- package/dist/util/telemetry/telemetryStoreDebug.js +7 -0
- package/dist/util/telemetry/telemetryStoreDebug.js.map +1 -0
- package/dist/{telemetry/store → util/telemetry}/trace.js +2 -2
- package/dist/util/telemetry/trace.js.map +1 -0
- package/dist/util/toForwardSlashes.js +8 -0
- package/dist/util/toForwardSlashes.js.map +1 -0
- package/dist/util/update/fetchLatestVersion.js +21 -0
- package/dist/util/update/fetchLatestVersion.js.map +1 -0
- package/dist/util/update/getUpdateCommand.js +20 -0
- package/dist/util/update/getUpdateCommand.js.map +1 -0
- package/dist/util/update/isInstalledUsingYarn.js +17 -0
- package/dist/util/update/isInstalledUsingYarn.js.map +1 -0
- package/dist/util/update/showNotificationUpdate.js +31 -0
- package/dist/util/update/showNotificationUpdate.js.map +1 -0
- package/dist/util/update/updateChecker.js +60 -0
- package/dist/util/update/updateChecker.js.map +1 -0
- package/dist/util/update/updateCheckerDebug.js +4 -0
- package/dist/util/update/updateCheckerDebug.js.map +1 -0
- package/dist/util/warnAboutMissingAppId.js +6 -2
- package/dist/util/warnAboutMissingAppId.js.map +1 -1
- package/dist/util/warnOnNonProductionEnvironment.js +18 -0
- package/dist/util/warnOnNonProductionEnvironment.js.map +1 -0
- package/oclif.config.js +7 -1
- package/oclif.manifest.json +1129 -146
- package/package.json +83 -78
- package/static/favicons/apple-touch-icon.png +0 -0
- package/static/favicons/favicon-192.png +0 -0
- package/static/favicons/favicon-512.png +0 -0
- package/static/favicons/favicon-96.png +0 -0
- package/static/favicons/favicon.ico +0 -0
- package/static/favicons/favicon.svg +12 -0
- package/dist/SanityHelp.d.ts +0 -4
- package/dist/actions/auth/authServer.d.ts +0 -33
- package/dist/actions/auth/getProviderName.d.ts +0 -8
- package/dist/actions/auth/login/getProvider.d.ts +0 -15
- package/dist/actions/auth/login/getSSOProvider.d.ts +0 -13
- package/dist/actions/auth/login/login.d.ts +0 -20
- package/dist/actions/auth/login/promptProviders.d.ts +0 -10
- package/dist/actions/auth/login/promptProviders.js.map +0 -1
- package/dist/actions/auth/login/samlProviderToLoginProvider.d.ts +0 -9
- package/dist/actions/auth/types.d.ts +0 -26
- package/dist/actions/backup/archiveDir.d.ts +0 -10
- package/dist/actions/backup/assertDatasetExist.d.ts +0 -8
- package/dist/actions/backup/backupDownloadDebug.d.ts +0 -1
- package/dist/actions/backup/cleanupTmpDir.d.ts +0 -6
- package/dist/actions/backup/constants.d.ts +0 -1
- package/dist/actions/backup/downloadAsset.d.ts +0 -9
- package/dist/actions/backup/downloadDocument.d.ts +0 -7
- package/dist/actions/backup/fetchNextBackupPage.d.ts +0 -23
- package/dist/actions/backup/progressSpinner.d.ts +0 -14
- package/dist/actions/build/buildApp.d.ts +0 -7
- package/dist/actions/build/buildDebug.d.ts +0 -1
- package/dist/actions/build/buildStaticFiles.d.ts +0 -35
- package/dist/actions/build/buildStudio.d.ts +0 -7
- package/dist/actions/build/buildVendorDependencies.d.ts +0 -11
- package/dist/actions/build/checkRequiredDependencies.d.ts +0 -22
- package/dist/actions/build/checkStudioDependencyVersions.d.ts +0 -2
- package/dist/actions/build/createExternalFromImportMap.d.ts +0 -11
- package/dist/actions/build/decorateIndexWithAutoGeneratedWarning.d.ts +0 -6
- package/dist/actions/build/decorateIndexWithBridgeScript.d.ts +0 -8
- package/dist/actions/build/determineBasePath.d.ts +0 -7
- package/dist/actions/build/generateWebManifest.d.ts +0 -15
- package/dist/actions/build/getAppEnvVars.d.ts +0 -6
- package/dist/actions/build/getAutoUpdatesImportMap.d.ts +0 -21
- package/dist/actions/build/getEntryModule.d.ts +0 -7
- package/dist/actions/build/getPossibleDocumentComponentLocations.d.ts +0 -4
- package/dist/actions/build/getStudioEnvVars.d.ts +0 -6
- package/dist/actions/build/getStudioEnvironmentVariables.d.ts +0 -52
- package/dist/actions/build/getViteConfig.d.ts +0 -66
- package/dist/actions/build/normalizeBasePath.d.ts +0 -6
- package/dist/actions/build/renderDocument.d.ts +0 -15
- package/dist/actions/build/renderDocument.worker.d.ts +0 -1
- package/dist/actions/build/renderDocumentWorker/addTimestampImportMapScriptToHtml.d.ts +0 -6
- package/dist/actions/build/renderDocumentWorker/components/BasicDocument.d.ts +0 -19
- package/dist/actions/build/renderDocumentWorker/components/DefaultDocument.d.ts +0 -13
- package/dist/actions/build/renderDocumentWorker/components/Favicons.d.ts +0 -2
- package/dist/actions/build/renderDocumentWorker/components/GlobalErrorHandler.d.ts +0 -3
- package/dist/actions/build/renderDocumentWorker/components/NoJavascript.d.ts +0 -3
- package/dist/actions/build/renderDocumentWorker/getDocumentComponent.d.ts +0 -5
- package/dist/actions/build/renderDocumentWorker/getDocumentHtml.d.ts +0 -8
- package/dist/actions/build/renderDocumentWorker/renderDocumentWorker.d.ts +0 -21
- package/dist/actions/build/renderDocumentWorker/tryLoadDocumentComponent.d.ts +0 -8
- package/dist/actions/build/renderDocumentWorker/types.d.ts +0 -8
- package/dist/actions/build/shouldAutoUpdate.d.ts +0 -16
- package/dist/actions/build/types.d.ts +0 -13
- package/dist/actions/build/writeFavicons.d.ts +0 -1
- package/dist/actions/build/writeSanityRuntime.d.ts +0 -19
- package/dist/actions/build/writeWebManifest.d.ts +0 -4
- package/dist/actions/codemods/deskRename.d.ts +0 -2
- package/dist/actions/codemods/index.d.ts +0 -5
- package/dist/actions/codemods/partsTypeDirective.d.ts +0 -2
- package/dist/actions/codemods/reactIconsV3.d.ts +0 -2
- package/dist/actions/codemods/types.d.ts +0 -8
- package/dist/actions/cors/filterAndValidateOrigin.d.ts +0 -7
- package/dist/actions/dataset/create.d.ts +0 -49
- package/dist/actions/dataset/determineDatasetAclMode.d.ts +0 -37
- package/dist/actions/dataset/processAliasName.d.ts +0 -9
- package/dist/actions/dataset/validateDatasetAliasName.d.ts +0 -1
- package/dist/actions/dataset/validateDatasetName.d.ts +0 -13
- package/dist/actions/debug/gatherDebugInfo.d.ts +0 -2
- package/dist/actions/debug/getGlobalConfigLocation.d.ts +0 -1
- package/dist/actions/debug/types.d.ts +0 -30
- package/dist/actions/deploy/checkDir.d.ts +0 -8
- package/dist/actions/deploy/createStudioUserApplication.d.ts +0 -2
- package/dist/actions/deploy/createUserApplicationForApp.d.ts +0 -2
- package/dist/actions/deploy/deployApp.d.ts +0 -7
- package/dist/actions/deploy/deployDebug.d.ts +0 -1
- package/dist/actions/deploy/deployStudio.d.ts +0 -2
- package/dist/actions/deploy/findUserApplicationForApp.d.ts +0 -15
- package/dist/actions/deploy/findUserApplicationForStudio.d.ts +0 -13
- package/dist/actions/deploy/types.d.ts +0 -11
- package/dist/actions/dev/devAction.d.ts +0 -4
- package/dist/actions/dev/devDebug.d.ts +0 -1
- package/dist/actions/dev/getCoreAppUrl.d.ts +0 -5
- package/dist/actions/dev/getCoreAppUrl.js +0 -10
- package/dist/actions/dev/getCoreAppUrl.js.map +0 -1
- package/dist/actions/dev/getDevServerConfig.d.ts +0 -9
- package/dist/actions/dev/startAppDevServer.d.ts +0 -4
- package/dist/actions/dev/startStudioDevServer.d.ts +0 -4
- package/dist/actions/dev/types.d.ts +0 -10
- package/dist/actions/docs/normalizeDocsPath.d.ts +0 -8
- package/dist/actions/documents/constants.d.ts +0 -1
- package/dist/actions/documents/editor.d.ts +0 -11
- package/dist/actions/documents/types.d.ts +0 -2
- package/dist/actions/documents/validate.d.ts +0 -26
- package/dist/actions/documents/validation/reporters/index.d.ts +0 -5
- package/dist/actions/documents/validation/reporters/jsonReporter.d.ts +0 -2
- package/dist/actions/documents/validation/reporters/ndjsonReporter.d.ts +0 -2
- package/dist/actions/documents/validation/reporters/prettyReporter/formatDocumentValidation.d.ts +0 -10
- package/dist/actions/documents/validation/reporters/prettyReporter/index.d.ts +0 -1
- package/dist/actions/documents/validation/reporters/prettyReporter/prettyReporter.d.ts +0 -5
- package/dist/actions/documents/validation/reporters/prettyReporter/util.d.ts +0 -53
- package/dist/actions/exec/execScript.d.ts +0 -11
- package/dist/actions/graphql/getGraphQLAPIs.d.ts +0 -2
- package/dist/actions/graphql/getGraphQLAPIs.worker.d.ts +0 -1
- package/dist/actions/graphql/types.d.ts +0 -68
- package/dist/actions/hook/constants.d.ts +0 -1
- package/dist/actions/hook/formatFailure.d.ts +0 -4
- package/dist/actions/hook/types.d.ts +0 -78
- package/dist/actions/init/bootstrapLocalTemplate.d.ts +0 -13
- package/dist/actions/init/bootstrapRemoteTemplate.d.ts +0 -12
- package/dist/actions/init/bootstrapTemplate.d.ts +0 -18
- package/dist/actions/init/checkNextJsReactCompatibility.d.ts +0 -9
- package/dist/actions/init/constants.d.ts +0 -1
- package/dist/actions/init/countNestedFolders.d.ts +0 -1
- package/dist/actions/init/createAppCliConfig.d.ts +0 -5
- package/dist/actions/init/createCliConfig.d.ts +0 -6
- package/dist/actions/init/createPackageManifest.d.ts +0 -6
- package/dist/actions/init/createStudioConfig.d.ts +0 -13
- package/dist/actions/init/determineAppTemplate.d.ts +0 -9
- package/dist/actions/init/env/createOrAppendEnvVars.d.ts +0 -12
- package/dist/actions/init/env/parseAndUpdateEnvVars.d.ts +0 -9
- package/dist/actions/init/env/writeEnvVarsToFile.d.ts +0 -12
- package/dist/actions/init/fetchPostInitPrompt.d.ts +0 -6
- package/dist/actions/init/git.d.ts +0 -1
- package/dist/actions/init/processTemplate.d.ts +0 -7
- package/dist/actions/init/remoteTemplate.d.ts +0 -20
- package/dist/actions/init/resolvePackageManager.d.ts +0 -10
- package/dist/actions/init/setupMCP.d.ts +0 -21
- package/dist/actions/init/setupMCP.js +0 -258
- package/dist/actions/init/setupMCP.js.map +0 -1
- package/dist/actions/init/templates/appQuickstart.d.ts +0 -3
- package/dist/actions/init/templates/appSanityUi.d.ts +0 -3
- package/dist/actions/init/templates/blog.d.ts +0 -3
- package/dist/actions/init/templates/clean.d.ts +0 -3
- package/dist/actions/init/templates/getStarted.d.ts +0 -3
- package/dist/actions/init/templates/index.d.ts +0 -3
- package/dist/actions/init/templates/moviedb.d.ts +0 -3
- package/dist/actions/init/templates/nextjs/index.d.ts +0 -6
- package/dist/actions/init/templates/nextjs/schemaTypes/blog.d.ts +0 -3
- package/dist/actions/init/templates/quickstart.d.ts +0 -3
- package/dist/actions/init/templates/shopify.d.ts +0 -3
- package/dist/actions/init/templates/shopifyOnline.d.ts +0 -3
- package/dist/actions/init/types.d.ts +0 -15
- package/dist/actions/init/updateInitialTemplateMetadata.d.ts +0 -1
- package/dist/actions/manifest/SchemaIcon.d.ts +0 -9
- package/dist/actions/manifest/extractAppManifest.d.ts +0 -20
- package/dist/actions/manifest/extractManifest.d.ts +0 -14
- package/dist/actions/manifest/extractWorkspaceManifest.d.ts +0 -3
- package/dist/actions/manifest/purifyConfig.d.ts +0 -10
- package/dist/actions/manifest/schemaTypeHelpers.d.ts +0 -17
- package/dist/actions/manifest/types.d.ts +0 -119
- package/dist/actions/mcp/detectAvailableEditors.d.ts +0 -8
- package/dist/actions/mcp/getEditorsWithExistingConfig.d.ts +0 -8
- package/dist/actions/mcp/getEditorsWithExistingConfig.js +0 -29
- package/dist/actions/mcp/getEditorsWithExistingConfig.js.map +0 -1
- package/dist/actions/mcp/writeMCPConfig.d.ts +0 -9
- package/dist/actions/media/getMediaLibraryConfig.d.ts +0 -2
- package/dist/actions/media/importAspects.d.ts +0 -52
- package/dist/actions/media/importMedia.d.ts +0 -55
- package/dist/actions/media/importMediaDebug.d.ts +0 -1
- package/dist/actions/organizations/getOrganizationChoices.d.ts +0 -6
- package/dist/actions/organizations/getOrganizationsWithAttachGrantInfo.d.ts +0 -2
- package/dist/actions/organizations/hasProjectAttachGrant.d.ts +0 -1
- package/dist/actions/preview/getPreviewServerConfig.d.ts +0 -15
- package/dist/actions/preview/previewAction.d.ts +0 -10
- package/dist/actions/preview/types.d.ts +0 -2
- package/dist/actions/schema/deleteSchemaAction.d.ts +0 -23
- package/dist/actions/schema/deploySchemas.d.ts +0 -15
- package/dist/actions/schema/extract.d.ts +0 -7
- package/dist/actions/schema/extract.js +0 -38
- package/dist/actions/schema/extract.js.map +0 -1
- package/dist/actions/schema/formatSchemaValidation.d.ts +0 -3
- package/dist/actions/schema/listSchemas.d.ts +0 -12
- package/dist/actions/schema/metafile.d.ts +0 -21
- package/dist/actions/schema/schemaStoreTypes.d.ts +0 -18
- package/dist/actions/schema/schemaStoreTypes.js +0 -19
- package/dist/actions/schema/schemaStoreTypes.js.map +0 -1
- package/dist/actions/schema/utils/debug.d.ts +0 -2
- package/dist/actions/schema/utils/manifestExtractor.d.ts +0 -9
- package/dist/actions/schema/utils/manifestExtractor.js +0 -33
- package/dist/actions/schema/utils/manifestExtractor.js.map +0 -1
- package/dist/actions/schema/utils/manifestReader.d.ts +0 -17
- package/dist/actions/schema/utils/manifestReader.js +0 -71
- package/dist/actions/schema/utils/manifestReader.js.map +0 -1
- package/dist/actions/schema/utils/schemaStoreOutStrings.d.ts +0 -2
- package/dist/actions/schema/utils/schemaStoreValidation.d.ts +0 -29
- package/dist/actions/schema/utils/uniqByProjectIdDataset.d.ts +0 -14
- package/dist/actions/schema/utils/workspaceSchemaId.d.ts +0 -8
- package/dist/actions/schema/validateAction.d.ts +0 -11
- package/dist/actions/telemetry/fetchTelemetryConsent.d.ts +0 -11
- package/dist/actions/telemetry/fetchTelemetryConsent.js +0 -38
- package/dist/actions/telemetry/fetchTelemetryConsent.js.map +0 -1
- package/dist/actions/telemetry/getLearnMoreMessage.d.ts +0 -2
- package/dist/actions/telemetry/getStatusDisplay.d.ts +0 -2
- package/dist/actions/telemetry/getStatusMessage.d.ts +0 -2
- package/dist/actions/telemetry/isValidApiConsentStatus.d.ts +0 -20
- package/dist/actions/telemetry/isValidApiConsentStatus.js +0 -25
- package/dist/actions/telemetry/isValidApiConsentStatus.js.map +0 -1
- package/dist/actions/telemetry/resolveConsent.d.ts +0 -2
- package/dist/actions/telemetry/setConsent.d.ts +0 -13
- package/dist/actions/telemetry/telemetryDebug.d.ts +0 -1
- package/dist/actions/telemetry/telemetryDisclosure.d.ts +0 -1
- package/dist/actions/telemetry/telemetryLearnMoreMessage.d.ts +0 -2
- package/dist/actions/telemetry/types.d.ts +0 -14
- package/dist/actions/telemetry/types.js.map +0 -1
- package/dist/actions/tokens/constants.d.ts +0 -4
- package/dist/actions/tokens/types.d.ts +0 -32
- package/dist/actions/tokens/validateRole.d.ts +0 -9
- package/dist/actions/undeploy/getStudioOrAppUserApplication.d.ts +0 -9
- package/dist/actions/users/getMembersForProject.d.ts +0 -24
- package/dist/actions/users/getPendingInvitations.d.ts +0 -13
- package/dist/actions/users/types.d.ts +0 -39
- package/dist/actions/users/usersDebug.d.ts +0 -1
- package/dist/actions/users/validateEmail.d.ts +0 -1
- package/dist/actions/versions/buildPackageArray.d.ts +0 -18
- package/dist/actions/versions/filterSanityModules.d.ts +0 -8
- package/dist/actions/versions/findSanityModulesVersions.d.ts +0 -14
- package/dist/actions/versions/getFormatters.d.ts +0 -17
- package/dist/actions/versions/tryFindLatestVersion.d.ts +0 -8
- package/dist/actions/versions/types.d.ts +0 -14
- package/dist/actions/versions/versionsDebug.d.ts +0 -1
- package/dist/commands/backup/disable.d.ts +0 -13
- package/dist/commands/backup/download.d.ts +0 -21
- package/dist/commands/backup/enable.d.ts +0 -12
- package/dist/commands/backup/list.d.ts +0 -19
- package/dist/commands/build.d.ts +0 -18
- package/dist/commands/codemod.d.ts +0 -19
- package/dist/commands/cors/add.d.ts +0 -29
- package/dist/commands/cors/delete.d.ts +0 -13
- package/dist/commands/cors/list.d.ts +0 -9
- package/dist/commands/dataset/alias/create.d.ts +0 -13
- package/dist/commands/dataset/alias/delete.d.ts +0 -16
- package/dist/commands/dataset/alias/link.d.ts +0 -17
- package/dist/commands/dataset/alias/unlink.d.ts +0 -16
- package/dist/commands/dataset/copy.d.ts +0 -27
- package/dist/commands/dataset/create.d.ts +0 -15
- package/dist/commands/dataset/delete.d.ts +0 -15
- package/dist/commands/dataset/export.d.ts +0 -26
- package/dist/commands/dataset/import.d.ts +0 -1
- package/dist/commands/dataset/list.d.ts +0 -9
- package/dist/commands/dataset/visibility/get.d.ts +0 -12
- package/dist/commands/dataset/visibility/set.d.ts +0 -13
- package/dist/commands/debug.d.ts +0 -9
- package/dist/commands/deploy.d.ts +0 -23
- package/dist/commands/dev.d.ts +0 -14
- package/dist/commands/docs/browse.d.ts +0 -6
- package/dist/commands/docs/read.d.ts +0 -15
- package/dist/commands/docs/search.d.ts +0 -15
- package/dist/commands/documents/create.d.ts +0 -39
- package/dist/commands/documents/delete.d.ts +0 -17
- package/dist/commands/documents/get.d.ts +0 -16
- package/dist/commands/documents/query.d.ts +0 -19
- package/dist/commands/documents/validate.d.ts +0 -29
- package/dist/commands/exec.d.ts +0 -19
- package/dist/commands/graphql/list.d.ts +0 -9
- package/dist/commands/graphql/undeploy.d.ts +0 -16
- package/dist/commands/hook/attempt.d.ts +0 -13
- package/dist/commands/hook/create.d.ts +0 -9
- package/dist/commands/hook/delete.d.ts +0 -13
- package/dist/commands/hook/list.d.ts +0 -9
- package/dist/commands/hook/logs.d.ts +0 -19
- package/dist/commands/init.d.ts +0 -65
- package/dist/commands/install.d.ts +0 -10
- package/dist/commands/learn.d.ts +0 -6
- package/dist/commands/login.d.ts +0 -13
- package/dist/commands/logout.d.ts +0 -6
- package/dist/commands/manage.d.ts +0 -6
- package/dist/commands/manifest/extract.d.ts +0 -12
- package/dist/commands/mcp/configure.d.ts +0 -9
- package/dist/commands/media/create-aspect.d.ts +0 -9
- package/dist/commands/media/delete-aspect.d.ts +0 -16
- package/dist/commands/media/deploy-aspect.d.ts +0 -20
- package/dist/commands/media/export.d.ts +0 -21
- package/dist/commands/media/import.d.ts +0 -18
- package/dist/commands/openapi/get.d.ts +0 -17
- package/dist/commands/openapi/list.d.ts +0 -14
- package/dist/commands/preview.d.ts +0 -17
- package/dist/commands/projects/list.d.ts +0 -13
- package/dist/commands/schema/delete.d.ts +0 -16
- package/dist/commands/schema/deploy.d.ts +0 -16
- package/dist/commands/schema/extract.d.ts +0 -15
- package/dist/commands/schema/list.d.ts +0 -15
- package/dist/commands/schema/validate.d.ts +0 -15
- package/dist/commands/telemetry/disable.d.ts +0 -8
- package/dist/commands/telemetry/enable.d.ts +0 -8
- package/dist/commands/telemetry/status.d.ts +0 -8
- package/dist/commands/tokens/add.d.ts +0 -19
- package/dist/commands/tokens/delete.d.ts +0 -17
- package/dist/commands/tokens/list.d.ts +0 -12
- package/dist/commands/undeploy.d.ts +0 -8
- package/dist/commands/users/invite.d.ts +0 -17
- package/dist/commands/users/list.d.ts +0 -16
- package/dist/commands/versions.d.ts +0 -6
- package/dist/config/createCliConfig.d.ts +0 -73
- package/dist/config/defineCliConfig.d.ts +0 -3
- package/dist/hooks/prerun/flushTelemetry.worker.d.ts +0 -2
- package/dist/hooks/prerun/setupTelemetry.d.ts +0 -2
- package/dist/index.d.ts +0 -6
- package/dist/index.js +0 -7
- package/dist/index.js.map +0 -1
- package/dist/prompts/init/nextjs.d.ts +0 -5
- package/dist/prompts/init/promptForTypescript.d.ts +0 -1
- package/dist/prompts/promptForDataset.d.ts +0 -17
- package/dist/prompts/promptForDatasetAclMode.d.ts +0 -9
- package/dist/prompts/promptForDatasetAliasName.d.ts +0 -4
- package/dist/prompts/promptForDatasetName.d.ts +0 -4
- package/dist/prompts/promptForMediaLibrary.d.ts +0 -15
- package/dist/prompts/selectDataset.d.ts +0 -3
- package/dist/prompts/selectMediaLibrary.d.ts +0 -5
- package/dist/server/devServer.d.ts +0 -24
- package/dist/server/gracefulServerDeath.d.ts +0 -3
- package/dist/server/previewServer.d.ts +0 -19
- package/dist/server/serverDebug.d.ts +0 -1
- package/dist/server/vite/plugin-sanity-basepath-redirect.d.ts +0 -2
- package/dist/server/vite/plugin-sanity-build-entries.d.ts +0 -9
- package/dist/server/vite/plugin-sanity-favicons.d.ts +0 -17
- package/dist/server/vite/plugin-sanity-runtime-rewrite.d.ts +0 -2
- package/dist/services/auth.d.ts +0 -2
- package/dist/services/backup.d.ts +0 -37
- package/dist/services/cors.d.ts +0 -23
- package/dist/services/datasetAliases.d.ts +0 -31
- package/dist/services/datasets.d.ts +0 -64
- package/dist/services/docs.d.ts +0 -15
- package/dist/services/getProjectFeatures.d.ts +0 -5
- package/dist/services/graphql.d.ts +0 -23
- package/dist/services/hooks.d.ts +0 -16
- package/dist/services/mcp.d.ts +0 -39
- package/dist/services/mediaLibraries.d.ts +0 -52
- package/dist/services/organizations.d.ts +0 -42
- package/dist/services/plans.d.ts +0 -2
- package/dist/services/projects.d.ts +0 -36
- package/dist/services/schemas.d.ts +0 -4
- package/dist/services/telemetry.d.ts +0 -2
- package/dist/services/tokens.d.ts +0 -43
- package/dist/services/user.d.ts +0 -15
- package/dist/services/userApplications.d.ts +0 -77
- package/dist/studioDependencies.d.ts +0 -16
- package/dist/studioDependencies.js.map +0 -1
- package/dist/telemetry/cli.telemetry.d.ts +0 -20
- package/dist/telemetry/store/cleanupOldTelemetryFiles.d.ts +0 -5
- package/dist/telemetry/store/cleanupOldTelemetryFiles.js.map +0 -1
- package/dist/telemetry/store/createTelemetryStore.d.ts +0 -39
- package/dist/telemetry/store/createTelemetryStore.js.map +0 -1
- package/dist/telemetry/store/createTraceId.d.ts +0 -10
- package/dist/telemetry/store/createTraceId.js.map +0 -1
- package/dist/telemetry/store/debug.d.ts +0 -5
- package/dist/telemetry/store/debug.js +0 -7
- package/dist/telemetry/store/debug.js.map +0 -1
- package/dist/telemetry/store/findTelemetryFiles.d.ts +0 -13
- package/dist/telemetry/store/findTelemetryFiles.js.map +0 -1
- package/dist/telemetry/store/flushTelemetryFiles.d.ts +0 -20
- package/dist/telemetry/store/flushTelemetryFiles.js.map +0 -1
- package/dist/telemetry/store/generateTelemetryFilePath.d.ts +0 -17
- package/dist/telemetry/store/generateTelemetryFilePath.js.map +0 -1
- package/dist/telemetry/store/getTelemetryBaseInfo.d.ts +0 -27
- package/dist/telemetry/store/getTelemetryBaseInfo.js +0 -34
- package/dist/telemetry/store/getTelemetryBaseInfo.js.map +0 -1
- package/dist/telemetry/store/logger.d.ts +0 -6
- package/dist/telemetry/store/logger.js.map +0 -1
- package/dist/telemetry/store/trace.d.ts +0 -6
- package/dist/telemetry/store/trace.js.map +0 -1
- package/dist/telemetry/utils/readNDJSON.d.ts +0 -10
- package/dist/telemetry/utils/readNDJSON.js +0 -18
- package/dist/telemetry/utils/readNDJSON.js.map +0 -1
- package/dist/threads/configClient.d.ts +0 -1
- package/dist/threads/configClient.js.map +0 -1
- package/dist/threads/registerBrowserEnv.d.ts +0 -1
- package/dist/threads/registerBrowserEnv.js.map +0 -1
- package/dist/threads/validateDocuments.d.ts +0 -45
- package/dist/threads/validateDocuments.js.map +0 -1
- package/dist/threads/validateSchema.d.ts +0 -35
- package/dist/threads/validateSchema.js.map +0 -1
- package/dist/types.d.ts +0 -49
- package/dist/typings/deepSortObject.d.js +0 -2
- package/dist/typings/deepSortObject.d.js.map +0 -1
- package/dist/util/absolutify.d.ts +0 -6
- package/dist/util/appId.d.ts +0 -18
- package/dist/util/canLaunchBrowser.d.ts +0 -1
- package/dist/util/cliClient.d.ts +0 -13
- package/dist/util/compareDependencyVersions.d.ts +0 -35
- package/dist/util/copy.d.ts +0 -5
- package/dist/util/copyDir.d.ts +0 -20
- package/dist/util/detectRuntime.d.ts +0 -8
- package/dist/util/determineIsApp.d.ts +0 -7
- package/dist/util/dirIsEmptyOrNonExistent.d.ts +0 -1
- package/dist/util/ensureTrailingSlash.d.ts +0 -9
- package/dist/util/errorMessages.d.ts +0 -4
- package/dist/util/extractDocumentsFromNdjsonOrTarball.d.ts +0 -6
- package/dist/util/findNdjsonEntry.d.ts +0 -7
- package/dist/util/findNdjsonEntry.js +0 -21
- package/dist/util/findNdjsonEntry.js.map +0 -1
- package/dist/util/formatSize.d.ts +0 -6
- package/dist/util/frameworkPort.d.ts +0 -12
- package/dist/util/fsUtils.d.ts +0 -2
- package/dist/util/getCliVersion.d.ts +0 -7
- package/dist/util/getErrorMessage.d.ts +0 -8
- package/dist/util/getLocalPackageVersion.d.ts +0 -9
- package/dist/util/getProjectDefaults.d.ts +0 -11
- package/dist/util/getSharedServerConfig.d.ts +0 -30
- package/dist/util/getWorkspace.d.ts +0 -3
- package/dist/util/humanFileSize.d.ts +0 -1
- package/dist/util/importStudioConfig.d.ts +0 -1
- package/dist/util/importStudioConfig.js +0 -43
- package/dist/util/importStudioConfig.js.map +0 -1
- package/dist/util/isPathDirName.d.ts +0 -1
- package/dist/util/isSanityDocumentish.d.ts +0 -19
- package/dist/util/isStaging.d.ts +0 -7
- package/dist/util/isStaging.js +0 -10
- package/dist/util/isStaging.js.map +0 -1
- package/dist/util/loadEnv.d.ts +0 -1
- package/dist/util/moduleFormatUtils.d.ts +0 -3
- package/dist/util/packageManager/installPackages.d.ts +0 -18
- package/dist/util/packageManager/packageManagerChoice.d.ts +0 -31
- package/dist/util/packageManager/upgradePackages.d.ts +0 -17
- package/dist/util/parseArguments.d.ts +0 -35
- package/dist/util/pluralize.d.ts +0 -8
- package/dist/util/readModuleVersion.d.ts +0 -8
- package/dist/util/readModuleVersion.js +0 -15
- package/dist/util/readModuleVersion.js.map +0 -1
- package/dist/util/readPackageJson.d.ts +0 -31
- package/dist/util/readPackageJson.js +0 -42
- package/dist/util/readPackageJson.js.map +0 -1
- package/dist/util/readPackageManifest.d.ts +0 -21
- package/dist/util/readPackageManifest.js +0 -46
- package/dist/util/readPackageManifest.js.map +0 -1
- package/dist/util/readdirRecursive.d.ts +0 -5
- package/dist/util/resolveLatestVersions.d.ts +0 -7
- package/dist/util/toInt.d.ts +0 -1
- package/dist/util/trimHashFromVersion.d.ts +0 -5
- package/dist/util/uniqBy.d.ts +0 -1
- package/dist/util/uniqBy.js +0 -14
- package/dist/util/uniqBy.js.map +0 -1
- package/dist/util/validation/validateDocumentsUtils.d.ts +0 -12
- package/dist/util/warnAboutMissingAppId.d.ts +0 -7
- package/dist/util/workerChannels.d.ts +0 -59
- package/dist/util/workerChannels.js +0 -172
- package/dist/util/workerChannels.js.map +0 -1
- /package/dist/actions/{telemetry → doctor}/types.js +0 -0
- /package/dist/{studioDependencies.js → actions/init/studioDependencies.js} +0 -0
- /package/dist/{telemetry/store → util/telemetry}/createTraceId.js +0 -0
package/README.md
CHANGED
|
@@ -5,28 +5,9 @@ Code for sanity cli
|
|
|
5
5
|
<!-- toc -->
|
|
6
6
|
|
|
7
7
|
- [@sanity/cli](#sanitycli)
|
|
8
|
-
- [Usage](#usage)
|
|
9
8
|
- [Commands](#commands)
|
|
10
9
|
<!-- tocstop -->
|
|
11
10
|
|
|
12
|
-
# Usage
|
|
13
|
-
|
|
14
|
-
<!-- usage -->
|
|
15
|
-
|
|
16
|
-
```sh-session
|
|
17
|
-
$ npm install -g @sanity/cli
|
|
18
|
-
$ sanity COMMAND
|
|
19
|
-
running command...
|
|
20
|
-
$ sanity (--version)
|
|
21
|
-
@sanity/cli/6.0.0-alpha.7 darwin-arm64 node-v24.11.0
|
|
22
|
-
$ sanity --help [COMMAND]
|
|
23
|
-
USAGE
|
|
24
|
-
$ sanity COMMAND
|
|
25
|
-
...
|
|
26
|
-
```
|
|
27
|
-
|
|
28
|
-
<!-- usagestop -->
|
|
29
|
-
|
|
30
11
|
# Commands
|
|
31
12
|
|
|
32
13
|
<!-- commands -->
|
|
@@ -57,8 +38,11 @@ USAGE
|
|
|
57
38
|
- [`sanity dataset copy [SOURCE] [TARGET]`](#sanity-dataset-copy-source-target)
|
|
58
39
|
- [`sanity dataset create [NAME]`](#sanity-dataset-create-name)
|
|
59
40
|
- [`sanity dataset delete DATASETNAME`](#sanity-dataset-delete-datasetname)
|
|
41
|
+
- [`sanity dataset embeddings disable [DATASET]`](#sanity-dataset-embeddings-disable-dataset)
|
|
42
|
+
- [`sanity dataset embeddings enable [DATASET]`](#sanity-dataset-embeddings-enable-dataset)
|
|
43
|
+
- [`sanity dataset embeddings status [DATASET]`](#sanity-dataset-embeddings-status-dataset)
|
|
60
44
|
- [`sanity dataset export [NAME] [DESTINATION]`](#sanity-dataset-export-name-destination)
|
|
61
|
-
- [`sanity dataset import SOURCE`](#sanity-dataset-import-source)
|
|
45
|
+
- [`sanity dataset import SOURCE [TARGETDATASET]`](#sanity-dataset-import-source-targetdataset)
|
|
62
46
|
- [`sanity dataset list`](#sanity-dataset-list)
|
|
63
47
|
- [`sanity dataset visibility get DATASET`](#sanity-dataset-visibility-get-dataset)
|
|
64
48
|
- [`sanity dataset visibility set DATASET MODE`](#sanity-dataset-visibility-set-dataset-mode)
|
|
@@ -68,6 +52,7 @@ USAGE
|
|
|
68
52
|
- [`sanity docs browse`](#sanity-docs-browse)
|
|
69
53
|
- [`sanity docs read PATH`](#sanity-docs-read-path)
|
|
70
54
|
- [`sanity docs search QUERY`](#sanity-docs-search-query)
|
|
55
|
+
- [`sanity doctor [CHECKS]`](#sanity-doctor-checks)
|
|
71
56
|
- [`sanity documents create [FILE]`](#sanity-documents-create-file)
|
|
72
57
|
- [`sanity documents delete ID [IDS]`](#sanity-documents-delete-id-ids)
|
|
73
58
|
- [`sanity documents get DOCUMENTID`](#sanity-documents-get-documentid)
|
|
@@ -81,6 +66,7 @@ USAGE
|
|
|
81
66
|
- [`sanity functions env remove NAME KEY`](#sanity-functions-env-remove-name-key)
|
|
82
67
|
- [`sanity functions logs [NAME]`](#sanity-functions-logs-name)
|
|
83
68
|
- [`sanity functions test [NAME]`](#sanity-functions-test-name)
|
|
69
|
+
- [`sanity graphql deploy`](#sanity-graphql-deploy)
|
|
84
70
|
- [`sanity graphql list`](#sanity-graphql-list)
|
|
85
71
|
- [`sanity graphql undeploy`](#sanity-graphql-undeploy)
|
|
86
72
|
- [`sanity help [COMMAND]`](#sanity-help-command)
|
|
@@ -108,6 +94,7 @@ USAGE
|
|
|
108
94
|
- [`sanity openapi get SLUG`](#sanity-openapi-get-slug)
|
|
109
95
|
- [`sanity openapi list`](#sanity-openapi-list)
|
|
110
96
|
- [`sanity preview [OUTPUTDIR]`](#sanity-preview-outputdir)
|
|
97
|
+
- [`sanity projects create [PROJECTNAME]`](#sanity-projects-create-projectname)
|
|
111
98
|
- [`sanity projects list`](#sanity-projects-list)
|
|
112
99
|
- [`sanity schema delete`](#sanity-schema-delete)
|
|
113
100
|
- [`sanity schema deploy`](#sanity-schema-deploy)
|
|
@@ -121,6 +108,7 @@ USAGE
|
|
|
121
108
|
- [`sanity tokens add [LABEL]`](#sanity-tokens-add-label)
|
|
122
109
|
- [`sanity tokens delete [TOKENID]`](#sanity-tokens-delete-tokenid)
|
|
123
110
|
- [`sanity tokens list`](#sanity-tokens-list)
|
|
111
|
+
- [`sanity typegen generate`](#sanity-typegen-generate)
|
|
124
112
|
- [`sanity undeploy`](#sanity-undeploy)
|
|
125
113
|
- [`sanity users invite [EMAIL]`](#sanity-users-invite-email)
|
|
126
114
|
- [`sanity users list`](#sanity-users-list)
|
|
@@ -132,11 +120,14 @@ Disable backup for a dataset.
|
|
|
132
120
|
|
|
133
121
|
```
|
|
134
122
|
USAGE
|
|
135
|
-
$ sanity backup disable [DATASET]
|
|
123
|
+
$ sanity backup disable [DATASET] [-p <id>]
|
|
136
124
|
|
|
137
125
|
ARGUMENTS
|
|
138
126
|
[DATASET] Dataset name to disable backup for
|
|
139
127
|
|
|
128
|
+
OVERRIDE FLAGS
|
|
129
|
+
-p, --project-id=<id> Project ID to disable backups for (overrides CLI configuration)
|
|
130
|
+
|
|
140
131
|
DESCRIPTION
|
|
141
132
|
Disable backup for a dataset.
|
|
142
133
|
|
|
@@ -150,7 +141,7 @@ EXAMPLES
|
|
|
150
141
|
$ sanity backup disable production
|
|
151
142
|
```
|
|
152
143
|
|
|
153
|
-
_See code: [src/commands/backup/disable.ts](https://github.com/sanity-io/cli/blob/
|
|
144
|
+
_See code: [src/commands/backup/disable.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/backup/disable.ts)_
|
|
154
145
|
|
|
155
146
|
## `sanity backup download [DATASET]`
|
|
156
147
|
|
|
@@ -158,7 +149,8 @@ Download a dataset backup to a local file.
|
|
|
158
149
|
|
|
159
150
|
```
|
|
160
151
|
USAGE
|
|
161
|
-
$ sanity backup download [DATASET] [--backup-id <value>] [--concurrency <value>] [--out <value>]
|
|
152
|
+
$ sanity backup download [DATASET] [-p <id>] [--backup-id <value>] [--concurrency <value>] [--out <value>]
|
|
153
|
+
[--overwrite]
|
|
162
154
|
|
|
163
155
|
ARGUMENTS
|
|
164
156
|
[DATASET] Dataset name to download backup from
|
|
@@ -169,6 +161,9 @@ FLAGS
|
|
|
169
161
|
--out=<value> The file or directory path the backup should download to
|
|
170
162
|
--overwrite Allows overwriting of existing backup file
|
|
171
163
|
|
|
164
|
+
OVERRIDE FLAGS
|
|
165
|
+
-p, --project-id=<id> Project ID to download backup from (overrides CLI configuration)
|
|
166
|
+
|
|
172
167
|
DESCRIPTION
|
|
173
168
|
Download a dataset backup to a local file.
|
|
174
169
|
|
|
@@ -190,7 +185,7 @@ EXAMPLES
|
|
|
190
185
|
$ sanity backup download production --backup-id 2024-01-01-backup-3 --out /path/to/file --overwrite
|
|
191
186
|
```
|
|
192
187
|
|
|
193
|
-
_See code: [src/commands/backup/download.ts](https://github.com/sanity-io/cli/blob/
|
|
188
|
+
_See code: [src/commands/backup/download.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/backup/download.ts)_
|
|
194
189
|
|
|
195
190
|
## `sanity backup enable [DATASET]`
|
|
196
191
|
|
|
@@ -198,11 +193,14 @@ Enable backup for a dataset.
|
|
|
198
193
|
|
|
199
194
|
```
|
|
200
195
|
USAGE
|
|
201
|
-
$ sanity backup enable [DATASET]
|
|
196
|
+
$ sanity backup enable [DATASET] [-p <id>]
|
|
202
197
|
|
|
203
198
|
ARGUMENTS
|
|
204
199
|
[DATASET] Dataset name to enable backup for
|
|
205
200
|
|
|
201
|
+
OVERRIDE FLAGS
|
|
202
|
+
-p, --project-id=<id> Project ID to enable backups for (overrides CLI configuration)
|
|
203
|
+
|
|
206
204
|
DESCRIPTION
|
|
207
205
|
Enable backup for a dataset.
|
|
208
206
|
|
|
@@ -216,7 +214,7 @@ EXAMPLES
|
|
|
216
214
|
$ sanity backup enable production
|
|
217
215
|
```
|
|
218
216
|
|
|
219
|
-
_See code: [src/commands/backup/enable.ts](https://github.com/sanity-io/cli/blob/
|
|
217
|
+
_See code: [src/commands/backup/enable.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/backup/enable.ts)_
|
|
220
218
|
|
|
221
219
|
## `sanity backup list [DATASET]`
|
|
222
220
|
|
|
@@ -224,7 +222,7 @@ List available backups for a dataset.
|
|
|
224
222
|
|
|
225
223
|
```
|
|
226
224
|
USAGE
|
|
227
|
-
$ sanity backup list [DATASET] [--after <value>] [--before <value>] [-l <value>]
|
|
225
|
+
$ sanity backup list [DATASET] [-p <id>] [--after <value>] [--before <value>] [-l <value>]
|
|
228
226
|
|
|
229
227
|
ARGUMENTS
|
|
230
228
|
[DATASET] Dataset name to list backups for
|
|
@@ -234,6 +232,9 @@ FLAGS
|
|
|
234
232
|
--after=<value> Only return backups after this date (inclusive, YYYY-MM-DD format)
|
|
235
233
|
--before=<value> Only return backups before this date (exclusive, YYYY-MM-DD format)
|
|
236
234
|
|
|
235
|
+
OVERRIDE FLAGS
|
|
236
|
+
-p, --project-id=<id> Project ID to list backups for (overrides CLI configuration)
|
|
237
|
+
|
|
237
238
|
DESCRIPTION
|
|
238
239
|
List available backups for a dataset.
|
|
239
240
|
|
|
@@ -255,7 +256,7 @@ EXAMPLES
|
|
|
255
256
|
$ sanity backup list production --after 2024-01-31 --limit 10
|
|
256
257
|
```
|
|
257
258
|
|
|
258
|
-
_See code: [src/commands/backup/list.ts](https://github.com/sanity-io/cli/blob/
|
|
259
|
+
_See code: [src/commands/backup/list.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/backup/list.ts)_
|
|
259
260
|
|
|
260
261
|
## `sanity blueprints add TYPE`
|
|
261
262
|
|
|
@@ -264,9 +265,9 @@ Add a function resource to a Blueprint
|
|
|
264
265
|
```
|
|
265
266
|
USAGE
|
|
266
267
|
$ sanity blueprints add TYPE [--example <value> | -n <value> | --fn-type
|
|
267
|
-
document-
|
|
268
|
-
te|media-library-asset-delete... | --language ts|js | --javascript | --fn-helpers |
|
|
269
|
-
skip|npm|pnpm|yarn] [-i | ]
|
|
268
|
+
document-publish|document-create|document-update|document-delete|media-library-asset-create|media-library-asset-upda
|
|
269
|
+
te|media-library-asset-delete|scheduled-function... | --language ts|js | --javascript | --fn-helpers |
|
|
270
|
+
--fn-installer skip|npm|pnpm|yarn] [-i | ]
|
|
270
271
|
|
|
271
272
|
ARGUMENTS
|
|
272
273
|
TYPE (function) Type of resource to add (only "function" is supported)
|
|
@@ -281,8 +282,8 @@ FLAGS
|
|
|
281
282
|
<options: skip|npm|pnpm|yarn>
|
|
282
283
|
--fn-type=<option>... Document change event(s) that should trigger the function; you can specify multiple
|
|
283
284
|
events by specifying this flag multiple times
|
|
284
|
-
<options: document-
|
|
285
|
-
asset-create|media-library-asset-update|media-library-asset-delete>
|
|
285
|
+
<options: document-publish|document-create|document-update|document-delete|media-library-
|
|
286
|
+
asset-create|media-library-asset-update|media-library-asset-delete|scheduled-function>
|
|
286
287
|
--javascript Use JavaScript instead of TypeScript
|
|
287
288
|
--language=<option> [default: ts] Language of the new function
|
|
288
289
|
<options: ts|js>
|
|
@@ -307,7 +308,7 @@ EXAMPLES
|
|
|
307
308
|
$ sanity blueprints add function --name my-function --fn-type document-create --fn-type document-update --lang js
|
|
308
309
|
```
|
|
309
310
|
|
|
310
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/
|
|
311
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.5.0/src/commands/blueprints/add.ts)_
|
|
311
312
|
|
|
312
313
|
## `sanity blueprints config`
|
|
313
314
|
|
|
@@ -315,12 +316,12 @@ View or edit the local Blueprint configuration
|
|
|
315
316
|
|
|
316
317
|
```
|
|
317
318
|
USAGE
|
|
318
|
-
$ sanity blueprints config [--project-id <value> -e] [--stack
|
|
319
|
+
$ sanity blueprints config [--project-id <value> -e] [--stack <value> ]
|
|
319
320
|
|
|
320
321
|
FLAGS
|
|
321
322
|
-e, --edit Modify the configuration interactively, or directly when combined with ID flags.
|
|
322
323
|
--project-id=<value> Directly set the project ID in the configuration. Requires --edit flag
|
|
323
|
-
--stack
|
|
324
|
+
--stack=<value> Stack name or ID to set in the configuration. Requires --edit flag
|
|
324
325
|
|
|
325
326
|
DESCRIPTION
|
|
326
327
|
View or edit the local Blueprint configuration
|
|
@@ -330,7 +331,7 @@ DESCRIPTION
|
|
|
330
331
|
Without flags, displays the current configuration. Use --edit to interactively modify settings, or combine --edit with
|
|
331
332
|
ID flags to update values directly (useful for scripting and automation).
|
|
332
333
|
|
|
333
|
-
If you need to switch your Blueprint to a different Stack, use --edit --stack
|
|
334
|
+
If you need to switch your Blueprint to a different Stack, use --edit --stack.
|
|
334
335
|
|
|
335
336
|
EXAMPLES
|
|
336
337
|
$ sanity blueprints config
|
|
@@ -339,10 +340,10 @@ EXAMPLES
|
|
|
339
340
|
|
|
340
341
|
$ sanity blueprints config --edit --project-id <projectId>
|
|
341
342
|
|
|
342
|
-
$ sanity blueprints config --edit --project-id <projectId> --stack-id
|
|
343
|
+
$ sanity blueprints config --edit --project-id <projectId> --stack <name-or-id>
|
|
343
344
|
```
|
|
344
345
|
|
|
345
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/
|
|
346
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.5.0/src/commands/blueprints/config.ts)_
|
|
346
347
|
|
|
347
348
|
## `sanity blueprints deploy`
|
|
348
349
|
|
|
@@ -350,10 +351,11 @@ Deploy the local Blueprint to the remote Stack
|
|
|
350
351
|
|
|
351
352
|
```
|
|
352
353
|
USAGE
|
|
353
|
-
$ sanity blueprints deploy [--no-wait]
|
|
354
|
+
$ sanity blueprints deploy [--stack <value>] [--no-wait]
|
|
354
355
|
|
|
355
356
|
FLAGS
|
|
356
|
-
--no-wait
|
|
357
|
+
--no-wait Do not wait for Stack deployment to complete
|
|
358
|
+
--stack=<value> Stack name or ID to use instead of the locally configured Stack
|
|
357
359
|
|
|
358
360
|
DESCRIPTION
|
|
359
361
|
Deploy the local Blueprint to the remote Stack
|
|
@@ -366,13 +368,19 @@ DESCRIPTION
|
|
|
366
368
|
|
|
367
369
|
Use --no-wait to queue the deployment and return immediately without waiting for completion.
|
|
368
370
|
|
|
371
|
+
Use --fn-installer to force which package manager to use when deploying functions.
|
|
372
|
+
|
|
373
|
+
Set SANITY_ASSET_TIMEOUT (seconds) to override the 60-second timeout for processing resource assets.
|
|
374
|
+
|
|
369
375
|
EXAMPLES
|
|
370
376
|
$ sanity blueprints deploy
|
|
371
377
|
|
|
372
378
|
$ sanity blueprints deploy --no-wait
|
|
379
|
+
|
|
380
|
+
$ sanity blueprints deploy --fn-installer npm
|
|
373
381
|
```
|
|
374
382
|
|
|
375
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/
|
|
383
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.5.0/src/commands/blueprints/deploy.ts)_
|
|
376
384
|
|
|
377
385
|
## `sanity blueprints destroy`
|
|
378
386
|
|
|
@@ -380,13 +388,13 @@ Destroy the remote Stack deployment and its resources (will not delete local fil
|
|
|
380
388
|
|
|
381
389
|
```
|
|
382
390
|
USAGE
|
|
383
|
-
$ sanity blueprints destroy [--project-id <value> --stack
|
|
391
|
+
$ sanity blueprints destroy [--project-id <value> --stack <value> --force] [--no-wait]
|
|
384
392
|
|
|
385
393
|
FLAGS
|
|
386
394
|
--force Force Stack destruction (skip confirmation)
|
|
387
395
|
--no-wait Do not wait for Stack destruction to complete
|
|
388
396
|
--project-id=<value> Project associated with the Stack
|
|
389
|
-
--stack
|
|
397
|
+
--stack=<value> Stack name or ID to destroy (defaults to the locally configured Stack)
|
|
390
398
|
|
|
391
399
|
DESCRIPTION
|
|
392
400
|
Destroy the remote Stack deployment and its resources (will not delete local files)
|
|
@@ -401,10 +409,10 @@ DESCRIPTION
|
|
|
401
409
|
EXAMPLES
|
|
402
410
|
$ sanity blueprints destroy
|
|
403
411
|
|
|
404
|
-
$ sanity blueprints destroy --stack-id
|
|
412
|
+
$ sanity blueprints destroy --stack <name-or-id> --project-id <projectId> --force --no-wait
|
|
405
413
|
```
|
|
406
414
|
|
|
407
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/
|
|
415
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.5.0/src/commands/blueprints/destroy.ts)_
|
|
408
416
|
|
|
409
417
|
## `sanity blueprints doctor`
|
|
410
418
|
|
|
@@ -412,13 +420,13 @@ Diagnose potential issues with local Blueprint and remote Stack configuration
|
|
|
412
420
|
|
|
413
421
|
```
|
|
414
422
|
USAGE
|
|
415
|
-
$ sanity blueprints doctor [--json] [
|
|
423
|
+
$ sanity blueprints doctor [--json] [-p <value>] [--verbose] [--fix]
|
|
416
424
|
|
|
417
425
|
FLAGS
|
|
418
|
-
--
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
426
|
+
-p, --path=<value> [env: SANITY_BLUEPRINT_PATH] Path to a Blueprint file or directory containing one
|
|
427
|
+
--fix Interactively fix configuration issues
|
|
428
|
+
--json Format output as json.
|
|
429
|
+
--[no-]verbose Verbose output; defaults to true
|
|
422
430
|
|
|
423
431
|
DESCRIPTION
|
|
424
432
|
Diagnose potential issues with local Blueprint and remote Stack configuration
|
|
@@ -430,7 +438,7 @@ DESCRIPTION
|
|
|
430
438
|
issues.
|
|
431
439
|
```
|
|
432
440
|
|
|
433
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/
|
|
441
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.5.0/src/commands/blueprints/doctor.ts)_
|
|
434
442
|
|
|
435
443
|
## `sanity blueprints info`
|
|
436
444
|
|
|
@@ -438,10 +446,10 @@ Show information about the local Blueprint's remote Stack deployment
|
|
|
438
446
|
|
|
439
447
|
```
|
|
440
448
|
USAGE
|
|
441
|
-
$ sanity blueprints info [--
|
|
449
|
+
$ sanity blueprints info [--stack <value>]
|
|
442
450
|
|
|
443
451
|
FLAGS
|
|
444
|
-
--
|
|
452
|
+
--stack=<value> Stack name or ID to use instead of the locally configured Stack
|
|
445
453
|
|
|
446
454
|
DESCRIPTION
|
|
447
455
|
Show information about the local Blueprint's remote Stack deployment
|
|
@@ -457,10 +465,10 @@ DESCRIPTION
|
|
|
457
465
|
EXAMPLES
|
|
458
466
|
$ sanity blueprints info
|
|
459
467
|
|
|
460
|
-
$ sanity blueprints info --
|
|
468
|
+
$ sanity blueprints info --stack <name-or-id>
|
|
461
469
|
```
|
|
462
470
|
|
|
463
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/
|
|
471
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.5.0/src/commands/blueprints/info.ts)_
|
|
464
472
|
|
|
465
473
|
## `sanity blueprints init [DIR]`
|
|
466
474
|
|
|
@@ -510,7 +518,7 @@ EXAMPLES
|
|
|
510
518
|
$ sanity blueprints init --blueprint-type <json|js|ts> --stack-name <stackName>
|
|
511
519
|
```
|
|
512
520
|
|
|
513
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/
|
|
521
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.5.0/src/commands/blueprints/init.ts)_
|
|
514
522
|
|
|
515
523
|
## `sanity blueprints logs`
|
|
516
524
|
|
|
@@ -518,10 +526,11 @@ Display logs for the current Blueprint's Stack deployment
|
|
|
518
526
|
|
|
519
527
|
```
|
|
520
528
|
USAGE
|
|
521
|
-
$ sanity blueprints logs [-w]
|
|
529
|
+
$ sanity blueprints logs [--stack <value>] [-w]
|
|
522
530
|
|
|
523
531
|
FLAGS
|
|
524
|
-
-w, --watch
|
|
532
|
+
-w, --watch Watch for new Stack logs (streaming mode)
|
|
533
|
+
--stack=<value> Stack name or ID to use instead of the locally configured Stack
|
|
525
534
|
|
|
526
535
|
DESCRIPTION
|
|
527
536
|
Display logs for the current Blueprint's Stack deployment
|
|
@@ -538,7 +547,7 @@ EXAMPLES
|
|
|
538
547
|
$ sanity blueprints logs --watch
|
|
539
548
|
```
|
|
540
549
|
|
|
541
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/
|
|
550
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.5.0/src/commands/blueprints/logs.ts)_
|
|
542
551
|
|
|
543
552
|
## `sanity blueprints plan`
|
|
544
553
|
|
|
@@ -546,7 +555,10 @@ Enumerate resources to be deployed to the remote Stack - will not modify any res
|
|
|
546
555
|
|
|
547
556
|
```
|
|
548
557
|
USAGE
|
|
549
|
-
$ sanity blueprints plan
|
|
558
|
+
$ sanity blueprints plan [--stack <value>]
|
|
559
|
+
|
|
560
|
+
FLAGS
|
|
561
|
+
--stack=<value> Stack name or ID to use instead of the locally configured Stack
|
|
550
562
|
|
|
551
563
|
DESCRIPTION
|
|
552
564
|
Enumerate resources to be deployed to the remote Stack - will not modify any resources
|
|
@@ -561,7 +573,7 @@ EXAMPLES
|
|
|
561
573
|
$ sanity blueprints plan
|
|
562
574
|
```
|
|
563
575
|
|
|
564
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/
|
|
576
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.5.0/src/commands/blueprints/plan.ts)_
|
|
565
577
|
|
|
566
578
|
## `sanity blueprints stacks`
|
|
567
579
|
|
|
@@ -590,7 +602,7 @@ EXAMPLES
|
|
|
590
602
|
$ sanity blueprints stacks --organization-id <organizationId>
|
|
591
603
|
```
|
|
592
604
|
|
|
593
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/
|
|
605
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.5.0/src/commands/blueprints/stacks.ts)_
|
|
594
606
|
|
|
595
607
|
## `sanity build [OUTPUTDIR]`
|
|
596
608
|
|
|
@@ -619,7 +631,7 @@ EXAMPLES
|
|
|
619
631
|
$ sanity build --no-minify --source-maps
|
|
620
632
|
```
|
|
621
633
|
|
|
622
|
-
_See code: [src/commands/build.ts](https://github.com/sanity-io/cli/blob/
|
|
634
|
+
_See code: [src/commands/build.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/build.ts)_
|
|
623
635
|
|
|
624
636
|
## `sanity codemod [CODEMODNAME]`
|
|
625
637
|
|
|
@@ -650,7 +662,7 @@ EXAMPLES
|
|
|
650
662
|
$ sanity codemod reactIconsV3 --dry
|
|
651
663
|
```
|
|
652
664
|
|
|
653
|
-
_See code: [src/commands/codemod.ts](https://github.com/sanity-io/cli/blob/
|
|
665
|
+
_See code: [src/commands/codemod.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/codemod.ts)_
|
|
654
666
|
|
|
655
667
|
## `sanity cors add ORIGIN`
|
|
656
668
|
|
|
@@ -658,7 +670,7 @@ Allow a new origin to use your project API through CORS
|
|
|
658
670
|
|
|
659
671
|
```
|
|
660
672
|
USAGE
|
|
661
|
-
$ sanity cors add ORIGIN [--credentials]
|
|
673
|
+
$ sanity cors add ORIGIN [-p <id>] [--credentials]
|
|
662
674
|
|
|
663
675
|
ARGUMENTS
|
|
664
676
|
ORIGIN Origin to allow (e.g., https://example.com)
|
|
@@ -666,6 +678,9 @@ ARGUMENTS
|
|
|
666
678
|
FLAGS
|
|
667
679
|
--[no-]credentials Allow credentials (token/cookie) to be sent from this origin
|
|
668
680
|
|
|
681
|
+
OVERRIDE FLAGS
|
|
682
|
+
-p, --project-id=<id> Project ID to add CORS origin to (overrides CLI configuration)
|
|
683
|
+
|
|
669
684
|
DESCRIPTION
|
|
670
685
|
Allow a new origin to use your project API through CORS
|
|
671
686
|
|
|
@@ -681,9 +696,13 @@ EXAMPLES
|
|
|
681
696
|
Add a production origin with credentials allowed
|
|
682
697
|
|
|
683
698
|
$ sanity cors add https://myapp.com --credentials
|
|
699
|
+
|
|
700
|
+
Add a CORS origin for a specific project
|
|
701
|
+
|
|
702
|
+
$ sanity cors add https://myapp.com --project-id abc123
|
|
684
703
|
```
|
|
685
704
|
|
|
686
|
-
_See code: [src/commands/cors/add.ts](https://github.com/sanity-io/cli/blob/
|
|
705
|
+
_See code: [src/commands/cors/add.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/cors/add.ts)_
|
|
687
706
|
|
|
688
707
|
## `sanity cors delete [ORIGIN]`
|
|
689
708
|
|
|
@@ -691,11 +710,14 @@ Delete an existing CORS origin from your project
|
|
|
691
710
|
|
|
692
711
|
```
|
|
693
712
|
USAGE
|
|
694
|
-
$ sanity cors delete [ORIGIN]
|
|
713
|
+
$ sanity cors delete [ORIGIN] [-p <id>]
|
|
695
714
|
|
|
696
715
|
ARGUMENTS
|
|
697
716
|
[ORIGIN] Origin to delete (will prompt if not provided)
|
|
698
717
|
|
|
718
|
+
OVERRIDE FLAGS
|
|
719
|
+
-p, --project-id=<id> Project ID to delete CORS origin from (overrides CLI configuration)
|
|
720
|
+
|
|
699
721
|
DESCRIPTION
|
|
700
722
|
Delete an existing CORS origin from your project
|
|
701
723
|
|
|
@@ -707,9 +729,13 @@ EXAMPLES
|
|
|
707
729
|
Delete a specific CORS origin
|
|
708
730
|
|
|
709
731
|
$ sanity cors delete https://example.com
|
|
732
|
+
|
|
733
|
+
Delete a CORS origin from a specific project
|
|
734
|
+
|
|
735
|
+
$ sanity cors delete --project-id abc123
|
|
710
736
|
```
|
|
711
737
|
|
|
712
|
-
_See code: [src/commands/cors/delete.ts](https://github.com/sanity-io/cli/blob/
|
|
738
|
+
_See code: [src/commands/cors/delete.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/cors/delete.ts)_
|
|
713
739
|
|
|
714
740
|
## `sanity cors list`
|
|
715
741
|
|
|
@@ -717,7 +743,10 @@ List all origins allowed to access the API for this project
|
|
|
717
743
|
|
|
718
744
|
```
|
|
719
745
|
USAGE
|
|
720
|
-
$ sanity cors list
|
|
746
|
+
$ sanity cors list [-p <id>]
|
|
747
|
+
|
|
748
|
+
OVERRIDE FLAGS
|
|
749
|
+
-p, --project-id=<id> Project ID to list CORS origins for (overrides CLI configuration)
|
|
721
750
|
|
|
722
751
|
DESCRIPTION
|
|
723
752
|
List all origins allowed to access the API for this project
|
|
@@ -726,9 +755,13 @@ EXAMPLES
|
|
|
726
755
|
List CORS origins for the current project
|
|
727
756
|
|
|
728
757
|
$ sanity cors list
|
|
758
|
+
|
|
759
|
+
List CORS origins for a specific project
|
|
760
|
+
|
|
761
|
+
$ sanity cors list --project-id abc123
|
|
729
762
|
```
|
|
730
763
|
|
|
731
|
-
_See code: [src/commands/cors/list.ts](https://github.com/sanity-io/cli/blob/
|
|
764
|
+
_See code: [src/commands/cors/list.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/cors/list.ts)_
|
|
732
765
|
|
|
733
766
|
## `sanity dataset alias create [ALIASNAME] [TARGETDATASET]`
|
|
734
767
|
|
|
@@ -736,16 +769,23 @@ Create a dataset alias within your project
|
|
|
736
769
|
|
|
737
770
|
```
|
|
738
771
|
USAGE
|
|
739
|
-
$ sanity dataset alias create [ALIASNAME] [TARGETDATASET]
|
|
772
|
+
$ sanity dataset alias create [ALIASNAME] [TARGETDATASET] [-p <id>]
|
|
740
773
|
|
|
741
774
|
ARGUMENTS
|
|
742
775
|
[ALIASNAME] Dataset alias name to create
|
|
743
776
|
[TARGETDATASET] Target dataset name to link the alias to
|
|
744
777
|
|
|
778
|
+
OVERRIDE FLAGS
|
|
779
|
+
-p, --project-id=<id> Project ID to create dataset alias in (overrides CLI configuration)
|
|
780
|
+
|
|
745
781
|
DESCRIPTION
|
|
746
782
|
Create a dataset alias within your project
|
|
747
783
|
|
|
748
784
|
EXAMPLES
|
|
785
|
+
Create alias in a specific project
|
|
786
|
+
|
|
787
|
+
$ sanity dataset alias create --project-id abc123 conference conf-2025
|
|
788
|
+
|
|
749
789
|
Create an alias with interactive prompts
|
|
750
790
|
|
|
751
791
|
$ sanity dataset alias create
|
|
@@ -763,7 +803,7 @@ EXAMPLES
|
|
|
763
803
|
$ sanity dataset alias create ~conference conf-2025
|
|
764
804
|
```
|
|
765
805
|
|
|
766
|
-
_See code: [src/commands/dataset/alias/create.ts](https://github.com/sanity-io/cli/blob/
|
|
806
|
+
_See code: [src/commands/dataset/alias/create.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/dataset/alias/create.ts)_
|
|
767
807
|
|
|
768
808
|
## `sanity dataset alias delete ALIASNAME`
|
|
769
809
|
|
|
@@ -771,7 +811,7 @@ Delete a dataset alias within your project
|
|
|
771
811
|
|
|
772
812
|
```
|
|
773
813
|
USAGE
|
|
774
|
-
$ sanity dataset alias delete ALIASNAME [--force]
|
|
814
|
+
$ sanity dataset alias delete ALIASNAME [-p <id>] [--force]
|
|
775
815
|
|
|
776
816
|
ARGUMENTS
|
|
777
817
|
ALIASNAME Dataset alias name to delete
|
|
@@ -779,6 +819,9 @@ ARGUMENTS
|
|
|
779
819
|
FLAGS
|
|
780
820
|
--force Skip confirmation prompt and delete immediately
|
|
781
821
|
|
|
822
|
+
OVERRIDE FLAGS
|
|
823
|
+
-p, --project-id=<id> Project ID to delete dataset alias from (overrides CLI configuration)
|
|
824
|
+
|
|
782
825
|
DESCRIPTION
|
|
783
826
|
Delete a dataset alias within your project
|
|
784
827
|
|
|
@@ -796,7 +839,7 @@ EXAMPLES
|
|
|
796
839
|
$ sanity dataset alias delete conference --force
|
|
797
840
|
```
|
|
798
841
|
|
|
799
|
-
_See code: [src/commands/dataset/alias/delete.ts](https://github.com/sanity-io/cli/blob/
|
|
842
|
+
_See code: [src/commands/dataset/alias/delete.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/dataset/alias/delete.ts)_
|
|
800
843
|
|
|
801
844
|
## `sanity dataset alias link [ALIASNAME] [TARGETDATASET]`
|
|
802
845
|
|
|
@@ -804,7 +847,7 @@ Link a dataset alias to a dataset within your project
|
|
|
804
847
|
|
|
805
848
|
```
|
|
806
849
|
USAGE
|
|
807
|
-
$ sanity dataset alias link [ALIASNAME] [TARGETDATASET] [--force]
|
|
850
|
+
$ sanity dataset alias link [ALIASNAME] [TARGETDATASET] [-p <id>] [--force]
|
|
808
851
|
|
|
809
852
|
ARGUMENTS
|
|
810
853
|
[ALIASNAME] Dataset alias name to link
|
|
@@ -813,6 +856,9 @@ ARGUMENTS
|
|
|
813
856
|
FLAGS
|
|
814
857
|
--force Skip confirmation prompt when relinking existing alias
|
|
815
858
|
|
|
859
|
+
OVERRIDE FLAGS
|
|
860
|
+
-p, --project-id=<id> Project ID to link dataset alias in (overrides CLI configuration)
|
|
861
|
+
|
|
816
862
|
DESCRIPTION
|
|
817
863
|
Link a dataset alias to a dataset within your project
|
|
818
864
|
|
|
@@ -838,7 +884,7 @@ EXAMPLES
|
|
|
838
884
|
$ sanity dataset alias link conference conf-2025 --force
|
|
839
885
|
```
|
|
840
886
|
|
|
841
|
-
_See code: [src/commands/dataset/alias/link.ts](https://github.com/sanity-io/cli/blob/
|
|
887
|
+
_See code: [src/commands/dataset/alias/link.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/dataset/alias/link.ts)_
|
|
842
888
|
|
|
843
889
|
## `sanity dataset alias unlink [ALIASNAME]`
|
|
844
890
|
|
|
@@ -846,7 +892,7 @@ Unlink a dataset alias from its dataset within your project
|
|
|
846
892
|
|
|
847
893
|
```
|
|
848
894
|
USAGE
|
|
849
|
-
$ sanity dataset alias unlink [ALIASNAME] [--force]
|
|
895
|
+
$ sanity dataset alias unlink [ALIASNAME] [-p <id>] [--force]
|
|
850
896
|
|
|
851
897
|
ARGUMENTS
|
|
852
898
|
[ALIASNAME] Dataset alias name to unlink
|
|
@@ -854,6 +900,9 @@ ARGUMENTS
|
|
|
854
900
|
FLAGS
|
|
855
901
|
--force Skip confirmation prompt and unlink immediately
|
|
856
902
|
|
|
903
|
+
OVERRIDE FLAGS
|
|
904
|
+
-p, --project-id=<id> Project ID to unlink dataset alias in (overrides CLI configuration)
|
|
905
|
+
|
|
857
906
|
DESCRIPTION
|
|
858
907
|
Unlink a dataset alias from its dataset within your project
|
|
859
908
|
|
|
@@ -875,7 +924,7 @@ EXAMPLES
|
|
|
875
924
|
$ sanity dataset alias unlink conference --force
|
|
876
925
|
```
|
|
877
926
|
|
|
878
|
-
_See code: [src/commands/dataset/alias/unlink.ts](https://github.com/sanity-io/cli/blob/
|
|
927
|
+
_See code: [src/commands/dataset/alias/unlink.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/dataset/alias/unlink.ts)_
|
|
879
928
|
|
|
880
929
|
## `sanity dataset copy [SOURCE] [TARGET]`
|
|
881
930
|
|
|
@@ -883,8 +932,8 @@ Manages dataset copying, including starting a new copy job, listing copy jobs an
|
|
|
883
932
|
|
|
884
933
|
```
|
|
885
934
|
USAGE
|
|
886
|
-
$ sanity dataset copy [SOURCE] [TARGET] [--attach <value> | --list | --detach | --skip-history]
|
|
887
|
-
] [--offset <value> ]
|
|
935
|
+
$ sanity dataset copy [SOURCE] [TARGET] [-p <id>] [--attach <value> | --list | --detach | --skip-history]
|
|
936
|
+
[--limit <value> ] [--offset <value> ]
|
|
888
937
|
|
|
889
938
|
ARGUMENTS
|
|
890
939
|
[SOURCE] Name of the dataset to copy from
|
|
@@ -898,6 +947,9 @@ FLAGS
|
|
|
898
947
|
--offset=<value> Start position in the list of jobs (default 0)
|
|
899
948
|
--skip-history Don't preserve document history on copy
|
|
900
949
|
|
|
950
|
+
OVERRIDE FLAGS
|
|
951
|
+
-p, --project-id=<id> Project ID to copy dataset in (overrides CLI configuration)
|
|
952
|
+
|
|
901
953
|
DESCRIPTION
|
|
902
954
|
Manages dataset copying, including starting a new copy job, listing copy jobs and following the progress of a running
|
|
903
955
|
copy job
|
|
@@ -936,7 +988,7 @@ EXAMPLES
|
|
|
936
988
|
$ sanity dataset copy --list --offset 2 --limit 10
|
|
937
989
|
```
|
|
938
990
|
|
|
939
|
-
_See code: [src/commands/dataset/copy.ts](https://github.com/sanity-io/cli/blob/
|
|
991
|
+
_See code: [src/commands/dataset/copy.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/dataset/copy.ts)_
|
|
940
992
|
|
|
941
993
|
## `sanity dataset create [NAME]`
|
|
942
994
|
|
|
@@ -944,14 +996,20 @@ Create a new dataset within your project
|
|
|
944
996
|
|
|
945
997
|
```
|
|
946
998
|
USAGE
|
|
947
|
-
$ sanity dataset create [NAME] [--
|
|
999
|
+
$ sanity dataset create [NAME] [-p <id>] [--embeddings-projection <value> --embeddings] [--visibility
|
|
1000
|
+
custom|private|public]
|
|
948
1001
|
|
|
949
1002
|
ARGUMENTS
|
|
950
1003
|
[NAME] Name of the dataset to create
|
|
951
1004
|
|
|
952
1005
|
FLAGS
|
|
953
|
-
--
|
|
954
|
-
|
|
1006
|
+
--embeddings Enable embeddings for this dataset
|
|
1007
|
+
--embeddings-projection=<value> GROQ projection for embeddings indexing (e.g. "{ title, body }")
|
|
1008
|
+
--visibility=<option> Set visibility for this dataset (custom/private/public)
|
|
1009
|
+
<options: custom|private|public>
|
|
1010
|
+
|
|
1011
|
+
OVERRIDE FLAGS
|
|
1012
|
+
-p, --project-id=<id> Project ID to create dataset in (overrides CLI configuration)
|
|
955
1013
|
|
|
956
1014
|
DESCRIPTION
|
|
957
1015
|
Create a new dataset within your project
|
|
@@ -970,7 +1028,7 @@ EXAMPLES
|
|
|
970
1028
|
$ sanity dataset create my-dataset --visibility private
|
|
971
1029
|
```
|
|
972
1030
|
|
|
973
|
-
_See code: [src/commands/dataset/create.ts](https://github.com/sanity-io/cli/blob/
|
|
1031
|
+
_See code: [src/commands/dataset/create.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/dataset/create.ts)_
|
|
974
1032
|
|
|
975
1033
|
## `sanity dataset delete DATASETNAME`
|
|
976
1034
|
|
|
@@ -978,7 +1036,7 @@ Delete a dataset within your project
|
|
|
978
1036
|
|
|
979
1037
|
```
|
|
980
1038
|
USAGE
|
|
981
|
-
$ sanity dataset delete DATASETNAME [--force]
|
|
1039
|
+
$ sanity dataset delete DATASETNAME [-p <id>] [--force]
|
|
982
1040
|
|
|
983
1041
|
ARGUMENTS
|
|
984
1042
|
DATASETNAME Dataset name to delete
|
|
@@ -986,6 +1044,9 @@ ARGUMENTS
|
|
|
986
1044
|
FLAGS
|
|
987
1045
|
--force Do not prompt for delete confirmation - forcefully delete
|
|
988
1046
|
|
|
1047
|
+
OVERRIDE FLAGS
|
|
1048
|
+
-p, --project-id=<id> Project ID to delete dataset from (overrides CLI configuration)
|
|
1049
|
+
|
|
989
1050
|
DESCRIPTION
|
|
990
1051
|
Delete a dataset within your project
|
|
991
1052
|
|
|
@@ -999,7 +1060,94 @@ EXAMPLES
|
|
|
999
1060
|
$ sanity dataset delete my-dataset --force
|
|
1000
1061
|
```
|
|
1001
1062
|
|
|
1002
|
-
_See code: [src/commands/dataset/delete.ts](https://github.com/sanity-io/cli/blob/
|
|
1063
|
+
_See code: [src/commands/dataset/delete.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/dataset/delete.ts)_
|
|
1064
|
+
|
|
1065
|
+
## `sanity dataset embeddings disable [DATASET]`
|
|
1066
|
+
|
|
1067
|
+
Disable embeddings for a dataset
|
|
1068
|
+
|
|
1069
|
+
```
|
|
1070
|
+
USAGE
|
|
1071
|
+
$ sanity dataset embeddings disable [DATASET] [-p <id>]
|
|
1072
|
+
|
|
1073
|
+
ARGUMENTS
|
|
1074
|
+
[DATASET] Dataset name to disable embeddings for
|
|
1075
|
+
|
|
1076
|
+
OVERRIDE FLAGS
|
|
1077
|
+
-p, --project-id=<id> Project ID to disable embeddings for (overrides CLI configuration)
|
|
1078
|
+
|
|
1079
|
+
DESCRIPTION
|
|
1080
|
+
Disable embeddings for a dataset
|
|
1081
|
+
|
|
1082
|
+
EXAMPLES
|
|
1083
|
+
Disable embeddings for the production dataset
|
|
1084
|
+
|
|
1085
|
+
$ sanity dataset embeddings disable production
|
|
1086
|
+
```
|
|
1087
|
+
|
|
1088
|
+
_See code: [src/commands/dataset/embeddings/disable.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/dataset/embeddings/disable.ts)_
|
|
1089
|
+
|
|
1090
|
+
## `sanity dataset embeddings enable [DATASET]`
|
|
1091
|
+
|
|
1092
|
+
Enable embeddings for a dataset
|
|
1093
|
+
|
|
1094
|
+
```
|
|
1095
|
+
USAGE
|
|
1096
|
+
$ sanity dataset embeddings enable [DATASET] [-p <id>] [--projection <value>] [--wait]
|
|
1097
|
+
|
|
1098
|
+
ARGUMENTS
|
|
1099
|
+
[DATASET] Dataset name to enable embeddings for
|
|
1100
|
+
|
|
1101
|
+
FLAGS
|
|
1102
|
+
--projection=<value> GROQ projection defining which fields to embed (e.g. "{ title, body }")
|
|
1103
|
+
--wait Wait for embeddings processing to complete before returning
|
|
1104
|
+
|
|
1105
|
+
OVERRIDE FLAGS
|
|
1106
|
+
-p, --project-id=<id> Project ID to enable embeddings for (overrides CLI configuration)
|
|
1107
|
+
|
|
1108
|
+
DESCRIPTION
|
|
1109
|
+
Enable embeddings for a dataset
|
|
1110
|
+
|
|
1111
|
+
EXAMPLES
|
|
1112
|
+
Enable embeddings for the production dataset
|
|
1113
|
+
|
|
1114
|
+
$ sanity dataset embeddings enable production
|
|
1115
|
+
|
|
1116
|
+
Enable embeddings with a specific projection
|
|
1117
|
+
|
|
1118
|
+
$ sanity dataset embeddings enable production --projection "{ title, body }"
|
|
1119
|
+
|
|
1120
|
+
Enable embeddings and wait for processing to complete
|
|
1121
|
+
|
|
1122
|
+
$ sanity dataset embeddings enable production --wait
|
|
1123
|
+
```
|
|
1124
|
+
|
|
1125
|
+
_See code: [src/commands/dataset/embeddings/enable.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/dataset/embeddings/enable.ts)_
|
|
1126
|
+
|
|
1127
|
+
## `sanity dataset embeddings status [DATASET]`
|
|
1128
|
+
|
|
1129
|
+
Show embeddings settings and status for a dataset
|
|
1130
|
+
|
|
1131
|
+
```
|
|
1132
|
+
USAGE
|
|
1133
|
+
$ sanity dataset embeddings status [DATASET] [-p <id>]
|
|
1134
|
+
|
|
1135
|
+
ARGUMENTS
|
|
1136
|
+
[DATASET] The name of the dataset to check embeddings status for
|
|
1137
|
+
|
|
1138
|
+
OVERRIDE FLAGS
|
|
1139
|
+
-p, --project-id=<id> Project ID to check embeddings status for (overrides CLI configuration)
|
|
1140
|
+
|
|
1141
|
+
DESCRIPTION
|
|
1142
|
+
Show embeddings settings and status for a dataset
|
|
1143
|
+
|
|
1144
|
+
EXAMPLES
|
|
1145
|
+
Show embeddings status for the production dataset
|
|
1146
|
+
|
|
1147
|
+
$ sanity dataset embeddings status production
|
|
1148
|
+
```
|
|
1149
|
+
|
|
1150
|
+
_See code: [src/commands/dataset/embeddings/status.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/dataset/embeddings/status.ts)_
|
|
1003
1151
|
|
|
1004
1152
|
## `sanity dataset export [NAME] [DESTINATION]`
|
|
1005
1153
|
|
|
@@ -1007,8 +1155,8 @@ Export dataset to local filesystem as a gzipped tarball. Assets failing with HTT
|
|
|
1007
1155
|
|
|
1008
1156
|
```
|
|
1009
1157
|
USAGE
|
|
1010
|
-
$ sanity dataset export [NAME] [DESTINATION] [--asset-concurrency <value>] [--mode stream|cursor]
|
|
1011
|
-
[--no-compress] [--no-drafts] [--overwrite] [--raw] [--types <value>]
|
|
1158
|
+
$ sanity dataset export [NAME] [DESTINATION] [-p <id>] [--asset-concurrency <value>] [--mode stream|cursor]
|
|
1159
|
+
[--no-assets] [--no-compress] [--no-drafts] [--overwrite] [--raw] [--types <value>]
|
|
1012
1160
|
|
|
1013
1161
|
ARGUMENTS
|
|
1014
1162
|
[NAME] Name of the dataset to export
|
|
@@ -1027,6 +1175,9 @@ FLAGS
|
|
|
1027
1175
|
--raw Extract only documents, without rewriting asset references
|
|
1028
1176
|
--types=<value> Defines which document types to export (comma-separated)
|
|
1029
1177
|
|
|
1178
|
+
OVERRIDE FLAGS
|
|
1179
|
+
-p, --project-id=<id> Project ID to export dataset from (overrides CLI configuration)
|
|
1180
|
+
|
|
1030
1181
|
DESCRIPTION
|
|
1031
1182
|
Export dataset to local filesystem as a gzipped tarball. Assets failing with HTTP status codes 401, 403 and 404 upon
|
|
1032
1183
|
download are ignored and excluded from export.
|
|
@@ -1049,24 +1200,24 @@ EXAMPLES
|
|
|
1049
1200
|
$ sanity dataset export staging staging.tar.gz --types products,shops
|
|
1050
1201
|
```
|
|
1051
1202
|
|
|
1052
|
-
_See code: [src/commands/dataset/export.ts](https://github.com/sanity-io/cli/blob/
|
|
1203
|
+
_See code: [src/commands/dataset/export.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/dataset/export.ts)_
|
|
1053
1204
|
|
|
1054
|
-
## `sanity dataset import SOURCE`
|
|
1205
|
+
## `sanity dataset import SOURCE [TARGETDATASET]`
|
|
1055
1206
|
|
|
1056
1207
|
Import documents to a Sanity dataset
|
|
1057
1208
|
|
|
1058
1209
|
```
|
|
1059
1210
|
USAGE
|
|
1060
|
-
$ sanity dataset import SOURCE
|
|
1061
|
-
[--allow-
|
|
1062
|
-
[--
|
|
1211
|
+
$ sanity dataset import SOURCE [TARGETDATASET] [--allow-assets-in-different-dataset] [--allow-failing-assets]
|
|
1212
|
+
[--allow-replacement-characters] [--allow-system-documents] [--asset-concurrency <value>] [-d <name>] [--missing |
|
|
1213
|
+
--replace] [-p <id>] [--replace-assets] [--skip-cross-dataset-references] [-t <value>]
|
|
1063
1214
|
|
|
1064
1215
|
ARGUMENTS
|
|
1065
|
-
SOURCE
|
|
1216
|
+
SOURCE Source file (use "-" for stdin)
|
|
1217
|
+
[TARGETDATASET] Target dataset (prefer --dataset flag instead)
|
|
1066
1218
|
|
|
1067
1219
|
FLAGS
|
|
1068
|
-
-d, --dataset=<
|
|
1069
|
-
-p, --project=<value> (required) Project ID to import to
|
|
1220
|
+
-d, --dataset=<name> Dataset to import to
|
|
1070
1221
|
-t, --token=<value> [env: SANITY_IMPORT_TOKEN] Token to authenticate with
|
|
1071
1222
|
--allow-assets-in-different-dataset Allow asset documents to reference different project/dataset
|
|
1072
1223
|
--allow-failing-assets Skip assets that cannot be fetched/uploaded
|
|
@@ -1078,20 +1229,27 @@ FLAGS
|
|
|
1078
1229
|
--replace-assets Skip reuse of existing assets
|
|
1079
1230
|
--skip-cross-dataset-references Skips references to other datasets
|
|
1080
1231
|
|
|
1232
|
+
OVERRIDE FLAGS
|
|
1233
|
+
-p, --project-id=<id> Project ID to import to (overrides CLI configuration)
|
|
1234
|
+
|
|
1081
1235
|
DESCRIPTION
|
|
1082
1236
|
Import documents to a Sanity dataset
|
|
1083
1237
|
|
|
1084
1238
|
EXAMPLES
|
|
1085
1239
|
Import "./my-dataset.ndjson" into dataset "staging"
|
|
1086
1240
|
|
|
1087
|
-
$ sanity dataset import -
|
|
1241
|
+
$ sanity dataset import -d staging -t someSecretToken my-dataset.ndjson
|
|
1242
|
+
|
|
1243
|
+
Import into dataset "test" from stdin
|
|
1244
|
+
|
|
1245
|
+
cat my-dataset.ndjson | sanity dataset import -d test -t someToken -
|
|
1088
1246
|
|
|
1089
|
-
Import
|
|
1247
|
+
Import with explicit project ID (overrides CLI configuration)
|
|
1090
1248
|
|
|
1091
|
-
|
|
1249
|
+
$ sanity dataset import -p projectId -d staging -t someSecretToken my-dataset.ndjson
|
|
1092
1250
|
```
|
|
1093
1251
|
|
|
1094
|
-
_See code: [src/commands/dataset/import.ts](https://github.com/sanity-io/cli/blob/
|
|
1252
|
+
_See code: [src/commands/dataset/import.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/dataset/import.ts)_
|
|
1095
1253
|
|
|
1096
1254
|
## `sanity dataset list`
|
|
1097
1255
|
|
|
@@ -1099,7 +1257,10 @@ List datasets of your project
|
|
|
1099
1257
|
|
|
1100
1258
|
```
|
|
1101
1259
|
USAGE
|
|
1102
|
-
$ sanity dataset list
|
|
1260
|
+
$ sanity dataset list [-p <id>]
|
|
1261
|
+
|
|
1262
|
+
OVERRIDE FLAGS
|
|
1263
|
+
-p, --project-id=<id> Project ID to list datasets for (overrides CLI configuration)
|
|
1103
1264
|
|
|
1104
1265
|
DESCRIPTION
|
|
1105
1266
|
List datasets of your project
|
|
@@ -1108,9 +1269,13 @@ EXAMPLES
|
|
|
1108
1269
|
List datasets of your project
|
|
1109
1270
|
|
|
1110
1271
|
$ sanity dataset list
|
|
1272
|
+
|
|
1273
|
+
List datasets for a specific project
|
|
1274
|
+
|
|
1275
|
+
$ sanity dataset list --project-id abc123
|
|
1111
1276
|
```
|
|
1112
1277
|
|
|
1113
|
-
_See code: [src/commands/dataset/list.ts](https://github.com/sanity-io/cli/blob/
|
|
1278
|
+
_See code: [src/commands/dataset/list.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/dataset/list.ts)_
|
|
1114
1279
|
|
|
1115
1280
|
## `sanity dataset visibility get DATASET`
|
|
1116
1281
|
|
|
@@ -1118,11 +1283,14 @@ Get the visibility of a dataset
|
|
|
1118
1283
|
|
|
1119
1284
|
```
|
|
1120
1285
|
USAGE
|
|
1121
|
-
$ sanity dataset visibility get DATASET
|
|
1286
|
+
$ sanity dataset visibility get DATASET [-p <id>]
|
|
1122
1287
|
|
|
1123
1288
|
ARGUMENTS
|
|
1124
1289
|
DATASET The name of the dataset to get visibility for
|
|
1125
1290
|
|
|
1291
|
+
OVERRIDE FLAGS
|
|
1292
|
+
-p, --project-id=<id> Project ID to get dataset visibility for (overrides CLI configuration)
|
|
1293
|
+
|
|
1126
1294
|
DESCRIPTION
|
|
1127
1295
|
Get the visibility of a dataset
|
|
1128
1296
|
|
|
@@ -1132,7 +1300,7 @@ EXAMPLES
|
|
|
1132
1300
|
$ sanity dataset visibility get my-dataset
|
|
1133
1301
|
```
|
|
1134
1302
|
|
|
1135
|
-
_See code: [src/commands/dataset/visibility/get.ts](https://github.com/sanity-io/cli/blob/
|
|
1303
|
+
_See code: [src/commands/dataset/visibility/get.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/dataset/visibility/get.ts)_
|
|
1136
1304
|
|
|
1137
1305
|
## `sanity dataset visibility set DATASET MODE`
|
|
1138
1306
|
|
|
@@ -1140,12 +1308,15 @@ Set the visibility of a dataset
|
|
|
1140
1308
|
|
|
1141
1309
|
```
|
|
1142
1310
|
USAGE
|
|
1143
|
-
$ sanity dataset visibility set DATASET MODE
|
|
1311
|
+
$ sanity dataset visibility set DATASET MODE [-p <id>]
|
|
1144
1312
|
|
|
1145
1313
|
ARGUMENTS
|
|
1146
1314
|
DATASET The name of the dataset to set visibility for
|
|
1147
1315
|
MODE (public|private) The visibility mode to set
|
|
1148
1316
|
|
|
1317
|
+
OVERRIDE FLAGS
|
|
1318
|
+
-p, --project-id=<id> Project ID to set dataset visibility for (overrides CLI configuration)
|
|
1319
|
+
|
|
1149
1320
|
DESCRIPTION
|
|
1150
1321
|
Set the visibility of a dataset
|
|
1151
1322
|
|
|
@@ -1159,7 +1330,7 @@ EXAMPLES
|
|
|
1159
1330
|
$ sanity dataset visibility set my-dataset public
|
|
1160
1331
|
```
|
|
1161
1332
|
|
|
1162
|
-
_See code: [src/commands/dataset/visibility/set.ts](https://github.com/sanity-io/cli/blob/
|
|
1333
|
+
_See code: [src/commands/dataset/visibility/set.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/dataset/visibility/set.ts)_
|
|
1163
1334
|
|
|
1164
1335
|
## `sanity debug`
|
|
1165
1336
|
|
|
@@ -1181,7 +1352,7 @@ EXAMPLES
|
|
|
1181
1352
|
$ sanity debug --secrets
|
|
1182
1353
|
```
|
|
1183
1354
|
|
|
1184
|
-
_See code: [src/commands/debug.ts](https://github.com/sanity-io/cli/blob/
|
|
1355
|
+
_See code: [src/commands/debug.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/debug.ts)_
|
|
1185
1356
|
|
|
1186
1357
|
## `sanity deploy [SOURCEDIR]`
|
|
1187
1358
|
|
|
@@ -1189,8 +1360,8 @@ Builds and deploys Sanity Studio or application to Sanity hosting
|
|
|
1189
1360
|
|
|
1190
1361
|
```
|
|
1191
1362
|
USAGE
|
|
1192
|
-
$ sanity deploy [SOURCEDIR] [--auto-updates] [--
|
|
1193
|
-
[--verbose] [-y]
|
|
1363
|
+
$ sanity deploy [SOURCEDIR] [--auto-updates] [--external | --source-maps | --minify | --build]
|
|
1364
|
+
[--schema-required] [--verbose] [-y]
|
|
1194
1365
|
|
|
1195
1366
|
ARGUMENTS
|
|
1196
1367
|
[SOURCEDIR] Source directory
|
|
@@ -1199,6 +1370,7 @@ FLAGS
|
|
|
1199
1370
|
-y, --yes Unattended mode, answers "yes" to any "yes/no" prompt and otherwise uses defaults
|
|
1200
1371
|
--[no-]auto-updates Automatically update the studio to the latest version
|
|
1201
1372
|
--[no-]build Don't build the studio prior to deploy, instead deploying the version currently in `dist/`
|
|
1373
|
+
--external Register an externally hosted studio
|
|
1202
1374
|
--[no-]minify Skip minifying built JavaScript (speeds up build, increases size of bundle)
|
|
1203
1375
|
--schema-required Fail-fast deployment if schema store fails
|
|
1204
1376
|
--source-maps Enable source maps for built bundles (increases size of bundle)
|
|
@@ -1208,7 +1380,7 @@ DESCRIPTION
|
|
|
1208
1380
|
Builds and deploys Sanity Studio or application to Sanity hosting
|
|
1209
1381
|
|
|
1210
1382
|
EXAMPLES
|
|
1211
|
-
Build the studio
|
|
1383
|
+
Build and deploy the studio to Sanity hosting
|
|
1212
1384
|
|
|
1213
1385
|
$ sanity deploy
|
|
1214
1386
|
|
|
@@ -1219,9 +1391,13 @@ EXAMPLES
|
|
|
1219
1391
|
Fail fast on schema store fails - for when other services rely on the stored schema
|
|
1220
1392
|
|
|
1221
1393
|
$ sanity deploy --schema-required
|
|
1394
|
+
|
|
1395
|
+
Register an externally hosted studio (studioHost contains full URL)
|
|
1396
|
+
|
|
1397
|
+
$ sanity deploy --external
|
|
1222
1398
|
```
|
|
1223
1399
|
|
|
1224
|
-
_See code: [src/commands/deploy.ts](https://github.com/sanity-io/cli/blob/
|
|
1400
|
+
_See code: [src/commands/deploy.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/deploy.ts)_
|
|
1225
1401
|
|
|
1226
1402
|
## `sanity dev`
|
|
1227
1403
|
|
|
@@ -1248,7 +1424,7 @@ EXAMPLES
|
|
|
1248
1424
|
$ sanity dev --load-in-dashboard
|
|
1249
1425
|
```
|
|
1250
1426
|
|
|
1251
|
-
_See code: [src/commands/dev.ts](https://github.com/sanity-io/cli/blob/
|
|
1427
|
+
_See code: [src/commands/dev.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/dev.ts)_
|
|
1252
1428
|
|
|
1253
1429
|
## `sanity docs browse`
|
|
1254
1430
|
|
|
@@ -1262,7 +1438,7 @@ DESCRIPTION
|
|
|
1262
1438
|
Open Sanity docs in a web browser
|
|
1263
1439
|
```
|
|
1264
1440
|
|
|
1265
|
-
_See code: [src/commands/docs/browse.ts](https://github.com/sanity-io/cli/blob/
|
|
1441
|
+
_See code: [src/commands/docs/browse.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/docs/browse.ts)_
|
|
1266
1442
|
|
|
1267
1443
|
## `sanity docs read PATH`
|
|
1268
1444
|
|
|
@@ -1299,7 +1475,7 @@ EXAMPLES
|
|
|
1299
1475
|
$ sanity docs read https://www.sanity.io/docs/studio/installation -w
|
|
1300
1476
|
```
|
|
1301
1477
|
|
|
1302
|
-
_See code: [src/commands/docs/read.ts](https://github.com/sanity-io/cli/blob/
|
|
1478
|
+
_See code: [src/commands/docs/read.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/docs/read.ts)_
|
|
1303
1479
|
|
|
1304
1480
|
## `sanity docs search QUERY`
|
|
1305
1481
|
|
|
@@ -1332,7 +1508,38 @@ EXAMPLES
|
|
|
1332
1508
|
$ sanity docs search "deployment" --limit=5
|
|
1333
1509
|
```
|
|
1334
1510
|
|
|
1335
|
-
_See code: [src/commands/docs/search.ts](https://github.com/sanity-io/cli/blob/
|
|
1511
|
+
_See code: [src/commands/docs/search.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/docs/search.ts)_
|
|
1512
|
+
|
|
1513
|
+
## `sanity doctor [CHECKS]`
|
|
1514
|
+
|
|
1515
|
+
Run diagnostics on your Sanity project
|
|
1516
|
+
|
|
1517
|
+
```
|
|
1518
|
+
USAGE
|
|
1519
|
+
$ sanity doctor [CHECKS...] [-j]
|
|
1520
|
+
|
|
1521
|
+
ARGUMENTS
|
|
1522
|
+
[CHECKS...] Checks to enable (defaults to all). Valid: cli
|
|
1523
|
+
|
|
1524
|
+
FLAGS
|
|
1525
|
+
-j, --json Output results as JSON
|
|
1526
|
+
|
|
1527
|
+
DESCRIPTION
|
|
1528
|
+
Run diagnostics on your Sanity project
|
|
1529
|
+
|
|
1530
|
+
EXAMPLES
|
|
1531
|
+
$ sanity doctor
|
|
1532
|
+
|
|
1533
|
+
Output results as JSON
|
|
1534
|
+
|
|
1535
|
+
$ sanity doctor --json
|
|
1536
|
+
|
|
1537
|
+
Only run CLI-related diagnostics
|
|
1538
|
+
|
|
1539
|
+
$ sanity doctor cli
|
|
1540
|
+
```
|
|
1541
|
+
|
|
1542
|
+
_See code: [src/commands/doctor.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/doctor.ts)_
|
|
1336
1543
|
|
|
1337
1544
|
## `sanity documents create [FILE]`
|
|
1338
1545
|
|
|
@@ -1340,18 +1547,21 @@ Create one or more documents
|
|
|
1340
1547
|
|
|
1341
1548
|
```
|
|
1342
1549
|
USAGE
|
|
1343
|
-
$ sanity documents create [FILE] [-d <
|
|
1550
|
+
$ sanity documents create [FILE] [-p <id>] [-d <name>] [--id <value>] [--json5] [--missing] [--replace] [--watch]
|
|
1344
1551
|
|
|
1345
1552
|
ARGUMENTS
|
|
1346
1553
|
[FILE] JSON file to create document(s) from
|
|
1347
1554
|
|
|
1348
1555
|
FLAGS
|
|
1349
|
-
|
|
1350
|
-
|
|
1351
|
-
|
|
1352
|
-
|
|
1353
|
-
|
|
1354
|
-
|
|
1556
|
+
--id=<value> Specify a document ID to use. Will fetch remote document ID and populate editor.
|
|
1557
|
+
--json5 Use JSON5 file type to allow a "simplified" version of JSON
|
|
1558
|
+
--missing On duplicate document IDs, don't modify the target document(s)
|
|
1559
|
+
--replace On duplicate document IDs, replace existing document with specified document(s)
|
|
1560
|
+
--watch Write the documents whenever the target file or buffer changes
|
|
1561
|
+
|
|
1562
|
+
OVERRIDE FLAGS
|
|
1563
|
+
-d, --dataset=<name> Dataset to create document(s) in (overrides CLI configuration)
|
|
1564
|
+
-p, --project-id=<id> Project ID to create document(s) in (overrides CLI configuration)
|
|
1355
1565
|
|
|
1356
1566
|
DESCRIPTION
|
|
1357
1567
|
Create one or more documents
|
|
@@ -1374,9 +1584,13 @@ EXAMPLES
|
|
|
1374
1584
|
parser for simplified syntax.
|
|
1375
1585
|
|
|
1376
1586
|
$ sanity documents create --id myDocId --watch --replace --json5
|
|
1587
|
+
|
|
1588
|
+
Create documents in a specific project
|
|
1589
|
+
|
|
1590
|
+
$ sanity documents create myDocument.json --project-id abc123
|
|
1377
1591
|
```
|
|
1378
1592
|
|
|
1379
|
-
_See code: [src/commands/documents/create.ts](https://github.com/sanity-io/cli/blob/
|
|
1593
|
+
_See code: [src/commands/documents/create.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/documents/create.ts)_
|
|
1380
1594
|
|
|
1381
1595
|
## `sanity documents delete ID [IDS]`
|
|
1382
1596
|
|
|
@@ -1384,14 +1598,15 @@ Delete one or more documents from the projects configured dataset
|
|
|
1384
1598
|
|
|
1385
1599
|
```
|
|
1386
1600
|
USAGE
|
|
1387
|
-
$ sanity documents delete ID... [IDS...] [
|
|
1601
|
+
$ sanity documents delete ID... [IDS...] [-p <id>] [-d <name>]
|
|
1388
1602
|
|
|
1389
1603
|
ARGUMENTS
|
|
1390
1604
|
ID... Document ID to delete
|
|
1391
1605
|
[IDS...] Additional document IDs to delete
|
|
1392
1606
|
|
|
1393
|
-
FLAGS
|
|
1394
|
-
--dataset=<
|
|
1607
|
+
OVERRIDE FLAGS
|
|
1608
|
+
-d, --dataset=<name> Dataset to delete from (overrides CLI configuration)
|
|
1609
|
+
-p, --project-id=<id> Project ID to delete from (overrides CLI configuration)
|
|
1395
1610
|
|
|
1396
1611
|
DESCRIPTION
|
|
1397
1612
|
Delete one or more documents from the projects configured dataset
|
|
@@ -1412,9 +1627,13 @@ EXAMPLES
|
|
|
1412
1627
|
Delete the document with ID "doc1" and "doc2"
|
|
1413
1628
|
|
|
1414
1629
|
$ sanity documents delete doc1 doc2
|
|
1630
|
+
|
|
1631
|
+
Delete a document from a specific project
|
|
1632
|
+
|
|
1633
|
+
$ sanity documents delete myDocId --project-id abc123
|
|
1415
1634
|
```
|
|
1416
1635
|
|
|
1417
|
-
_See code: [src/commands/documents/delete.ts](https://github.com/sanity-io/cli/blob/
|
|
1636
|
+
_See code: [src/commands/documents/delete.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/documents/delete.ts)_
|
|
1418
1637
|
|
|
1419
1638
|
## `sanity documents get DOCUMENTID`
|
|
1420
1639
|
|
|
@@ -1422,14 +1641,17 @@ Get and print a document by ID
|
|
|
1422
1641
|
|
|
1423
1642
|
```
|
|
1424
1643
|
USAGE
|
|
1425
|
-
$ sanity documents get DOCUMENTID [-d <
|
|
1644
|
+
$ sanity documents get DOCUMENTID [-p <id>] [-d <name>] [--pretty]
|
|
1426
1645
|
|
|
1427
1646
|
ARGUMENTS
|
|
1428
1647
|
DOCUMENTID Document ID to retrieve
|
|
1429
1648
|
|
|
1430
1649
|
FLAGS
|
|
1431
|
-
|
|
1432
|
-
|
|
1650
|
+
--pretty Colorize JSON output
|
|
1651
|
+
|
|
1652
|
+
OVERRIDE FLAGS
|
|
1653
|
+
-d, --dataset=<name> Dataset to get document from (overrides CLI configuration)
|
|
1654
|
+
-p, --project-id=<id> Project ID to get document from (overrides CLI configuration)
|
|
1433
1655
|
|
|
1434
1656
|
DESCRIPTION
|
|
1435
1657
|
Get and print a document by ID
|
|
@@ -1446,9 +1668,13 @@ EXAMPLES
|
|
|
1446
1668
|
Get document from a specific dataset
|
|
1447
1669
|
|
|
1448
1670
|
$ sanity documents get myDocId --dataset production
|
|
1671
|
+
|
|
1672
|
+
Get a document from a specific project
|
|
1673
|
+
|
|
1674
|
+
$ sanity documents get myDocId --project-id abc123
|
|
1449
1675
|
```
|
|
1450
1676
|
|
|
1451
|
-
_See code: [src/commands/documents/get.ts](https://github.com/sanity-io/cli/blob/
|
|
1677
|
+
_See code: [src/commands/documents/get.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/documents/get.ts)_
|
|
1452
1678
|
|
|
1453
1679
|
## `sanity documents query QUERY`
|
|
1454
1680
|
|
|
@@ -1456,17 +1682,19 @@ Query for documents
|
|
|
1456
1682
|
|
|
1457
1683
|
```
|
|
1458
1684
|
USAGE
|
|
1459
|
-
$ sanity documents query QUERY [
|
|
1685
|
+
$ sanity documents query QUERY [-p <id>] [-d <name>] [--anonymous] [--api-version <value>] [--pretty]
|
|
1460
1686
|
|
|
1461
1687
|
ARGUMENTS
|
|
1462
1688
|
QUERY GROQ query to run against the dataset
|
|
1463
1689
|
|
|
1464
1690
|
FLAGS
|
|
1465
|
-
|
|
1466
|
-
-
|
|
1467
|
-
|
|
1468
|
-
|
|
1469
|
-
|
|
1691
|
+
--anonymous Send the query without any authorization token
|
|
1692
|
+
--api-version=<value> [env: SANITY_CLI_QUERY_API_VERSION] API version to use (defaults to 2025-08-15)
|
|
1693
|
+
--pretty Colorize JSON output
|
|
1694
|
+
|
|
1695
|
+
OVERRIDE FLAGS
|
|
1696
|
+
-d, --dataset=<name> Dataset to query (overrides CLI configuration)
|
|
1697
|
+
-p, --project-id=<id> Project ID to query (overrides CLI configuration)
|
|
1470
1698
|
|
|
1471
1699
|
DESCRIPTION
|
|
1472
1700
|
Query for documents
|
|
@@ -1483,9 +1711,13 @@ EXAMPLES
|
|
|
1483
1711
|
Use API version v2021-06-07 and do a query
|
|
1484
1712
|
|
|
1485
1713
|
$ sanity documents query '*[_id == "header"] { "headerText": pt::text(body) }' --api-version v2021-06-07
|
|
1714
|
+
|
|
1715
|
+
Query documents in a specific project and dataset
|
|
1716
|
+
|
|
1717
|
+
$ sanity documents query '*[_type == "post"]' --project-id abc123 --dataset production
|
|
1486
1718
|
```
|
|
1487
1719
|
|
|
1488
|
-
_See code: [src/commands/documents/query.ts](https://github.com/sanity-io/cli/blob/
|
|
1720
|
+
_See code: [src/commands/documents/query.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/documents/query.ts)_
|
|
1489
1721
|
|
|
1490
1722
|
## `sanity documents validate`
|
|
1491
1723
|
|
|
@@ -1493,23 +1725,24 @@ Validate documents in a dataset against the studio schema
|
|
|
1493
1725
|
|
|
1494
1726
|
```
|
|
1495
1727
|
USAGE
|
|
1496
|
-
$ sanity documents validate [-d <
|
|
1728
|
+
$ sanity documents validate [-p <id>] [-d <name>] [--file <value>] [--format <value>] [--level error|warning|info]
|
|
1497
1729
|
[--max-custom-validation-concurrency <value>] [--max-fetch-concurrency <value>] [--workspace <value>] [-y]
|
|
1498
1730
|
|
|
1499
1731
|
FLAGS
|
|
1500
|
-
-d, --dataset=<
|
|
1732
|
+
-d, --dataset=<name> Override the dataset used. By default, this is derived from the given
|
|
1501
1733
|
workspace
|
|
1734
|
+
-p, --project-id=<id> Override the project ID used. By default, this is derived from the
|
|
1735
|
+
given workspace
|
|
1502
1736
|
-y, --yes Skips the first confirmation prompt
|
|
1503
1737
|
--file=<value> Provide a path to either an .ndjson file or a tarball containing an
|
|
1504
1738
|
.ndjson file
|
|
1505
1739
|
--format=<value> The output format used to print the found validation markers and
|
|
1506
1740
|
report progress
|
|
1507
|
-
--level=<option> [default: warning] The minimum level reported
|
|
1508
|
-
warning
|
|
1741
|
+
--level=<option> [default: warning] The minimum level reported. Defaults to warning
|
|
1509
1742
|
<options: error|warning|info>
|
|
1510
1743
|
--max-custom-validation-concurrency=<value> [default: 5] Specify how many custom validators can run concurrently
|
|
1511
|
-
--max-fetch-concurrency=<value> [default: 25] Specify how many `client.fetch` requests are
|
|
1512
|
-
|
|
1744
|
+
--max-fetch-concurrency=<value> [default: 25] Specify how many `client.fetch` requests are allowed to
|
|
1745
|
+
run concurrently
|
|
1513
1746
|
--workspace=<value> The name of the workspace to use when downloading and validating all
|
|
1514
1747
|
documents
|
|
1515
1748
|
|
|
@@ -1532,9 +1765,13 @@ EXAMPLES
|
|
|
1532
1765
|
Report out info level validation markers too
|
|
1533
1766
|
|
|
1534
1767
|
$ sanity documents validate --level info
|
|
1768
|
+
|
|
1769
|
+
Validate documents in a specific project and dataset
|
|
1770
|
+
|
|
1771
|
+
$ sanity documents validate --project-id abc123 --dataset production
|
|
1535
1772
|
```
|
|
1536
1773
|
|
|
1537
|
-
_See code: [src/commands/documents/validate.ts](https://github.com/sanity-io/cli/blob/
|
|
1774
|
+
_See code: [src/commands/documents/validate.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/documents/validate.ts)_
|
|
1538
1775
|
|
|
1539
1776
|
## `sanity exec SCRIPT`
|
|
1540
1777
|
|
|
@@ -1575,7 +1812,7 @@ EXAMPLES
|
|
|
1575
1812
|
$ sanity exec --mock-browser-env myscript.js -- --dry-run positional-argument
|
|
1576
1813
|
```
|
|
1577
1814
|
|
|
1578
|
-
_See code: [src/commands/exec.ts](https://github.com/sanity-io/cli/blob/
|
|
1815
|
+
_See code: [src/commands/exec.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/exec.ts)_
|
|
1579
1816
|
|
|
1580
1817
|
## `sanity functions add`
|
|
1581
1818
|
|
|
@@ -1584,8 +1821,8 @@ Add a Function to your Blueprint
|
|
|
1584
1821
|
```
|
|
1585
1822
|
USAGE
|
|
1586
1823
|
$ sanity functions add [--example <value> | -n <value> | | --language ts|js | --javascript | | ] [--type
|
|
1587
|
-
document-
|
|
1588
|
-
te|media-library-asset-delete... ] [--helpers] [--installer skip|npm|pnpm|yarn] [-i | ]
|
|
1824
|
+
document-publish|document-create|document-update|document-delete|media-library-asset-create|media-library-asset-upda
|
|
1825
|
+
te|media-library-asset-delete|scheduled-function... ] [--helpers] [--installer skip|npm|pnpm|yarn] [-i | ]
|
|
1589
1826
|
|
|
1590
1827
|
FLAGS
|
|
1591
1828
|
-i, --install Shortcut for --fn-installer npm
|
|
@@ -1599,8 +1836,8 @@ FLAGS
|
|
|
1599
1836
|
<options: ts|js>
|
|
1600
1837
|
--type=<option>... Document change event(s) that should trigger the function; you can specify multiple events
|
|
1601
1838
|
by specifying this flag multiple times
|
|
1602
|
-
<options: document-
|
|
1603
|
-
et-create|media-library-asset-update|media-library-asset-delete>
|
|
1839
|
+
<options: document-publish|document-create|document-update|document-delete|media-library-ass
|
|
1840
|
+
et-create|media-library-asset-update|media-library-asset-delete|scheduled-function>
|
|
1604
1841
|
|
|
1605
1842
|
DESCRIPTION
|
|
1606
1843
|
Add a Function to your Blueprint
|
|
@@ -1624,7 +1861,7 @@ EXAMPLES
|
|
|
1624
1861
|
$ sanity functions add --name my-function --type document-create --type document-update --lang js
|
|
1625
1862
|
```
|
|
1626
1863
|
|
|
1627
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/
|
|
1864
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.5.0/src/commands/functions/add.ts)_
|
|
1628
1865
|
|
|
1629
1866
|
## `sanity functions dev`
|
|
1630
1867
|
|
|
@@ -1658,7 +1895,7 @@ EXAMPLES
|
|
|
1658
1895
|
$ sanity functions dev --timeout 60
|
|
1659
1896
|
```
|
|
1660
1897
|
|
|
1661
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/
|
|
1898
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.5.0/src/commands/functions/dev.ts)_
|
|
1662
1899
|
|
|
1663
1900
|
## `sanity functions env add NAME KEY VALUE`
|
|
1664
1901
|
|
|
@@ -1685,7 +1922,7 @@ EXAMPLES
|
|
|
1685
1922
|
$ sanity functions env add MyFunction API_URL https://api.example.com/
|
|
1686
1923
|
```
|
|
1687
1924
|
|
|
1688
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/
|
|
1925
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.5.0/src/commands/functions/env/add.ts)_
|
|
1689
1926
|
|
|
1690
1927
|
## `sanity functions env list NAME`
|
|
1691
1928
|
|
|
@@ -1709,7 +1946,7 @@ EXAMPLES
|
|
|
1709
1946
|
$ sanity functions env list MyFunction
|
|
1710
1947
|
```
|
|
1711
1948
|
|
|
1712
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/
|
|
1949
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.5.0/src/commands/functions/env/list.ts)_
|
|
1713
1950
|
|
|
1714
1951
|
## `sanity functions env remove NAME KEY`
|
|
1715
1952
|
|
|
@@ -1735,7 +1972,7 @@ EXAMPLES
|
|
|
1735
1972
|
$ sanity functions env remove MyFunction API_URL
|
|
1736
1973
|
```
|
|
1737
1974
|
|
|
1738
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/
|
|
1975
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.5.0/src/commands/functions/env/remove.ts)_
|
|
1739
1976
|
|
|
1740
1977
|
## `sanity functions logs [NAME]`
|
|
1741
1978
|
|
|
@@ -1743,7 +1980,7 @@ Retrieve or delete logs for a Sanity Function
|
|
|
1743
1980
|
|
|
1744
1981
|
```
|
|
1745
1982
|
USAGE
|
|
1746
|
-
$ sanity functions logs [NAME] [-u] [-f [-d | -l <value> | -j]] [-w]
|
|
1983
|
+
$ sanity functions logs [NAME] [--stack <value>] [-u] [-f [-d | -l <value> | -j]] [-w]
|
|
1747
1984
|
|
|
1748
1985
|
ARGUMENTS
|
|
1749
1986
|
[NAME] The name of the Sanity Function
|
|
@@ -1755,6 +1992,7 @@ FLAGS
|
|
|
1755
1992
|
-l, --limit=<value> [default: 50] Total number of log entries to retrieve
|
|
1756
1993
|
-u, --utc Show dates in UTC time zone
|
|
1757
1994
|
-w, --watch Watch for new logs (streaming mode)
|
|
1995
|
+
--stack=<value> Stack name or ID to use instead of the locally configured Stack
|
|
1758
1996
|
|
|
1759
1997
|
DESCRIPTION
|
|
1760
1998
|
Retrieve or delete logs for a Sanity Function
|
|
@@ -1774,7 +2012,7 @@ EXAMPLES
|
|
|
1774
2012
|
$ sanity functions logs <name> --delete
|
|
1775
2013
|
```
|
|
1776
2014
|
|
|
1777
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/
|
|
2015
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.5.0/src/commands/functions/logs.ts)_
|
|
1778
2016
|
|
|
1779
2017
|
## `sanity functions test [NAME]`
|
|
1780
2018
|
|
|
@@ -1828,7 +2066,52 @@ EXAMPLES
|
|
|
1828
2066
|
$ sanity functions test <name> --event update --data-before '{ "title": "before" }' --data-after '{ "title": "after" }'
|
|
1829
2067
|
```
|
|
1830
2068
|
|
|
1831
|
-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/
|
|
2069
|
+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.5.0/src/commands/functions/test.ts)_
|
|
2070
|
+
|
|
2071
|
+
## `sanity graphql deploy`
|
|
2072
|
+
|
|
2073
|
+
Deploy a GraphQL API from the current Sanity schema
|
|
2074
|
+
|
|
2075
|
+
```
|
|
2076
|
+
USAGE
|
|
2077
|
+
$ sanity graphql deploy [--api <value>...] [-d <name>] [--dry-run] [--force] [--generation gen1|gen2|gen3]
|
|
2078
|
+
[--non-null-document-fields] [--playground] [--tag <value>] [--with-union-cache]
|
|
2079
|
+
|
|
2080
|
+
FLAGS
|
|
2081
|
+
-d, --dataset=<name> Deploy API for the given dataset
|
|
2082
|
+
--api=<value>... Only deploy API with this ID. Can be specified multiple times.
|
|
2083
|
+
--dry-run Validate defined GraphQL APIs, check for breaking changes, skip deploy
|
|
2084
|
+
--force Deploy API without confirming breaking changes
|
|
2085
|
+
--generation=<option> API generation to deploy (defaults to "gen3")
|
|
2086
|
+
<options: gen1|gen2|gen3>
|
|
2087
|
+
--non-null-document-fields Use non-null document fields (_id, _type etc)
|
|
2088
|
+
--[no-]playground Enable GraphQL playground for easier debugging
|
|
2089
|
+
--tag=<value> Deploy API(s) to given tag (defaults to "default")
|
|
2090
|
+
--with-union-cache Enable union cache that optimizes schema generation for schemas with many self
|
|
2091
|
+
referencing types
|
|
2092
|
+
|
|
2093
|
+
DESCRIPTION
|
|
2094
|
+
Deploy a GraphQL API from the current Sanity schema
|
|
2095
|
+
|
|
2096
|
+
EXAMPLES
|
|
2097
|
+
Deploy all defined GraphQL APIs
|
|
2098
|
+
|
|
2099
|
+
$ sanity graphql deploy
|
|
2100
|
+
|
|
2101
|
+
Validate defined GraphQL APIs, check for breaking changes, skip deploy
|
|
2102
|
+
|
|
2103
|
+
$ sanity graphql deploy --dry-run
|
|
2104
|
+
|
|
2105
|
+
Deploy only the GraphQL APIs with the IDs "staging" and "ios"
|
|
2106
|
+
|
|
2107
|
+
$ sanity graphql deploy --api staging --api ios
|
|
2108
|
+
|
|
2109
|
+
Deploy all defined GraphQL APIs, overriding any playground setting
|
|
2110
|
+
|
|
2111
|
+
$ sanity graphql deploy --playground
|
|
2112
|
+
```
|
|
2113
|
+
|
|
2114
|
+
_See code: [src/commands/graphql/deploy.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/graphql/deploy.ts)_
|
|
1832
2115
|
|
|
1833
2116
|
## `sanity graphql list`
|
|
1834
2117
|
|
|
@@ -1836,7 +2119,10 @@ List all GraphQL endpoints deployed for this project
|
|
|
1836
2119
|
|
|
1837
2120
|
```
|
|
1838
2121
|
USAGE
|
|
1839
|
-
$ sanity graphql list
|
|
2122
|
+
$ sanity graphql list [-p <id>]
|
|
2123
|
+
|
|
2124
|
+
OVERRIDE FLAGS
|
|
2125
|
+
-p, --project-id=<id> Project ID to list GraphQL endpoints for (overrides CLI configuration)
|
|
1840
2126
|
|
|
1841
2127
|
DESCRIPTION
|
|
1842
2128
|
List all GraphQL endpoints deployed for this project
|
|
@@ -1845,9 +2131,13 @@ EXAMPLES
|
|
|
1845
2131
|
List GraphQL endpoints for the current project
|
|
1846
2132
|
|
|
1847
2133
|
$ sanity graphql list
|
|
2134
|
+
|
|
2135
|
+
List GraphQL endpoints for a specific project
|
|
2136
|
+
|
|
2137
|
+
$ sanity graphql list --project-id abc123
|
|
1848
2138
|
```
|
|
1849
2139
|
|
|
1850
|
-
_See code: [src/commands/graphql/list.ts](https://github.com/sanity-io/cli/blob/
|
|
2140
|
+
_See code: [src/commands/graphql/list.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/graphql/list.ts)_
|
|
1851
2141
|
|
|
1852
2142
|
## `sanity graphql undeploy`
|
|
1853
2143
|
|
|
@@ -1855,14 +2145,16 @@ Remove a deployed GraphQL API
|
|
|
1855
2145
|
|
|
1856
2146
|
```
|
|
1857
2147
|
USAGE
|
|
1858
|
-
$ sanity graphql undeploy [--api <value>] [
|
|
2148
|
+
$ sanity graphql undeploy [--api <value> | -p <id> | ] [-d <name>] [--force] [--tag <value>]
|
|
1859
2149
|
|
|
1860
2150
|
FLAGS
|
|
1861
|
-
--api=<value>
|
|
1862
|
-
--
|
|
1863
|
-
--
|
|
1864
|
-
|
|
1865
|
-
|
|
2151
|
+
--api=<value> Undeploy API with this ID
|
|
2152
|
+
--force Skip confirmation prompt
|
|
2153
|
+
--tag=<value> [default: default] Tag to undeploy GraphQL API from
|
|
2154
|
+
|
|
2155
|
+
OVERRIDE FLAGS
|
|
2156
|
+
-d, --dataset=<name> Dataset to undeploy GraphQL API from (overrides CLI configuration)
|
|
2157
|
+
-p, --project-id=<id> Project ID to undeploy GraphQL API from (overrides CLI configuration)
|
|
1866
2158
|
|
|
1867
2159
|
DESCRIPTION
|
|
1868
2160
|
Remove a deployed GraphQL API
|
|
@@ -1887,9 +2179,13 @@ EXAMPLES
|
|
|
1887
2179
|
Undeploy GraphQL API without confirmation prompt
|
|
1888
2180
|
|
|
1889
2181
|
$ sanity graphql undeploy --force
|
|
2182
|
+
|
|
2183
|
+
Undeploy GraphQL API for a specific project and dataset
|
|
2184
|
+
|
|
2185
|
+
$ sanity graphql undeploy --project-id abc123 --dataset production
|
|
1890
2186
|
```
|
|
1891
2187
|
|
|
1892
|
-
_See code: [src/commands/graphql/undeploy.ts](https://github.com/sanity-io/cli/blob/
|
|
2188
|
+
_See code: [src/commands/graphql/undeploy.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/graphql/undeploy.ts)_
|
|
1893
2189
|
|
|
1894
2190
|
## `sanity help [COMMAND]`
|
|
1895
2191
|
|
|
@@ -1909,7 +2205,7 @@ DESCRIPTION
|
|
|
1909
2205
|
Display help for sanity.
|
|
1910
2206
|
```
|
|
1911
2207
|
|
|
1912
|
-
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.
|
|
2208
|
+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.37/src/commands/help.ts)_
|
|
1913
2209
|
|
|
1914
2210
|
## `sanity hook attempt ATTEMPTID`
|
|
1915
2211
|
|
|
@@ -1917,11 +2213,14 @@ Print details of a given webhook delivery attempt
|
|
|
1917
2213
|
|
|
1918
2214
|
```
|
|
1919
2215
|
USAGE
|
|
1920
|
-
$ sanity hook attempt ATTEMPTID
|
|
2216
|
+
$ sanity hook attempt ATTEMPTID [-p <id>]
|
|
1921
2217
|
|
|
1922
2218
|
ARGUMENTS
|
|
1923
2219
|
ATTEMPTID The delivery attempt ID to get details for
|
|
1924
2220
|
|
|
2221
|
+
OVERRIDE FLAGS
|
|
2222
|
+
-p, --project-id=<id> Project ID to view webhook attempt for (overrides CLI configuration)
|
|
2223
|
+
|
|
1925
2224
|
DESCRIPTION
|
|
1926
2225
|
Print details of a given webhook delivery attempt
|
|
1927
2226
|
|
|
@@ -1929,9 +2228,13 @@ EXAMPLES
|
|
|
1929
2228
|
Print details of webhook delivery attempt with ID abc123
|
|
1930
2229
|
|
|
1931
2230
|
$ sanity hook attempt abc123
|
|
2231
|
+
|
|
2232
|
+
Get attempt details for a specific project
|
|
2233
|
+
|
|
2234
|
+
$ sanity hook attempt abc123 --project-id projectId
|
|
1932
2235
|
```
|
|
1933
2236
|
|
|
1934
|
-
_See code: [src/commands/hook/attempt.ts](https://github.com/sanity-io/cli/blob/
|
|
2237
|
+
_See code: [src/commands/hook/attempt.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/hook/attempt.ts)_
|
|
1935
2238
|
|
|
1936
2239
|
## `sanity hook create`
|
|
1937
2240
|
|
|
@@ -1939,7 +2242,10 @@ Create a new webhook for the current project
|
|
|
1939
2242
|
|
|
1940
2243
|
```
|
|
1941
2244
|
USAGE
|
|
1942
|
-
$ sanity hook create
|
|
2245
|
+
$ sanity hook create [-p <id>]
|
|
2246
|
+
|
|
2247
|
+
OVERRIDE FLAGS
|
|
2248
|
+
-p, --project-id=<id> Project ID to create webhook for (overrides CLI configuration)
|
|
1943
2249
|
|
|
1944
2250
|
DESCRIPTION
|
|
1945
2251
|
Create a new webhook for the current project
|
|
@@ -1948,9 +2254,13 @@ EXAMPLES
|
|
|
1948
2254
|
Create a new webhook for the current project
|
|
1949
2255
|
|
|
1950
2256
|
$ sanity hook create
|
|
2257
|
+
|
|
2258
|
+
Create a webhook for a specific project
|
|
2259
|
+
|
|
2260
|
+
$ sanity hook create --project-id abc123
|
|
1951
2261
|
```
|
|
1952
2262
|
|
|
1953
|
-
_See code: [src/commands/hook/create.ts](https://github.com/sanity-io/cli/blob/
|
|
2263
|
+
_See code: [src/commands/hook/create.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/hook/create.ts)_
|
|
1954
2264
|
|
|
1955
2265
|
## `sanity hook delete [NAME]`
|
|
1956
2266
|
|
|
@@ -1958,11 +2268,14 @@ Delete a hook within your project
|
|
|
1958
2268
|
|
|
1959
2269
|
```
|
|
1960
2270
|
USAGE
|
|
1961
|
-
$ sanity hook delete [NAME]
|
|
2271
|
+
$ sanity hook delete [NAME] [-p <id>]
|
|
1962
2272
|
|
|
1963
2273
|
ARGUMENTS
|
|
1964
2274
|
[NAME] Name of hook to delete (will prompt if not provided)
|
|
1965
2275
|
|
|
2276
|
+
OVERRIDE FLAGS
|
|
2277
|
+
-p, --project-id=<id> Project ID to delete webhook from (overrides CLI configuration)
|
|
2278
|
+
|
|
1966
2279
|
DESCRIPTION
|
|
1967
2280
|
Delete a hook within your project
|
|
1968
2281
|
|
|
@@ -1974,9 +2287,13 @@ EXAMPLES
|
|
|
1974
2287
|
Delete a specific hook by name
|
|
1975
2288
|
|
|
1976
2289
|
$ sanity hook delete my-hook
|
|
2290
|
+
|
|
2291
|
+
Delete a hook from a specific project
|
|
2292
|
+
|
|
2293
|
+
$ sanity hook delete --project-id abc123
|
|
1977
2294
|
```
|
|
1978
2295
|
|
|
1979
|
-
_See code: [src/commands/hook/delete.ts](https://github.com/sanity-io/cli/blob/
|
|
2296
|
+
_See code: [src/commands/hook/delete.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/hook/delete.ts)_
|
|
1980
2297
|
|
|
1981
2298
|
## `sanity hook list`
|
|
1982
2299
|
|
|
@@ -1984,7 +2301,10 @@ List hooks for a given project
|
|
|
1984
2301
|
|
|
1985
2302
|
```
|
|
1986
2303
|
USAGE
|
|
1987
|
-
$ sanity hook list
|
|
2304
|
+
$ sanity hook list [-p <id>]
|
|
2305
|
+
|
|
2306
|
+
OVERRIDE FLAGS
|
|
2307
|
+
-p, --project-id=<id> Project ID to list webhooks for (overrides CLI configuration)
|
|
1988
2308
|
|
|
1989
2309
|
DESCRIPTION
|
|
1990
2310
|
List hooks for a given project
|
|
@@ -1993,9 +2313,13 @@ EXAMPLES
|
|
|
1993
2313
|
List hooks for a given project
|
|
1994
2314
|
|
|
1995
2315
|
$ sanity hook list
|
|
2316
|
+
|
|
2317
|
+
List hooks for a specific project
|
|
2318
|
+
|
|
2319
|
+
$ sanity hook list --project-id abc123
|
|
1996
2320
|
```
|
|
1997
2321
|
|
|
1998
|
-
_See code: [src/commands/hook/list.ts](https://github.com/sanity-io/cli/blob/
|
|
2322
|
+
_See code: [src/commands/hook/list.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/hook/list.ts)_
|
|
1999
2323
|
|
|
2000
2324
|
## `sanity hook logs [NAME]`
|
|
2001
2325
|
|
|
@@ -2003,7 +2327,7 @@ List latest log entries for a given hook
|
|
|
2003
2327
|
|
|
2004
2328
|
```
|
|
2005
2329
|
USAGE
|
|
2006
|
-
$ sanity hook logs [NAME] [--detailed]
|
|
2330
|
+
$ sanity hook logs [NAME] [-p <id>] [--detailed]
|
|
2007
2331
|
|
|
2008
2332
|
ARGUMENTS
|
|
2009
2333
|
[NAME] Name of the hook to show logs for
|
|
@@ -2011,6 +2335,9 @@ ARGUMENTS
|
|
|
2011
2335
|
FLAGS
|
|
2012
2336
|
--detailed Include detailed payload and attempts
|
|
2013
2337
|
|
|
2338
|
+
OVERRIDE FLAGS
|
|
2339
|
+
-p, --project-id=<id> Project ID to view webhook logs for (overrides CLI configuration)
|
|
2340
|
+
|
|
2014
2341
|
DESCRIPTION
|
|
2015
2342
|
List latest log entries for a given hook
|
|
2016
2343
|
|
|
@@ -2022,9 +2349,13 @@ EXAMPLES
|
|
|
2022
2349
|
List latest log entries for a specific hook by name
|
|
2023
2350
|
|
|
2024
2351
|
$ sanity hook logs [NAME]
|
|
2352
|
+
|
|
2353
|
+
List hook logs for a specific project
|
|
2354
|
+
|
|
2355
|
+
$ sanity hook logs --project-id abc123
|
|
2025
2356
|
```
|
|
2026
2357
|
|
|
2027
|
-
_See code: [src/commands/hook/logs.ts](https://github.com/sanity-io/cli/blob/
|
|
2358
|
+
_See code: [src/commands/hook/logs.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/hook/logs.ts)_
|
|
2028
2359
|
|
|
2029
2360
|
## `sanity init`
|
|
2030
2361
|
|
|
@@ -2093,7 +2424,7 @@ EXAMPLES
|
|
|
2093
2424
|
--output-path /Users/espenh/movies-unlimited
|
|
2094
2425
|
```
|
|
2095
2426
|
|
|
2096
|
-
_See code: [src/commands/init.ts](https://github.com/sanity-io/cli/blob/
|
|
2427
|
+
_See code: [src/commands/init.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/init.ts)_
|
|
2097
2428
|
|
|
2098
2429
|
## `sanity install [PACKAGES]`
|
|
2099
2430
|
|
|
@@ -2117,7 +2448,7 @@ EXAMPLES
|
|
|
2117
2448
|
$ sanity install some-package another-package
|
|
2118
2449
|
```
|
|
2119
2450
|
|
|
2120
|
-
_See code: [src/commands/install.ts](https://github.com/sanity-io/cli/blob/
|
|
2451
|
+
_See code: [src/commands/install.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/install.ts)_
|
|
2121
2452
|
|
|
2122
2453
|
## `sanity learn`
|
|
2123
2454
|
|
|
@@ -2131,7 +2462,7 @@ DESCRIPTION
|
|
|
2131
2462
|
Opens Sanity Learn in your web browser
|
|
2132
2463
|
```
|
|
2133
2464
|
|
|
2134
|
-
_See code: [src/commands/learn.ts](https://github.com/sanity-io/cli/blob/
|
|
2465
|
+
_See code: [src/commands/learn.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/learn.ts)_
|
|
2135
2466
|
|
|
2136
2467
|
## `sanity login`
|
|
2137
2468
|
|
|
@@ -2139,7 +2470,7 @@ Authenticates the CLI for access to Sanity projects
|
|
|
2139
2470
|
|
|
2140
2471
|
```
|
|
2141
2472
|
USAGE
|
|
2142
|
-
$ sanity login [--open] [--provider <providerId>
|
|
2473
|
+
$ sanity login [--open] [--provider <providerId> | --sso <slug>]
|
|
2143
2474
|
|
|
2144
2475
|
FLAGS
|
|
2145
2476
|
--[no-]open Open a browser window to log in (`--no-open` only prints URL)
|
|
@@ -2163,7 +2494,7 @@ EXAMPLES
|
|
|
2163
2494
|
$ sanity login --provider github --no-open
|
|
2164
2495
|
```
|
|
2165
2496
|
|
|
2166
|
-
_See code: [src/commands/login.ts](https://github.com/sanity-io/cli/blob/
|
|
2497
|
+
_See code: [src/commands/login.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/login.ts)_
|
|
2167
2498
|
|
|
2168
2499
|
## `sanity logout`
|
|
2169
2500
|
|
|
@@ -2177,7 +2508,7 @@ DESCRIPTION
|
|
|
2177
2508
|
Logs out the CLI from the current user session
|
|
2178
2509
|
```
|
|
2179
2510
|
|
|
2180
|
-
_See code: [src/commands/logout.ts](https://github.com/sanity-io/cli/blob/
|
|
2511
|
+
_See code: [src/commands/logout.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/logout.ts)_
|
|
2181
2512
|
|
|
2182
2513
|
## `sanity manage`
|
|
2183
2514
|
|
|
@@ -2191,7 +2522,7 @@ DESCRIPTION
|
|
|
2191
2522
|
Opens project management interface in your web browser
|
|
2192
2523
|
```
|
|
2193
2524
|
|
|
2194
|
-
_See code: [src/commands/manage.ts](https://github.com/sanity-io/cli/blob/
|
|
2525
|
+
_See code: [src/commands/manage.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/manage.ts)_
|
|
2195
2526
|
|
|
2196
2527
|
## `sanity manifest extract`
|
|
2197
2528
|
|
|
@@ -2202,7 +2533,7 @@ USAGE
|
|
|
2202
2533
|
$ sanity manifest extract [--path <value>]
|
|
2203
2534
|
|
|
2204
2535
|
FLAGS
|
|
2205
|
-
--path=<value> [default:
|
|
2536
|
+
--path=<value> [default: dist/static] Optional path to specify destination directory of the manifest files
|
|
2206
2537
|
|
|
2207
2538
|
DESCRIPTION
|
|
2208
2539
|
Extracts the studio configuration as one or more JSON manifest files.
|
|
@@ -2219,18 +2550,18 @@ EXAMPLES
|
|
|
2219
2550
|
$ sanity manifest extract --path /public/static
|
|
2220
2551
|
```
|
|
2221
2552
|
|
|
2222
|
-
_See code: [src/commands/manifest/extract.ts](https://github.com/sanity-io/cli/blob/
|
|
2553
|
+
_See code: [src/commands/manifest/extract.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/manifest/extract.ts)_
|
|
2223
2554
|
|
|
2224
2555
|
## `sanity mcp configure`
|
|
2225
2556
|
|
|
2226
|
-
Configure Sanity MCP server for AI editors (Cursor,
|
|
2557
|
+
Configure Sanity MCP server for AI editors (Claude Code, Codex CLI, Cursor, Gemini CLI, GitHub Copilot CLI, VS Code)
|
|
2227
2558
|
|
|
2228
2559
|
```
|
|
2229
2560
|
USAGE
|
|
2230
2561
|
$ sanity mcp configure
|
|
2231
2562
|
|
|
2232
2563
|
DESCRIPTION
|
|
2233
|
-
Configure Sanity MCP server for AI editors (Cursor,
|
|
2564
|
+
Configure Sanity MCP server for AI editors (Claude Code, Codex CLI, Cursor, Gemini CLI, GitHub Copilot CLI, VS Code)
|
|
2234
2565
|
|
|
2235
2566
|
EXAMPLES
|
|
2236
2567
|
Configure Sanity MCP server for detected AI editors
|
|
@@ -2238,7 +2569,7 @@ EXAMPLES
|
|
|
2238
2569
|
$ sanity mcp configure
|
|
2239
2570
|
```
|
|
2240
2571
|
|
|
2241
|
-
_See code: [src/commands/mcp/configure.ts](https://github.com/sanity-io/cli/blob/
|
|
2572
|
+
_See code: [src/commands/mcp/configure.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/mcp/configure.ts)_
|
|
2242
2573
|
|
|
2243
2574
|
## `sanity media create-aspect`
|
|
2244
2575
|
|
|
@@ -2257,7 +2588,7 @@ EXAMPLES
|
|
|
2257
2588
|
$ sanity media create-aspect
|
|
2258
2589
|
```
|
|
2259
2590
|
|
|
2260
|
-
_See code: [src/commands/media/create-aspect.ts](https://github.com/sanity-io/cli/blob/
|
|
2591
|
+
_See code: [src/commands/media/create-aspect.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/media/create-aspect.ts)_
|
|
2261
2592
|
|
|
2262
2593
|
## `sanity media delete-aspect ASPECTNAME`
|
|
2263
2594
|
|
|
@@ -2265,7 +2596,7 @@ Undeploy an aspect
|
|
|
2265
2596
|
|
|
2266
2597
|
```
|
|
2267
2598
|
USAGE
|
|
2268
|
-
$ sanity media delete-aspect ASPECTNAME [--media-library-id <value>] [--yes]
|
|
2599
|
+
$ sanity media delete-aspect ASPECTNAME [-p <id>] [--media-library-id <value>] [--yes]
|
|
2269
2600
|
|
|
2270
2601
|
ARGUMENTS
|
|
2271
2602
|
ASPECTNAME Name of the aspect to delete
|
|
@@ -2274,6 +2605,9 @@ FLAGS
|
|
|
2274
2605
|
--media-library-id=<value> The id of the target media library
|
|
2275
2606
|
--yes Skip confirmation prompt
|
|
2276
2607
|
|
|
2608
|
+
OVERRIDE FLAGS
|
|
2609
|
+
-p, --project-id=<id> Project ID to delete media aspect from (overrides CLI configuration)
|
|
2610
|
+
|
|
2277
2611
|
DESCRIPTION
|
|
2278
2612
|
Undeploy an aspect
|
|
2279
2613
|
|
|
@@ -2283,7 +2617,7 @@ EXAMPLES
|
|
|
2283
2617
|
$ sanity media delete-aspect someAspect
|
|
2284
2618
|
```
|
|
2285
2619
|
|
|
2286
|
-
_See code: [src/commands/media/delete-aspect.ts](https://github.com/sanity-io/cli/blob/
|
|
2620
|
+
_See code: [src/commands/media/delete-aspect.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/media/delete-aspect.ts)_
|
|
2287
2621
|
|
|
2288
2622
|
## `sanity media deploy-aspect [ASPECTNAME]`
|
|
2289
2623
|
|
|
@@ -2291,7 +2625,7 @@ Deploy an aspect
|
|
|
2291
2625
|
|
|
2292
2626
|
```
|
|
2293
2627
|
USAGE
|
|
2294
|
-
$ sanity media deploy-aspect [ASPECTNAME] [--all] [--media-library-id <value>]
|
|
2628
|
+
$ sanity media deploy-aspect [ASPECTNAME] [-p <id>] [--all] [--media-library-id <value>]
|
|
2295
2629
|
|
|
2296
2630
|
ARGUMENTS
|
|
2297
2631
|
[ASPECTNAME] Name of the aspect to deploy
|
|
@@ -2300,6 +2634,9 @@ FLAGS
|
|
|
2300
2634
|
--all Deploy all aspects
|
|
2301
2635
|
--media-library-id=<value> The id of the target media library
|
|
2302
2636
|
|
|
2637
|
+
OVERRIDE FLAGS
|
|
2638
|
+
-p, --project-id=<id> Project ID to deploy media aspect to (overrides CLI configuration)
|
|
2639
|
+
|
|
2303
2640
|
DESCRIPTION
|
|
2304
2641
|
Deploy an aspect
|
|
2305
2642
|
|
|
@@ -2313,7 +2650,7 @@ EXAMPLES
|
|
|
2313
2650
|
$ sanity media deploy-aspect --all
|
|
2314
2651
|
```
|
|
2315
2652
|
|
|
2316
|
-
_See code: [src/commands/media/deploy-aspect.ts](https://github.com/sanity-io/cli/blob/
|
|
2653
|
+
_See code: [src/commands/media/deploy-aspect.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/media/deploy-aspect.ts)_
|
|
2317
2654
|
|
|
2318
2655
|
## `sanity media export [DESTINATION]`
|
|
2319
2656
|
|
|
@@ -2321,8 +2658,8 @@ Export an archive of all file and image assets including their aspect data from
|
|
|
2321
2658
|
|
|
2322
2659
|
```
|
|
2323
2660
|
USAGE
|
|
2324
|
-
$ sanity media export [DESTINATION] [--asset-concurrency <value>] [--media-library-id <value>]
|
|
2325
|
-
[--overwrite]
|
|
2661
|
+
$ sanity media export [DESTINATION] [-p <id>] [--asset-concurrency <value>] [--media-library-id <value>]
|
|
2662
|
+
[--no-compress] [--overwrite]
|
|
2326
2663
|
|
|
2327
2664
|
ARGUMENTS
|
|
2328
2665
|
[DESTINATION] Output destination file path
|
|
@@ -2333,6 +2670,9 @@ FLAGS
|
|
|
2333
2670
|
--no-compress Skips compressing tarball entries (still generates a gzip file)
|
|
2334
2671
|
--overwrite Overwrite any file with the same name
|
|
2335
2672
|
|
|
2673
|
+
OVERRIDE FLAGS
|
|
2674
|
+
-p, --project-id=<id> Project ID to export media from (overrides CLI configuration)
|
|
2675
|
+
|
|
2336
2676
|
DESCRIPTION
|
|
2337
2677
|
Export an archive of all file and image assets including their aspect data from the target media library. Video assets
|
|
2338
2678
|
are excluded from the export.
|
|
@@ -2351,7 +2691,7 @@ EXAMPLES
|
|
|
2351
2691
|
$ sanity media export --media-library-id my-library-id
|
|
2352
2692
|
```
|
|
2353
2693
|
|
|
2354
|
-
_See code: [src/commands/media/export.ts](https://github.com/sanity-io/cli/blob/
|
|
2694
|
+
_See code: [src/commands/media/export.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/media/export.ts)_
|
|
2355
2695
|
|
|
2356
2696
|
## `sanity media import SOURCE`
|
|
2357
2697
|
|
|
@@ -2359,7 +2699,7 @@ Import a set of assets to the target media library.
|
|
|
2359
2699
|
|
|
2360
2700
|
```
|
|
2361
2701
|
USAGE
|
|
2362
|
-
$ sanity media import SOURCE [--media-library-id <value>] [--replace-aspects]
|
|
2702
|
+
$ sanity media import SOURCE [-p <id>] [--media-library-id <value>] [--replace-aspects]
|
|
2363
2703
|
|
|
2364
2704
|
ARGUMENTS
|
|
2365
2705
|
SOURCE Image file or folder to import from
|
|
@@ -2369,6 +2709,9 @@ FLAGS
|
|
|
2369
2709
|
--replace-aspects Replace existing aspect data. All versions will be replaced (e.g. published and draft
|
|
2370
2710
|
aspect data)
|
|
2371
2711
|
|
|
2712
|
+
OVERRIDE FLAGS
|
|
2713
|
+
-p, --project-id=<id> Project ID to import media to (overrides CLI configuration)
|
|
2714
|
+
|
|
2372
2715
|
DESCRIPTION
|
|
2373
2716
|
Import a set of assets to the target media library.
|
|
2374
2717
|
|
|
@@ -2386,7 +2729,7 @@ EXAMPLES
|
|
|
2386
2729
|
$ sanity media import products --replace-aspects
|
|
2387
2730
|
```
|
|
2388
2731
|
|
|
2389
|
-
_See code: [src/commands/media/import.ts](https://github.com/sanity-io/cli/blob/
|
|
2732
|
+
_See code: [src/commands/media/import.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/media/import.ts)_
|
|
2390
2733
|
|
|
2391
2734
|
## `sanity migration create [TITLE]`
|
|
2392
2735
|
|
|
@@ -2412,7 +2755,7 @@ EXAMPLES
|
|
|
2412
2755
|
$ sanity migration create "Rename field from location to address"
|
|
2413
2756
|
```
|
|
2414
2757
|
|
|
2415
|
-
_See code: [@sanity/migrate](https://github.com/sanity-io/migrate/blob/
|
|
2758
|
+
_See code: [@sanity/migrate](https://github.com/sanity-io/migrate/blob/v6.0.0/src/commands/migration/create.ts)_
|
|
2416
2759
|
|
|
2417
2760
|
## `sanity migration list`
|
|
2418
2761
|
|
|
@@ -2431,7 +2774,7 @@ EXAMPLES
|
|
|
2431
2774
|
$ sanity migration list
|
|
2432
2775
|
```
|
|
2433
2776
|
|
|
2434
|
-
_See code: [@sanity/migrate](https://github.com/sanity-io/migrate/blob/
|
|
2777
|
+
_See code: [@sanity/migrate](https://github.com/sanity-io/migrate/blob/v6.0.0/src/commands/migration/list.ts)_
|
|
2435
2778
|
|
|
2436
2779
|
## `sanity migration run [ID]`
|
|
2437
2780
|
|
|
@@ -2475,7 +2818,7 @@ EXAMPLES
|
|
|
2475
2818
|
$ sanity migration run <id> --from-export=production.tar.gz --no-dry-run --project xyz --dataset staging
|
|
2476
2819
|
```
|
|
2477
2820
|
|
|
2478
|
-
_See code: [@sanity/migrate](https://github.com/sanity-io/migrate/blob/
|
|
2821
|
+
_See code: [@sanity/migrate](https://github.com/sanity-io/migrate/blob/v6.0.0/src/commands/migration/run.ts)_
|
|
2479
2822
|
|
|
2480
2823
|
## `sanity openapi get SLUG`
|
|
2481
2824
|
|
|
@@ -2514,7 +2857,7 @@ EXAMPLES
|
|
|
2514
2857
|
$ sanity openapi get query > query-api.yaml
|
|
2515
2858
|
```
|
|
2516
2859
|
|
|
2517
|
-
_See code: [src/commands/openapi/get.ts](https://github.com/sanity-io/cli/blob/
|
|
2860
|
+
_See code: [src/commands/openapi/get.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/openapi/get.ts)_
|
|
2518
2861
|
|
|
2519
2862
|
## `sanity openapi list`
|
|
2520
2863
|
|
|
@@ -2545,7 +2888,7 @@ EXAMPLES
|
|
|
2545
2888
|
$ sanity openapi list --web
|
|
2546
2889
|
```
|
|
2547
2890
|
|
|
2548
|
-
_See code: [src/commands/openapi/list.ts](https://github.com/sanity-io/cli/blob/
|
|
2891
|
+
_See code: [src/commands/openapi/list.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/openapi/list.ts)_
|
|
2549
2892
|
|
|
2550
2893
|
## `sanity preview [OUTPUTDIR]`
|
|
2551
2894
|
|
|
@@ -2576,7 +2919,55 @@ EXAMPLES
|
|
|
2576
2919
|
$ sanity preview some/build-output-dir
|
|
2577
2920
|
```
|
|
2578
2921
|
|
|
2579
|
-
_See code: [src/commands/preview.ts](https://github.com/sanity-io/cli/blob/
|
|
2922
|
+
_See code: [src/commands/preview.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/preview.ts)_
|
|
2923
|
+
|
|
2924
|
+
## `sanity projects create [PROJECTNAME]`
|
|
2925
|
+
|
|
2926
|
+
Create a new Sanity project
|
|
2927
|
+
|
|
2928
|
+
```
|
|
2929
|
+
USAGE
|
|
2930
|
+
$ sanity projects create [PROJECTNAME] [--dataset <value>] [--dataset-visibility private|public] [--json]
|
|
2931
|
+
[--organization <slug|id>] [-y]
|
|
2932
|
+
|
|
2933
|
+
ARGUMENTS
|
|
2934
|
+
[PROJECTNAME] Name of the project to create
|
|
2935
|
+
|
|
2936
|
+
FLAGS
|
|
2937
|
+
-y, --yes Skip prompts and use defaults (project: "My Sanity Project", dataset: production,
|
|
2938
|
+
visibility: public)
|
|
2939
|
+
--dataset=<value> Create a dataset. Prompts for visibility unless specified or --yes used
|
|
2940
|
+
--dataset-visibility=<option> Dataset visibility: public or private
|
|
2941
|
+
<options: private|public>
|
|
2942
|
+
--json Output in JSON format
|
|
2943
|
+
--organization=<slug|id> Organization to create the project in
|
|
2944
|
+
|
|
2945
|
+
DESCRIPTION
|
|
2946
|
+
Create a new Sanity project
|
|
2947
|
+
|
|
2948
|
+
EXAMPLES
|
|
2949
|
+
Interactively create a project
|
|
2950
|
+
|
|
2951
|
+
$ sanity projects create
|
|
2952
|
+
|
|
2953
|
+
Create a project named "My New Project"
|
|
2954
|
+
|
|
2955
|
+
$ sanity projects create "My New Project"
|
|
2956
|
+
|
|
2957
|
+
Create a project in a specific organization
|
|
2958
|
+
|
|
2959
|
+
$ sanity projects create "My Project" --organization=my-org
|
|
2960
|
+
|
|
2961
|
+
Create a project with a private dataset named "staging"
|
|
2962
|
+
|
|
2963
|
+
$ sanity projects create "My Project" --dataset=staging --dataset-visibility=private
|
|
2964
|
+
|
|
2965
|
+
Create a project non-interactively with JSON output
|
|
2966
|
+
|
|
2967
|
+
$ sanity projects create "CI Project" --yes --json
|
|
2968
|
+
```
|
|
2969
|
+
|
|
2970
|
+
_See code: [src/commands/projects/create.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/projects/create.ts)_
|
|
2580
2971
|
|
|
2581
2972
|
## `sanity projects list`
|
|
2582
2973
|
|
|
@@ -2605,7 +2996,7 @@ EXAMPLES
|
|
|
2605
2996
|
$ sanity projects list --sort=members --order=asc
|
|
2606
2997
|
```
|
|
2607
2998
|
|
|
2608
|
-
_See code: [src/commands/projects/list.ts](https://github.com/sanity-io/cli/blob/
|
|
2999
|
+
_See code: [src/commands/projects/list.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/projects/list.ts)_
|
|
2609
3000
|
|
|
2610
3001
|
## `sanity schema delete`
|
|
2611
3002
|
|
|
@@ -2613,14 +3004,15 @@ Delete schema documents by id
|
|
|
2613
3004
|
|
|
2614
3005
|
```
|
|
2615
3006
|
USAGE
|
|
2616
|
-
$ sanity schema delete --ids <value> [
|
|
3007
|
+
$ sanity schema delete --ids <value> [-p <id>] [-d <name>] [--verbose]
|
|
2617
3008
|
|
|
2618
3009
|
FLAGS
|
|
2619
|
-
--dataset=<
|
|
2620
|
-
|
|
2621
|
-
|
|
2622
|
-
|
|
2623
|
-
|
|
3010
|
+
-d, --dataset=<name> Delete schemas from a specific dataset
|
|
3011
|
+
--ids=<value> (required) Comma-separated list of schema ids to delete
|
|
3012
|
+
--verbose Enable verbose logging
|
|
3013
|
+
|
|
3014
|
+
OVERRIDE FLAGS
|
|
3015
|
+
-p, --project-id=<id> Project ID to delete schema from (overrides CLI configuration)
|
|
2624
3016
|
|
|
2625
3017
|
DESCRIPTION
|
|
2626
3018
|
Delete schema documents by id
|
|
@@ -2633,13 +3025,9 @@ EXAMPLES
|
|
|
2633
3025
|
Delete multiple schemas
|
|
2634
3026
|
|
|
2635
3027
|
$ sanity schema delete --ids sanity.workspace.schema.workspaceName,prefix.sanity.workspace.schema.otherWorkspace
|
|
2636
|
-
|
|
2637
|
-
Delete using a pre-existing manifest file (config changes in sanity.config will not be picked up)
|
|
2638
|
-
|
|
2639
|
-
$ sanity schema delete --no-extract-manifest --ids sanity.workspace.schema.workspaceName
|
|
2640
3028
|
```
|
|
2641
3029
|
|
|
2642
|
-
_See code: [src/commands/schema/delete.ts](https://github.com/sanity-io/cli/blob/
|
|
3030
|
+
_See code: [src/commands/schema/delete.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/schema/delete.ts)_
|
|
2643
3031
|
|
|
2644
3032
|
## `sanity schema deploy`
|
|
2645
3033
|
|
|
@@ -2673,13 +3061,9 @@ EXAMPLES
|
|
|
2673
3061
|
Deploy the schema for only the workspace "default"
|
|
2674
3062
|
|
|
2675
3063
|
$ sanity schema deploy --workspace default
|
|
2676
|
-
|
|
2677
|
-
Runs using a pre-existing manifest file. Config changes in sanity.config will not be picked up in this case.
|
|
2678
|
-
|
|
2679
|
-
$ sanity schema deploy --no-extract-manifest
|
|
2680
3064
|
```
|
|
2681
3065
|
|
|
2682
|
-
_See code: [src/commands/schema/deploy.ts](https://github.com/sanity-io/cli/blob/
|
|
3066
|
+
_See code: [src/commands/schema/deploy.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/schema/deploy.ts)_
|
|
2683
3067
|
|
|
2684
3068
|
## `sanity schema extract`
|
|
2685
3069
|
|
|
@@ -2687,14 +3071,17 @@ Extracts a JSON representation of a Sanity schema within a Studio context.
|
|
|
2687
3071
|
|
|
2688
3072
|
```
|
|
2689
3073
|
USAGE
|
|
2690
|
-
$ sanity schema extract [--enforce-required-fields] [--format <format>] [--path <value>] [--
|
|
3074
|
+
$ sanity schema extract [--enforce-required-fields] [--format <format>] [--path <value>] [--watch]
|
|
3075
|
+
[--watch-patterns <glob>...] [--workspace <name>]
|
|
2691
3076
|
|
|
2692
3077
|
FLAGS
|
|
2693
|
-
--enforce-required-fields
|
|
2694
|
-
--format=<format>
|
|
2695
|
-
|
|
2696
|
-
--path=<value>
|
|
2697
|
-
--
|
|
3078
|
+
--enforce-required-fields Makes the schema generated treat fields marked as required as non-optional
|
|
3079
|
+
--format=<format> [default: groq-type-nodes] Format the schema as GROQ type nodes. Only available format at
|
|
3080
|
+
the moment.
|
|
3081
|
+
--path=<value> Optional path to specify destination of the schema file
|
|
3082
|
+
--watch Enable watch mode to re-extract schema on file changes
|
|
3083
|
+
--watch-patterns=<glob>... Additional glob pattern(s) to watch (can be specified multiple times)
|
|
3084
|
+
--workspace=<name> The name of the workspace to generate a schema for
|
|
2698
3085
|
|
|
2699
3086
|
DESCRIPTION
|
|
2700
3087
|
Extracts a JSON representation of a Sanity schema within a Studio context.
|
|
@@ -2705,9 +3092,17 @@ EXAMPLES
|
|
|
2705
3092
|
Extracts schema types in a Sanity project with more than one workspace
|
|
2706
3093
|
|
|
2707
3094
|
$ sanity schema extract --workspace default
|
|
3095
|
+
|
|
3096
|
+
Watch mode - re-extract on changes
|
|
3097
|
+
|
|
3098
|
+
$ sanity schema extract --watch
|
|
3099
|
+
|
|
3100
|
+
Watch with custom glob patterns
|
|
3101
|
+
|
|
3102
|
+
$ sanity schema extract --watch --watch-patterns "lib/**/*.ts"
|
|
2708
3103
|
```
|
|
2709
3104
|
|
|
2710
|
-
_See code: [src/commands/schema/extract.ts](https://github.com/sanity-io/cli/blob/
|
|
3105
|
+
_See code: [src/commands/schema/extract.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/schema/extract.ts)_
|
|
2711
3106
|
|
|
2712
3107
|
## `sanity schema list`
|
|
2713
3108
|
|
|
@@ -2715,13 +3110,11 @@ Lists all schemas in the current dataset.
|
|
|
2715
3110
|
|
|
2716
3111
|
```
|
|
2717
3112
|
USAGE
|
|
2718
|
-
$ sanity schema list [--
|
|
3113
|
+
$ sanity schema list [--id <schema_id>] [--json]
|
|
2719
3114
|
|
|
2720
3115
|
FLAGS
|
|
2721
|
-
--
|
|
2722
|
-
--
|
|
2723
|
-
--json Get schema as json
|
|
2724
|
-
--manifest-dir=<directory> [default: ./dist/static] Directory containing manifest file
|
|
3116
|
+
--id=<schema_id> Fetch a single schema by id
|
|
3117
|
+
--json Get schema as json
|
|
2725
3118
|
|
|
2726
3119
|
DESCRIPTION
|
|
2727
3120
|
Lists all schemas in the current dataset.
|
|
@@ -2747,13 +3140,9 @@ EXAMPLES
|
|
|
2747
3140
|
Get singular stored schema as pretty-printed json-object
|
|
2748
3141
|
|
|
2749
3142
|
$ sanity schema list --json --id _.schemas.workspaceName
|
|
2750
|
-
|
|
2751
|
-
Runs using a pre-existing manifest file. Config changes in sanity.config will not be picked up in this case.
|
|
2752
|
-
|
|
2753
|
-
$ sanity schema list --no-extract-manifest
|
|
2754
3143
|
```
|
|
2755
3144
|
|
|
2756
|
-
_See code: [src/commands/schema/list.ts](https://github.com/sanity-io/cli/blob/
|
|
3145
|
+
_See code: [src/commands/schema/list.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/schema/list.ts)_
|
|
2757
3146
|
|
|
2758
3147
|
## `sanity schema validate`
|
|
2759
3148
|
|
|
@@ -2796,7 +3185,7 @@ EXAMPLES
|
|
|
2796
3185
|
$ sanity schema validate --debug-metafile-path metafile.json
|
|
2797
3186
|
```
|
|
2798
3187
|
|
|
2799
|
-
_See code: [src/commands/schema/validate.ts](https://github.com/sanity-io/cli/blob/
|
|
3188
|
+
_See code: [src/commands/schema/validate.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/schema/validate.ts)_
|
|
2800
3189
|
|
|
2801
3190
|
## `sanity start [OUTPUTDIR]`
|
|
2802
3191
|
|
|
@@ -2844,7 +3233,7 @@ EXAMPLES
|
|
|
2844
3233
|
$ sanity telemetry telemetry disable
|
|
2845
3234
|
```
|
|
2846
3235
|
|
|
2847
|
-
_See code: [src/commands/telemetry/disable.ts](https://github.com/sanity-io/cli/blob/
|
|
3236
|
+
_See code: [src/commands/telemetry/disable.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/telemetry/disable.ts)_
|
|
2848
3237
|
|
|
2849
3238
|
## `sanity telemetry enable`
|
|
2850
3239
|
|
|
@@ -2863,7 +3252,7 @@ EXAMPLES
|
|
|
2863
3252
|
$ sanity telemetry telemetry enable
|
|
2864
3253
|
```
|
|
2865
3254
|
|
|
2866
|
-
_See code: [src/commands/telemetry/enable.ts](https://github.com/sanity-io/cli/blob/
|
|
3255
|
+
_See code: [src/commands/telemetry/enable.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/telemetry/enable.ts)_
|
|
2867
3256
|
|
|
2868
3257
|
## `sanity telemetry status`
|
|
2869
3258
|
|
|
@@ -2882,7 +3271,7 @@ EXAMPLES
|
|
|
2882
3271
|
$ sanity telemetry telemetry status
|
|
2883
3272
|
```
|
|
2884
3273
|
|
|
2885
|
-
_See code: [src/commands/telemetry/status.ts](https://github.com/sanity-io/cli/blob/
|
|
3274
|
+
_See code: [src/commands/telemetry/status.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/telemetry/status.ts)_
|
|
2886
3275
|
|
|
2887
3276
|
## `sanity tokens add [LABEL]`
|
|
2888
3277
|
|
|
@@ -2890,7 +3279,7 @@ Create a new API token for this project
|
|
|
2890
3279
|
|
|
2891
3280
|
```
|
|
2892
3281
|
USAGE
|
|
2893
|
-
$ sanity tokens add [LABEL] [--json] [--role viewer] [-y]
|
|
3282
|
+
$ sanity tokens add [LABEL] [-p <id>] [--json] [--role viewer] [-y]
|
|
2894
3283
|
|
|
2895
3284
|
ARGUMENTS
|
|
2896
3285
|
[LABEL] Label for the new token
|
|
@@ -2900,6 +3289,9 @@ FLAGS
|
|
|
2900
3289
|
--json Output as JSON
|
|
2901
3290
|
--role=viewer Role to assign to the token
|
|
2902
3291
|
|
|
3292
|
+
OVERRIDE FLAGS
|
|
3293
|
+
-p, --project-id=<id> Project ID to add token to (overrides CLI configuration)
|
|
3294
|
+
|
|
2903
3295
|
DESCRIPTION
|
|
2904
3296
|
Create a new API token for this project
|
|
2905
3297
|
|
|
@@ -2919,9 +3311,13 @@ EXAMPLES
|
|
|
2919
3311
|
Output token information as JSON
|
|
2920
3312
|
|
|
2921
3313
|
$ sanity tokens add "API Token" --json
|
|
3314
|
+
|
|
3315
|
+
Create a token for a specific project
|
|
3316
|
+
|
|
3317
|
+
$ sanity tokens add "My Token" --project-id abc123 --role=editor
|
|
2922
3318
|
```
|
|
2923
3319
|
|
|
2924
|
-
_See code: [src/commands/tokens/add.ts](https://github.com/sanity-io/cli/blob/
|
|
3320
|
+
_See code: [src/commands/tokens/add.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/tokens/add.ts)_
|
|
2925
3321
|
|
|
2926
3322
|
## `sanity tokens delete [TOKENID]`
|
|
2927
3323
|
|
|
@@ -2929,7 +3325,7 @@ Delete an API token from this project
|
|
|
2929
3325
|
|
|
2930
3326
|
```
|
|
2931
3327
|
USAGE
|
|
2932
|
-
$ sanity tokens delete [TOKENID] [--yes]
|
|
3328
|
+
$ sanity tokens delete [TOKENID] [-p <id>] [--yes]
|
|
2933
3329
|
|
|
2934
3330
|
ARGUMENTS
|
|
2935
3331
|
[TOKENID] Token ID to delete (will prompt if not provided)
|
|
@@ -2937,6 +3333,9 @@ ARGUMENTS
|
|
|
2937
3333
|
FLAGS
|
|
2938
3334
|
--yes Skip confirmation prompt (unattended mode)
|
|
2939
3335
|
|
|
3336
|
+
OVERRIDE FLAGS
|
|
3337
|
+
-p, --project-id=<id> Project ID to delete token from (overrides CLI configuration)
|
|
3338
|
+
|
|
2940
3339
|
DESCRIPTION
|
|
2941
3340
|
Delete an API token from this project
|
|
2942
3341
|
|
|
@@ -2952,9 +3351,13 @@ EXAMPLES
|
|
|
2952
3351
|
Delete a specific token without confirmation prompt
|
|
2953
3352
|
|
|
2954
3353
|
$ sanity tokens delete silJ2lFmK6dONB --yes
|
|
3354
|
+
|
|
3355
|
+
Delete a token from a specific project
|
|
3356
|
+
|
|
3357
|
+
$ sanity tokens delete --project-id abc123
|
|
2955
3358
|
```
|
|
2956
3359
|
|
|
2957
|
-
_See code: [src/commands/tokens/delete.ts](https://github.com/sanity-io/cli/blob/
|
|
3360
|
+
_See code: [src/commands/tokens/delete.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/tokens/delete.ts)_
|
|
2958
3361
|
|
|
2959
3362
|
## `sanity tokens list`
|
|
2960
3363
|
|
|
@@ -2962,11 +3365,14 @@ List API tokens for the current project
|
|
|
2962
3365
|
|
|
2963
3366
|
```
|
|
2964
3367
|
USAGE
|
|
2965
|
-
$ sanity tokens list [--json]
|
|
3368
|
+
$ sanity tokens list [-p <id>] [--json]
|
|
2966
3369
|
|
|
2967
3370
|
FLAGS
|
|
2968
3371
|
--json Output tokens in JSON format
|
|
2969
3372
|
|
|
3373
|
+
OVERRIDE FLAGS
|
|
3374
|
+
-p, --project-id=<id> Project ID to list tokens for (overrides CLI configuration)
|
|
3375
|
+
|
|
2970
3376
|
DESCRIPTION
|
|
2971
3377
|
List API tokens for the current project
|
|
2972
3378
|
|
|
@@ -2978,9 +3384,59 @@ EXAMPLES
|
|
|
2978
3384
|
List tokens in JSON format
|
|
2979
3385
|
|
|
2980
3386
|
$ sanity tokens list --json
|
|
3387
|
+
|
|
3388
|
+
List tokens for a specific project
|
|
3389
|
+
|
|
3390
|
+
$ sanity tokens list --project-id abc123
|
|
3391
|
+
```
|
|
3392
|
+
|
|
3393
|
+
_See code: [src/commands/tokens/list.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/tokens/list.ts)_
|
|
3394
|
+
|
|
3395
|
+
## `sanity typegen generate`
|
|
3396
|
+
|
|
3397
|
+
Sanity TypeGen
|
|
3398
|
+
|
|
2981
3399
|
```
|
|
3400
|
+
USAGE
|
|
3401
|
+
$ sanity typegen generate [--config-path <value>] [--watch]
|
|
3402
|
+
|
|
3403
|
+
FLAGS
|
|
3404
|
+
--config-path=<value> [Default: sanity-typegen.json] Specifies the path to the typegen configuration file. This file
|
|
3405
|
+
should be a JSON file that contains settings for the type generation process.
|
|
3406
|
+
--watch [Default: false] Run the typegen in watch mode
|
|
3407
|
+
|
|
3408
|
+
DESCRIPTION
|
|
3409
|
+
Sanity TypeGen
|
|
3410
|
+
|
|
3411
|
+
Configuration:
|
|
3412
|
+
This command can utilize configuration settings defined in a `sanity-typegen.json` file. These settings include:
|
|
2982
3413
|
|
|
2983
|
-
|
|
3414
|
+
- "path": Specifies a glob pattern to locate your TypeScript or JavaScript files.
|
|
3415
|
+
Default: "./src/**/*.{ts,tsx,js,jsx}"
|
|
3416
|
+
|
|
3417
|
+
- "schema": Defines the path to your Sanity schema file. This file should be generated using the `sanity schema
|
|
3418
|
+
extract` command.
|
|
3419
|
+
Default: "schema.json"
|
|
3420
|
+
|
|
3421
|
+
- "generates": Indicates the path where the generated TypeScript type definitions will be saved.
|
|
3422
|
+
Default: "./sanity.types.ts"
|
|
3423
|
+
|
|
3424
|
+
The default configuration values listed above are used if not overridden in your `sanity-typegen.json` configuration
|
|
3425
|
+
file. To customize the behavior of the type generation, adjust these properties in the configuration file according to
|
|
3426
|
+
your project's needs.
|
|
3427
|
+
|
|
3428
|
+
Note:
|
|
3429
|
+
- The `sanity schema extract` command is a prerequisite for extracting your Sanity Studio schema into a `schema.json`
|
|
3430
|
+
file, which is then used by the `sanity typegen generate` command to generate type definitions.
|
|
3431
|
+
|
|
3432
|
+
EXAMPLES
|
|
3433
|
+
Generate TypeScript type definitions from a Sanity Studio schema extracted using the `sanity schema extract`
|
|
3434
|
+
command.
|
|
3435
|
+
|
|
3436
|
+
$ sanity typegen generate
|
|
3437
|
+
```
|
|
3438
|
+
|
|
3439
|
+
_See code: [@sanity/codegen](https://github.com/sanity-io/codegen/blob/v6.0.0/src/commands/typegen/generate.ts)_
|
|
2984
3440
|
|
|
2985
3441
|
## `sanity undeploy`
|
|
2986
3442
|
|
|
@@ -2997,7 +3453,7 @@ DESCRIPTION
|
|
|
2997
3453
|
Removes the deployed Sanity Studio/App from Sanity hosting
|
|
2998
3454
|
```
|
|
2999
3455
|
|
|
3000
|
-
_See code: [src/commands/undeploy.ts](https://github.com/sanity-io/cli/blob/
|
|
3456
|
+
_See code: [src/commands/undeploy.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/undeploy.ts)_
|
|
3001
3457
|
|
|
3002
3458
|
## `sanity users invite [EMAIL]`
|
|
3003
3459
|
|
|
@@ -3005,7 +3461,7 @@ Invite a new user to the project
|
|
|
3005
3461
|
|
|
3006
3462
|
```
|
|
3007
3463
|
USAGE
|
|
3008
|
-
$ sanity users invite [EMAIL] [--role <value>]
|
|
3464
|
+
$ sanity users invite [EMAIL] [-p <id>] [--role <value>]
|
|
3009
3465
|
|
|
3010
3466
|
ARGUMENTS
|
|
3011
3467
|
[EMAIL] Email address to invite
|
|
@@ -3013,6 +3469,9 @@ ARGUMENTS
|
|
|
3013
3469
|
FLAGS
|
|
3014
3470
|
--role=<value> Role to invite the user as
|
|
3015
3471
|
|
|
3472
|
+
OVERRIDE FLAGS
|
|
3473
|
+
-p, --project-id=<id> Project ID to invite user to (overrides CLI configuration)
|
|
3474
|
+
|
|
3016
3475
|
DESCRIPTION
|
|
3017
3476
|
Invite a new user to the project
|
|
3018
3477
|
|
|
@@ -3028,9 +3487,13 @@ EXAMPLES
|
|
|
3028
3487
|
Send a new user invite to the email "pippi@sanity.io", as administrator
|
|
3029
3488
|
|
|
3030
3489
|
$ sanity users invite pippi@sanity.io --role administrator
|
|
3490
|
+
|
|
3491
|
+
Invite a user to a specific project
|
|
3492
|
+
|
|
3493
|
+
$ sanity users invite pippi@sanity.io --project-id abc123
|
|
3031
3494
|
```
|
|
3032
3495
|
|
|
3033
|
-
_See code: [src/commands/users/invite.ts](https://github.com/sanity-io/cli/blob/
|
|
3496
|
+
_See code: [src/commands/users/invite.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/users/invite.ts)_
|
|
3034
3497
|
|
|
3035
3498
|
## `sanity users list`
|
|
3036
3499
|
|
|
@@ -3038,7 +3501,7 @@ List all users of the project
|
|
|
3038
3501
|
|
|
3039
3502
|
```
|
|
3040
3503
|
USAGE
|
|
3041
|
-
$ sanity users list [--invitations] [--order asc|desc] [--robots] [--sort id|name|role|date]
|
|
3504
|
+
$ sanity users list [-p <id>] [--invitations] [--order asc|desc] [--robots] [--sort id|name|role|date]
|
|
3042
3505
|
|
|
3043
3506
|
FLAGS
|
|
3044
3507
|
--[no-]invitations Includes or excludes pending invitations
|
|
@@ -3048,6 +3511,9 @@ FLAGS
|
|
|
3048
3511
|
--sort=<option> [default: date] Sort users by specified column
|
|
3049
3512
|
<options: id|name|role|date>
|
|
3050
3513
|
|
|
3514
|
+
OVERRIDE FLAGS
|
|
3515
|
+
-p, --project-id=<id> Project ID to list users for (overrides CLI configuration)
|
|
3516
|
+
|
|
3051
3517
|
DESCRIPTION
|
|
3052
3518
|
List all users of the project
|
|
3053
3519
|
|
|
@@ -3063,9 +3529,13 @@ EXAMPLES
|
|
|
3063
3529
|
List all users, sorted by role
|
|
3064
3530
|
|
|
3065
3531
|
$ sanity users list --sort role
|
|
3532
|
+
|
|
3533
|
+
List users for a specific project
|
|
3534
|
+
|
|
3535
|
+
$ sanity users list --project-id abc123
|
|
3066
3536
|
```
|
|
3067
3537
|
|
|
3068
|
-
_See code: [src/commands/users/list.ts](https://github.com/sanity-io/cli/blob/
|
|
3538
|
+
_See code: [src/commands/users/list.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/users/list.ts)_
|
|
3069
3539
|
|
|
3070
3540
|
## `sanity versions`
|
|
3071
3541
|
|
|
@@ -3082,6 +3552,6 @@ EXAMPLES
|
|
|
3082
3552
|
$ sanity versions
|
|
3083
3553
|
```
|
|
3084
3554
|
|
|
3085
|
-
_See code: [src/commands/versions.ts](https://github.com/sanity-io/cli/blob/
|
|
3555
|
+
_See code: [src/commands/versions.ts](https://github.com/sanity-io/cli/blob/v5.14.1/src/commands/versions.ts)_
|
|
3086
3556
|
|
|
3087
3557
|
<!-- commandsstop -->
|