roboto-cli v6.0.1

Roboto Studio CLI

An all-purpose CLI tool for making projects easier to bootstrap.

• Usage
• Commands

Usage

$ npm install -g roboto-cli
$ roboto-cli COMMAND
running command...
$ roboto-cli (--version)
roboto-cli/6.0.1 linux-x64 node-v16.13.1
$ roboto-cli --help [COMMAND]
USAGE
  $ roboto-cli COMMAND
...

Commands

• roboto-cli bootstrap
• roboto-cli bootstrap turbo
• roboto-cli help [COMMAND]
• roboto-cli plugins
• roboto-cli plugins:inspect PLUGIN...
• roboto-cli plugins:install PLUGIN...
• roboto-cli plugins:link PLUGIN
• roboto-cli plugins:uninstall PLUGIN...
• roboto-cli plugins update

roboto-cli bootstrap

Bootstrap a Project pre-defined by Roboto Studio

USAGE
  $ roboto-cli bootstrap

DESCRIPTION
  Bootstrap a Project pre-defined by Roboto Studio

EXAMPLES
  $ roboto-cli bootstrap {project-type}

See code: dist/commands/bootstrap/index.ts

roboto-cli bootstrap turbo

Create a project with Turbo, Sanity and NextJS

USAGE
  $ roboto-cli bootstrap turbo [-n <value>] [-d <value>] [-p <value>] [-t <value>] [-s <value>] [-w <value>] [-g
    <value>]

FLAGS
  -d, --dataset=<value>     [default: production] Sanity Dataset
  -g, --gitRepo=<value>     The SSH URL of the Git Repo
  -n, --name=<value>        Name of the Website
  -p, --pid=<value>         Sanity Project ID
  -s, --studioUrl=<value>   Sanity Studio URL
  -t, --token=<value>       Sanity API Token
  -w, --websiteUrl=<value>  NextJS Website URL

DESCRIPTION
  Create a project with Turbo, Sanity and NextJS

EXAMPLES
  $ roboto-cli bootstrap turbo

roboto-cli help [COMMAND]

Display help for roboto-cli.

USAGE
  $ roboto-cli 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 roboto-cli.

See code: @oclif/plugin-help

roboto-cli plugins

List installed plugins.

USAGE
  $ roboto-cli plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ roboto-cli plugins

See code: @oclif/plugin-plugins

roboto-cli plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ roboto-cli plugins:inspect PLUGIN...

ARGUMENTS
  PLUGIN  [default: .] Plugin to inspect.

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

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ roboto-cli plugins:inspect myplugin

roboto-cli plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ roboto-cli plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.

  Can be installed from npm or a git url.

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

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.

ALIASES
  $ roboto-cli plugins add

EXAMPLES
  $ roboto-cli plugins:install myplugin 

  $ roboto-cli plugins:install https://github.com/someuser/someplugin

  $ roboto-cli plugins:install someuser/someplugin

roboto-cli plugins:link PLUGIN

Links a plugin into the CLI for development.

USAGE
  $ roboto-cli plugins:link PLUGIN

ARGUMENTS
  PATH  [default: .] path to plugin

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

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
  $ roboto-cli plugins:link myplugin

roboto-cli plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ roboto-cli plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ roboto-cli plugins unlink
  $ roboto-cli plugins remove

roboto-cli plugins update

Update installed plugins.

USAGE
  $ roboto-cli plugins update [-h] [-v]

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

DESCRIPTION
  Update installed plugins.

• roboto-cli help [COMMAND]
• roboto-cli bootstrap [INTEGRATION]

roboto-cli help [COMMAND]

Display help for roboto-cli.

USAGE
  $ roboto-cli 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 roboto-cli.

Bootstrap Command

Integrations

roboto-cli bootstrap sanity-next

Create a project with the Roboto Turbo/Sanity/Next template.

USAGE
  $ roboto-cli bootstrap sanity-next [-n] [-d] [-p] [-t]

ARGUMENTS
  N/A

FLAGS
  -n, --name  Name of the Website/Project
  -d, --dataset  Name of the Sanity Dataset
  -p, --pid  Sanity Project ID
  -t, --token  Sanity Project API Token

DESCRIPTION
  Display help for roboto-cli.