tao-shen commited on
Commit
92acc07
·
1 Parent(s): 34729f6

docs: update README to reflect new features and improved descriptions for HuggingClaw

Browse files

Revise short description and key features to emphasize the always-on AI assistant capabilities, including support for WhatsApp and Telegram. Enhance clarity on data persistence and setup instructions, and streamline the explanation of HuggingClaw's advantages over traditional deployments.

Files changed (1) hide show
  1. README.md +29 -20
README.md CHANGED
@@ -8,7 +8,7 @@ pinned: false
8
  license: mit
9
  datasets:
10
  - tao-shen/HuggingClaw-data
11
- short_description: Deploy OpenClaw on HuggingFace Spaces
12
  app_port: 7860
13
  tags:
14
  - huggingface
@@ -37,9 +37,9 @@ tags:
37
  <div align="center">
38
  <img src="HuggingClaw.png" alt="HuggingClaw" width="720"/>
39
  <br/><br/>
40
- <strong>The best way to deploy <a href="https://github.com/openclaw/openclaw">OpenClaw</a> on the cloud</strong>
41
  <br/>
42
- <sub>Zero hardware · Always online · Auto-persistent · One-click deploy</sub>
43
  <br/><br/>
44
 
45
  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
@@ -55,11 +55,19 @@ tags:
55
 
56
  ---
57
 
58
- ## Why HuggingClaw?
59
 
60
- [OpenClaw](https://github.com/openclaw/openclaw) is a powerful, popular AI assistant (Telegram, WhatsApp, 40+ channels), but its meant to run on your own machine (e.g. a Mac Mini). Not everyone has that. You can deploy on the cloud, but most providers either charge by the hour or offer only very limited resources. **HuggingFace Spaces** gives you 2 vCPU and **16 GB RAM** for free a good fit for OpenClaw, but Spaces have two problems we fix.
61
 
62
- **HuggingClaw** is this repo. It fixes two Hugging Face Space issues: **(1) Data is not persistent** — we use a private **HuggingFace Dataset** to sync and restore your conversations, settings, and credentials so they survive restarts; **(2) DNS resolution fails** for some domains (e.g. WhatsApp) — we fix it with DNS-over-HTTPS and a Node.js DNS patch so OpenClaw can connect reliably.
 
 
 
 
 
 
 
 
63
 
64
  ## Architecture
65
 
@@ -77,37 +85,38 @@ Click **Duplicate this Space** on the [HuggingClaw Space page](https://huggingfa
77
 
78
  ### 2. Set Secrets
79
 
80
- Go to **Settings → Repository secrets** and configure:
81
 
82
  | Secret | Status | Description | Example |
83
  |--------|:------:|-------------|---------|
84
  | `HF_TOKEN` | **Required** | HF Access Token with write permission ([create one](https://huggingface.co/settings/tokens)) | `hf_AbCdEfGhIjKlMnOpQrStUvWxYz` |
85
- | `OPENCLAW_DATASET_REPO` | See below | Dataset repo for backup format: `username/repo-name`. Required in manual mode; optional in auto mode (see [Data Persistence](#data-persistence)) | `your-name/YourSpace-data` |
86
- | `OPENAI_API_KEY` | Recommended | OpenAI (or any [OpenAI-compatible](https://openclawdoc.com/docs/reference/environment-variables)) API key | `sk-proj-xxxxxxxxxxxx` |
87
- | `OPENROUTER_API_KEY` | Optional | [OpenRouter](https://openrouter.ai) API key (200+ models, free tier available) | `sk-or-v1-xxxxxxxxxxxx` |
88
  | `ANTHROPIC_API_KEY` | Optional | Anthropic Claude API key | `sk-ant-xxxxxxxxxxxx` |
89
  | `GOOGLE_API_KEY` | Optional | Google / Gemini API key | `AIzaSyXxXxXxXxXx` |
90
  | `OPENCLAW_DEFAULT_MODEL` | Optional | Default model for new conversations | `openai/gpt-oss-20b:free` |
91
 
92
  ### Data Persistence
93
 
94
- HuggingClaw syncs `~/.openclaw` (conversations, settings, credentials) to a private HuggingFace Dataset repo so data survives restarts. There are two ways to set this up:
 
 
 
 
 
 
 
 
95
 
96
- **Option A — Manual mode (default, recommended)**
97
 
98
  1. Go to [huggingface.co/new-dataset](https://huggingface.co/new-dataset) and create a **private** Dataset repo (e.g. `your-name/HuggingClaw-data`)
99
  2. Set `OPENCLAW_DATASET_REPO` = `your-name/HuggingClaw-data` in your Space secrets
100
  3. Set `HF_TOKEN` with write permission
101
  4. Done — HuggingClaw will sync to this repo every 60 seconds
102
 
103
- **Option BAuto mode**
104
-
105
- 1. Set `AUTO_CREATE_DATASET` = `true` in your Space secrets
106
- 2. Set `HF_TOKEN` with write permission
107
- 3. (Optional) Set `OPENCLAW_DATASET_REPO` if you want a custom repo name
108
- 4. On first startup, HuggingClaw automatically creates a **private** Dataset repo. If `OPENCLAW_DATASET_REPO` is not set, it derives the name from your HF username + Space name: `your-username/SpaceName-data` (e.g. `your-name/YourSpace-data`). Each Space gets its own dataset, so duplicating a Space won't cause conflicts
109
-
110
- > **Security note:** `AUTO_CREATE_DATASET` defaults to `false` — the system will not create repos on your behalf unless you explicitly opt in.
111
 
112
  ### Environment Variables
113
 
 
8
  license: mit
9
  datasets:
10
  - tao-shen/HuggingClaw-data
11
+ short_description: Always-on AI assistant free, zero hardware, WhatsApp & Telegram ready
12
  app_port: 7860
13
  tags:
14
  - huggingface
 
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)
 
55
 
56
  ---
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 channelsno server, no subscription, no hardware required.
61
 
62
+ | | |
63
+ |---|---|
64
+ | **Free forever** | HuggingFace Spaces gives you 2 vCPU + 16 GB RAM at no cost |
65
+ | **Always online** | Your conversations, settings, and credentials survive every restart |
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
 
72
  ## Architecture
73
 
 
85
 
86
  ### 2. Set Secrets
87
 
88
+ Go to **Settings → Repository secrets** and add the following. The only two you *must* set are `HF_TOKEN` and one API key.
89
 
90
  | Secret | Status | Description | Example |
91
  |--------|:------:|-------------|---------|
92
  | `HF_TOKEN` | **Required** | HF Access Token with write permission ([create one](https://huggingface.co/settings/tokens)) | `hf_AbCdEfGhIjKlMnOpQrStUvWxYz` |
93
+ | `AUTO_CREATE_DATASET` | **Recommended** | Set to `true`HuggingClaw will automatically create a private backup dataset on first startup. No manual setup needed. | `true` |
94
+ | `OPENROUTER_API_KEY` | Recommended | [OpenRouter](https://openrouter.ai) API key — 200+ models, free tier available. Easiest way to get started. | `sk-or-v1-xxxxxxxxxxxx` |
95
+ | `OPENAI_API_KEY` | Optional | OpenAI (or any [OpenAI-compatible](https://openclawdoc.com/docs/reference/environment-variables)) API key | `sk-proj-xxxxxxxxxxxx` |
96
  | `ANTHROPIC_API_KEY` | Optional | Anthropic Claude API key | `sk-ant-xxxxxxxxxxxx` |
97
  | `GOOGLE_API_KEY` | Optional | Google / Gemini API key | `AIzaSyXxXxXxXxXx` |
98
  | `OPENCLAW_DEFAULT_MODEL` | Optional | Default model for new conversations | `openai/gpt-oss-20b:free` |
99
 
100
  ### Data Persistence
101
 
102
+ HuggingClaw syncs `~/.openclaw` (conversations, settings, credentials) to a private HuggingFace Dataset repo so your data survives every restart.
103
+
104
+ **Option A — Auto mode (recommended)**
105
+
106
+ 1. Set `AUTO_CREATE_DATASET` = `true` in your Space secrets
107
+ 2. Set `HF_TOKEN` with write permission
108
+ 3. Done — on first startup, HuggingClaw automatically creates a private Dataset repo named `your-username/SpaceName-data`. Each duplicated Space gets its own isolated dataset.
109
+
110
+ > (Optional) Set `OPENCLAW_DATASET_REPO` = `your-name/custom-name` if you prefer a specific repo name.
111
 
112
+ **Option B — Manual mode**
113
 
114
  1. Go to [huggingface.co/new-dataset](https://huggingface.co/new-dataset) and create a **private** Dataset repo (e.g. `your-name/HuggingClaw-data`)
115
  2. Set `OPENCLAW_DATASET_REPO` = `your-name/HuggingClaw-data` in your Space secrets
116
  3. Set `HF_TOKEN` with write permission
117
  4. Done — HuggingClaw will sync to this repo every 60 seconds
118
 
119
+ > **Security note:** `AUTO_CREATE_DATASET` defaults to `false` HuggingClaw will never create repos on your behalf unless you explicitly opt in.
 
 
 
 
 
 
 
120
 
121
  ### Environment Variables
122