Commands

Plugify provides a powerful Command Line Interface (CLI) for managing plugins, language modules, and packages. Below is a comprehensive list of available commands, organized by functionality.

Important Note

The commands listed here are not part of the Plugify core itself. Instead, they are implemented manually by each project that integrates Plugify. This is because different projects may have unique input systems, CLI frameworks, or user interaction requirements. The examples provided in this documentation are based on the implementations used in MM2-Plugify and S2-Plugify, which are specific to those projects. Your implementation may vary depending on your project's needs.

Plugin Manager Commands

Load Plugin Manager

Load the plugin manager with plugins and language modules.

plg load

Options:

• --ignore: Load the plugin manager while ignoring missing or conflicting packages.
  plg load --ignore
  

Unload Plugin Manager

Unload the plugin manager and all associated plugins and language modules.

plg unload

Search Commands

Show Plugin Information

Display detailed information about a specific plugin.

plg plugin _plugin_name_

Show Module Information

Display detailed information about a specific language module.

plg module _module_name_

List Running Modules

List all currently loaded language modules.

plg modules

List Running Plugins

List all currently loaded plugins.

plg plugins

Miscellaneous Commands

Show Help

Display the help menu with a list of available commands.

plg help

Version Information

Display the current version of Plugify.

plg version

Package Manager Commands

Plugify's package manager allows you to install, update, remove, and search for packages. It also supports managing local and remote repositories.

Install Packages

Install one or more packages by name.

plg install _package_name1_ _package_name2_ ...

Options:

• Install packages from a local manifest file:
  plg install --file D:/_package_file_.json
  

• Install packages from a remote manifest file:
  plg install --link https://website.com/_package_file_.json
  

• Install missing packages to resolve dependencies:
  plg install --missing
  

Update Packages

Update one or more installed packages.

plg update _package_name1_ _package_name2_ ...

Options:

• Update all installed packages:
  plg update --all
  

Remove Packages

Remove one or more installed packages.

plg remove _package_name1_ _package_name2_ ...

Options:

• Remove all installed packages:
  plg remove --all
  

• Remove conflicted packages with unresolved dependencies:
  plg remove --conflict
  

Search for Packages

List Local Packages

Display all locally installed packages.

plg list

List Remote Packages

Display all packages available in remote repositories.

plg query

Search Remote Packages

Search for remote packages by name.

plg search _package_name_

Search Local Packages

Search for locally installed packages by name.

plg show _package_name_

Manage Repositories

Add a Repository

Add a new remote repository for package installation.

plg repo https://website.com/_package_file_.json

Note: Only add repositories from trusted sources to avoid security risks.

Create a Snapshot

Generate a snapshot of all installed packages into a manifest file. The file will be saved in the base directory.

plg snapshot

Best Practices

• Always use the --ignore flag with caution, as it may lead to unstable behavior if dependencies are missing or conflicted.
• Regularly update your packages to ensure compatibility and security.
• Use snapshots to back up your package configurations before making significant changes.