docs: replace WeChat group QR with personal QR, update copy

2026-03-16 11:58:03 +01:00
parent 8afd19f473
commit be9f9ab838
4 changed files with 48 additions and 4 deletions
@@ -0,0 +1,44 @@
+# CLAUDE.md
+
+## Project
+Agent Reach — Python CLI + library that gives AI agents read/search access to 14+ internet platforms.
+Positioning: installer + doctor + config tool. NOT a wrapper — after install, agents call upstream tools directly.
+Repo: github.com/Panniantong/Agent-Reach | License: MIT | Version: 1.3.0
+
+## Commands
+- `pip install -e .` — Dev install
+- `pytest tests/ -v` — All tests
+- `pytest tests/test_cli.py -v` — CLI tests only
+- `bash test.sh` — Full integration test (creates venv, installs, runs doctor + channel tests)
+- `python -m agent_reach.cli doctor` — Run diagnostics
+- `python -m agent_reach.cli install --env=auto` — Auto-configure
+
+## Structure
+- `agent_reach/cli.py` — CLI entry point (argparse)
+- `agent_reach/core.py` — Core read/search routing logic
+- `agent_reach/config.py` — Config management (YAML, env vars)
+- `agent_reach/doctor.py` — Diagnostics engine
+- `agent_reach/channels/` — One file per platform (twitter.py, reddit.py, youtube.py, etc.)
+- `agent_reach/channels/base.py` — Base channel class (all channels inherit from this)
+- `agent_reach/integrations/mcp_server.py` — MCP server integration
+- `agent_reach/skill/` — OpenClaw skill files
+- `agent_reach/guides/` — Usage guides
+- `tests/` — pytest tests
+- `config/mcporter.json` — MCP tool config
+
+## Conventions
+- Python 3.10+ with type hints
+- Each channel is a single file in `channels/`, inherits from `BaseChannel`
+- Channel contract: must implement `can_handle(url)`, `read(url)`, `search(query)`, `check()` methods
+- Use `loguru` for logging, `rich` for CLI output
+- Commit format: `type(scope): message` (one commit = one thing)
+- All upstream tool calls go through public API/CLI, never hack internals
+
+## Rules
+- NEVER modify upstream open source projects' source code
+- Agent Reach is a "glue layer" — only route and call, don't reimagine
+- Version in THREE places must match: `pyproject.toml`, `__init__.py`, `tests/test_cli.py`
+- Always new branch for changes, PR to main, never push to main directly
+- Run `pytest tests/ -v` before committing — all tests must pass
+- Cookie-based auth (Twitter, XHS): use Cookie-Editor export method only, no QR scan
+- XHS login: Cookie-Editor browser export only (QR will hang)
@@ -340,10 +340,10 @@ Yes! Agent Reach is an installer + configuration tool — any AI coding agent th
 - 📧 **Email:** pnt01@foxmail.com
 - 🐦 **Twitter/X:** [@Neo_Reidlab](https://x.com/Neo_Reidlab)

-想交流 AI Agent 使用心得、分享最新玩法和技巧？欢迎加入微信交流群，群里都是实战派：
+交流或合作可加微信，拉你进交流群：

 <p align="center">
-  <img src="docs/wechat-group-qr.jpg" width="280" alt="WeChat Group QR">
+  <img src="docs/wechat-group-qr.jpg" width="280" alt="WeChat QR">
 </p>

 > Bug 反馈和功能请求请用 [GitHub Issues](https://github.com/Panniantong/Agent-Reach/issues)，更容易跟踪。
@@ -304,10 +304,10 @@ Install douyin-mcp-server, then your agent can use `mcporter call 'douyin.parse_
 - 📧 **Email:** pnt01@foxmail.com
 - 🐦 **Twitter/X:** [@Neo_Reidlab](https://x.com/Neo_Reidlab)

-Want to exchange AI Agent tips, share workflows, and learn from power users? Join our WeChat community group:
+For collaboration or questions, add me on WeChat — I'll invite you to the community group:

 <p align="center">
-  <img src="wechat-group-qr.jpg" width="280" alt="WeChat Group QR">
+  <img src="wechat-group-qr.jpg" width="280" alt="WeChat QR">
 </p>

 > For bug reports and feature requests, please use [GitHub Issues](https://github.com/Panniantong/Agent-Reach/issues) — easier to track.