mirror of
https://github.com/clawdbot/clawdbot.git
synced 2026-01-31 19:37:45 +01:00
docs: expand plugin quickstart
This commit is contained in:
@@ -6,6 +6,33 @@ read_when:
|
|||||||
---
|
---
|
||||||
# Plugins (Extensions)
|
# Plugins (Extensions)
|
||||||
|
|
||||||
|
## Quick start (new to plugins?)
|
||||||
|
|
||||||
|
A plugin is just a **small code module** that extends Clawdbot with extra
|
||||||
|
features (commands, tools, and Gateway RPC).
|
||||||
|
|
||||||
|
Most of the time, you’ll use plugins when you want a feature that’s not built
|
||||||
|
into core Clawdbot yet (or you want to keep optional features out of your main
|
||||||
|
install).
|
||||||
|
|
||||||
|
Fast path:
|
||||||
|
|
||||||
|
1) See what’s already loaded:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
clawdbot plugins list
|
||||||
|
```
|
||||||
|
|
||||||
|
2) Install an official plugin (example: Voice Call):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
clawdbot plugins install @clawdbot/voice-call
|
||||||
|
```
|
||||||
|
|
||||||
|
3) Restart the Gateway, then configure under `plugins.entries.<id>.config`.
|
||||||
|
|
||||||
|
See [Voice Call](/plugins/voice-call) for a concrete example plugin.
|
||||||
|
|
||||||
Clawdbot plugins are **TypeScript modules** loaded at runtime via jiti. They can
|
Clawdbot plugins are **TypeScript modules** loaded at runtime via jiti. They can
|
||||||
register:
|
register:
|
||||||
|
|
||||||
|
|||||||
@@ -9,11 +9,18 @@ read_when:
|
|||||||
|
|
||||||
Outbound voice calls for Clawdbot via a plugin.
|
Outbound voice calls for Clawdbot via a plugin.
|
||||||
|
|
||||||
|
If you’re new to plugins, start with [Plugins](/plugin): what they are, where
|
||||||
|
they live on disk, and how install/config works.
|
||||||
|
|
||||||
Current providers:
|
Current providers:
|
||||||
- `twilio` (real calls)
|
- `twilio` (real calls)
|
||||||
- `log` (dev fallback; no network)
|
- `log` (dev fallback; no network)
|
||||||
|
|
||||||
If you haven’t read the general plugin docs yet, start with [Plugins](/plugin).
|
Quick mental model:
|
||||||
|
- Install plugin
|
||||||
|
- Restart Gateway
|
||||||
|
- Configure under `plugins.entries.voice-call.config`
|
||||||
|
- Use `clawdbot voicecall …` or the `voice_call` tool
|
||||||
|
|
||||||
## Install
|
## Install
|
||||||
|
|
||||||
@@ -27,7 +34,25 @@ This downloads the package, extracts it into `~/.clawdbot/extensions/`, and enab
|
|||||||
|
|
||||||
Restart the Gateway afterwards.
|
Restart the Gateway afterwards.
|
||||||
|
|
||||||
### Option B: install from a local folder (dev)
|
### Option B: install from a local folder (dev, no copying)
|
||||||
|
|
||||||
|
This keeps the plugin in-place (great for iterating locally) and adds the folder
|
||||||
|
to `plugins.load.paths`.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
clawdbot plugins install /absolute/path/to/voice-call
|
||||||
|
```
|
||||||
|
|
||||||
|
If your plugin has dependencies, install them in that folder (so it has a
|
||||||
|
`node_modules`):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd /absolute/path/to/voice-call && pnpm install
|
||||||
|
```
|
||||||
|
|
||||||
|
Restart the Gateway afterwards.
|
||||||
|
|
||||||
|
### Option C: copy into the global extensions folder (dev)
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
mkdir -p ~/.clawdbot/extensions
|
mkdir -p ~/.clawdbot/extensions
|
||||||
|
|||||||
@@ -6,6 +6,7 @@ Official Voice Call plugin for **Clawdbot**.
|
|||||||
- Dev fallback: `log` (no network)
|
- Dev fallback: `log` (no network)
|
||||||
|
|
||||||
Docs: `https://docs.clawd.bot/plugins/voice-call`
|
Docs: `https://docs.clawd.bot/plugins/voice-call`
|
||||||
|
Plugin system: `https://docs.clawd.bot/plugin`
|
||||||
|
|
||||||
## Install (local dev)
|
## Install (local dev)
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user