> ## Documentation Index
> Fetch the complete documentation index at: https://docs.placet.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Creating Plugins
> Step-by-step guide to building a Placet plugin.
## Create a Plugin
```bash theme={null}
mkdir packages/plugins/my-plugin
```
```json theme={null}
{
"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."
}
]
}
```
```html theme={null}
```
Place an `icon.svg` (or `.png`) in the plugin directory and reference it in `plugin.json`:
```json theme={null}
{ "icon": "./icon.svg" }
```
```bash theme={null}
make stop && make start
```
The plugin is automatically discovered and available.
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:
```bash theme={null}
npx ts-node scripts/validate-plugin.ts packages/plugins/my-plugin
```