From bdf692c3915b0d1eebd08ab4c1eea9408d60a67e Mon Sep 17 00:00:00 2001 From: nyxst4ck Date: Wed, 10 Jun 2026 03:12:15 -0300 Subject: [PATCH] docs(en): document safe mode and OpenClaw exec requirement (#330) The English README was missing two things present in the Chinese README: the OpenClaw 'exec' permission prerequisite (without it the Agent silently can't run install commands) and the --safe install mode. Both refer to real, supported features (cli.py exposes --safe; install.md documents it). Also align the Chinese README's Python badge alt-text (3.8+ -> 3.10+) with requires-python and the badge image. Co-authored-by: nyxst4ck <289980115+nyxst4ck@users.noreply.github.com> Co-authored-by: Claude Opus 4.8 (1M context) --- README.md | 2 +- docs/README_en.md | 15 +++++++++++++++ 2 files changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index efac08f..f418fa6 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@

MIT License - Python 3.8+ + Python 3.10+ GitHub Stars

diff --git a/docs/README_en.md b/docs/README_en.md index 331d74f..bb8f5db 100644 --- a/docs/README_en.md +++ b/docs/README_en.md @@ -84,6 +84,15 @@ Update Agent Reach: https://raw.githubusercontent.com/Panniantong/agent-reach/ma ## Quick Start +> ⚠️ **OpenClaw users: enable `exec` permission first** +> +> Agent Reach relies on the Agent running shell commands (`pip install`, `mcporter`, `bird`, etc.). If your OpenClaw uses the default `messaging` tool profile, the Agent won't be able to run them. **Enable `exec` before installing:** +> +> ```bash +> openclaw config set tools.profile "coding" +> ``` +> Or set `"tools": { "profile": "coding" }` in `~/.openclaw/openclaw.json`. After changing it, restart the Gateway (`openclaw gateway restart`) and start a new conversation. Other platforms (Claude Code, Cursor, Windsurf, etc.) are not affected. + Copy this to your AI Agent (Claude Code, OpenClaw, Cursor, etc.): ``` @@ -97,6 +106,12 @@ The Agent auto-installs, detects your environment, and tells you what's ready. > Update Agent Reach: https://raw.githubusercontent.com/Panniantong/agent-reach/main/docs/update.md > ``` +> 🛡️ **Worried about security?** Use safe mode — it won't auto-install system packages, it only tells you what you need: +> ``` +> Install Agent Reach (safe mode): https://raw.githubusercontent.com/Panniantong/agent-reach/main/docs/install.md +> Use the --safe flag during install +> ``` +
Manual install