All apps/Sanity CLI

Sanity CLI

sanity

Command-line tool for Sanity Studio projects.

Runs as sanity|macOS, Linux, Windows|www.sanity.io

Autocomplete

Fig spec, with what the manifest adds · 55 subcommands · 1 option
Published once and never changed; check the digest before caching
sha256
12191c150ce3d938563e0b1c692c28fd60a85709c3d9a979943a4ff01fb69a66
Size
29805 bytes
Subcommands55 subcommands
sanity help
Displays help information about Sanity
sanity build
Builds the current Sanity configuration to a static bundle
sanity codemod
Runs a code modification script
sanity configcheck
Checks if the required configuration files for plugins exists and are up to date
sanity cors
Interact with CORS-entries for your project
sanity cors add
Allow a new origin to use your project API through CORS
sanity cors delete
Delete an existing CORS-origin from your project
sanity cors list
List all origins allowed to access the API for this project
sanity dataset
Interact with datasets in your project
sanity dataset alias
You can manage your dataset alias using this command
sanity dataset alias create
sanity dataset alias delete
sanity dataset alias link
sanity dataset alias unlink
sanity dataset copy
Manages dataset copying, including starting a new copy job, listing copy jobs and following the progress of a running copy job
sanity dataset create
Create a new dataset within your project
sanity dataset delete
Delete a dataset within your project
sanity dataset export
Export dataset to local filesystem as a gzipped tarball
sanity dataset import
Import documents to given dataset from ndjson file
sanity dataset list
List datasets of your project
sanity dataset visibility
Set visibility of a dataset
sanity debug
Gathers information on Sanity environment
sanity deploy
Deploys a statically built Sanity studio
sanity docs
Opens the Sanity documentation
sanity documents
Interact with documents in your project
sanity documents create
Create one or more documents
sanity documents delete
Delete a document by ID
sanity documents get
Get and print a document by ID
sanity documents query
Query for documents
sanity exec
Runs a script in Sanity context
sanity graphql
Interact with GraphQL APIs
sanity graphql deploy
Deploy a GraphQL API from the current Sanity schema
sanity graphql list
Lists all the GraphQL endpoints deployed for this project
sanity graphql undeploy
Remove a deployed GraphQL API
sanity hook
Interact with hooks in your project
sanity hook attempt
Print details of a given webhook delivery attempt
sanity hook create
Create a new hook for the given dataset
sanity hook delete
Delete a hook within your project
sanity hook list
List hooks for a given project
sanity hook logs
List latest log entries for a given hook
sanity init
Initialize a new Sanity project or plugin
sanity install
Installs a Sanity plugin to the current Sanity configuration
sanity login
Authenticates against the Sanity.io API (no flag) or a third-party identity provider (with --sso flag)
sanity logout
Logs out of the Sanity.io session
sanity manage
Opens the Sanity project management UI
sanity projects
Interact with projects connected to your logged in user
sanity projects list
Lists projects connected to your user
sanity start
Starts a web server for the Content Studio
sanity undeploy
Removes the deployed studio from <hostname>.sanity.studio
sanity uninstall
Removes a Sanity plugin from the current Sanity configuration
sanity upgrade
Upgrades all (or some) Sanity modules to their latest versions
sanity users
Manage users of your project
sanity users invite
Invite a new user to the project
sanity users list
List users of the project
sanity versions
Shows the installed versions of Sanity CLI and core components
OptionsOn sanity itself
--help-h
Show help for sanity