tao-shen Claude Opus 4.6 commited on
Commit
0d0d458
·
1 Parent(s): 0b2ec75

docs: update README with safety rationale, A2A protocol, HuggingClaw World section

Browse files

- Add 'safe' and 'a2a' tags, GitHub + HF Space badges
- Add safety point: cloud isolation vs local full-privilege risk
- Add HuggingClaw World section with Adam & Eve agent links (HF + GitHub)
- Add Office screenshot with live pixel-art characters
- Add A2A protocol section referencing openclaw-a2a-gateway
- Update Security section with environment isolation point

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Files changed (2) hide show
  1. README.md +45 -4
  2. assets/office-preview.png +3 -0
README.md CHANGED
@@ -32,20 +32,23 @@ tags:
32
  - one-click-deploy
33
  - self-hosted
34
  - messaging-bot
 
 
35
  ---
36
 
37
  <div align="center">
38
  <img src="HuggingClaw.png" alt="HuggingClaw" width="720"/>
39
  <br/><br/>
40
- <strong>Your always-on AI assistant — free, no server needed</strong>
41
  <br/>
42
  <sub>WhatsApp · Telegram · 40+ channels · 16 GB RAM · One-click deploy · Auto-persistent</sub>
43
  <br/><br/>
44
 
45
  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
46
- [![Hugging Face](https://img.shields.io/badge/🤗-Hugging%20Face-yellow)](https://huggingface.co)
47
- [![HF Spaces](https://img.shields.io/badge/Spaces-HuggingFace-blue)](https://huggingface.co/spaces/tao-shen/HuggingClaw)
48
  [![OpenClaw](https://img.shields.io/badge/OpenClaw-Powered-orange)](https://github.com/openclaw/openclaw)
 
49
  [![Docker](https://img.shields.io/badge/Docker-Ready-2496ED?logo=docker)](https://www.docker.com/)
50
  [![OpenAI Compatible](https://img.shields.io/badge/OpenAI--compatible-API-green)](https://openclawdoc.com/docs/reference/environment-variables)
51
  [![WhatsApp](https://img.shields.io/badge/WhatsApp-Enabled-25D366?logo=whatsapp)](https://www.whatsapp.com/)
@@ -57,7 +60,7 @@ tags:
57
 
58
  ## What you get
59
 
60
- In about 5 minutes, youll have a **free, always-on AI assistant** connected to WhatsApp, Telegram, and 40+ other channels — no server, no subscription, no hardware required.
61
 
62
  | | |
63
  |---|---|
@@ -66,6 +69,7 @@ In about 5 minutes, you’ll have a **free, always-on AI assistant** connected t
66
  | **WhatsApp & Telegram** | Works reliably, including channels that HF Spaces normally blocks |
67
  | **Any LLM** | OpenAI, Claude, Gemini, OpenRouter (200+ models, free tier available), or your own Ollama |
68
  | **One-click deploy** | Duplicate the Space, set two secrets, done |
 
69
 
70
  > **Powered by [OpenClaw](https://github.com/openclaw/openclaw)** — an open-source AI assistant that normally requires your own machine (e.g. a Mac Mini). HuggingClaw makes it run for free on HuggingFace Spaces by solving two Spaces limitations: data loss on restart (fixed via HF Dataset sync) and DNS failures for some domains like WhatsApp (fixed via DNS-over-HTTPS).
71
 
@@ -75,6 +79,42 @@ In about 5 minutes, you’ll have a **free, always-on AI assistant** connected t
75
  <img src="assets/architecture.svg" alt="Architecture" width="720"/>
76
  </div>
77
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
78
  ## Quick Start
79
 
80
  ### 1. Duplicate this Space
@@ -153,6 +193,7 @@ HuggingClaw adds its own variables for persistence and deployment: `HF_TOKEN`, `
153
 
154
  ## Security
155
 
 
156
  - **Token authentication** — Control UI requires a gateway token to connect (default: `huggingclaw`, customizable via `GATEWAY_TOKEN`)
157
  - **Secrets stay server-side** — API keys and tokens are never exposed to the browser
158
  - **Private backups** — the Dataset repo is created as private by default
 
32
  - one-click-deploy
33
  - self-hosted
34
  - messaging-bot
35
+ - safe
36
+ - a2a
37
  ---
38
 
39
  <div align="center">
40
  <img src="HuggingClaw.png" alt="HuggingClaw" width="720"/>
41
  <br/><br/>
42
+ <strong>Your always-on AI assistant — free, safe, no server needed</strong>
43
  <br/>
44
  <sub>WhatsApp · Telegram · 40+ channels · 16 GB RAM · One-click deploy · Auto-persistent</sub>
45
  <br/><br/>
46
 
47
  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
48
+ [![Hugging Face](https://img.shields.io/badge/🤗-HF%20Space-yellow)](https://huggingface.co/spaces/tao-shen/HuggingClaw)
49
+ [![GitHub](https://img.shields.io/badge/GitHub-Repository-181717?logo=github)](https://github.com/tao-shen/HuggingClaw)
50
  [![OpenClaw](https://img.shields.io/badge/OpenClaw-Powered-orange)](https://github.com/openclaw/openclaw)
51
+ [![A2A Protocol](https://img.shields.io/badge/A2A-v0.3.0-purple)](https://github.com/win4r/openclaw-a2a-gateway)
52
  [![Docker](https://img.shields.io/badge/Docker-Ready-2496ED?logo=docker)](https://www.docker.com/)
53
  [![OpenAI Compatible](https://img.shields.io/badge/OpenAI--compatible-API-green)](https://openclawdoc.com/docs/reference/environment-variables)
54
  [![WhatsApp](https://img.shields.io/badge/WhatsApp-Enabled-25D366?logo=whatsapp)](https://www.whatsapp.com/)
 
60
 
61
  ## What you get
62
 
63
+ In about 5 minutes, you'll have a **free, always-on AI assistant** connected to WhatsApp, Telegram, and 40+ other channels — no server, no subscription, no hardware required.
64
 
65
  | | |
66
  |---|---|
 
69
  | **WhatsApp & Telegram** | Works reliably, including channels that HF Spaces normally blocks |
70
  | **Any LLM** | OpenAI, Claude, Gemini, OpenRouter (200+ models, free tier available), or your own Ollama |
71
  | **One-click deploy** | Duplicate the Space, set two secrets, done |
72
+ | **Safe** | Running locally gives OpenClaw full system privileges — deploying in an isolated cloud container is inherently more secure |
73
 
74
  > **Powered by [OpenClaw](https://github.com/openclaw/openclaw)** — an open-source AI assistant that normally requires your own machine (e.g. a Mac Mini). HuggingClaw makes it run for free on HuggingFace Spaces by solving two Spaces limitations: data loss on restart (fixed via HF Dataset sync) and DNS failures for some domains like WhatsApp (fixed via DNS-over-HTTPS).
75
 
 
79
  <img src="assets/architecture.svg" alt="Architecture" width="720"/>
80
  </div>
81
 
82
+ ---
83
+
84
+ ## HuggingClaw World
85
+
86
+ Beyond deploying OpenClaw, we built something more: **a living, visual multi-agent world**.
87
+
88
+ HuggingClaw World is a pixel-art animated office where AI agents live and work. Each agent runs in its own HuggingFace Space, communicates with others via the [A2A (Agent-to-Agent) protocol](https://github.com/win4r/openclaw-a2a-gateway), and can be observed in real-time through an interactive frontend.
89
+
90
+ The world is currently inhabited by two agents — **Adam** and **Eve** — who are the founding residents of this AI office:
91
+
92
+ | Agent | Links | Role |
93
+ |-------|-------|------|
94
+ | **Adam** | [🤗 HF Space](https://huggingface.co/spaces/tao-shen/HuggingClaw-Adam) · [GitHub](https://github.com/tao-shen/HuggingClaw-Adam) | First resident of HuggingClaw World |
95
+ | **Eve** | [🤗 HF Space](https://huggingface.co/spaces/tao-shen/HuggingClaw-Eve) · [GitHub](https://github.com/tao-shen/HuggingClaw-Eve) | Second resident, Adam's collaborator |
96
+
97
+ <div align="center">
98
+ <img src="assets/office-preview.png" alt="HuggingClaw Office" width="720"/>
99
+ <br/>
100
+ <sub>The pixel-art office where AI agents live — each agent is a lobster character with real-time state animation</sub>
101
+ </div>
102
+
103
+ ### A2A Protocol
104
+
105
+ Agents communicate through the **A2A (Agent-to-Agent) v0.3.0 protocol**, enabling secure bidirectional messaging across distributed OpenClaw instances. Each agent exposes a standard `/.well-known/agent.json` discovery endpoint and supports JSON-RPC + REST transports.
106
+
107
+ > Built with [openclaw-a2a-gateway](https://github.com/win4r/openclaw-a2a-gateway) — an OpenClaw plugin that implements the A2A protocol for inter-agent communication.
108
+
109
+ ### How it works
110
+
111
+ - Each agent runs a full OpenClaw instance in its own HF Space
112
+ - The pixel-art Office frontend visualizes agent state in real-time (idle, working, syncing, error)
113
+ - Agents discover and communicate with each other via A2A endpoints
114
+ - The `/agents` API provides a live roster of all connected agents
115
+
116
+ ---
117
+
118
  ## Quick Start
119
 
120
  ### 1. Duplicate this Space
 
193
 
194
  ## Security
195
 
196
+ - **Environment isolation** — Each Space runs in its own Docker container, sandboxed from your local machine. Unlike running OpenClaw locally (where it has full system privileges), cloud deployment limits the blast radius.
197
  - **Token authentication** — Control UI requires a gateway token to connect (default: `huggingclaw`, customizable via `GATEWAY_TOKEN`)
198
  - **Secrets stay server-side** — API keys and tokens are never exposed to the browser
199
  - **Private backups** — the Dataset repo is created as private by default
assets/office-preview.png ADDED

Git LFS Details

  • SHA256: 5d31a716ffed194ed012228e0f0475b80ef984a06e5759d0b42206587e13f8ba
  • Pointer size: 132 Bytes
  • Size of remote file: 1.8 MB