Skip to main content

Installing Plugins

PracticalKit supports installing plugins from external sources.

Adding a plugin​

  1. Build your plugin (or obtain a built plugin folder)
  2. Open PracticalKit
  3. Go to Plugins > Add Plugin... in the menu bar
  4. Navigate to the plugin's folder and select the manifest.json file
  5. Click Open
  6. Restart PracticalKit when prompted

The plugin will be loaded on every subsequent launch.

Plugin requirements​

For a plugin to be installable, it must have:

  • A valid manifest.json file
  • All referenced files (HTML, JS, CSS) in the same directory
  • The manifest path must be an absolute path on your filesystem

Development workflow​

During development, you can install your plugin directly from its dist/ folder:

# Build your plugin
pnpm build

# This creates:
# dist/
#   manifest.json
#   index.html
#   assets/
#     index-xxx.js
#     index-xxx.css

Then add it via Plugins > Add Plugin... and select dist/manifest.json.

Hot reload during development

Run pnpm dev in your plugin folder for hot reload. After adding the plugin once, changes will appear on browser refresh (Cmd+R / Ctrl+R in PracticalKit).

Managing plugins​

Go to Plugins > Manage Plugins... to see all installed plugins.

From here you can:

  • See the plugin's manifest path
  • Remove external plugins (built-in plugins cannot be removed)

Removing a plugin​

  1. Go to Plugins > Manage Plugins...
  2. Find the plugin you want to remove
  3. Click the Remove button
  4. Restart PracticalKit
note

Only external plugins (ones you added via "Add Plugin...") can be removed. Built-in plugins are part of the PracticalKit installation.