oclif-hello-world

oclif example Hello World CLI

• Usage
• Commands

Usage

$ npm install -g @thebeyondgroup/shopkeeper
$ shopkeeper COMMAND
running command...
$ shopkeeper (--version)
@thebeyondgroup/shopkeeper/1.0.0 darwin-x64 node-v18.17.0
$ shopkeeper --help [COMMAND]
USAGE
  $ shopkeeper COMMAND
...

Commands

• shopkeeper bucket create
• shopkeeper bucket current
• shopkeeper bucket init
• shopkeeper bucket restore
• shopkeeper bucket save [BUCKET]
• shopkeeper bucket switch BUCKET
• shopkeeper help [COMMANDS]
• shopkeeper plugins
• shopkeeper plugins:install PLUGIN...
• shopkeeper plugins:inspect PLUGIN...
• shopkeeper plugins:install PLUGIN...
• shopkeeper plugins:link PLUGIN
• shopkeeper plugins:uninstall PLUGIN...
• shopkeeper plugins:uninstall PLUGIN...
• shopkeeper plugins:uninstall PLUGIN...
• shopkeeper plugins update
• shopkeeper theme deploy
• shopkeeper theme get
• shopkeeper theme settings backup
• shopkeeper theme settings download

shopkeeper bucket create

Create a bucket in .shopkeeper

USAGE
  $ shopkeeper bucket create [--no-color] [--verbose]

FLAGS
  --no-color  Disable color output.
  --verbose   Increase the verbosity of the logs.

DESCRIPTION
  Create a bucket in .shopkeeper

shopkeeper bucket current

Output the current bucket

USAGE
  $ shopkeeper bucket current [--no-color] [--verbose]

FLAGS
  --no-color  Disable color output.
  --verbose   Increase the verbosity of the logs.

DESCRIPTION
  Output the current bucket

shopkeeper bucket init

Initialize .shopkeeper directory in the current directory

USAGE
  $ shopkeeper bucket init [--no-color] [--verbose]

FLAGS
  --no-color  Disable color output.
  --verbose   Increase the verbosity of the logs.

DESCRIPTION
  Initialize .shopkeeper directory in the current directory

shopkeeper bucket restore

USAGE
  $ shopkeeper bucket restore

shopkeeper bucket save [BUCKET]

Saves the current theme settings to the specified bucket

USAGE
  $ shopkeeper bucket save [BUCKET] [--no-color] [--verbose] [--path <value>] [-e <value>] [-n]

ARGUMENTS
  BUCKET  The bucket where you want to save your settings.

FLAGS
  -e, --environment=<value>  The environment to apply to the current command.
  -n, --nodelete             Runs the save command without deleting the bucket's contents.
  --no-color                 Disable color output.
  --path=<value>             [default: /Users/jeff/Beyond/shopkeeper@1] The path to your theme directory.
  --verbose                  Increase the verbosity of the logs.

DESCRIPTION
  Saves the current theme settings to the specified bucket

shopkeeper bucket switch BUCKET

Switches the current bucket by copying settings and .env

USAGE
  $ shopkeeper bucket switch BUCKET [--no-color] [--verbose]

ARGUMENTS
  BUCKET  The bucket to switch to

FLAGS
  --no-color  Disable color output.
  --verbose   Increase the verbosity of the logs.

DESCRIPTION
  Switches the current bucket by copying settings and .env

shopkeeper help [COMMANDS]

Display help for shopkeeper.

USAGE
  $ shopkeeper help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  Command to show help for.

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

DESCRIPTION
  Display help for shopkeeper.

See code: @oclif/plugin-help

shopkeeper plugins

List installed plugins.

USAGE
  $ shopkeeper plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ shopkeeper plugins

See code: @oclif/plugin-plugins

shopkeeper plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ shopkeeper 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
  $ shopkeeper plugins add

EXAMPLES
  $ shopkeeper plugins:install myplugin 

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

  $ shopkeeper plugins:install someuser/someplugin

shopkeeper plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ shopkeeper 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
  $ shopkeeper plugins:inspect myplugin

shopkeeper plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ shopkeeper 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
  $ shopkeeper plugins add

EXAMPLES
  $ shopkeeper plugins:install myplugin 

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

  $ shopkeeper plugins:install someuser/someplugin

shopkeeper plugins:link PLUGIN

Links a plugin into the CLI for development.

USAGE
  $ shopkeeper 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
  $ shopkeeper plugins:link myplugin

shopkeeper plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ shopkeeper plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ shopkeeper plugins unlink
  $ shopkeeper plugins remove

shopkeeper plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ shopkeeper plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ shopkeeper plugins unlink
  $ shopkeeper plugins remove

shopkeeper plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ shopkeeper plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ shopkeeper plugins unlink
  $ shopkeeper plugins remove

shopkeeper plugins update

Update installed plugins.

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

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

DESCRIPTION
  Update installed plugins.

shopkeeper theme deploy

Deploy source to on-deck theme

USAGE
  $ shopkeeper theme deploy

DESCRIPTION
  Deploy source to on-deck theme

shopkeeper theme get

USAGE
  $ shopkeeper theme get

shopkeeper theme settings backup

USAGE
  $ shopkeeper theme settings backup

shopkeeper theme settings download

USAGE
  $ shopkeeper theme settings download