Package Exports

@sanity/runtime-cli
@sanity/runtime-cli/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@sanity/runtime-cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@sanity/runtime-cli

A new CLI generated with oclif

Usage
Commands

Usage

$ npm install -g @sanity/runtime-cli
$ sanity COMMAND
running command...
$ sanity (--version)
@sanity/runtime-cli/1.4.1 linux-x64 node-v22.14.0
$ sanity --help [COMMAND]
USAGE
  $ sanity COMMAND
...

Commands

sanity blueprints deploy
sanity blueprints info
sanity blueprints logs
sanity blueprints plan
sanity functions dev
sanity functions invoke ID
sanity functions logs ID
sanity functions test PATH
sanity help [COMMAND]
sanity plugins
sanity plugins add PLUGIN
sanity plugins:inspect PLUGIN...
sanity plugins install PLUGIN
sanity plugins link PATH
sanity plugins remove [PLUGIN]
sanity plugins reset
sanity plugins uninstall [PLUGIN]
sanity plugins unlink [PLUGIN]
sanity plugins update

`sanity blueprints deploy`

Deploy a Blueprint

USAGE
  $ sanity blueprints deploy

DESCRIPTION
  Deploy a Blueprint

EXAMPLES
  $ sanity blueprints deploy

See code: src/commands/blueprints/deploy.ts

`sanity blueprints info`

Show information about a Blueprint

USAGE
  $ sanity blueprints info

DESCRIPTION
  Show information about a Blueprint

EXAMPLES
  $ sanity blueprints info

See code: src/commands/blueprints/info.ts

`sanity blueprints logs`

Display logs for a Blueprint stack

USAGE
  $ sanity blueprints logs [-w]

FLAGS
  -w, --watch  Watch for new logs (streaming mode)

DESCRIPTION
  Display logs for a Blueprint stack

EXAMPLES
  $ sanity blueprints logs

  $ sanity blueprints logs --watch

See code: src/commands/blueprints/logs.ts

`sanity blueprints plan`

Enumerate resources to be deployed - will not modify any resources

USAGE
  $ sanity blueprints plan

DESCRIPTION
  Enumerate resources to be deployed - will not modify any resources

EXAMPLES
  $ sanity blueprints plan

See code: src/commands/blueprints/plan.ts

`sanity functions dev`

Start the Sanity Function emulator

USAGE
  $ sanity functions dev [-p <value>]

FLAGS
  -p, --port=<value>  Port to start emulator on

DESCRIPTION
  Start the Sanity Function emulator

EXAMPLES
  $ sanity functions dev --port 8974

See code: src/commands/functions/dev.ts

`sanity functions invoke ID`

Invoke a remote Sanity Function

USAGE
  $ sanity functions invoke ID [-d <value>] [-f <value>]

ARGUMENTS
  ID  The ID of the function to invoke

FLAGS
  -d, --data=<value>  Data to send to the function
  -f, --file=<value>  Read data from file and send to the function

DESCRIPTION
  Invoke a remote Sanity Function

EXAMPLES
  $ sanity functions invoke <ID> --data '{ "id": 1 }'

  $ sanity functions invoke <ID> --file 'payload.json'

See code: src/commands/functions/invoke.ts

`sanity functions logs ID`

Retrieve logs for a Sanity Function

USAGE
  $ sanity functions logs ID

ARGUMENTS
  ID  The ID of the function to retrieve logs for

DESCRIPTION
  Retrieve logs for a Sanity Function

EXAMPLES
  $ sanity functions logs <ID>

See code: src/commands/functions/logs.ts

`sanity functions test PATH`

Invoke a local Sanity Function

USAGE
  $ sanity functions test PATH [-d <value>] [-f <value>] [-t <value>]

ARGUMENTS
  PATH  The path to the function source code

FLAGS
  -d, --data=<value>     Data to send to the function
  -f, --file=<value>     Read data from file and send to the function
  -t, --timeout=<value>  Execution timeout value in seconds

DESCRIPTION
  Invoke a local Sanity Function

EXAMPLES
  $ sanity functions test ./test.ts --data '{ "id": 1 }'

  $ sanity functions test ./test.js --file 'payload.json'

  $ sanity functions test ./test.ts --data '{ "id": 1 }' --timeout 60

See code: src/commands/functions/test.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 plugins`

List installed plugins.

USAGE
  $ sanity plugins [--json] [--core]

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ sanity plugins

See code: @oclif/plugin-plugins

`sanity plugins add PLUGIN`

Installs a plugin into sanity.

USAGE
  $ sanity plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]

ARGUMENTS
  PLUGIN...  Plugin to install.

FLAGS
  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
  -h, --help     Show CLI help.
  -s, --silent   Silences npm output.
  -v, --verbose  Show verbose npm output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into sanity.

  Uses npm to install plugins.

  Installation of a user-installed plugin will override a core plugin.

  Use the SANITY_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the SANITY_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ sanity plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ sanity plugins add myplugin

  Install a plugin from a github url.

    $ sanity plugins add https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ sanity plugins add someuser/someplugin

`sanity plugins:inspect PLUGIN...`

Displays installation properties of a plugin.

USAGE
  $ sanity plugins inspect PLUGIN...

ARGUMENTS
  PLUGIN...  [default: .] Plugin to inspect.

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ sanity plugins inspect myplugin

See code: @oclif/plugin-plugins

`sanity plugins install PLUGIN`

Installs a plugin into sanity.

USAGE
  $ sanity plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]

ARGUMENTS
  PLUGIN...  Plugin to install.

FLAGS
  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
  -h, --help     Show CLI help.
  -s, --silent   Silences npm output.
  -v, --verbose  Show verbose npm output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into sanity.

  Uses npm to install plugins.

  Installation of a user-installed plugin will override a core plugin.

  Use the SANITY_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the SANITY_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ sanity plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ sanity plugins install myplugin

  Install a plugin from a github url.

    $ sanity plugins install https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ sanity plugins install someuser/someplugin

See code: @oclif/plugin-plugins

`sanity plugins link PATH`

Links a plugin into the CLI for development.

USAGE
  $ sanity plugins link PATH [-h] [--install] [-v]

ARGUMENTS
  PATH  [default: .] path to plugin

FLAGS
  -h, --help          Show CLI help.
  -v, --verbose
      --[no-]install  Install dependencies after linking the plugin.

DESCRIPTION
  Links a plugin into the CLI for development.

  Installation of a linked plugin will override a user-installed or core plugin.

  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
  command will override the user-installed or core plugin implementation. This is useful for development work.


EXAMPLES
  $ sanity plugins link myplugin

See code: @oclif/plugin-plugins

`sanity plugins remove [PLUGIN]`

Removes a plugin from the CLI.

USAGE
  $ sanity plugins remove [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ sanity plugins unlink
  $ sanity plugins remove

EXAMPLES
  $ sanity plugins remove myplugin

`sanity plugins reset`

Remove all user-installed and linked plugins.

USAGE
  $ sanity plugins reset [--hard] [--reinstall]

FLAGS
  --hard       Delete node_modules and package manager related files in addition to uninstalling plugins.
  --reinstall  Reinstall all plugins after uninstalling.

See code: @oclif/plugin-plugins

`sanity plugins uninstall [PLUGIN]`

Removes a plugin from the CLI.

USAGE
  $ sanity plugins uninstall [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ sanity plugins unlink
  $ sanity plugins remove

EXAMPLES
  $ sanity plugins uninstall myplugin

See code: @oclif/plugin-plugins

`sanity plugins unlink [PLUGIN]`

Removes a plugin from the CLI.

USAGE
  $ sanity plugins unlink [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ sanity plugins unlink
  $ sanity plugins remove

EXAMPLES
  $ sanity plugins unlink myplugin

`sanity plugins update`

Update installed plugins.

USAGE
  $ sanity plugins update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins

sanity functions dev
sanity functions invoke
sanity functions logs
sanity functions test

`sanity functions dev`

Start the Sanity Function emulator

USAGE
  $ sanity functions dev [-p <value>]

FLAGS
  -p, --port=<value>  Port to start emulator on

DESCRIPTION
  Start the Sanity Function emulator

EXAMPLES
  $ sanity functions dev --port 8974

See code: src/commands/functions/dev.ts

`sanity functions invoke`

Invoke a remote Sanity Function

USAGE
  $ sanity functions invoke ID [-d <value>] [-f <value>]

ARGUMENTS
  ID  The ID of the function to invoke

FLAGS
  -d, --data=<value>  Data to send to the function
  -f, --file=<value>  Read data from file and send to the function

DESCRIPTION
  Invoke a remote Sanity Function

EXAMPLES
  $ sanity functions invoke <ID> --data '{ "id": 1 }'

  $ sanity functions invoke <ID> --file 'payload.json'

See code: src/commands/functions/invoke.ts

`sanity functions logs`

Retrieve logs for a Sanity Function

USAGE
  $ sanity functions logs ID

ARGUMENTS
  ID  The ID of the function to retrieve logs for

DESCRIPTION
  Retrieve logs for a Sanity Function

EXAMPLES
  $ sanity functions logs <ID>

See code: src/commands/functions/logs.ts

`sanity functions test`

Invoke a local Sanity Function

USAGE
  $ sanity functions test PATH [-d <value>] [-f <value>]

ARGUMENTS
  PATH  The path to the function source code

FLAGS
  -d, --data=<value>  Data to send to the function
  -f, --file=<value>  Read data from file and send to the function

DESCRIPTION
  Invoke a local Sanity Function

EXAMPLES
  $ sanity functions test ./test.ts --data '{ "id": 1 }'

  $ sanity functions test ./test.js --file 'payload.json'

See code: src/commands/functions/test.ts