sharemani v1.0.0

oclif-hello-world

oclif example Hello World CLI

• Usage
• Commands

Usage

$ npm install -g sharemani
$ shareman COMMAND
running command...
$ shareman (--version)
sharemani/1.0.0 linux-x64 node-v19.3.0
$ shareman --help [COMMAND]
USAGE
  $ shareman COMMAND
...

Commands

• shareman help [COMMAND]
• shareman plugins
• shareman plugins:install PLUGIN...
• shareman plugins:inspect PLUGIN...
• shareman plugins:install PLUGIN...
• shareman plugins:link PLUGIN
• shareman plugins:uninstall PLUGIN...
• shareman plugins:uninstall PLUGIN...
• shareman plugins:uninstall PLUGIN...
• shareman plugins update
• shareman share --port

shareman help [COMMAND]

Display help for shareman.

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

See code: @oclif/plugin-help

shareman plugins

List installed plugins.

USAGE
  $ shareman plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ shareman plugins

See code: @oclif/plugin-plugins

shareman plugins:install PLUGIN...

Installs a plugin into the CLI.

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

EXAMPLES
  $ shareman plugins:install myplugin 

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

  $ shareman plugins:install someuser/someplugin

shareman plugins:inspect PLUGIN...

Displays installation properties of a plugin.

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

shareman plugins:install PLUGIN...

Installs a plugin into the CLI.

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

EXAMPLES
  $ shareman plugins:install myplugin 

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

  $ shareman plugins:install someuser/someplugin

shareman plugins:link PLUGIN

Links a plugin into the CLI for development.

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

shareman plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ shareman plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ shareman plugins unlink
  $ shareman plugins remove

shareman plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ shareman plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ shareman plugins unlink
  $ shareman plugins remove

shareman plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ shareman plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ shareman plugins unlink
  $ shareman plugins remove

shareman plugins update

Update installed plugins.

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

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

DESCRIPTION
  Update installed plugins.

shareman share --port

Shares the given directory in local or external network.

USAGE
  $ shareman share --port

ARGUMENTS
  DIRECTORY  [default: .] shared directory

USAGE FLAGS
  -p, --port=<value>  exposed port for connecting to the shared directory

DESCRIPTION
  Shares the given directory in local or external network.

  Shares the given directory in local or external network.

EXAMPLES
  $ shareman share

FLAG DESCRIPTIONS
  -p, --port=<value>  exposed port for connecting to the shared directory

    exposed port for connecting to the shared directory

See code: dist/commands/share.ts