liuyu/openclaw
1
0
Fork 0
mirror of https://github.com/openclaw/openclaw.git synced 2026-06-06 05:51:15 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(plugins): add external package readmes

Browse Source
This commit is contained in:
Peter Steinberger
2026-05-29 21:00:17 +01:00
parent 2b15850b47
commit b245cb2b6d
14 changed files with 351 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
extensions/acpx/README.md Normal file
View File

@@ -0,0 +1,33 @@
# @openclaw/acpx
Official ACP runtime backend for OpenClaw.
ACPx lets OpenClaw run external coding harnesses through the Agent Client Protocol while OpenClaw still owns sessions, channels, delivery, permissions, and Gateway state.
## Install
```bash
openclaw plugins install @openclaw/acpx
```
Restart the Gateway after installing or updating the plugin.
## What it provides
- ACP-backed agent runtime sessions.
- Plugin-owned session and transport management.
- MCP bridge helpers for OpenClaw tools and plugin tools.
- Static runtime assets used by the ACP process bridge.
## Configure
Use the ACP docs for harness-specific setup, permission modes, and model/runtime selection:
- https://docs.openclaw.ai/tools/acp-agents-setup
- https://docs.openclaw.ai/tools/acp-agents
## Package
- Plugin id: `acpx`
- Package: `@openclaw/acpx`
- Minimum OpenClaw host: `2026.4.25`

36
extensions/brave/README.md Normal file
View File

@@ -0,0 +1,36 @@
# @openclaw/brave-plugin
Official Brave Search provider plugin for OpenClaw.
This plugin registers Brave as a `web_search` provider. It supports normal Brave web search and Brave LLM Context API mode.
## Install
```bash
openclaw plugins install @openclaw/brave-plugin
```
Restart the Gateway after installing or updating the plugin.
## Configure
Store a Brave Search API key in plugin config or expose `BRAVE_API_KEY` to the Gateway:
```bash
openclaw config set plugins.entries.brave.enabled true
openclaw config set tools.web.search.provider brave
```
Provider-specific options live under `plugins.entries.brave.config.webSearch.*`.
## Docs
Full setup, config examples, search modes, and tool parameters:
- https://docs.openclaw.ai/tools/brave-search
## Package
- Plugin id: `brave`
- Package: `@openclaw/brave-plugin`
- Minimum OpenClaw host: `2026.4.10`

17
extensions/copilot/README.md
View File

@@ -1,7 +1,14 @@
# GitHub Copilot agent runtime (OpenClaw plugin)
Bundled OpenClaw plugin that registers a `copilot` agent harness backed
by `@github/copilot-sdk` and the GitHub Copilot CLI.
External OpenClaw plugin that registers a `copilot` agent harness backed by `@github/copilot-sdk` and the GitHub Copilot CLI.
## Install
```bash
openclaw plugins install @openclaw/copilot
```
Restart the Gateway after installing or updating the plugin.
The harness claims the canonical subscription `github-copilot` provider and
is opt-in only — selection requires explicit `agentRuntime.id: "copilot"`
@@ -13,3 +20,9 @@ configuration, doctor probes, transcript mirroring, compaction, side
questions, replay, and the supported-surface contract.
See [qa/copilot-capabilities.md](../../qa/copilot-capabilities.md)
for the SDK capability inventory the harness is pinned to.
## Package
- Plugin id: `copilot`
- Package: `@openclaw/copilot`
- Minimum OpenClaw host: `2026.5.28`

27
extensions/diagnostics-otel/README.md Normal file
View File

@@ -0,0 +1,27 @@
# @openclaw/diagnostics-otel
Official OpenTelemetry diagnostics exporter for OpenClaw.
This plugin exports OpenClaw Gateway traces, metrics, and logs to an OTLP collector for observability stacks such as Grafana, Datadog, Honeycomb, New Relic, Tempo, and compatible collectors.
## Install
```bash
openclaw plugins install @openclaw/diagnostics-otel
```
Restart the Gateway after installing or updating the plugin.
## Configure
Enable the plugin and set the OTLP endpoint in `plugins.entries.diagnostics-otel.config`.
The full config surface, metric names, span names, and collector examples live in the docs:
- https://docs.openclaw.ai/gateway/opentelemetry
## Package
- Plugin id: `diagnostics-otel`
- Package: `@openclaw/diagnostics-otel`
- Minimum OpenClaw host: `2026.4.25`

27
extensions/diagnostics-prometheus/README.md Normal file
View File

@@ -0,0 +1,27 @@
# @openclaw/diagnostics-prometheus
Official Prometheus diagnostics exporter for OpenClaw.
This plugin exposes OpenClaw Gateway runtime metrics in Prometheus text format for Prometheus, Grafana, VictoriaMetrics, and compatible scrapers.
## Install
```bash
openclaw plugins install @openclaw/diagnostics-prometheus
```
Restart the Gateway after installing or updating the plugin.
## Configure
Enable the plugin and set the scrape endpoint options in `plugins.entries.diagnostics-prometheus.config`.
The full config surface, metric names, and scrape examples live in the docs:
- https://docs.openclaw.ai/gateway/prometheus
## Package
- Plugin id: `diagnostics-prometheus`
- Package: `@openclaw/diagnostics-prometheus`
- Minimum OpenClaw host: `2026.4.25`

28
extensions/diffs-language-pack/README.md Normal file
View File

@@ -0,0 +1,28 @@
# @openclaw/diffs-language-pack
Official extended syntax highlighting pack for the OpenClaw Diffs plugin.
The base `@openclaw/diffs` plugin ships a curated language set. Install this package when you want the full Shiki language catalog available in rendered diff viewers and diff image/PDF output.
## Install
```bash
openclaw plugins install @openclaw/diffs-language-pack
```
Restart the Gateway after installing or updating the plugin.
## Use with Diffs
Install `@openclaw/diffs` first, then install this language pack. The language pack contributes static viewer assets; it does not register a separate agent tool.
## Docs
- https://docs.openclaw.ai/tools/diffs
- https://docs.openclaw.ai/plugins/reference/diffs-language-pack
## Package
- Plugin id: `diffs-language-pack`
- Package: `@openclaw/diffs-language-pack`
- Minimum OpenClaw host: `2026.5.27`

18
extensions/diffs/README.md
View File

@@ -2,6 +2,14 @@
Read-only diff viewer plugin for **OpenClaw** agents.
## Install
```bash
openclaw plugins install @openclaw/diffs
```
Restart the Gateway after installing or updating the plugin.
It gives agents one tool, `diffs`, that can:
- render a gateway-hosted diff viewer for canvas use
@@ -118,6 +126,16 @@ Set plugin-wide defaults in `~/.openclaw/openclaw.json`:
Explicit tool parameters still win over these defaults.
## Docs
- https://docs.openclaw.ai/tools/diffs
## Package
- Plugin id: `diffs`
- Package: `@openclaw/diffs`
- Minimum OpenClaw host: `2026.4.30`
Security options:
- `security.allowRemoteViewer` (default `false`): allows non-loopback access to `/plugins/diffs/view/...` token URLs

26
extensions/google-meet/README.md Normal file
View File

@@ -0,0 +1,26 @@
# @openclaw/google-meet
Official Google Meet participant plugin for OpenClaw.
This plugin registers the `google_meet` tool so agents can join Google Meet calls through supported Chrome or Twilio transports.
## Install
```bash
openclaw plugins install @openclaw/google-meet
```
Restart the Gateway after installing or updating the plugin.
## Configure
Enable the plugin and follow the Google Meet docs for browser profile, transport, and call-join setup:
- https://docs.openclaw.ai/plugins/google-meet
## Package
- Plugin id: `google-meet`
- Tool: `google_meet`
- Package: `@openclaw/google-meet`
- Minimum OpenClaw host: `2026.4.20`

19
extensions/lobster/README.md
View File

@@ -2,6 +2,14 @@
Adds the `lobster` agent tool as an **optional** plugin tool.
## Install
```bash
openclaw plugins install @openclaw/lobster
```
Restart the Gateway after installing or updating the plugin.
## What this is
- Lobster is a standalone workflow shell (typed JSON-first pipelines + approvals/resume).
@@ -72,3 +80,14 @@ Notes:
- Runs Lobster in process via the published `@clawdbot/lobster/core` runtime.
- Does not manage OAuth/tokens.
- Uses timeouts, stdout caps, and strict JSON envelope parsing.
## Docs
- https://docs.openclaw.ai/tools/lobster
## Package
- Plugin id: `lobster`
- Tool: `lobster`
- Package: `@openclaw/lobster`
- Minimum OpenClaw host: `2026.4.25`

32
extensions/memory-lancedb/README.md Normal file
View File

@@ -0,0 +1,32 @@
# @openclaw/memory-lancedb
Official LanceDB-backed long-term memory plugin for OpenClaw.
This plugin adds persistent memory tools backed by LanceDB, vector search, auto-recall, and auto-capture.
## Install
```bash
openclaw plugins install @openclaw/memory-lancedb
```
Restart the Gateway after installing or updating the plugin.
## What it provides
- `memory_store`
- `memory_recall`
- `memory_forget`
- LanceDB vector storage and hybrid memory retrieval.
## Configure
Use the memory plugin docs for embedding provider setup, storage paths, indexing, and recall behavior:
- https://docs.openclaw.ai/plugins/memory-lancedb
## Package
- Plugin id: `memory-lancedb`
- Package: `@openclaw/memory-lancedb`
- Minimum OpenClaw host: `2026.4.10`

25
extensions/openshell/README.md Normal file
View File

@@ -0,0 +1,25 @@
# @openclaw/openshell-sandbox
Official NVIDIA OpenShell sandbox backend for OpenClaw.
This plugin lets OpenClaw use OpenShell-managed sandboxes with mirrored local workspaces and SSH command execution.
## Install
```bash
openclaw plugins install @openclaw/openshell-sandbox
```
Restart the Gateway after installing or updating the plugin.
## Configure
Use the OpenShell docs for credentials, workspace mirroring, runtime selection, and troubleshooting:
- https://docs.openclaw.ai/gateway/openshell
## Package
- Plugin id: `openshell`
- Package: `@openclaw/openshell-sandbox`
- Minimum OpenClaw host: `2026.5.12-beta.1`

27
extensions/pixverse/README.md Normal file
View File

@@ -0,0 +1,27 @@
# @openclaw/pixverse-provider
Official PixVerse video generation provider plugin for OpenClaw.
This plugin registers PixVerse as a `video_generate` provider for text-to-video and image-to-video workflows.
## Install
```bash
openclaw plugins install @openclaw/pixverse-provider
```
Restart the Gateway after installing or updating the plugin.
## Configure
Store your PixVerse API key in OpenClaw config or expose the supported environment variable to the Gateway. Then select PixVerse as a video generation provider.
Full setup and model/provider examples:
- https://docs.openclaw.ai/providers/pixverse
## Package
- Plugin id: `pixverse`
- Package: `@openclaw/pixverse-provider`
- Minimum OpenClaw host: `2026.5.26`

35
extensions/tokenjuice/README.md Normal file
View File

@@ -0,0 +1,35 @@
# @openclaw/tokenjuice
Official Tokenjuice output compaction plugin for OpenClaw.
Tokenjuice compacts noisy `exec` and `bash` tool results after commands run, before the result is fed back into the active agent session. It does not rewrite commands, rerun commands, or change exit codes.
## Install
```bash
openclaw plugins install @openclaw/tokenjuice
```
Restart the Gateway after installing or updating the plugin.
## Enable
```bash
openclaw config set plugins.entries.tokenjuice.enabled true
```
Equivalent:
```bash
openclaw plugins enable tokenjuice
```
## Docs
- https://docs.openclaw.ai/tools/tokenjuice
## Package
- Plugin id: `tokenjuice`
- Package: `@openclaw/tokenjuice`
- Minimum OpenClaw host: `2026.5.28`

8
extensions/voice-call/README.md
View File

@@ -10,11 +10,9 @@ Providers:
- **Mock** (dev/no network)
Docs: `https://docs.openclaw.ai/plugins/voice-call`
Plugin system: `https://docs.openclaw.ai/plugin`
Plugin system: `https://docs.openclaw.ai/tools/plugin`
## Install (local dev)
### Option A: install via OpenClaw (recommended)
## Install
```bash
openclaw plugins install @openclaw/voice-call
@@ -22,7 +20,7 @@ openclaw plugins install @openclaw/voice-call
Restart the Gateway afterwards.
### Option B: copy into your global extensions folder (dev)
## Local dev install
```bash
PLUGIN_HOME=~/.openclaw/extensions