Skip to content
Raphaël edited this page Aug 31, 2022 · 5 revisions

This page contains all information on how to use RtopPluginManager.

List of available commands

Install command

Flags: -S --install
Description: This command allows to install plugins, to update plugin repositories and to update plugins.
Sub-flags:

  • --upgrade -d
    Description: This command allows to update all the plugins.
    Conflicts: This command cannot be used with a list of plugins.
    Example:
    rtpm -Sd
  • --update -u
    Description: This command allows to update all the repositories of plugins.
    Examples:
    • Simple update of repositories
      rtpm -Su
    • Updating repositories and plugins
      rtpm -Sud
  • Arguments
    Description: You can fill in a list of plugins you want to install.
    Note: By using the --unsecure-git-url or -z flag, you can set the URL of a git repository that contains a single plugin to install it.
    Examples:
    • Install some plugins
      rtpm -S some another plugin
    • Updating repositories and install plugins
      rtpm -Su some another plugin
    • Use of flag --unsecure-git-url
      rtpm -Sz "https://github.com/RtopRS/PluginTemplate.git"

Search command

Flags: -Q --search
Description: This command allows you to search for a plugin by its name in all the repositories of downloaded plugins.
Arguments: You can fill in a list of plugins to search.
Example:

rtpm -Q some another plugin

Uninstall command

Flags: -U --uninstall
Description: This command allows you to uninstall one or several plugins.
Arguments: You can fill in a list of plugins to uninstall.
Example:

rtpm -U some another plugin

Add repository command

Flags: -A --add-repository
Description: This command allows you to add custom Rtop plugin repository.
Argument: A repository URL.
Example:

rtpm -A "https://github.com/RtopRS/PluginsRepository"

Remove repository command

Flags: -R --remove-repository
Description: This command allows you to remove custom Rtop plugin repository.
Argument: A repository URL.
Example:

rtpm -R "https://github.com/RtopRS/PluginsRepository"

Infos command

Flags: -I --infos
Description: This command allows to get some information about plugin or repository.
Sub-flags:

  • --repository -r
    Description: This command allows to get some information about a repository.
    Note: This flag can be associated with the -a flag to list all repositories present.
    Example:
    • Get information about Rtop official repository
      rtpm -Ir rtop
    • List installed repositories
      rtpm -Ira
  • --plugin -p
    Description: This command allows to get some information about a plugin.
    Note: This flag can be associated with the -a flag to list all plugins present.
    Example:
    • Get information about some plugins
      rtpm -Ip some plugin
    • List installed plugins
      rtpm -Ipa