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-run COMMAND
running command...
$ sanity-run (--version)
@sanity/runtime-cli/1.8.0 linux-x64 node-v22.14.0
$ sanity-run --help [COMMAND]
USAGE
  $ sanity-run COMMAND
...

Commands

sanity-run blueprints add TYPE
sanity-run blueprints config
sanity-run blueprints deploy
sanity-run blueprints info
sanity-run blueprints init
sanity-run blueprints logs
sanity-run blueprints plan
sanity-run blueprints stacks
sanity-run functions dev
sanity-run functions invoke NAME
sanity-run functions logs NAME
sanity-run functions test NAME
sanity-run help [COMMAND]
sanity-run plugins
sanity-run plugins add PLUGIN
sanity-run plugins:inspect PLUGIN...
sanity-run plugins install PLUGIN
sanity-run plugins link PATH
sanity-run plugins remove [PLUGIN]
sanity-run plugins reset
sanity-run plugins uninstall [PLUGIN]
sanity-run plugins unlink [PLUGIN]
sanity-run plugins update

`sanity-run blueprints add TYPE`

Add a resource to a Blueprint

USAGE
  $ sanity-run blueprints add TYPE

ARGUMENTS
  TYPE  (function) Type of resource to add (e.g. function)

DESCRIPTION
  Add a resource to a Blueprint

EXAMPLES
  $ sanity-run blueprints add function

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

`sanity-run blueprints config`

View or edit Blueprint configuration

USAGE
  $ sanity-run blueprints config [--edit]

FLAGS
  --edit  Edit the configuration

DESCRIPTION
  View or edit Blueprint configuration

EXAMPLES
  $ sanity-run blueprints config

  $ sanity-run blueprints config --edit

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

`sanity-run blueprints deploy`

Deploy a Blueprint

USAGE
  $ sanity-run blueprints deploy

DESCRIPTION
  Deploy a Blueprint

EXAMPLES
  $ sanity-run blueprints deploy

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

`sanity-run blueprints info`

Show information about a Blueprint

USAGE
  $ sanity-run blueprints info [--id <value>]

FLAGS
  --id=<value>  Stack ID to show info for (defaults to current stack)

DESCRIPTION
  Show information about a Blueprint

EXAMPLES
  $ sanity-run blueprints info

  $ sanity-run blueprints info --id abc123

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

`sanity-run blueprints init`

Initialize a new Blueprint

USAGE
  $ sanity-run blueprints init

DESCRIPTION
  Initialize a new Blueprint

EXAMPLES
  $ sanity-run blueprints init

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

`sanity-run blueprints logs`

Display logs for a Blueprint stack

USAGE
  $ sanity-run blueprints logs [-w]

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

DESCRIPTION
  Display logs for a Blueprint stack

EXAMPLES
  $ sanity-run blueprints logs

  $ sanity-run blueprints logs --watch

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

`sanity-run blueprints plan`

Enumerate resources to be deployed - will not modify any resources

USAGE
  $ sanity-run blueprints plan

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

EXAMPLES
  $ sanity-run blueprints plan

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

`sanity-run blueprints stacks`

List all Blueprint stacks

USAGE
  $ sanity-run blueprints stacks

DESCRIPTION
  List all Blueprint stacks

EXAMPLES
  $ sanity-run blueprints stacks

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

`sanity-run functions dev`

Start the Sanity Function emulator

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

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

DESCRIPTION
  Start the Sanity Function emulator

EXAMPLES
  $ sanity-run functions dev --port 8974

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

`sanity-run functions invoke NAME`

Invoke a remote Sanity Function

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

ARGUMENTS
  NAME  The name of the Sanity Function

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-run functions invoke <ID> --data '{ "id": 1 }'

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

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

`sanity-run functions logs NAME`

Retrieve logs for a Sanity Function

USAGE
  $ sanity-run functions logs NAME

ARGUMENTS
  NAME  The name of the Sanity Function

DESCRIPTION
  Retrieve logs for a Sanity Function

EXAMPLES
  $ sanity-run functions logs <ID>

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

`sanity-run functions test NAME`

Invoke a local Sanity Function

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

ARGUMENTS
  NAME  The name of the Sanity Function

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-run functions test echo-fn --data '{ "id": 1 }'

  $ sanity-run functions test echo-fn --file 'payload.json'

  $ sanity-run functions test echo-fn --data '{ "id": 1 }' --timeout 60

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

`sanity-run help [COMMAND]`

Display help for sanity-run.

USAGE
  $ sanity-run 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-run.

See code: @oclif/plugin-help

`sanity-run plugins`

List installed plugins.

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

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ sanity-run plugins

See code: @oclif/plugin-plugins

`sanity-run plugins add PLUGIN`

Installs a plugin into sanity-run.

USAGE
  $ sanity-run 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-run.

  Uses npm to install plugins.

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

  Use the SANITY_RUN_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the SANITY_RUN_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ sanity-run plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ sanity-run plugins add myplugin

  Install a plugin from a github url.

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

  Install a plugin from a github slug.

    $ sanity-run plugins add someuser/someplugin

`sanity-run plugins:inspect PLUGIN...`

Displays installation properties of a plugin.

USAGE
  $ sanity-run 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-run plugins inspect myplugin

See code: @oclif/plugin-plugins

`sanity-run plugins install PLUGIN`

Installs a plugin into sanity-run.

USAGE
  $ sanity-run 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-run.

  Uses npm to install plugins.

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

  Use the SANITY_RUN_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the SANITY_RUN_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ sanity-run plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ sanity-run plugins install myplugin

  Install a plugin from a github url.

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

  Install a plugin from a github slug.

    $ sanity-run plugins install someuser/someplugin

See code: @oclif/plugin-plugins

`sanity-run plugins link PATH`

Links a plugin into the CLI for development.

USAGE
  $ sanity-run 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-run plugins link myplugin

See code: @oclif/plugin-plugins

`sanity-run plugins remove [PLUGIN]`

Removes a plugin from the CLI.

USAGE
  $ sanity-run 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-run plugins unlink
  $ sanity-run plugins remove

EXAMPLES
  $ sanity-run plugins remove myplugin

`sanity-run plugins reset`

Remove all user-installed and linked plugins.

USAGE
  $ sanity-run 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-run plugins uninstall [PLUGIN]`

Removes a plugin from the CLI.

USAGE
  $ sanity-run 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-run plugins unlink
  $ sanity-run plugins remove

EXAMPLES
  $ sanity-run plugins uninstall myplugin

See code: @oclif/plugin-plugins

`sanity-run plugins unlink [PLUGIN]`

Removes a plugin from the CLI.

USAGE
  $ sanity-run 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-run plugins unlink
  $ sanity-run plugins remove

EXAMPLES
  $ sanity-run plugins unlink myplugin

`sanity-run plugins update`

Update installed plugins.

USAGE
  $ sanity-run 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