Skip to content

Commit 7f1d067

Browse files
authored
docs: update README to reflect OpenClaw/Hermes Agent (#107)
1 parent c132f00 commit 7f1d067

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

‎README.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
![ClawShell Banner](docs/images/banner.png)
44

5-
> **Powered by Runta. The essential safety harness for OpenClaw's PII & Sensitive Credentials.**
5+
> **Powered by Runta. The essential safety harness for OpenClaw/Hermes Agent's PII & Sensitive Credentials.**
66
77
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
88
[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/clawshell/clawshell/rust.yml)](https://github.com/clawshell/clawshell/actions)
@@ -12,33 +12,33 @@
1212

1313
## 📖 Introduction
1414

15-
**ClawShell** is a security-privileged process for the **OpenClaw** ecosystem. It sits between OpenClaw and upstream LLM API providers (OpenAI, Anthropic, OpenRouter), performing virtual-to-real API key mapping and DLP (Data Loss Prevention) scanning on request and response bodies. It can also expose an Email read endpoint with sender allowlist/denylist filtering.
15+
**ClawShell** is a security-privileged process for the **OpenClaw/Hermes Agent** ecosystem. It sits between OpenClaw/Hermes Agent and upstream LLM API providers (OpenAI, Anthropic, OpenRouter), performing virtual-to-real API key mapping and DLP (Data Loss Prevention) scanning on request and response bodies. It can also expose an Email read endpoint with sender allowlist/denylist filtering.
1616

17-
OpenClaw never holds real API keys, only virtual keys that ClawShell swaps for real ones before forwarding requests upstream. Real keys are stored in a privileged config directory (`/etc/clawshell`) protected by Unix file system permissions.
17+
OpenClaw/Hermes Agent never holds real API keys, only virtual keys that ClawShell swaps for real ones before forwarding requests upstream. Real keys are stored in a privileged config directory (`/etc/clawshell`) protected by Unix file system permissions.
1818

1919
## Key Features
2020

2121
### 1. API Token Secure Binding
2222

23-
ClawShell maps virtual API keys to real provider keys so that OpenClaw never has direct access to real credentials.
23+
ClawShell maps virtual API keys to real provider keys so that OpenClaw/Hermes Agent never has direct access to real credentials.
2424

25-
- **Key Isolation**: Real API keys are stored in `/etc/clawshell/clawshell.toml`, readable only by the `clawshell` system user. OpenClaw holds only virtual keys.
25+
- **Key Isolation**: Real API keys are stored in `/etc/clawshell/clawshell.toml`, readable only by the `clawshell` system user. OpenClaw/Hermes Agent holds only virtual keys.
2626
- **Multi-Provider Support**: Maps keys to OpenAI or Anthropic, injecting the correct authentication header format (`Authorization: Bearer` for OpenAI, `x-api-key` for Anthropic).
2727

2828
### 2. PII Safety Net (DLP)
2929

3030
ClawShell scans HTTP request and response bodies for sensitive data using configurable regex patterns.
3131

3232
- **Request Scanning**: Detects PII (SSNs, credit card numbers, emails, etc.) in outbound requests. Patterns can be configured to either block the request or redact the matched text before forwarding.
33-
- **Response Scanning**: Optionally scans upstream responses and redacts detected PII before returning to OpenClaw. Streaming (SSE) responses are passed through without scanning.
33+
- **Response Scanning**: Optionally scans upstream responses and redacts detected PII before returning to OpenClaw/Hermes Agent. Streaming (SSE) responses are passed through without scanning.
3434
- **Custom Patterns**: Define sensitive data patterns using regex in the TOML config, each with a `block` or `redact` action.
3535

3636
### 3. Sensitive Email Isolation
3737

3838
ClawShell supports sender-based email filtering so each virtual key only sees mailbox content based on sender rules.
3939

4040
- **Sender Filtering**: Filter emails by sender.
41-
- **Key Isolation**: IMAP credentials are stored in `/etc/clawshell/clawshell.toml`, readable only by the `clawshell` system user. OpenClaw holds only virtual keys.
41+
- **Key Isolation**: IMAP credentials are stored in `/etc/clawshell/clawshell.toml`, readable only by the `clawshell` system user. OpenClaw/Hermes Agent holds only virtual keys.
4242
- **Provider Support**: Built-in Gmail and Outlook presets, with manual IMAP setup for other providers.
4343

4444
### 4. OAuth Authentication (Codex / ChatGPT)
@@ -84,8 +84,8 @@ ClawShell exposes running counters at `GET /admin/stats` so operators can audit
8484
║ ┌──────────┴────────────────┐
8585
┌──────────────┐ REQUEST ║ │ │ REQUEST ┌────────────┐
8686
│ ├──(virtual───╫─►│ ClawShell ├──-(real key,───►│ │
87-
│ OpenClaw │ key) ║ │ │ PII redacted) │ OpenAI / │
88-
│ │ ║ │ DLP scan │ │ Anthropic/ │
87+
│ OpenClaw or │ key) ║ │ │ PII redacted) │ OpenAI / │
88+
│ Hermes Agent │ ║ │ DLP scan │ │ Anthropic/ │
8989
│ holds only │ RESPONSE ║ │ real-key mapping │ RESPONSE │ OpenRouter │
9090
│ virtual keys │◄────────────║◄─┤ email sender filtering │◄────────────────┤ │
9191
│ │ ║ │ │ └────────────┘
@@ -100,7 +100,7 @@ ClawShell exposes running counters at `GET /admin/stats` so operators can audit
100100
║ └───────────────────────────┘
101101
```
102102

103-
OpenClaw only holds virtual keys and cannot access the real API keys stored in the privileged config.
103+
OpenClaw/Hermes Agent only holds virtual keys and cannot access the real API keys stored in the privileged config.
104104

105105
ClawShell swaps virtual keys for real ones and scans for PII before forwarding requests upstream.
106106

0 commit comments

Comments
 (0)