akadmin/headroom
1
0
Fork 0
mirror of https://github.com/headroomlabs-ai/headroom.git synced 2026-08-27 14:17:10 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: add OpenClaw plugin to README, integration guide, index, and TS SDK docs

Browse source
This commit is contained in:
chopratejas 2026-03-29 00:02:05 -07:00
parent 8925be9b2b
commit 95f9e7a3e0
4 changed files with 40 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

3
README.md
View file

@ -7,7 +7,7 @@
Every tool call, DB query, file read, and RAG retrieval your agent makes is 70-95% boilerplate.<br>
Headroom compresses it away before it hits the model.<br><br>
Works with <b>any agent</b> — coding agents (Claude Code, Codex, Cursor, Aider), custom agents<br>
(LangChain, LangGraph, Agno, Strands), or your own Python and TypeScript code.
(LangChain, LangGraph, Agno, Strands, OpenClaw), or your own Python and TypeScript code.
</p>
</p>
@ -164,6 +164,7 @@ Gives your AI tool three MCP tools: `headroom_compress`, `headroom_retrieve`, `h
| **Any Python proxy** | ASGI Middleware | `app.add_middleware(CompressionMiddleware)` |
| **Agno agents** | Wrap model | `HeadroomAgnoModel(your_model)` |
| **LangChain** | Wrap model | `HeadroomChatModel(your_llm)` |
| **OpenClaw** | ContextEngine plugin | `openclaw plugins install headroom-openclaw` |
| **Claude Code** | Wrap | `headroom wrap claude` |
| **Codex / Aider** | Wrap | `headroom wrap codex` or `headroom wrap aider` |

14
docs/index.md
View file

@ -208,6 +208,20 @@ npm install headroom-ai
</div>
<div class="grid-item" markdown>
### OpenClaw
ContextEngine plugin for OpenClaw agents. Auto-compresses context in `assemble()`.
```bash
openclaw plugins install headroom-openclaw
```
[OpenClaw Plugin &rarr;](https://github.com/chopratejas/headroom/tree/main/plugins/openclaw)
</div>
</div>
[All integration patterns &rarr;](integration-guide.md){ .md-button }

20
docs/integration-guide.md
View file

@ -265,6 +265,26 @@ See the [TypeScript SDK Guide](typescript-sdk.md) for full documentation includi
---
## OpenClaw
Context compression plugin for [OpenClaw](https://github.com/openclaw/openclaw) agents.
```bash
pip install "headroom-ai[proxy]"
openclaw plugins install headroom-openclaw
```
Configure as context engine:
```json
{ "plugins": { "slots": { "contextEngine": "headroom" } } }
```
The plugin auto-detects a running Headroom proxy or starts one. Compression happens in `assemble()` — zero changes to the agent's behavior.
See the [OpenClaw plugin documentation](https://github.com/chopratejas/headroom/tree/main/plugins/openclaw) for full setup.
---
## Compression Hooks (Advanced)
Customize compression behavior without modifying Headroom's code:

4
docs/typescript-sdk.md
View file

@ -198,6 +198,10 @@ By default, `compress()` never blocks your app. If the proxy is unreachable:
The `headroom-ai` package has no runtime dependencies. Framework SDKs (Vercel AI, OpenAI, Anthropic) are optional peer dependencies — only install what you use.
## OpenClaw Plugin
The TypeScript SDK powers the [`headroom-openclaw`](https://www.npmjs.com/package/headroom-openclaw) plugin for [OpenClaw](https://github.com/openclaw/openclaw) agents. The plugin uses `HeadroomClient` internally to compress context during the `assemble()` lifecycle hook. Install it with `openclaw plugins install headroom-openclaw`. See the [plugin source](https://github.com/chopratejas/headroom/tree/main/plugins/openclaw) for details.
## Comparison with Python SDK
| Feature | Python SDK | TypeScript SDK |