Commands
Server console commands for managing Plugify, its plugins, language modules and packages.
Plugify is managed from the server console with two commands: plg controls the plugin manager, and mamba installs, updates and removes packages.
Plugin manager: plg
plg has the aliases plugify and plug. Run plg --help for the list of subcommands and plg <subcommand> --help for the options of one of them.
| Command | What it does |
|---|---|
plg load | Load the plugin manager with all language modules and plugins |
plg unload | Unload the plugin manager, all plugins and language modules |
plg reload | Unload and load everything again |
plg plugins | List plugins with their state |
plg modules | List language modules with their state |
plg plugin <name> | Show details of a plugin |
plg module <name> | Show details of a language module |
plg health | Show the overall health of the system |
plg tree <name> | Show the dependency tree of a plugin or module |
plg search <query> | Search plugins and modules |
plg validate <path> | Check a manifest file |
plg compare <a> <b> | Compare two plugins or modules |
plg --version | Show the Plugify version |
load, unload and reload take effect on the next server frame. reload restarts all plugins and modules at once.
Lists
plg plugins and plg modules accept filters and sorting:
| Option | Meaning |
|---|---|
--filter-state <states> | Show only the given states, comma separated |
--filter-lang <languages> | Show only the given languages, comma separated |
-s, --sort <field> | Sort by name, version, state, language or loadtime |
-r, --reverse | Reverse the order |
-f, --failed | Show only the ones that failed to load |
Details
plg plugin, plg module, plg tree and plg compare take a name. Add -u to pass the numeric id from the list instead.
JSON output
The global flag -j, --json prints the result as JSON, which is handy for scripts and panels:
Packages: mamba
Plugins and language modules are distributed as conda packages. The server console has the mamba command (aliases conda and micromamba) that runs the bundled micromamba inside the Plugify folder.
Package operations run while Plugify is unloaded. Unload it first and load it back when you are done. Type the commands one by one, not as one pasted block: plg unload takes effect on the next server frame, so mamba typed in the same frame is refused:
Packages live in environments: modules for language modules and plugins for plugins. -n <environment> selects the one to work with.
| Command | What it does |
|---|---|
mamba list -n plugins | List installed packages |
mamba install -n plugins <package> | Install a package |
mamba update -n plugins <package> | Update a package |
mamba update -n plugins --all | Update everything in the environment |
mamba remove -n plugins <package> | Remove a package |
mamba search <package> | Find a package in the channels |
mamba create -n <name> | Create an environment of your own |
mamba activate <name> | Make an environment the current one, so -n can be left out |
The Plugify Source 2 build ships a .condarc that lists the channels of its components, so packages are installed by name. To install from another channel, pass it with -c: