{ "commands": { "blueprints:add": { "aliases": [], "args": { "type": { "description": "Type of resource to add (only \"function\" is supported)", "name": "type", "options": [ "function" ], "required": true } }, "deprecationOptions": { "to": "functions add" }, "description": "This command is deprecated. Use \"functions add\" instead.\n\nEquivalent usage:\n $ <%= config.bin %> functions add\n $ <%= config.bin %> functions add --name my-function --type document-create", "examples": [ "<%= config.bin %> <%= command.id %> function", "<%= config.bin %> <%= command.id %> function --helpers", "<%= config.bin %> <%= command.id %> function --name my-function", "<%= config.bin %> <%= command.id %> function --name my-function --fn-type document-create", "<%= config.bin %> <%= command.id %> function --name my-function --fn-type document-create --fn-type document-update --lang js" ], "flags": { "json": { "description": "Format output as json", "name": "json", "allowNo": false, "type": "boolean" }, "path": { "aliases": [ "blueprint-path" ], "char": "p", "description": "Path to a Blueprint file or directory containing one", "env": "SANITY_BLUEPRINT_PATH", "hidden": true, "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "trace": { "description": "Trace output", "hidden": true, "name": "trace", "allowNo": false, "type": "boolean" }, "validate-resources": { "description": "Validate resources", "hidden": true, "name": "validate-resources", "allowNo": true, "type": "boolean" }, "verbose": { "description": "Verbose output", "hidden": true, "name": "verbose", "allowNo": false, "type": "boolean" }, "stack": { "description": "Stack name or ID to use instead of the locally configured Stack", "hidden": true, "name": "stack", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "project-id": { "aliases": [ "project", "projectId" ], "description": "Sanity project ID used to scope Blueprint and Stack", "exclusive": [ "organization-id" ], "hidden": true, "name": "project-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "organization-id": { "aliases": [ "organization", "organizationId", "org" ], "description": "Sanity organization ID used to scope Blueprint and Stack", "exclusive": [ "project-id" ], "hidden": true, "name": "organization-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "example": { "aliases": [ "recipe" ], "description": "Example to use for the function resource. Discover examples at https://www.sanity.io/exchange/type=recipes/by=sanity", "exclusive": [ "name", "fn-type", "language", "javascript", "fn-helpers", "fn-installer" ], "name": "example", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "char": "n", "description": "Name of the resource to add", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "fn-type": { "aliases": [ "function-type" ], "dependsOn": [ "name" ], "description": "Document change event(s) that should trigger the function; you can specify multiple events by specifying this flag multiple times", "name": "fn-type", "hasDynamicHelp": false, "multiple": true, "options": [ "document-publish", "document-create", "document-delete", "document-update", "media-library-asset-create", "media-library-asset-delete", "media-library-asset-update", "scheduled-function", "sync-tag-invalidate" ], "type": "option" }, "language": { "aliases": [ "function-language", "fn-language", "lang" ], "description": "Language of the new function", "name": "language", "default": "ts", "hasDynamicHelp": false, "multiple": false, "options": [ "ts", "js" ], "type": "option" }, "javascript": { "aliases": [ "js" ], "description": "Use JavaScript instead of TypeScript", "exclusive": [ "language" ], "name": "javascript", "allowNo": false, "type": "boolean" }, "fn-helpers": { "aliases": [ "function-helpers", "helpers" ], "description": "Add helpers to the new function", "name": "fn-helpers", "allowNo": true, "type": "boolean" }, "fn-installer": { "aliases": [ "function-installer", "installer" ], "description": "Which package manager to use when installing the @sanity/functions helpers", "name": "fn-installer", "hasDynamicHelp": false, "multiple": false, "options": [ "skip", "npm", "pnpm", "yarn" ], "type": "option" }, "install": { "char": "i", "description": "Shortcut for --fn-installer npm", "exclusive": [ "fn-installer" ], "name": "install", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "blueprints:add", "pluginAlias": "@sanity/runtime-cli", "pluginName": "@sanity/runtime-cli", "pluginType": "core", "state": "deprecated", "strict": true, "summary": "[deprecated] Use \"functions add\" instead", "enableJsonFlag": true, "needs": [ "blueprint" ], "isESM": true, "relativePath": [ "dist", "commands", "blueprints", "add.js" ] }, "blueprints:config": { "aliases": [], "args": {}, "description": "Manages the local Blueprint configuration, which links your Blueprint to a Sanity project and Stack.\n\nWithout flags, displays the current configuration. Use --edit to interactively modify settings, or combine --edit with ID flags to update values directly (useful for scripting and automation).\n\nIf you need to switch your Blueprint to a different Stack, use --edit --stack.", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --edit", "<%= config.bin %> <%= command.id %> --edit --project-id ", "<%= config.bin %> <%= command.id %> --edit --project-id --stack " ], "flags": { "json": { "description": "Format output as json", "name": "json", "allowNo": false, "type": "boolean" }, "path": { "aliases": [ "blueprint-path" ], "char": "p", "description": "Path to a Blueprint file or directory containing one", "env": "SANITY_BLUEPRINT_PATH", "hidden": true, "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "trace": { "description": "Trace output", "hidden": true, "name": "trace", "allowNo": false, "type": "boolean" }, "validate-resources": { "description": "Validate resources", "hidden": true, "name": "validate-resources", "allowNo": true, "type": "boolean" }, "verbose": { "description": "Verbose output", "hidden": true, "name": "verbose", "allowNo": false, "type": "boolean" }, "stack": { "aliases": [ "stack-id", "stackId" ], "dependsOn": [ "edit" ], "description": "Stack name or ID to set in the configuration. Requires --edit flag", "name": "stack", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "project-id": { "aliases": [ "project", "projectId" ], "dependsOn": [ "edit" ], "description": "Sanity project ID used to scope Blueprint and Stack", "exclusive": [ "organization-id" ], "name": "project-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "organization-id": { "aliases": [ "organization", "organizationId", "org" ], "dependsOn": [ "edit" ], "description": "Sanity organization ID used to scope Blueprint and Stack", "exclusive": [ "project-id" ], "name": "organization-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "edit": { "char": "e", "description": "Modify the configuration interactively, or directly when combined with ID flags.", "name": "edit", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "blueprints:config", "pluginAlias": "@sanity/runtime-cli", "pluginName": "@sanity/runtime-cli", "pluginType": "core", "strict": true, "summary": "View or edit the local Blueprint configuration", "enableJsonFlag": true, "needs": [ "token", "blueprint" ], "isESM": true, "relativePath": [ "dist", "commands", "blueprints", "config.js" ] }, "blueprints:deploy": { "aliases": [], "args": {}, "description": "Applies your local Blueprint to the remote Stack, creating, updating, or removing resources as needed. This is the primary command for applying infrastructure changes.\n\nBefore deploying, run 'blueprints plan' to preview changes. After deployment, use 'blueprints info' to verify Stack status or 'blueprints logs' to monitor activity.\n\nUse --no-wait to queue the deployment and return immediately without waiting for completion.\n\nUse --fn-installer to force which package manager to use when deploying functions.\n\nSet SANITY_ASSET_TIMEOUT (seconds) to override the 60-second timeout for processing resource assets.", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --message \"Enable staging dataset\"", "<%= config.bin %> <%= command.id %> --no-wait", "<%= config.bin %> <%= command.id %> --fn-installer npm", "<%= config.bin %> <%= command.id %> --stack ", "<%= config.bin %> <%= command.id %> --organization-id --stack ", "<%= config.bin %> <%= command.id %> --new-stack-name " ], "flags": { "json": { "description": "Format output as json", "name": "json", "allowNo": false, "type": "boolean" }, "path": { "aliases": [ "blueprint-path" ], "char": "p", "description": "Path to a Blueprint file or directory containing one", "env": "SANITY_BLUEPRINT_PATH", "hidden": true, "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "trace": { "description": "Trace output", "hidden": true, "name": "trace", "allowNo": false, "type": "boolean" }, "validate-resources": { "description": "Validate resources", "hidden": true, "name": "validate-resources", "allowNo": true, "type": "boolean" }, "verbose": { "description": "Verbose output", "hidden": true, "name": "verbose", "allowNo": false, "type": "boolean" }, "stack": { "description": "Stack name or ID to use instead of the locally configured Stack", "name": "stack", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "project-id": { "aliases": [ "project", "projectId" ], "description": "Sanity project ID used to scope Blueprint and Stack", "exclusive": [ "organization-id" ], "name": "project-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "organization-id": { "aliases": [ "organization", "organizationId", "org" ], "description": "Sanity organization ID used to scope Blueprint and Stack", "exclusive": [ "project-id" ], "name": "organization-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "message": { "char": "m", "description": "Message describing the deployment (e.g. reason for change)", "name": "message", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "fn-installer": { "aliases": [ "function-installer", "installer" ], "description": "Which package manager to use when installing Function dependencies", "hidden": true, "name": "fn-installer", "hasDynamicHelp": false, "multiple": false, "options": [ "npm", "pnpm", "yarn" ], "type": "option" }, "no-wait": { "description": "Do not wait for Stack deployment to complete", "name": "no-wait", "allowNo": false, "type": "boolean" }, "new-stack-name": { "description": "Set a new name for the Stack", "name": "new-stack-name", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "blueprints:deploy", "pluginAlias": "@sanity/runtime-cli", "pluginName": "@sanity/runtime-cli", "pluginType": "core", "strict": true, "summary": "Deploy the local Blueprint to the remote Stack", "enableJsonFlag": true, "needs": [ "deployedStack", "blueprint" ], "isESM": true, "relativePath": [ "dist", "commands", "blueprints", "deploy.js" ] }, "blueprints:destroy": { "aliases": [], "args": {}, "description": "Permanently removes the remote Stack and all its provisioned resources. Your local Blueprint files remain untouched, allowing you to redeploy later with 'blueprints init' + 'blueprints deploy'.\n\nThis is a destructive operation. You will be prompted to confirm unless --force is specified.\n\nUse this to clean up test environments or decommission a Stack you no longer need.", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --stack --project-id --force --no-wait" ], "flags": { "json": { "description": "Format output as json", "name": "json", "allowNo": false, "type": "boolean" }, "path": { "aliases": [ "blueprint-path" ], "char": "p", "description": "Path to a Blueprint file or directory containing one", "env": "SANITY_BLUEPRINT_PATH", "hidden": true, "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "trace": { "description": "Trace output", "hidden": true, "name": "trace", "allowNo": false, "type": "boolean" }, "validate-resources": { "description": "Validate resources", "hidden": true, "name": "validate-resources", "allowNo": true, "type": "boolean" }, "verbose": { "description": "Verbose output", "hidden": true, "name": "verbose", "allowNo": false, "type": "boolean" }, "stack": { "aliases": [ "stack-id", "stackId" ], "description": "Stack name or ID to destroy (defaults to the locally configured Stack)", "name": "stack", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "project-id": { "aliases": [ "project", "projectId" ], "dependsOn": [ "stack", "force" ], "description": "Sanity project ID used to scope Blueprint and Stack", "exclusive": [ "organization-id" ], "name": "project-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "organization-id": { "aliases": [ "organization", "organizationId", "org" ], "dependsOn": [ "stack", "force" ], "description": "Sanity organization ID used to scope Blueprint and Stack", "exclusive": [ "project-id" ], "name": "organization-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "force": { "aliases": [ "f" ], "description": "Force Stack destruction (skip confirmation)", "name": "force", "allowNo": false, "type": "boolean" }, "no-wait": { "description": "Do not wait for Stack destruction to complete", "name": "no-wait", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "blueprints:destroy", "pluginAlias": "@sanity/runtime-cli", "pluginName": "@sanity/runtime-cli", "pluginType": "core", "strict": true, "summary": "Destroy a remote Stack deployment and its resources", "enableJsonFlag": true, "needs": [ "token", "blueprint" ], "isESM": true, "relativePath": [ "dist", "commands", "blueprints", "destroy.js" ] }, "blueprints:doctor": { "aliases": [], "args": {}, "description": "Analyzes your local Blueprint and remote Stack configuration for common issues, such as missing authentication, invalid project references, or misconfigured resources.\n\nRun this command when encountering errors with other Blueprint commands. Use --fix to interactively resolve detected issues.", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --fix" ], "flags": { "json": { "description": "Format output as json", "name": "json", "allowNo": false, "type": "boolean" }, "path": { "aliases": [ "blueprint-path" ], "char": "p", "description": "Path to a Blueprint file or directory containing one", "env": "SANITY_BLUEPRINT_PATH", "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "trace": { "description": "Trace output", "hidden": true, "name": "trace", "allowNo": false, "type": "boolean" }, "validate-resources": { "description": "Validate resources", "hidden": true, "name": "validate-resources", "allowNo": true, "type": "boolean" }, "verbose": { "description": "Verbose output; defaults to true", "name": "verbose", "allowNo": true, "type": "boolean" }, "fix": { "description": "Interactively fix configuration issues", "name": "fix", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "blueprints:doctor", "pluginAlias": "@sanity/runtime-cli", "pluginName": "@sanity/runtime-cli", "pluginType": "core", "strict": true, "summary": "Diagnose potential issues with local Blueprint and remote Stack configuration", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "blueprints", "doctor.js" ] }, "blueprints:info": { "aliases": [], "args": {}, "description": "Displays the current state and metadata of your remote Stack deployment, including deployed resources, status, and configuration.\n\nUse this command to verify a deployment succeeded, check what resources are live, or confirm which Stack your local Blueprint is connected to.\n\nRun 'blueprints stacks' to see all available Stacks in your project or organization.", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --stack ", "<%= config.bin %> <%= command.id %> --project-id --stack ", "<%= config.bin %> <%= command.id %> --organization-id --stack " ], "flags": { "json": { "description": "Format output as json", "name": "json", "allowNo": false, "type": "boolean" }, "path": { "aliases": [ "blueprint-path" ], "char": "p", "description": "Path to a Blueprint file or directory containing one", "env": "SANITY_BLUEPRINT_PATH", "hidden": true, "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "trace": { "description": "Trace output", "hidden": true, "name": "trace", "allowNo": false, "type": "boolean" }, "validate-resources": { "description": "Validate resources", "hidden": true, "name": "validate-resources", "allowNo": true, "type": "boolean" }, "verbose": { "description": "Verbose output", "hidden": true, "name": "verbose", "allowNo": false, "type": "boolean" }, "stack": { "aliases": [ "id" ], "description": "Stack name or ID", "name": "stack", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "project-id": { "aliases": [ "project", "projectId" ], "description": "Sanity project ID used to scope Blueprint and Stack", "exclusive": [ "organization-id" ], "name": "project-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "organization-id": { "aliases": [ "organization", "organizationId", "org" ], "description": "Sanity organization ID used to scope Blueprint and Stack", "exclusive": [ "project-id" ], "name": "organization-id", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "blueprints:info", "pluginAlias": "@sanity/runtime-cli", "pluginName": "@sanity/runtime-cli", "pluginType": "core", "strict": true, "summary": "Display the status and resources of the remote Stack deployment", "enableJsonFlag": true, "needs": [ "deployedStack" ], "isESM": true, "relativePath": [ "dist", "commands", "blueprints", "info.js" ] }, "blueprints:init": { "aliases": [], "args": { "dir": { "description": "Directory to create the local Blueprint in", "name": "dir" } }, "description": "A Blueprint is your local infrastructure-as-code configuration that defines Sanity resources (datasets, functions, etc.). A Stack is the remote deployment target where your Blueprint is applied.\n[NOTE: Currently, accounts are limited to three (3) Stacks per project scope.]\n\nThis is typically the first command you run in a new project. It creates a local Blueprint manifest file (sanity.blueprint.ts, .js, or .json) and provisions a new remote Stack.\nAdditionally, a Blueprint configuration file is created in .sanity/ containing the scope and Stack IDs. This is .gitignored by default.\n\nAfter initialization, use 'blueprints plan' to preview changes, then 'blueprints deploy' to apply them.", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> [directory]", "<%= config.bin %> <%= command.id %> --blueprint-type ", "<%= config.bin %> <%= command.id %> --blueprint-type --project-id --stack-id ", "<%= config.bin %> <%= command.id %> --blueprint-type --stack-name " ], "flags": { "json": { "description": "Format output as json", "name": "json", "allowNo": false, "type": "boolean" }, "path": { "aliases": [ "blueprint-path" ], "char": "p", "description": "Path to a Blueprint file or directory containing one", "env": "SANITY_BLUEPRINT_PATH", "hidden": true, "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "trace": { "description": "Trace output", "hidden": true, "name": "trace", "allowNo": false, "type": "boolean" }, "validate-resources": { "description": "Validate resources", "hidden": true, "name": "validate-resources", "allowNo": true, "type": "boolean" }, "verbose": { "description": "Verbose output", "hidden": true, "name": "verbose", "allowNo": false, "type": "boolean" }, "dir": { "description": "Directory to create the local Blueprint in", "name": "dir", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "example": { "aliases": [ "recipe" ], "description": "Example to use for the local Blueprint", "exclusive": [ "blueprint-type", "stack-id", "stack-name" ], "name": "example", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "blueprint-type": { "aliases": [ "type" ], "description": "Blueprint manifest type to use for the local Blueprint", "name": "blueprint-type", "hasDynamicHelp": false, "multiple": false, "options": [ "json", "js", "ts" ], "type": "option" }, "project-id": { "aliases": [ "project", "projectId" ], "description": "Sanity project ID used to scope Blueprint and Stack", "exclusive": [ "organization-id" ], "name": "project-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "organization-id": { "aliases": [ "organization", "organizationId", "org" ], "description": "Sanity organization ID used to scope Blueprint and Stack", "exclusive": [ "project-id" ], "name": "organization-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stack-id": { "aliases": [ "stackId" ], "description": "Existing Stack ID used to scope local Blueprint", "exclusive": [ "stack-name" ], "name": "stack-id", "relationships": [ { "type": "some", "flags": [ "project-id", "organization-id" ] } ], "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stack-name": { "aliases": [ "name" ], "description": "Name to use for a new Stack provisioned during initialization", "exclusive": [ "stack-id" ], "name": "stack-name", "relationships": [ { "type": "some", "flags": [ "project-id", "organization-id" ] } ], "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "blueprints:init", "pluginAlias": "@sanity/runtime-cli", "pluginName": "@sanity/runtime-cli", "pluginType": "core", "strict": true, "summary": "Initialize a Blueprint and create a remote Stack", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "blueprints", "init.js" ] }, "blueprints:logs": { "aliases": [], "args": {}, "description": "Retrieves Stack deployment logs, useful for debugging and monitoring deployment activity.\n\nUse --watch (-w) to tail logs in real-time.\n\nUse --limit, --since, or --before to narrow the result set when not watching.\n\nIf you're not seeing expected logs, verify your Stack is deployed with 'blueprints info'.", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --watch", "<%= config.bin %> <%= command.id %> --stack ", "<%= config.bin %> <%= command.id %> --limit 500", "<%= config.bin %> <%= command.id %> --since 2026-05-01T00:00:00Z", "<%= config.bin %> <%= command.id %> --before 2026-05-01T00:00:00Z" ], "flags": { "json": { "description": "Format output as json", "name": "json", "allowNo": false, "type": "boolean" }, "path": { "aliases": [ "blueprint-path" ], "char": "p", "description": "Path to a Blueprint file or directory containing one", "env": "SANITY_BLUEPRINT_PATH", "hidden": true, "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "trace": { "description": "Trace output", "hidden": true, "name": "trace", "allowNo": false, "type": "boolean" }, "validate-resources": { "description": "Validate resources", "hidden": true, "name": "validate-resources", "allowNo": true, "type": "boolean" }, "verbose": { "description": "Verbose output", "hidden": true, "name": "verbose", "allowNo": false, "type": "boolean" }, "stack": { "description": "Stack name or ID to use instead of the locally configured Stack", "name": "stack", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "project-id": { "aliases": [ "project", "projectId" ], "description": "Sanity project ID used to scope Blueprint and Stack", "exclusive": [ "organization-id" ], "name": "project-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "organization-id": { "aliases": [ "organization", "organizationId", "org" ], "description": "Sanity organization ID used to scope Blueprint and Stack", "exclusive": [ "project-id" ], "name": "organization-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "watch": { "aliases": [ "follow" ], "char": "w", "description": "Watch for new Stack logs", "name": "watch", "allowNo": false, "type": "boolean" }, "limit": { "char": "l", "description": "Maximum number of log entries to retrieve (1-500)", "exclusive": [ "watch" ], "name": "limit", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "since": { "description": "Only show logs after this ISO 8601 timestamp", "exclusive": [ "watch" ], "name": "since", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "before": { "description": "Only show logs before this ISO 8601 timestamp", "exclusive": [ "watch" ], "name": "before", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "blueprints:logs", "pluginAlias": "@sanity/runtime-cli", "pluginName": "@sanity/runtime-cli", "pluginType": "core", "strict": true, "summary": "Display logs for the current Blueprint's Stack deployment", "enableJsonFlag": true, "needs": [ "deployedStack" ], "isESM": true, "relativePath": [ "dist", "commands", "blueprints", "logs.js" ] }, "blueprints:mint-deploy-token": { "aliases": [], "args": {}, "description": "Mints a long-lived robot token with the role required to plan, deploy, and destroy Blueprints in this project or organization.\n\nBy default the command runs interactively and asks how you want to receive the token (clipboard, print, or exit). Use --print to emit only the raw token for shell pipelines, or --json for full API output.\n\nThe minted token is also visible in your Sanity Manage UI under Robots, where it can be revoked.", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --label \"ci-deploy\"", "<%= config.bin %> <%= command.id %> --print", "export SANITY_AUTH_TOKEN=$(<%= config.bin %> <%= command.id %> --print)", "<%= config.bin %> <%= command.id %> --json", "<%= config.bin %> <%= command.id %> --project-id ", "<%= config.bin %> <%= command.id %> --organization-id " ], "flags": { "json": { "description": "Format output as json", "name": "json", "allowNo": false, "type": "boolean" }, "path": { "aliases": [ "blueprint-path" ], "char": "p", "description": "Path to a Blueprint file or directory containing one", "env": "SANITY_BLUEPRINT_PATH", "hidden": true, "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "trace": { "description": "Trace output", "hidden": true, "name": "trace", "allowNo": false, "type": "boolean" }, "validate-resources": { "description": "Validate resources", "hidden": true, "name": "validate-resources", "allowNo": true, "type": "boolean" }, "verbose": { "description": "Verbose output", "hidden": true, "name": "verbose", "allowNo": false, "type": "boolean" }, "stack": { "description": "Stack name or ID to use instead of the locally configured Stack", "hidden": true, "name": "stack", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "project-id": { "aliases": [ "project", "projectId" ], "description": "Sanity project ID used to scope Blueprint and Stack", "exclusive": [ "organization-id" ], "name": "project-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "organization-id": { "aliases": [ "organization", "organizationId", "org" ], "description": "Sanity organization ID used to scope Blueprint and Stack", "exclusive": [ "project-id" ], "name": "organization-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "label": { "description": "Human-readable label for the robot. Defaults to a generated value.", "name": "label", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "print": { "char": "P", "description": "Print only the raw token to stdout (suitable for shell substitution)", "exclusive": [ "json" ], "name": "print", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "blueprints:mint-deploy-token", "pluginAlias": "@sanity/runtime-cli", "pluginName": "@sanity/runtime-cli", "pluginType": "core", "strict": true, "summary": "Create a robot API token for deploying Blueprints from CI/CD", "enableJsonFlag": true, "needs": [ "scope" ], "isESM": true, "relativePath": [ "dist", "commands", "blueprints", "mint-deploy-token.js" ] }, "blueprints:plan": { "aliases": [], "args": {}, "description": "Use this command to preview what changes will be applied to your remote Stack before deploying. This is a safe, read-only operation—no resources are created, modified, or deleted.\n\nRun 'blueprints plan' after making local changes to your Blueprint manifest to verify the expected diff. When ready, run 'blueprints deploy' to apply changes.", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --stack ", "<%= config.bin %> <%= command.id %> --organization-id --stack " ], "flags": { "json": { "description": "Format output as json", "name": "json", "allowNo": false, "type": "boolean" }, "path": { "aliases": [ "blueprint-path" ], "char": "p", "description": "Path to a Blueprint file or directory containing one", "env": "SANITY_BLUEPRINT_PATH", "hidden": true, "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "trace": { "description": "Trace output", "hidden": true, "name": "trace", "allowNo": false, "type": "boolean" }, "validate-resources": { "description": "Validate resources", "hidden": true, "name": "validate-resources", "allowNo": true, "type": "boolean" }, "verbose": { "description": "Verbose output", "hidden": true, "name": "verbose", "allowNo": false, "type": "boolean" }, "stack": { "description": "Stack name or ID to use instead of the locally configured Stack", "name": "stack", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "project-id": { "aliases": [ "project", "projectId" ], "description": "Sanity project ID used to scope Blueprint and Stack", "exclusive": [ "organization-id" ], "name": "project-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "organization-id": { "aliases": [ "organization", "organizationId", "org" ], "description": "Sanity organization ID used to scope Blueprint and Stack", "exclusive": [ "project-id" ], "name": "organization-id", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "blueprints:plan", "pluginAlias": "@sanity/runtime-cli", "pluginName": "@sanity/runtime-cli", "pluginType": "core", "strict": true, "summary": "Preview changes that will be applied to the remote Stack", "enableJsonFlag": true, "needs": [ "token", "blueprint" ], "isESM": true, "relativePath": [ "dist", "commands", "blueprints", "plan.js" ] }, "blueprints:promote": { "aliases": [], "args": {}, "description": "Promotes a deployed Stack to organization scope, enabling management of org-level resources. Promotion cannot be reversed.\n\nYour local Blueprint configuration will be updated to reflect the new scope.", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --stack ", "<%= config.bin %> <%= command.id %> --project-id --stack ", "<%= config.bin %> <%= command.id %> --new-stack-name " ], "flags": { "json": { "description": "Format output as json", "name": "json", "allowNo": false, "type": "boolean" }, "path": { "aliases": [ "blueprint-path" ], "char": "p", "description": "Path to a Blueprint file or directory containing one", "env": "SANITY_BLUEPRINT_PATH", "hidden": true, "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "trace": { "description": "Trace output", "hidden": true, "name": "trace", "allowNo": false, "type": "boolean" }, "validate-resources": { "description": "Validate resources", "hidden": true, "name": "validate-resources", "allowNo": true, "type": "boolean" }, "verbose": { "description": "Verbose output", "hidden": true, "name": "verbose", "allowNo": false, "type": "boolean" }, "stack": { "aliases": [ "id" ], "description": "Stack name or ID to promote", "name": "stack", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "project-id": { "aliases": [ "project", "projectId" ], "description": "Sanity project ID used to scope Blueprint and Stack", "exclusive": [ "organization-id" ], "name": "project-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "organization-id": { "aliases": [ "organization", "organizationId", "org" ], "description": "Sanity organization ID used to scope Blueprint and Stack", "exclusive": [ "project-id" ], "hidden": true, "name": "organization-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "force": { "description": "Skip confirmation prompt", "name": "force", "allowNo": false, "type": "boolean" }, "new-stack-name": { "description": "Set a new name for the Stack while promoting", "name": "new-stack-name", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "blueprints:promote", "pluginAlias": "@sanity/runtime-cli", "pluginName": "@sanity/runtime-cli", "pluginType": "core", "strict": true, "summary": "Promote a Stack from project scope to organization scope", "enableJsonFlag": true, "needs": [ "deployedStack", "blueprint" ], "isESM": true, "relativePath": [ "dist", "commands", "blueprints", "promote.js" ] }, "blueprints:stacks": { "aliases": [], "args": {}, "description": "Shows all Stacks associated with a project or organization. By default, lists Stacks scoped to the local Blueprint.\n\nUse this to discover existing Stacks you can scope a local Blueprint to (using 'blueprints config --edit'), or to audit what's deployed across your project.\n\nUse --include-projects with --organization-id to also list Stacks from all projects within the organization.", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --project-id ", "<%= config.bin %> <%= command.id %> --organization-id ", "<%= config.bin %> <%= command.id %> --organization-id --include-projects" ], "flags": { "json": { "description": "Format output as json", "name": "json", "allowNo": false, "type": "boolean" }, "path": { "aliases": [ "blueprint-path" ], "char": "p", "description": "Path to a Blueprint file or directory containing one", "env": "SANITY_BLUEPRINT_PATH", "hidden": true, "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "trace": { "description": "Trace output", "hidden": true, "name": "trace", "allowNo": false, "type": "boolean" }, "validate-resources": { "description": "Validate resources", "hidden": true, "name": "validate-resources", "allowNo": true, "type": "boolean" }, "verbose": { "description": "Verbose output", "hidden": true, "name": "verbose", "allowNo": false, "type": "boolean" }, "stack": { "description": "Stack name or ID to use instead of the locally configured Stack", "hidden": true, "name": "stack", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "project-id": { "aliases": [ "project", "projectId" ], "description": "Sanity project ID used to scope Blueprint and Stack", "exclusive": [ "organization-id", "include-projects" ], "name": "project-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "organization-id": { "aliases": [ "organization", "organizationId", "org" ], "description": "Sanity organization ID used to scope Blueprint and Stack", "exclusive": [ "project-id" ], "name": "organization-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "include-projects": { "dependsOn": [ "organization-id" ], "description": "Include Stacks from all projects within the organization. Requires --organization-id.", "name": "include-projects", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "blueprints:stacks", "pluginAlias": "@sanity/runtime-cli", "pluginName": "@sanity/runtime-cli", "pluginType": "core", "strict": true, "summary": "List remote Stack deployments for your project or organization", "enableJsonFlag": true, "needs": [ "token", "blueprint" ], "isESM": true, "relativePath": [ "dist", "commands", "blueprints", "stacks.js" ] }, "functions:add": { "aliases": [], "args": {}, "description": "Scaffolds a new Function in the functions/ folder and templates a resource for your Blueprint manifest.\n\nFunctions are serverless handlers triggered by document, live content or media-library events (create, update, delete, publish).\n\nAfter adding, use 'functions dev' to test locally, then 'blueprints deploy' to publish.", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --helpers", "<%= config.bin %> <%= command.id %> --name my-function", "<%= config.bin %> <%= command.id %> --name my-function --type document-create", "<%= config.bin %> <%= command.id %> --name my-function --type document-create --type document-update --lang js" ], "flags": { "json": { "description": "Format output as json", "name": "json", "allowNo": false, "type": "boolean" }, "path": { "aliases": [ "blueprint-path" ], "char": "p", "description": "Path to a Blueprint file or directory containing one", "env": "SANITY_BLUEPRINT_PATH", "hidden": true, "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "trace": { "description": "Trace output", "hidden": true, "name": "trace", "allowNo": false, "type": "boolean" }, "validate-resources": { "description": "Validate resources", "hidden": true, "name": "validate-resources", "allowNo": true, "type": "boolean" }, "verbose": { "description": "Verbose output", "hidden": true, "name": "verbose", "allowNo": false, "type": "boolean" }, "stack": { "description": "Stack name or ID to use instead of the locally configured Stack", "hidden": true, "name": "stack", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "project-id": { "aliases": [ "project", "projectId" ], "description": "Sanity project ID used to scope Blueprint and Stack", "exclusive": [ "organization-id" ], "hidden": true, "name": "project-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "organization-id": { "aliases": [ "organization", "organizationId", "org" ], "description": "Sanity organization ID used to scope Blueprint and Stack", "exclusive": [ "project-id" ], "hidden": true, "name": "organization-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "example": { "aliases": [ "recipe" ], "description": "Example to use for the Function", "exclusive": [ "name", "fn-type", "language", "javascript", "fn-helpers", "fn-installer" ], "name": "example", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "char": "n", "description": "Name of the Function to add", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "type": { "dependsOn": [ "name" ], "description": "Document change event(s) that should trigger the function; you can specify multiple events by specifying this flag multiple times", "name": "type", "hasDynamicHelp": false, "multiple": true, "options": [ "document-publish", "document-create", "document-delete", "document-update", "media-library-asset-create", "media-library-asset-delete", "media-library-asset-update", "scheduled-function", "sync-tag-invalidate" ], "type": "option" }, "language": { "aliases": [ "lang" ], "description": "Language of the new Function", "name": "language", "default": "ts", "hasDynamicHelp": false, "multiple": false, "options": [ "ts", "js" ], "type": "option" }, "javascript": { "aliases": [ "js" ], "description": "Use JavaScript instead of TypeScript", "exclusive": [ "language" ], "name": "javascript", "allowNo": false, "type": "boolean" }, "helpers": { "description": "Add helpers to the new Function", "name": "helpers", "allowNo": true, "type": "boolean" }, "installer": { "description": "How to install the @sanity/functions helpers", "name": "installer", "hasDynamicHelp": false, "multiple": false, "options": [ "skip", "npm", "pnpm", "yarn" ], "type": "option" }, "install": { "char": "i", "description": "Shortcut for --fn-installer npm", "exclusive": [ "fn-installer" ], "name": "install", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "functions:add", "pluginAlias": "@sanity/runtime-cli", "pluginName": "@sanity/runtime-cli", "pluginType": "core", "strict": true, "summary": "Add a Function to your Blueprint", "enableJsonFlag": true, "needs": [ "blueprint" ], "isESM": true, "relativePath": [ "dist", "commands", "functions", "add.js" ] }, "functions:build": { "aliases": [], "args": { "name": { "description": "The name of the Sanity Function", "name": "name", "required": false } }, "flags": { "json": { "description": "Format output as json", "name": "json", "allowNo": false, "type": "boolean" }, "path": { "aliases": [ "blueprint-path" ], "char": "p", "description": "Path to a Blueprint file or directory containing one", "env": "SANITY_BLUEPRINT_PATH", "hidden": true, "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "trace": { "description": "Trace output", "hidden": true, "name": "trace", "allowNo": false, "type": "boolean" }, "validate-resources": { "description": "Validate resources", "hidden": true, "name": "validate-resources", "allowNo": true, "type": "boolean" }, "verbose": { "description": "Verbose output", "hidden": true, "name": "verbose", "allowNo": false, "type": "boolean" }, "stack": { "description": "Stack name or ID to use instead of the locally configured Stack", "hidden": true, "name": "stack", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "project-id": { "aliases": [ "project", "projectId" ], "description": "Sanity project ID used to scope Blueprint and Stack", "exclusive": [ "organization-id" ], "hidden": true, "name": "project-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "organization-id": { "aliases": [ "organization", "organizationId", "org" ], "description": "Sanity organization ID used to scope Blueprint and Stack", "exclusive": [ "project-id" ], "hidden": true, "name": "organization-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "fn-installer": { "aliases": [ "function-installer", "installer" ], "description": "Which package manager to use when building Functions", "hidden": true, "name": "fn-installer", "hasDynamicHelp": false, "multiple": false, "options": [ "npm", "pnpm", "yarn" ], "type": "option" }, "out-dir": { "char": "o", "description": "Output directory for zip files", "name": "out-dir", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hidden": true, "hiddenAliases": [], "id": "functions:build", "pluginAlias": "@sanity/runtime-cli", "pluginName": "@sanity/runtime-cli", "pluginType": "core", "strict": true, "summary": "Build Sanity Function(s) to zip archives", "enableJsonFlag": true, "needs": [ "blueprint" ], "isESM": true, "relativePath": [ "dist", "commands", "functions", "build.js" ] }, "functions:dev": { "aliases": [], "args": {}, "description": "Runs a local, web-based development server to test your functions before deploying.\n\nOpen the emulator in your browser to interactively test your functions with the payload editor.\n\nOptionally, set the host and port with the --host and --port flags. Function timeout can be configured with the --timeout flag.\n\nTo invoke a function with the CLI, use 'functions test'.", "examples": [ "<%= config.bin %> <%= command.id %> --host 127.0.0.1 --port 8974", "<%= config.bin %> <%= command.id %> --timeout 60" ], "flags": { "json": { "description": "Format output as json", "name": "json", "allowNo": false, "type": "boolean" }, "path": { "aliases": [ "blueprint-path" ], "char": "p", "description": "Path to a Blueprint file or directory containing one", "env": "SANITY_BLUEPRINT_PATH", "hidden": true, "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "trace": { "description": "Trace output", "hidden": true, "name": "trace", "allowNo": false, "type": "boolean" }, "validate-resources": { "description": "Validate resources", "hidden": true, "name": "validate-resources", "allowNo": true, "type": "boolean" }, "verbose": { "description": "Verbose output", "hidden": true, "name": "verbose", "allowNo": false, "type": "boolean" }, "stack": { "description": "Stack name or ID to use instead of the locally configured Stack", "hidden": true, "name": "stack", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "project-id": { "aliases": [ "project", "projectId" ], "description": "Sanity project ID used to scope Blueprint and Stack", "exclusive": [ "organization-id" ], "hidden": true, "name": "project-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "organization-id": { "aliases": [ "organization", "organizationId", "org" ], "description": "Sanity organization ID used to scope Blueprint and Stack", "exclusive": [ "project-id" ], "hidden": true, "name": "organization-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "host": { "char": "h", "description": "The local network interface at which to listen. [default: \"localhost\"]", "name": "host", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "port": { "char": "p", "description": "TCP port to start emulator on. [default: 8080]", "name": "port", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "timeout": { "char": "t", "description": "Maximum execution time for all functions, in seconds. Takes precedence over function-specific `timeout`", "name": "timeout", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "functions:dev", "pluginAlias": "@sanity/runtime-cli", "pluginName": "@sanity/runtime-cli", "pluginType": "core", "strict": true, "summary": "Start the Sanity Function emulator", "enableJsonFlag": true, "needs": [ "blueprint" ], "isESM": true, "relativePath": [ "dist", "commands", "functions", "dev.js" ] }, "functions:logs": { "aliases": [], "args": { "name": { "description": "The name of the Sanity Function", "name": "name", "required": false } }, "description": "Fetches execution logs from a deployed function, useful for debugging production issues or monitoring activity.\n\nUse --watch (-w) to stream logs in real-time. Use --delete to clear all logs for a function (requires confirmation unless --force is specified).", "examples": [ "<%= config.bin %> <%= command.id %> ", "<%= config.bin %> <%= command.id %> --json", "<%= config.bin %> <%= command.id %> --limit 100", "<%= config.bin %> <%= command.id %> --delete" ], "flags": { "json": { "description": "Format output as json", "name": "json", "allowNo": false, "type": "boolean" }, "path": { "aliases": [ "blueprint-path" ], "char": "p", "description": "Path to a Blueprint file or directory containing one", "env": "SANITY_BLUEPRINT_PATH", "hidden": true, "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "trace": { "description": "Trace output", "hidden": true, "name": "trace", "allowNo": false, "type": "boolean" }, "validate-resources": { "description": "Validate resources", "hidden": true, "name": "validate-resources", "allowNo": true, "type": "boolean" }, "verbose": { "description": "Verbose output", "hidden": true, "name": "verbose", "allowNo": false, "type": "boolean" }, "stack": { "description": "Stack name or ID to use instead of the locally configured Stack", "name": "stack", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "project-id": { "aliases": [ "project", "projectId" ], "description": "Sanity project ID used to scope Blueprint and Stack", "exclusive": [ "organization-id" ], "hidden": true, "name": "project-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "organization-id": { "aliases": [ "organization", "organizationId", "org" ], "description": "Sanity organization ID used to scope Blueprint and Stack", "exclusive": [ "project-id" ], "hidden": true, "name": "organization-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "limit": { "char": "l", "description": "Total number of log entries to retrieve", "name": "limit", "required": false, "default": 50, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "utc": { "char": "u", "description": "Show dates in UTC time zone", "name": "utc", "required": false, "allowNo": false, "type": "boolean" }, "delete": { "char": "d", "description": "Delete all logs for the function", "exclusive": [ "limit", "json" ], "name": "delete", "required": false, "allowNo": false, "type": "boolean" }, "force": { "char": "f", "dependsOn": [ "delete" ], "description": "Skip confirmation for deleting logs", "name": "force", "required": false, "allowNo": false, "type": "boolean" }, "watch": { "aliases": [ "follow" ], "char": "w", "description": "Watch for new logs (streaming mode)", "name": "watch", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "functions:logs", "pluginAlias": "@sanity/runtime-cli", "pluginName": "@sanity/runtime-cli", "pluginType": "core", "strict": true, "summary": "Retrieve or delete logs for a Sanity Function", "enableJsonFlag": true, "needs": [ "deployedStack", "blueprint" ], "isESM": true, "relativePath": [ "dist", "commands", "functions", "logs.js" ] }, "functions:test": { "aliases": [], "args": { "name": { "description": "The name of the Sanity Function", "name": "name", "required": false } }, "description": "Executes a function locally with the provided payload, simulating how it would run when deployed. Use this to test your function logic before deploying.\n\nProvide test data via --data (inline JSON), --file (JSON file), or --document-id (fetch from Sanity). For update events, use the before/after flag pairs to simulate document changes.", "examples": [ "<%= config.bin %> <%= command.id %> --data '{ \"id\": 1 }'", "<%= config.bin %> <%= command.id %> --file 'payload.json'", "<%= config.bin %> <%= command.id %> --data '{ \"id\": 1 }' --timeout 60", "<%= config.bin %> <%= command.id %> --event update --data-before '{ \"title\": \"before\" }' --data-after '{ \"title\": \"after\" }'" ], "flags": { "json": { "description": "Format output as json", "name": "json", "allowNo": false, "type": "boolean" }, "path": { "aliases": [ "blueprint-path" ], "char": "p", "description": "Path to a Blueprint file or directory containing one", "env": "SANITY_BLUEPRINT_PATH", "hidden": true, "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "trace": { "description": "Trace output", "hidden": true, "name": "trace", "allowNo": false, "type": "boolean" }, "validate-resources": { "description": "Validate resources", "hidden": true, "name": "validate-resources", "allowNo": true, "type": "boolean" }, "verbose": { "description": "Verbose output", "hidden": true, "name": "verbose", "allowNo": false, "type": "boolean" }, "stack": { "description": "Stack name or ID to use instead of the locally configured Stack", "hidden": true, "name": "stack", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "project-id": { "aliases": [ "project", "projectId" ], "description": "Sanity project ID used to scope Blueprint and Stack", "exclusive": [ "organization-id" ], "name": "project-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "organization-id": { "aliases": [ "organization", "organizationId", "org" ], "description": "Sanity organization ID used to scope Blueprint and Stack", "exclusive": [ "project-id" ], "name": "organization-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "data": { "char": "d", "description": "Data to send to the function", "exclusive": [ "file", "document-id" ], "name": "data", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "data-before": { "description": "Original document", "exclusive": [ "data", "file", "document-id", "file-before", "file-after", "document-id-before", "document-id-after" ], "name": "data-before", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "data-after": { "description": "Current document", "exclusive": [ "data", "file", "document-id", "file-before", "file-after", "document-id-before", "document-id-after" ], "name": "data-after", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "event": { "char": "e", "description": "Type of event (create, update, delete)", "name": "event", "required": false, "hasDynamicHelp": false, "multiple": false, "options": [ "create", "update", "delete" ], "type": "option" }, "file": { "char": "f", "description": "Read data from file and send to the function", "exclusive": [ "data", "document-id" ], "name": "file", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "file-before": { "description": "Original document", "exclusive": [ "data", "file", "document-id", "data-before", "data-after", "document-id-before", "document-id-after" ], "name": "file-before", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "file-after": { "description": "Current document", "exclusive": [ "data", "file", "document-id", "data-before", "data-after", "document-id-before", "document-id-after" ], "name": "file-after", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "timeout": { "char": "t", "description": "Execution timeout value in seconds", "name": "timeout", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "api": { "char": "a", "description": "Sanity API Version to use", "name": "api", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "dataset": { "description": "The Sanity dataset to use", "name": "dataset", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "document-id": { "aliases": [ "doc", "documentId" ], "description": "Document to fetch and send to function", "exclusive": [ "data", "file" ], "name": "document-id", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "document-id-before": { "description": "Original document", "exclusive": [ "data", "file", "document-id", "data-before", "data-after", "file-before", "file-after" ], "name": "document-id-before", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "document-id-after": { "description": "Current document", "exclusive": [ "data", "file", "document-id", "data-before", "data-after", "file-before", "file-after" ], "name": "document-id-after", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "with-user-token": { "description": "Prime access token from CLI config", "name": "with-user-token", "allowNo": false, "type": "boolean" }, "media-library-id": { "aliases": [ "media" ], "description": "Sanity Media Library ID to use", "exclusive": [ "project-id", "dataset" ], "name": "media-library-id", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "functions:test", "pluginAlias": "@sanity/runtime-cli", "pluginName": "@sanity/runtime-cli", "pluginType": "core", "strict": true, "summary": "Invoke a local Sanity Function", "enableJsonFlag": true, "needs": [ "blueprint" ], "isESM": true, "relativePath": [ "dist", "commands", "functions", "test.js" ] }, "functions:env:add": { "aliases": [], "args": { "name": { "description": "The name of the Sanity Function", "name": "name", "required": true }, "key": { "description": "The name of the environment variable", "name": "key", "required": true }, "value": { "description": "The value of the environment variable", "name": "value", "required": true } }, "description": "Sets an environment variable in a deployed Sanity Function. If the variable already exists, its value is updated.\n\nEnvironment variables are useful for API keys, configuration values, and other secrets that shouldn't be hardcoded. Changes take effect on the next function invocation.", "examples": [ "<%= config.bin %> <%= command.id %> MyFunction API_URL https://api.example.com/" ], "flags": { "json": { "description": "Format output as json", "name": "json", "allowNo": false, "type": "boolean" }, "path": { "aliases": [ "blueprint-path" ], "char": "p", "description": "Path to a Blueprint file or directory containing one", "env": "SANITY_BLUEPRINT_PATH", "hidden": true, "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "trace": { "description": "Trace output", "hidden": true, "name": "trace", "allowNo": false, "type": "boolean" }, "validate-resources": { "description": "Validate resources", "hidden": true, "name": "validate-resources", "allowNo": true, "type": "boolean" }, "verbose": { "description": "Verbose output", "hidden": true, "name": "verbose", "allowNo": false, "type": "boolean" }, "stack": { "description": "Stack name or ID to use instead of the locally configured Stack", "hidden": true, "name": "stack", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "project-id": { "aliases": [ "project", "projectId" ], "description": "Sanity project ID used to scope Blueprint and Stack", "exclusive": [ "organization-id" ], "hidden": true, "name": "project-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "organization-id": { "aliases": [ "organization", "organizationId", "org" ], "description": "Sanity organization ID used to scope Blueprint and Stack", "exclusive": [ "project-id" ], "hidden": true, "name": "organization-id", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "functions:env:add", "pluginAlias": "@sanity/runtime-cli", "pluginName": "@sanity/runtime-cli", "pluginType": "core", "strict": true, "summary": "Add or set an environment variable for a deployed function", "enableJsonFlag": true, "needs": [ "deployedStack", "blueprint" ], "isESM": true, "relativePath": [ "dist", "commands", "functions", "env", "add.js" ] }, "functions:env:list": { "aliases": [], "args": { "name": { "description": "The name of the Sanity Function", "name": "name", "required": true } }, "description": "Displays all environment variables (keys only) configured in a deployed Sanity Function.\n\nUse 'functions env add' to set variables or 'functions env remove' to delete them.", "examples": [ "<%= config.bin %> <%= command.id %> MyFunction" ], "flags": { "json": { "description": "Format output as json", "name": "json", "allowNo": false, "type": "boolean" }, "path": { "aliases": [ "blueprint-path" ], "char": "p", "description": "Path to a Blueprint file or directory containing one", "env": "SANITY_BLUEPRINT_PATH", "hidden": true, "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "trace": { "description": "Trace output", "hidden": true, "name": "trace", "allowNo": false, "type": "boolean" }, "validate-resources": { "description": "Validate resources", "hidden": true, "name": "validate-resources", "allowNo": true, "type": "boolean" }, "verbose": { "description": "Verbose output", "hidden": true, "name": "verbose", "allowNo": false, "type": "boolean" }, "stack": { "description": "Stack name or ID to use instead of the locally configured Stack", "hidden": true, "name": "stack", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "project-id": { "aliases": [ "project", "projectId" ], "description": "Sanity project ID used to scope Blueprint and Stack", "exclusive": [ "organization-id" ], "hidden": true, "name": "project-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "organization-id": { "aliases": [ "organization", "organizationId", "org" ], "description": "Sanity organization ID used to scope Blueprint and Stack", "exclusive": [ "project-id" ], "hidden": true, "name": "organization-id", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "functions:env:list", "pluginAlias": "@sanity/runtime-cli", "pluginName": "@sanity/runtime-cli", "pluginType": "core", "strict": true, "summary": "List environment variables for a deployed function", "enableJsonFlag": true, "needs": [ "deployedStack", "blueprint" ], "isESM": true, "relativePath": [ "dist", "commands", "functions", "env", "list.js" ] }, "functions:env:remove": { "aliases": [], "args": { "name": { "description": "The name of the Sanity Function", "name": "name", "required": true }, "key": { "description": "The name of the environment variable", "name": "key", "required": true } }, "description": "Deletes an environment variable from a deployed Sanity Function. The change takes effect on the next function invocation.\n\nUse 'functions env list' to see current variables before removing.", "examples": [ "<%= config.bin %> <%= command.id %> MyFunction API_URL" ], "flags": { "json": { "description": "Format output as json", "name": "json", "allowNo": false, "type": "boolean" }, "path": { "aliases": [ "blueprint-path" ], "char": "p", "description": "Path to a Blueprint file or directory containing one", "env": "SANITY_BLUEPRINT_PATH", "hidden": true, "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "trace": { "description": "Trace output", "hidden": true, "name": "trace", "allowNo": false, "type": "boolean" }, "validate-resources": { "description": "Validate resources", "hidden": true, "name": "validate-resources", "allowNo": true, "type": "boolean" }, "verbose": { "description": "Verbose output", "hidden": true, "name": "verbose", "allowNo": false, "type": "boolean" }, "stack": { "description": "Stack name or ID to use instead of the locally configured Stack", "hidden": true, "name": "stack", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "project-id": { "aliases": [ "project", "projectId" ], "description": "Sanity project ID used to scope Blueprint and Stack", "exclusive": [ "organization-id" ], "hidden": true, "name": "project-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "organization-id": { "aliases": [ "organization", "organizationId", "org" ], "description": "Sanity organization ID used to scope Blueprint and Stack", "exclusive": [ "project-id" ], "hidden": true, "name": "organization-id", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "functions:env:remove", "pluginAlias": "@sanity/runtime-cli", "pluginName": "@sanity/runtime-cli", "pluginType": "core", "strict": true, "summary": "Remove an environment variable from a deployed function", "enableJsonFlag": true, "needs": [ "deployedStack", "blueprint" ], "isESM": true, "relativePath": [ "dist", "commands", "functions", "env", "remove.js" ] } }, "version": "15.0.4" }