Skip to main content

Plugins

Rostyman supports a plugin system for extending functionality. Install community plugins or develop your own.

Plugin Manager​

Open the Plugin Manager from the sidebar (or + New Tab → Plugin Manager). The manager shows:

  • Installed — plugins currently active in your workspace
  • Available — plugins you can install (marketplace, coming soon)

Installing Plugins​

From File​

  1. Open the Plugin Manager
  2. Click Install from File
  3. Select a plugin package (.zip or folder)
  4. The plugin loads and appears in the Installed list

Dev Mode​

For plugin development, use Dev Mode to load a plugin from a local folder with live reload:

  1. Click Load Dev Plugin
  2. Select your plugin's root folder
  3. The plugin loads immediately
  4. File changes in the watched folder trigger automatic reload — no restart needed

Uninstalling Plugins​

Click Uninstall on any installed plugin. The plugin is removed and its effects are reverted immediately.

Plugin Structure​

A minimal plugin contains:

my-plugin/
├── package.json
└── index.js

The package.json must include:

{
  "name": "my-plugin",
  "version": "1.0.0",
  "main": "index.js",
  "rostyman": {
    "displayName": "My Plugin",
    "description": "What this plugin does"
  }
}

The entry point (index.js) exports an activate function:

module.exports = {
  activate(context) {
    // context provides APIs for interacting with Rostyman
    console.log('Plugin activated');
  },
  deactivate() {
    // cleanup when plugin is uninstalled or app closes
  }
};

Plugin Marketplace​

A community plugin marketplace is planned for a future release. It will allow browsing, searching, and one-click installation of plugins shared by the community.

Tips​

  • Use Dev Mode during development for the fastest iteration cycle
  • Plugins run in a sandboxed context — they cannot access the filesystem directly
  • Check the plugin's package.json for compatibility with your Rostyman version