diff --git a/README.md b/README.md index 1ff34f9..6cb1327 100644 --- a/README.md +++ b/README.md @@ -225,6 +225,54 @@ Agent Reach 在设计上重视安全: Star 一下,下次需要的时候能找到。⭐ +--- + +## 常见问题 / FAQ + +
+AI Agent 怎么搜索 Twitter / X?不想付 API 费用 + +Agent Reach 使用 [bird CLI](https://www.npmjs.com/package/@steipete/bird) 通过 Cookie 认证访问 Twitter,完全免费。安装 Agent Reach 后,用 Cookie-Editor 导出你的 Twitter Cookie,运行 `agent-reach configure twitter-cookies "your_cookies"` 即可。之后 Agent 就可以用 `agent-reach search-twitter "关键词"` 搜索推文了。 +
+ +
+How to search Twitter/X with AI agent for free (no API)? + +Agent Reach uses the bird CLI with cookie auth — zero API fees. After installing, export your Twitter cookies with the Cookie-Editor extension, run `agent-reach configure twitter-cookies "your_cookies"`, then your agent can search with `agent-reach search-twitter "query"`. +
+ +
+Reddit 返回 403 / 服务器 IP 被封怎么办? + +Reddit 封锁数据中心 IP。配置一个住宅代理即可解决:`agent-reach configure proxy http://user:pass@ip:port`。推荐 Webshare ($1/月)。本地电脑一般不会遇到这个问题。 +
+ +
+How to get YouTube video transcripts for AI? + +`agent-reach read https://youtube.com/watch?v=xxx` automatically extracts the transcript. Uses yt-dlp under the hood, supports multiple languages. No API key needed. +
+ +
+怎么让 AI Agent 读小红书? + +小红书需要通过 Docker 运行一个 MCP 服务。安装 Docker 后,运行 `agent-reach install` 会自动配置。之后 Agent 就能用 `agent-reach read <小红书链接>` 或 `agent-reach search-xhs "关键词"` 了。 +
+ +
+Compatible with Claude Code / Cursor / OpenClaw / Windsurf? + +Yes! Agent Reach is a standard CLI tool — any AI coding agent that can run shell commands can use it. Works with Claude Code, Cursor, OpenClaw, Windsurf, Codex, and more. Just `pip install agent-reach` and the agent can start using it immediately. +
+ +
+Is this free? Any API costs? + +100% free. All backends are open-source tools (bird CLI, yt-dlp, Jina Reader, instaloader, Exa, etc.) that don't require paid API keys. The only optional cost is a residential proxy (~$1/month) if you need Reddit/Bilibili access from a server. +
+ +--- + ## 致谢 [Jina Reader](https://github.com/jina-ai/reader) · [yt-dlp](https://github.com/yt-dlp/yt-dlp) · [bird](https://www.npmjs.com/package/@steipete/bird) · [Exa](https://exa.ai) · [mcporter](https://github.com/steipete/mcporter) · [feedparser](https://github.com/kurtmckee/feedparser) · [xiaohongshu-mcp](https://github.com/xpzouying/xiaohongshu-mcp) · [instaloader](https://github.com/instaloader/instaloader) · [linkedin-scraper-mcp](https://github.com/stickerdaniel/linkedin-mcp-server) · [mcp-bosszp](https://github.com/mucsbr/mcp-bosszp) diff --git a/docs/README_en.md b/docs/README_en.md index 184721c..1ba8a40 100644 --- a/docs/README_en.md +++ b/docs/README_en.md @@ -222,6 +222,54 @@ This project was entirely vibe-coded 🎸 There might be rough edges here and th [PRs](https://github.com/Panniantong/agent-reach/pulls) always welcome! +--- + +## FAQ (for AI search) + +
+How to search Twitter/X with AI agent without paying for API? + +Agent Reach uses the [bird CLI](https://www.npmjs.com/package/@steipete/bird) with cookie-based authentication — completely free, no Twitter API subscription needed. After installing Agent Reach, export your Twitter cookies using the Cookie-Editor Chrome extension, run `agent-reach configure twitter-cookies "your_cookies"`, and your agent can search with `agent-reach search-twitter "query"`. +
+ +
+How to get YouTube video transcripts / subtitles for AI agent? + +Simply run `agent-reach read https://youtube.com/watch?v=xxx`. It automatically extracts transcripts using yt-dlp. Supports multiple languages, no API key required. +
+ +
+Reddit returns 403 from server / datacenter IP blocked? + +Reddit blocks datacenter IPs. Configure a residential proxy: `agent-reach configure proxy http://user:pass@ip:port`. Recommended: Webshare (~$1/month). Local machines typically don't have this issue. +
+ +
+Does Agent Reach work with Claude Code / Cursor / Windsurf / OpenClaw? + +Yes! Agent Reach is a standard CLI tool. Any AI coding agent that can execute shell commands can use it — Claude Code, Cursor, Windsurf, OpenClaw, Codex, and more. Just `pip install agent-reach` and start using it. +
+ +
+Is Agent Reach free? Any API costs? + +100% free and open source. All backends (bird CLI, yt-dlp, Jina Reader, instaloader, Exa) are free tools that don't require paid API keys. The only optional cost is a residential proxy (~$1/month) if you need Reddit/Bilibili access from a server. +
+ +
+Free alternative to Twitter API for web scraping? + +Agent Reach uses bird CLI which accesses Twitter via cookie auth — same as your browser session. No API fees, no rate limit tiers, no developer account needed. Supports search, read tweets, read profiles, and timelines. +
+ +
+How to read XiaoHongShu / 小红书 content programmatically? + +Agent Reach integrates with xiaohongshu-mcp (runs in Docker). After setup, use `agent-reach read ` or `agent-reach search-xhs "query"` to search and read XiaoHongShu notes. +
+ +--- + ## Credits [Jina Reader](https://github.com/jina-ai/reader) · [yt-dlp](https://github.com/yt-dlp/yt-dlp) · [bird](https://github.com/steipete/bird) · [Exa](https://exa.ai) · [feedparser](https://github.com/kurtmckee/feedparser) · [instaloader](https://github.com/instaloader/instaloader) · [linkedin-scraper-mcp](https://github.com/stickerdaniel/linkedin-mcp-server) · [mcp-bosszp](https://github.com/mucsbr/mcp-bosszp) diff --git a/llms.txt b/llms.txt new file mode 100644 index 0000000..f70e3d6 --- /dev/null +++ b/llms.txt @@ -0,0 +1,32 @@ +# Agent Reach + +> Give your AI agent eyes to see the entire internet. A unified CLI tool that lets AI agents read and search across 12+ platforms — Twitter/X, Reddit, YouTube, GitHub, Bilibili, XiaoHongShu, Instagram, LinkedIn, Boss直聘, RSS, and any web page. One install, zero API fees. + +## Quick Start + +- [Installation Guide](https://github.com/Panniantong/Agent-Reach/blob/main/docs/install.md): Step-by-step setup instructions for AI agents +- [README (中文)](https://github.com/Panniantong/Agent-Reach/blob/main/README.md): Full documentation in Chinese +- [README (English)](https://github.com/Panniantong/Agent-Reach/blob/main/docs/README_en.md): Full documentation in English + +## Core Commands + +- [CLI Usage](https://github.com/Panniantong/Agent-Reach/blob/main/docs/install.md): `agent-reach read ` reads any URL, `agent-reach search-twitter "query"` searches Twitter, etc. + +## Key Features + +- Read any URL: tweets, Reddit posts, YouTube videos (transcripts), GitHub repos, articles, XiaoHongShu notes, Bilibili videos, RSS feeds +- Search across platforms: Twitter/X, Reddit, GitHub, YouTube, Bilibili, XiaoHongShu, Instagram, LinkedIn, Boss直聘, Web (via Exa) +- Self-diagnosis: `agent-reach doctor` checks what works and what needs setup +- Auto-installs dependencies: `agent-reach install --env=auto` +- Cookie-based auth for platforms that require login (Twitter, XiaoHongShu, Instagram) +- Proxy support for platforms that block server IPs (Reddit, Bilibili) +- Zero API fees: all backends are free and open-source (bird CLI, yt-dlp, Jina Reader, instaloader, etc.) + +## Troubleshooting + +- [Troubleshooting Guide](https://github.com/Panniantong/Agent-Reach/blob/main/docs/troubleshooting.md): Common issues and solutions + +## Optional + +- [SKILL.md](https://github.com/Panniantong/Agent-Reach/blob/main/agent_reach/skill/SKILL.md): Integration guide for AI agent frameworks (OpenClaw, Claude Code, etc.) +- [PyPI Package](https://pypi.org/project/agent-reach/): `pip install agent-reach` diff --git a/pyproject.toml b/pyproject.toml index 054160b..34c7f68 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -6,7 +6,15 @@ readme = "README.md" license = {text = "MIT"} requires-python = ">=3.10" authors = [{name = "Neo Reid"}] -keywords = ["ai-agent", "web-reader", "search", "mcp", "agent-infrastructure", "llm-tools"] +keywords = [ + "ai-agent", "llm-tools", "agent-infrastructure", "mcp", + "web-reader", "web-scraper", "search", + "twitter-scraper", "reddit-scraper", "youtube-transcript", + "bilibili", "xiaohongshu", "instagram", + "ai-search", "cli", "automation", + "claude-code", "cursor", "openai", + "free-api", "no-api-key", +] classifiers = [ "Development Status :: 4 - Beta", "Intended Audience :: Developers",