@sanity/cli

Code for sanity cli

Usage

$ npm install -g @sanity/cli
$ sanity COMMAND
running command...
$ sanity (--version)
@sanity/cli/0.0.0 darwin-arm64 node-v20.19.1
$ sanity --help [COMMAND]
USAGE
  $ sanity COMMAND
...

Commands

• sanity build [OUTPUTDIR]
• sanity dev
• sanity docs
• sanity help [COMMAND]
• sanity learn
• sanity login
• sanity logout
• sanity manage
• sanity projects list
• sanity users list
• sanity versions

sanity build [OUTPUTDIR]

Builds the Sanity Studio configuration into a static bundle

USAGE
  $ sanity build [OUTPUTDIR] [--auto-updates] [--minify] [--source-maps] [-y]

ARGUMENTS
  OUTPUTDIR  Output directory

FLAGS
  -y, --yes                Unattended mode, answers "yes" to any "yes/no" prompt and otherwise uses defaults
      --[no-]auto-updates  Enable/disable auto updates of studio versions
      --[no-]minify        Enable/disable minifying of built bundles
      --[no-]source-maps   Enable source maps for built bundles (increases size of bundle)

DESCRIPTION
  Builds the Sanity Studio configuration into a static bundle

EXAMPLES
  $ sanity build

  $ sanity build --no-minify --source-maps

See code: src/commands/build.ts

sanity dev

Starts a local development server for Sanity Studio with live reloading

USAGE
  $ sanity dev [--host <value>] [--port <value>]

FLAGS
  --host=<value>  [default: 127.0.0.1] The local network interface at which to listen
  --port=<value>  [default: 3333] TCP port to start server on

DESCRIPTION
  Starts a local development server for Sanity Studio with live reloading

EXAMPLES
  $ sanity dev --host=0.0.0.0

  $ sanity dev --port=1942

See code: src/commands/dev.ts

sanity docs

Opens Sanity Studio documentation in your web browser

USAGE
  $ sanity docs

DESCRIPTION
  Opens Sanity Studio documentation in your web browser

See code: src/commands/docs.ts

sanity help [COMMAND]

Display help for sanity.

USAGE
  $ sanity help [COMMAND...] [-n]

ARGUMENTS
  COMMAND...  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for sanity.

See code: @oclif/plugin-help

sanity learn

Opens Sanity Learn in your web browser

USAGE
  $ sanity learn

DESCRIPTION
  Opens Sanity Learn in your web browser

See code: src/commands/learn.ts

sanity login

Authenticates the CLI for access to Sanity projects

USAGE
  $ sanity login [--open] [--provider <providerId>] [--sso <slug>]

FLAGS
  --[no-]open              Open a browser window to log in (`--no-open` only prints URL)
  --provider=<providerId>  Log in using the given provider
  --sso=<slug>             Log in using Single Sign-On, using the given organization slug

DESCRIPTION
  Authenticates the CLI for access to Sanity projects

EXAMPLES
  Log in using default settings

    $ sanity login

  Log in using Single Sign-On with the "my-organization" slug

    $ sanity login --sso my-organization

  Login with GitHub provider, but do not open a browser window automatically

    $ sanity login --provider github --no-open

See code: src/commands/login.ts

sanity logout

Logs out the CLI from the current user session

USAGE
  $ sanity logout

DESCRIPTION
  Logs out the CLI from the current user session

See code: src/commands/logout.ts

sanity manage

Opens project management interface in your web browser

USAGE
  $ sanity manage

DESCRIPTION
  Opens project management interface in your web browser

See code: src/commands/manage.ts

sanity projects list

Lists projects connected to your user

USAGE
  $ sanity projects list [--order asc|desc] [--sort id|members|name|url|created]

FLAGS
  --order=<option>  [default: desc]
                    <options: asc|desc>
  --sort=<option>   [default: created]
                    <options: id|members|name|url|created>

DESCRIPTION
  Lists projects connected to your user

EXAMPLES
  List projects

    $ sanity projects list

  List all users of the project, but exclude pending invitations and robots

    $ sanity projects list --sort=members --order=asc

See code: src/commands/projects/list.ts

sanity users list

List all users of the project

USAGE
  $ sanity users list [--invitations] [--order asc|desc] [--robots] [--sort id|name|role|date]

FLAGS
  --[no-]invitations  Includes or excludes pending invitations
  --order=<option>    [default: asc] Sort output ascending/descending
                      <options: asc|desc>
  --[no-]robots       Includes or excludes robots (token users)
  --sort=<option>     [default: date] Sort users by specified column
                      <options: id|name|role|date>

DESCRIPTION
  List all users of the project

EXAMPLES
  List all users of the project

    $ sanity users list

  List all users of the project, but exclude pending invitations and robots

    $ sanity users list --no-invitations --no-robots

  List all users, sorted by role

    $ sanity users list --sort role

See code: src/commands/users/list.ts

sanity versions

Shows installed versions of Sanity Studio and components

USAGE
  $ sanity versions

DESCRIPTION
  Shows installed versions of Sanity Studio and components

EXAMPLES
  $ sanity versions

See code: src/commands/versions.ts

Table of contents

• @sanity/cli
• Usage
• Commands
• Table of contents