Creating Plugins

Create a Plugin

Create the directory

mkdir packages/plugins/my-plugin

Define plugin.json

{
  "name": "my-plugin",
  "displayName": "My Plugin",
  "description": "What this plugin does",
  "version": "1.0.0",
  "author": "Your Name",
  "icon": "./icon.svg",
  "inputSchema": {
    "type": "object",
    "properties": {
      "title": { "type": "string" },
      "url": { "type": "string" }
    },
    "required": ["title"]
  },
  "permissions": {
    "httpRequests": true,
    "maxHttpDomains": ["api.example.com"]
  },
  "env": [
    {
      "key": "API_KEY",
      "label": "API Key",
      "required": true,
      "secret": true,
      "description": "Your API key for the external service."
    }
  ]
}

Create render.html

<!DOCTYPE html>
<html>
  <head>
    <style>
      body {
        font-family: sans-serif;
        padding: 16px;
        color: #1a1a19;
        background: transparent;
      }
      body.dark { color: #e5e5e4; }
    </style>
  </head>
  <body>
    <div id="app">
      <h3 id="title"></h3>
      <p id="info"></p>
    </div>
    <script>
      document.addEventListener('DOMContentLoaded', function () {
        if (Placet.theme === 'dark') document.body.classList.add('dark');
        document.getElementById('title').textContent = Placet.data.title;
        document.getElementById('info').textContent = Placet.data.url || 'No URL';
        Placet.resize();
      });
    </script>
  </body>
</html>

Optionally add an icon

Place an icon.svg (or .png) in the plugin directory and reference it in plugin.json:

{ "icon": "./icon.svg" }

Restart the backend

make stop && make start

The plugin is automatically discovered and available.

Configure env values

Go to Settings → Plugins, expand your plugin, fill in the environment variables, and click Save.

Manifest Reference

Top-Level Fields

Field	Required	Description
`name`	Yes	Unique plugin identifier (kebab-case)
`displayName`	Yes	Human-readable name
`version`	Yes	Semver version
`description`	No	Short description
`author`	No	Author name
`icon`	No	Relative file path (`./icon.svg`) or Lucide icon name
`inputSchema`	No	JSON Schema for the plugin’s input data
`permissions.httpRequests`	No	Whether the plugin can make HTTP requests
`permissions.maxHttpDomains`	No	Allowed domains for HTTP requests (`["*"]` = any)
`env`	No	Array of environment variable definitions

Environment Variables

Each entry in the env array:

Field	Required	Description
`key`	Yes	Variable name (e.g. `API_KEY`)
`label`	Yes	Human-readable label for the Settings UI
`required`	No	Whether this variable must be set
`default`	No	Default value
`secret`	No	If `true`, rendered as a password field
`description`	No	Help text shown below the input

Env values are configured per-plugin in Settings → Plugins and stored in the database, version-coupled. Plugins access them at runtime via Placet.env.

Validate a Plugin

Use the included validation script:

npx ts-node scripts/validate-plugin.ts packages/plugins/my-plugin

Getting Started

Core Concepts

Connections

Examples

Plugins

Creating Plugins

Create a Plugin

Manifest Reference

Top-Level Fields

Environment Variables

Validate a Plugin

​Create a Plugin

​Manifest Reference

​Top-Level Fields

​Environment Variables

​Validate a Plugin

Create a Plugin

Manifest Reference

Top-Level Fields

Environment Variables

Validate a Plugin