diff --git a/packages/@sanity/cli/src/commands/codemod/codemodCommand.ts b/packages/@sanity/cli/src/commands/codemod/codemodCommand.ts index e956fffebfca..eb8f8d95e649 100644 --- a/packages/@sanity/cli/src/commands/codemod/codemodCommand.ts +++ b/packages/@sanity/cli/src/commands/codemod/codemodCommand.ts @@ -24,7 +24,7 @@ Examples const codemodCommand: CliCommandDefinition = { name: 'codemod', signature: '[CODEMOD_NAME]', - description: 'Runs a code modification script', + description: 'Executes a code modification script to update Sanity Studio codebase', helpText, action: codemodAction, } diff --git a/packages/@sanity/cli/src/commands/debug/debugCommand.ts b/packages/@sanity/cli/src/commands/debug/debugCommand.ts index c6a0d7af3a7a..822619db734f 100644 --- a/packages/@sanity/cli/src/commands/debug/debugCommand.ts +++ b/packages/@sanity/cli/src/commands/debug/debugCommand.ts @@ -18,7 +18,7 @@ Examples const debugCommand: CliCommandDefinition = { name: 'debug', signature: '[--secrets]', - description: 'Gathers information on Sanity environment', + description: 'Provides detailed diagnostic information for troubleshooting a Sanity Studio', helpText: help, action: printDebugInfo, } diff --git a/packages/@sanity/cli/src/commands/docs/docsCommand.ts b/packages/@sanity/cli/src/commands/docs/docsCommand.ts index 2a95470fb39d..8ad7775c3c48 100644 --- a/packages/@sanity/cli/src/commands/docs/docsCommand.ts +++ b/packages/@sanity/cli/src/commands/docs/docsCommand.ts @@ -5,7 +5,7 @@ const docsCommand: CliCommandDefinition = { name: 'docs', helpText: '', signature: 'docs', - description: 'Opens the Sanity documentation', + description: 'Opens the official Sanity Studio documentation in your default web browser', async action(args, context) { const {output} = context const {print} = output diff --git a/packages/@sanity/cli/src/commands/help/helpCommand.ts b/packages/@sanity/cli/src/commands/help/helpCommand.ts index b3eecf79109b..b6f0a5d39447 100644 --- a/packages/@sanity/cli/src/commands/help/helpCommand.ts +++ b/packages/@sanity/cli/src/commands/help/helpCommand.ts @@ -13,7 +13,7 @@ the command list. const command: CliCommandDefinition = { name: 'help', signature: '[COMMAND]', - description: 'Displays help information about Sanity', + description: 'Displays help information about Sanity CLI commands', action: showHelp, helpText: help, } diff --git a/packages/@sanity/cli/src/commands/init/initCommand.ts b/packages/@sanity/cli/src/commands/init/initCommand.ts index 76f6d15790b3..68eba41aa47e 100644 --- a/packages/@sanity/cli/src/commands/init/initCommand.ts +++ b/packages/@sanity/cli/src/commands/init/initCommand.ts @@ -74,7 +74,7 @@ export interface InitFlags { export const initCommand: CliCommandDefinition = { name: 'init', signature: '', - description: 'Initialize a new Sanity Studio project', + description: 'Initializes a new Sanity Studio and/or a project', helpText, action: async (args, context) => { const {output, chalk, prompt} = context diff --git a/packages/@sanity/cli/src/commands/install/installCommand.ts b/packages/@sanity/cli/src/commands/install/installCommand.ts index 39ac38326ac5..731042c9ad4e 100644 --- a/packages/@sanity/cli/src/commands/install/installCommand.ts +++ b/packages/@sanity/cli/src/commands/install/installCommand.ts @@ -9,7 +9,7 @@ const installCommand: CliCommandDefinition = { name: 'install', signature: '', helpText: '', - description: 'Installs dependencies of the current project', + description: 'Installs dependencies for a Sanity Studio project', action: async (args, context) => { const {workDir, prompt, sanityMajorVersion} = context const packages = args.argsWithoutOptions diff --git a/packages/@sanity/cli/src/commands/login/loginCommand.ts b/packages/@sanity/cli/src/commands/login/loginCommand.ts index 05ecf678fbdd..d65e57722226 100644 --- a/packages/@sanity/cli/src/commands/login/loginCommand.ts +++ b/packages/@sanity/cli/src/commands/login/loginCommand.ts @@ -22,7 +22,7 @@ const loginCommand: CliCommandDefinition = { name: 'login', signature: '[--sso ] [--provider ] [--no-open]', helpText, - description: 'Authenticates against the Sanity.io API', + description: 'Authenticates the CLI for necessary access to your Sanity projects', action: login, } diff --git a/packages/@sanity/cli/src/commands/logout/logoutCommand.ts b/packages/@sanity/cli/src/commands/logout/logoutCommand.ts index af533c8af827..7a861bde933b 100644 --- a/packages/@sanity/cli/src/commands/logout/logoutCommand.ts +++ b/packages/@sanity/cli/src/commands/logout/logoutCommand.ts @@ -13,7 +13,7 @@ const logoutCommand: CliCommandDefinition = { name: 'logout', helpText, signature: 'logout', - description: 'Logs out of the Sanity.io session', + description: 'Logs out the CLI from the current user session', async action(args, {output, apiClient}) { const cfg = getUserConfig() diff --git a/packages/@sanity/cli/src/commands/manage/manageCommand.ts b/packages/@sanity/cli/src/commands/manage/manageCommand.ts index 3ec19d90f9fb..e4093fc2a51e 100644 --- a/packages/@sanity/cli/src/commands/manage/manageCommand.ts +++ b/packages/@sanity/cli/src/commands/manage/manageCommand.ts @@ -5,7 +5,7 @@ const manageCommand: CliCommandDefinition = { name: 'manage', signature: 'manage', helpText: '', - description: 'Opens the Sanity project management UI', + description: 'Opens the Sanity project management interface in your web browser', async action(args, context) { const {output, cliConfig} = context const {print} = output diff --git a/packages/@sanity/cli/src/commands/projects/projectsGroup.ts b/packages/@sanity/cli/src/commands/projects/projectsGroup.ts index 831ffa0b86e4..465193eb38e8 100755 --- a/packages/@sanity/cli/src/commands/projects/projectsGroup.ts +++ b/packages/@sanity/cli/src/commands/projects/projectsGroup.ts @@ -4,7 +4,7 @@ const projectGroup: CliCommandGroupDefinition = { name: 'projects', signature: '[COMMAND]', isGroupRoot: true, - description: 'Interact with projects connected to your logged in user', + description: 'Lists all Sanity projects associated with your logged-in user account', } export default projectGroup diff --git a/packages/@sanity/cli/src/commands/telemetry/telemetryGroup.ts b/packages/@sanity/cli/src/commands/telemetry/telemetryGroup.ts index 918ecbe394fd..b2872f942534 100644 --- a/packages/@sanity/cli/src/commands/telemetry/telemetryGroup.ts +++ b/packages/@sanity/cli/src/commands/telemetry/telemetryGroup.ts @@ -4,7 +4,7 @@ const telemetryGroup: CliCommandGroupDefinition = { name: 'telemetry', signature: '[COMMAND]', isGroupRoot: true, - description: 'Interact with telemetry settings for your logged in user', + description: 'Manages telemetry settings, opting in or out of data collection', } export default telemetryGroup diff --git a/packages/@sanity/cli/src/commands/versions/versionsCommand.ts b/packages/@sanity/cli/src/commands/versions/versionsCommand.ts index 7a89d6c96ed6..729581aa0f6a 100644 --- a/packages/@sanity/cli/src/commands/versions/versionsCommand.ts +++ b/packages/@sanity/cli/src/commands/versions/versionsCommand.ts @@ -7,7 +7,7 @@ checks the npm registry for the latest available versions.` export default { name: 'versions', signature: '', - description: 'Shows the installed versions of Sanity CLI and core components', + description: 'Displays the installed versions of Sanity Studio and core components', helpText: help, action: printVersionResult, } diff --git a/packages/sanity/src/_internal/cli/commands/build/buildCommand.ts b/packages/sanity/src/_internal/cli/commands/build/buildCommand.ts index a458f478d2db..0337e1942780 100644 --- a/packages/sanity/src/_internal/cli/commands/build/buildCommand.ts +++ b/packages/sanity/src/_internal/cli/commands/build/buildCommand.ts @@ -15,7 +15,7 @@ Examples const buildCommand: CliCommandDefinition = { name: 'build', signature: '[OUTPUT_DIR]', - description: 'Builds the current Sanity configuration to a static bundle', + description: 'Builds the current Sanity Studio configuration into a static bundle for deployment', action: async ( args: CliCommandArguments, context: CliCommandContext, diff --git a/packages/sanity/src/_internal/cli/commands/cors/corsGroup.ts b/packages/sanity/src/_internal/cli/commands/cors/corsGroup.ts index 26666874967c..29c6f5fe941c 100644 --- a/packages/sanity/src/_internal/cli/commands/cors/corsGroup.ts +++ b/packages/sanity/src/_internal/cli/commands/cors/corsGroup.ts @@ -4,7 +4,7 @@ const corsGroup: CliCommandGroupDefinition = { name: 'cors', signature: '[COMMAND]', isGroupRoot: true, - description: 'Interact with CORS-entries for your project', + description: 'Configures Cross-Origin Resource Sharing (CORS) settings for Sanity projects', } export default corsGroup diff --git a/packages/sanity/src/_internal/cli/commands/dataset/datasetGroup.ts b/packages/sanity/src/_internal/cli/commands/dataset/datasetGroup.ts index 0a242a30170a..8897017a5e27 100644 --- a/packages/sanity/src/_internal/cli/commands/dataset/datasetGroup.ts +++ b/packages/sanity/src/_internal/cli/commands/dataset/datasetGroup.ts @@ -2,5 +2,6 @@ export default { name: 'dataset', signature: '[COMMAND]', isGroupRoot: true, - description: 'Interact with datasets in your project', + description: + 'Manages datasets within your Sanity projects, such as creating or deleting datasets', } diff --git a/packages/sanity/src/_internal/cli/commands/deploy/deployCommand.ts b/packages/sanity/src/_internal/cli/commands/deploy/deployCommand.ts index cec5b1b3e7d9..985bce82008e 100644 --- a/packages/sanity/src/_internal/cli/commands/deploy/deployCommand.ts +++ b/packages/sanity/src/_internal/cli/commands/deploy/deployCommand.ts @@ -15,7 +15,7 @@ Examples const deployCommand: CliCommandDefinition = { name: 'deploy', signature: '[SOURCE_DIR] [--no-build] [--source-maps] [--no-minify]', - description: 'Deploys a statically built Sanity studio', + description: 'Deploys a statically built studio to the Sanity hosting environment', action: async ( args: CliCommandArguments, context: CliCommandContext, diff --git a/packages/sanity/src/_internal/cli/commands/deploy/undeployCommand.ts b/packages/sanity/src/_internal/cli/commands/deploy/undeployCommand.ts index e701edc874e8..0a3a4292ab08 100644 --- a/packages/sanity/src/_internal/cli/commands/deploy/undeployCommand.ts +++ b/packages/sanity/src/_internal/cli/commands/deploy/undeployCommand.ts @@ -8,7 +8,7 @@ Examples const undeployCommand: CliCommandDefinition = { name: 'undeploy', signature: '', - description: 'Removes the deployed studio from .sanity.studio', + description: 'Removes the deployed Sanity Studio from the studio hosting', action: async ( args: CliCommandArguments>, context: CliCommandContext, diff --git a/packages/sanity/src/_internal/cli/commands/dev/devCommand.ts b/packages/sanity/src/_internal/cli/commands/dev/devCommand.ts index b9d5ae9a7113..98460237daeb 100644 --- a/packages/sanity/src/_internal/cli/commands/dev/devCommand.ts +++ b/packages/sanity/src/_internal/cli/commands/dev/devCommand.ts @@ -17,7 +17,7 @@ Examples const devCommand: CliCommandDefinition = { name: 'dev', signature: '[--port ] [--host ]', - description: 'Starts a development server for the Sanity Studio', + description: 'Starts the local development server for Sanity Studio with live reloading', action: async ( args: CliCommandArguments, context: CliCommandContext, diff --git a/packages/sanity/src/_internal/cli/commands/documents/documentsGroup.ts b/packages/sanity/src/_internal/cli/commands/documents/documentsGroup.ts index d907270aa599..82483a50edff 100644 --- a/packages/sanity/src/_internal/cli/commands/documents/documentsGroup.ts +++ b/packages/sanity/src/_internal/cli/commands/documents/documentsGroup.ts @@ -4,7 +4,7 @@ const documentsGroup: CliCommandGroupDefinition = { name: 'documents', signature: '[COMMAND]', isGroupRoot: true, - description: 'Interact with documents in your project', + description: 'Manages and interacts with documents in your Sanity Content Lake datasets', } export default documentsGroup diff --git a/packages/sanity/src/_internal/cli/commands/exec/execCommand.ts b/packages/sanity/src/_internal/cli/commands/exec/execCommand.ts index aa4e4a1730aa..98536c95a39c 100644 --- a/packages/sanity/src/_internal/cli/commands/exec/execCommand.ts +++ b/packages/sanity/src/_internal/cli/commands/exec/execCommand.ts @@ -26,7 +26,7 @@ Examples export const execCommand: CliCommandDefinition = { name: 'exec', signature: 'SCRIPT', - description: 'Runs a script in Sanity context', + description: 'Executes a given script within the context of Sanity Studio', helpText, action: async (args, context) => { const mod = await import('../../actions/exec/execScript') diff --git a/packages/sanity/src/_internal/cli/commands/graphql/graphqlGroup.ts b/packages/sanity/src/_internal/cli/commands/graphql/graphqlGroup.ts index 1421cfc76a74..61279f693b38 100644 --- a/packages/sanity/src/_internal/cli/commands/graphql/graphqlGroup.ts +++ b/packages/sanity/src/_internal/cli/commands/graphql/graphqlGroup.ts @@ -4,7 +4,7 @@ const graphqlGroup: CliCommandGroupDefinition = { name: 'graphql', signature: '[COMMAND]', isGroupRoot: true, - description: 'Interact with GraphQL APIs', + description: "Create and deploy changes to your project's GraphQL API(s)", } export default graphqlGroup diff --git a/packages/sanity/src/_internal/cli/commands/hook/hookGroup.ts b/packages/sanity/src/_internal/cli/commands/hook/hookGroup.ts index 7d606afd2852..5e63ca4c24bc 100644 --- a/packages/sanity/src/_internal/cli/commands/hook/hookGroup.ts +++ b/packages/sanity/src/_internal/cli/commands/hook/hookGroup.ts @@ -4,7 +4,7 @@ const hookGroup: CliCommandGroupDefinition = { name: 'hook', signature: '[COMMAND]', isGroupRoot: true, - description: 'Interact with hooks in your project', + description: 'Set up and manages webhooks within your Sanity project', } export default hookGroup diff --git a/packages/sanity/src/_internal/cli/commands/migration/migrationGroup.ts b/packages/sanity/src/_internal/cli/commands/migration/migrationGroup.ts index 99e537d692ed..56a9e0c69b5a 100644 --- a/packages/sanity/src/_internal/cli/commands/migration/migrationGroup.ts +++ b/packages/sanity/src/_internal/cli/commands/migration/migrationGroup.ts @@ -2,5 +2,5 @@ export default { name: 'migration', signature: '[COMMAND]', isGroupRoot: true, - description: 'Scaffold and run migrations against your project dataset', + description: 'Manage content migrations for Sanity Content Lake datasets', } diff --git a/packages/sanity/src/_internal/cli/commands/preview/previewCommand.ts b/packages/sanity/src/_internal/cli/commands/preview/previewCommand.ts index d84035e015cc..5728cdc37121 100644 --- a/packages/sanity/src/_internal/cli/commands/preview/previewCommand.ts +++ b/packages/sanity/src/_internal/cli/commands/preview/previewCommand.ts @@ -18,7 +18,7 @@ Examples const previewCommand: CliCommandDefinition = { name: 'preview', signature: '[BUILD_OUTPUT_DIR] [--port ] [--host ]', - description: 'Starts a local web server for previewing production build', + description: 'Starts a local web server to preview a production build of Sanity Studio', action: async ( args: CliCommandArguments, context: CliCommandContext, diff --git a/packages/sanity/src/_internal/cli/commands/schema/schemaGroup.ts b/packages/sanity/src/_internal/cli/commands/schema/schemaGroup.ts index 8fe266ffae91..b1bff4badaee 100644 --- a/packages/sanity/src/_internal/cli/commands/schema/schemaGroup.ts +++ b/packages/sanity/src/_internal/cli/commands/schema/schemaGroup.ts @@ -2,5 +2,5 @@ export default { name: 'schema', signature: '[COMMAND]', isGroupRoot: true, - description: 'Interacts with schema(s) in your Sanity Studio project', + description: 'Interacts with Sanity Studio schema configurations', } diff --git a/packages/sanity/src/_internal/cli/commands/start/startCommand.ts b/packages/sanity/src/_internal/cli/commands/start/startCommand.ts index 4968823109c7..c77467783207 100644 --- a/packages/sanity/src/_internal/cli/commands/start/startCommand.ts +++ b/packages/sanity/src/_internal/cli/commands/start/startCommand.ts @@ -20,7 +20,8 @@ Examples const startCommand: CliCommandDefinition = { name: 'start', signature: '[BUILD_OUTPUT_DIR] [--port ] [--host ]', - description: 'Alias of `sanity preview`', + description: + 'Alias for `sanity preview` to run a local preview of a production built Sanity Studio', action: async ( args: CliCommandArguments, context: CliCommandContext, diff --git a/packages/sanity/src/_internal/cli/commands/users/usersGroup.ts b/packages/sanity/src/_internal/cli/commands/users/usersGroup.ts index ea1fa76c77c6..c3ac32193d60 100644 --- a/packages/sanity/src/_internal/cli/commands/users/usersGroup.ts +++ b/packages/sanity/src/_internal/cli/commands/users/usersGroup.ts @@ -4,7 +4,7 @@ export const usersGroup: CliCommandGroupDefinition = { name: 'users', signature: '[COMMAND]', isGroupRoot: true, - description: 'Manage users of your project', + description: 'Manages users of your Sanity project', } export default usersGroup