oclif-hello-world

oclif example Hello World CLI

• Usage
• Commands

Usage

$ npm install -g smith-cli
$ smith COMMAND
running command...
$ smith (--version)
smith-cli/0.0.2 darwin-x64 node-v16.13.1
$ smith --help [COMMAND]
USAGE
  $ smith COMMAND
...

Commands

• smith help [COMMAND]
• smith init PROJECTPATH
• smith new PROJECTPATH TEMPLATEURL
• smith plugins
• smith plugins:inspect PLUGIN...
• smith plugins:install PLUGIN...
• smith plugins:link PLUGIN
• smith plugins:uninstall PLUGIN...
• smith plugins update
• smith props add [NAME]
• smith props list
• smith props remove NAME

smith help [COMMAND]

Display help for smith.

USAGE
  $ smith 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 smith.

See code: @oclif/plugin-help

smith init PROJECTPATH

Initialize a directory as a smith template

USAGE
  $ smith init [PROJECTPATH] [-f]

ARGUMENTS
  PROJECTPATH  Path to create project

FLAGS
  -f, --force

DESCRIPTION
  Initialize a directory as a smith template

EXAMPLES
  $ smith init

See code: dist/commands/init.ts

smith new PROJECTPATH TEMPLATEURL

Create a new project based on a smith template

USAGE
  $ smith new [PROJECTPATH] [TEMPLATEURL] [-f]

ARGUMENTS
  PROJECTPATH  Path to create project
  TEMPLATEURL  Template repository url

FLAGS
  -f, --force

DESCRIPTION
  Create a new project based on a smith template

EXAMPLES
  $ smith new

See code: dist/commands/new.ts

smith plugins

List installed plugins.

USAGE
  $ smith plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ smith plugins

See code: @oclif/plugin-plugins

smith plugins:inspect PLUGIN...

Displays installation properties of a plugin.

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

smith plugins:install PLUGIN...

Installs a plugin into the CLI.

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

EXAMPLES
  $ smith plugins:install myplugin 

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

  $ smith plugins:install someuser/someplugin

smith plugins:link PLUGIN

Links a plugin into the CLI for development.

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

smith plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ smith plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ smith plugins unlink
  $ smith plugins remove

smith plugins update

Update installed plugins.

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

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

DESCRIPTION
  Update installed plugins.

smith props add [NAME]

describe the command here

USAGE
  $ smith props add [NAME] [-d <value>]

FLAGS
  -d, --dir=<value>  [default: .]

DESCRIPTION
  describe the command here

EXAMPLES
  $ smith props add

smith props list

List smith props in your template

USAGE
  $ smith props list [-d <value>]

FLAGS
  -d, --dir=<value>  [default: .]

DESCRIPTION
  List smith props in your template

EXAMPLES
  $ smith props list

smith props remove NAME

describe the command here

USAGE
  $ smith props remove [NAME] [-d <value>]

ARGUMENTS
  NAME  Prop name

FLAGS
  -d, --dir=<value>  [default: .]

DESCRIPTION
  describe the command here

EXAMPLES
  $ smith props remove