Skip to content

Latest commit

 

History

History
203 lines (135 loc) · 4.49 KB

plugins.md

File metadata and controls

203 lines (135 loc) · 4.49 KB

rdme plugins

List installed plugins.

rdme plugins

List installed plugins.

USAGE
  $ rdme plugins [--json] [--core]

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ rdme plugins

See code: @oclif/plugin-plugins

rdme plugins:inspect PLUGIN...

Displays installation properties of a plugin.

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

See code: @oclif/plugin-plugins

rdme plugins install PLUGIN

Installs a plugin into rdme.

USAGE
  $ rdme plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]

ARGUMENTS
  PLUGIN...  Plugin to install.

FLAGS
  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
  -h, --help     Show CLI help.
  -s, --silent   Silences npm output.
  -v, --verbose  Show verbose npm output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into rdme.

  Uses npm to install plugins.

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

  Use the RDME_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the RDME_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ rdme plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ rdme plugins install myplugin

  Install a plugin from a github url.

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

  Install a plugin from a github slug.

    $ rdme plugins install someuser/someplugin

See code: @oclif/plugin-plugins

rdme plugins link PATH

Links a plugin into the CLI for development.

USAGE
  $ rdme plugins link PATH [-h] [--install] [-v]

ARGUMENTS
  PATH  [default: .] path to plugin

FLAGS
  -h, --help          Show CLI help.
  -v, --verbose
      --[no-]install  Install dependencies after linking the plugin.

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
  $ rdme plugins link myplugin

See code: @oclif/plugin-plugins

rdme plugins reset

Remove all user-installed and linked plugins.

USAGE
  $ rdme plugins reset [--hard] [--reinstall]

FLAGS
  --hard       Delete node_modules and package manager related files in addition to uninstalling plugins.
  --reinstall  Reinstall all plugins after uninstalling.

See code: @oclif/plugin-plugins

rdme plugins uninstall [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ rdme plugins uninstall [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ rdme plugins unlink
  $ rdme plugins remove

EXAMPLES
  $ rdme plugins uninstall myplugin

See code: @oclif/plugin-plugins

rdme plugins update

Update installed plugins.

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

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

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins