@sophon-js/cli v0.0.9

oclif-hello-world

oclif example Hello World CLI

• Usage
• Commands

Usage

$ npm install -g @sophon-js/cli
$ sophon COMMAND
running command...
$ sophon (--version)
@sophon-js/cli/0.0.9 linux-x64 node-v16.20.2
$ sophon --help [COMMAND]
USAGE
  $ sophon COMMAND
...

Commands

• sophon generate SCHEMA
• sophon help [COMMANDS]
• sophon plugins
• sophon plugins:install PLUGIN...
• sophon plugins:inspect PLUGIN...
• sophon plugins:install PLUGIN...
• sophon plugins:link PLUGIN
• sophon plugins:uninstall PLUGIN...
• sophon plugins:uninstall PLUGIN...
• sophon plugins:uninstall PLUGIN...
• sophon plugins update

sophon generate SCHEMA

Generates source code from Sophon schema.

USAGE
  $ sophon generate [SCHEMA] -t <value> -o <value>

ARGUMENTS
  SCHEMA  location of the sophon schema

FLAGS
  -o, --output=<value>  (required) Generator output
  -t, --target=<value>  (required) Generator target

DESCRIPTION
  Generates source code from Sophon schema.

EXAMPLES
  $ sophon generate ./schema.sophon -t ts-socketio-server -o sophon.ts

See code: dist/commands/generate.ts

sophon help [COMMANDS]

Display help for sophon.

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

See code: @oclif/plugin-help

sophon plugins

List installed plugins.

USAGE
  $ sophon plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ sophon plugins

See code: @oclif/plugin-plugins

sophon plugins:install PLUGIN...

Installs a plugin into the CLI.

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

EXAMPLES
  $ sophon plugins:install myplugin 

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

  $ sophon plugins:install someuser/someplugin

sophon plugins:inspect PLUGIN...

Displays installation properties of a plugin.

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

sophon plugins:install PLUGIN...

Installs a plugin into the CLI.

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

EXAMPLES
  $ sophon plugins:install myplugin 

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

  $ sophon plugins:install someuser/someplugin

sophon plugins:link PLUGIN

Links a plugin into the CLI for development.

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

sophon plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ sophon plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ sophon plugins unlink
  $ sophon plugins remove

sophon plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ sophon plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ sophon plugins unlink
  $ sophon plugins remove

sophon plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ sophon plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ sophon plugins unlink
  $ sophon plugins remove

sophon plugins update

Update installed plugins.

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

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

DESCRIPTION
  Update installed plugins.