agent-zero/plugins/_plugin_installer
Alessandro 6d395ddeba Add channel plugin discovery to the welcome screen
Add a puzzle-icon "Find channels plugins" text button below the channel
buttons, reusing the welcome footer styling. Open Plugin Hub Browse with
the channels tag selected and any previous search cleared. Keep the
Channels filter visible even when no plugins have the tag.

Update the owning docs and regression coverage. Verified with 21 focused
tests and live browser checks for navigation, search reset, mobile layout,
and keyboard focus.
2026-11-01 00:19:17 +01:00
..
api Remove force parameter from plugin index fetch in API handler 2026-03-27 10:26:50 +01:00
extensions/webui Unify WebUI icons and fix message collapsing 2026-07-31 13:32:41 +00:00
helpers Preserve repository thumbnails during plugin installation 2026-09-16 00:43:54 +02:00
webui Add channel plugin discovery to the welcome screen 2026-11-01 00:19:17 +01:00
AGENTS.md Add channel plugin discovery to the welcome screen 2026-11-01 00:19:17 +01:00
plugin.yaml refactor - plugin names and builtin plugins 2026-03-10 22:20:53 +01:00
README.md Rebase local plugin commits during updates 2026-09-16 00:44:04 +02:00

Plugin Installer

Install and update Agent Zero plugins from ZIP uploads, Git repositories, or the community Plugin Index surfaced through the Plugin Hub.

What It Does

This plugin provides the built-in installation workflow for third-party plugins. It validates plugin manifests, prevents naming conflicts, installs plugins into usr/plugins/, optionally updates Git-based plugins, and exposes a UI for browsing and installing community plugins.

Main Behavior

  • ZIP install
    • Accepts an uploaded archive, extracts it safely, locates plugin.yaml, validates metadata, and moves the plugin into usr/plugins/.
  • Git install
    • Clones a repository to a temporary directory, validates the plugin, then installs it into usr/plugins/.
    • Preserves the plugin's thumbnail and downloads a fallback only when none exists. Repository-provided thumbnails update with the plugin through Git.
  • Plugin update
    • Updates installed Git-backed custom plugins by rebasing local commits onto upstream, then re-runs installation hooks.
    • If local commits or edits conflict, restores the original checkout and shows the conflicting files in the error toast and plugin details.
  • Safety checks
    • Rejects archives with unsafe paths.
    • Rejects missing or invalid plugin.yaml files.
    • Rejects plugin name conflicts.
  • Install hooks and refresh
    • Runs the plugin install hook when present and calls after_plugin_change(...) so the app refreshes plugin state.
  • Plugin Hub UI
    • The web UI store handles browsing Plugin Index entries, showing README content, prompting about third-party plugin risk, and launching install/update actions.

Key Files

  • API
    • api/plugin_install.py dispatches install, update, and index fetch actions.
  • Installer logic
    • helpers/install.py contains archive extraction, Git install, update, validation, and hook execution.
  • Frontend
    • webui/pluginInstallStore.js manages the installer modal state and community index interactions.

Configuration Scope

  • Settings sections: none
  • Always enabled: true

Plugin Metadata

  • Name: _plugin_installer
  • Title: Plugin Installer
  • Description: Install plugins from ZIP files, Git repositories, or the community index.