README: 对标爆火开源项目标准重写

研究了 Daytona(4K星首周)、yt-dlp(148K)、Jina Reader(9.8K)、OpenClaw 等项目的 README 模式。

新增/改进:
1. 居中 Logo + 标题 + 徽章区(License、Python、Stars)
2. 顶部导航链接
3. '为什么需要' → 痛点表格化(Twitter 00/月、Reddit 403...)
4. 安心清单改成表格,更整齐
5. 设计理念里选型理由改成表格
6. 加了 贡献 section(降低参与门槛)
7. 加了 LICENSE 文件
8. logo 占位(待设计)
This commit is contained in:
Panniantong 2026-02-24 10:17:52 +01:00
parent 06a729e5a7
commit 4b0ae20fd7
2 changed files with 75 additions and 28 deletions

View file

@ -1,6 +1,6 @@
MIT License
Copyright (c) 2026 Leo (@runes_leo)
Copyright (c) 2025 Agent Eyes
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal

101
README.md
View file

@ -1,24 +1,57 @@
# 👁️ Agent Eyes
<p align="center">
<img src="docs/assets/logo.png" alt="Agent Eyes" width="200">
</p>
**给你的 AI Agent 一键装上互联网能力。**
<h1 align="center">👁️ Agent Eyes</h1>
AI Agent 已经能访问互联网了——但只是"能上网"而已。
<p align="center">
<strong>给你的 AI Agent 一键装上互联网能力</strong>
</p>
真正有价值的信息散落在各种社媒和私域平台里Twitter 上的行业讨论、Reddit 上的真实反馈、小红书上的用户口碑、B站的深度视频、GitHub 的开源动态……这些地方才是信息密度最高的地方但每个平台都有自己的门槛Twitter API 要 $100/月、Reddit 封服务器 IP、小红书必须登录、B站屏蔽海外访问。
<p align="center">
<a href="LICENSE"><img src="https://img.shields.io/badge/License-MIT-blue.svg?style=for-the-badge" alt="MIT License"></a>
<a href="https://www.python.org/"><img src="https://img.shields.io/badge/Python-3.8+-green.svg?style=for-the-badge&logo=python&logoColor=white" alt="Python 3.8+"></a>
<a href="https://github.com/Panniantong/agent-eyes/stargazers"><img src="https://img.shields.io/github/stars/Panniantong/agent-eyes?style=for-the-badge" alt="GitHub Stars"></a>
</p>
<p align="center">
<a href="#30-秒上手">快速开始</a> · <a href="docs/README_en.md">English</a> · <a href="#支持的平台">支持平台</a> · <a href="#设计理念">设计理念</a>
</p>
---
## 为什么需要 Agent Eyes
AI Agent 已经能访问互联网——但只是"能上网"而已。
真正有价值的信息散落在各种社媒和私域平台里Twitter 上的行业讨论、Reddit 上的真实反馈、小红书上的用户口碑、B站的深度视频、GitHub 的开源动态……**这些地方才是信息密度最高的地方**,但每个平台都有自己的门槛:
| 痛点 | 现状 |
|------|------|
| Twitter API | $100/月起步 |
| Reddit | 服务器 IP 直接 403 |
| 小红书 | 必须登录才能看 |
| B站 | 屏蔽海外/服务器 IP |
你要让 Agent 接入这些平台,就得一个一个去踩坑、装工具、调配置。
**Agent Eyes 把这件事变成一行命令。**
**Agent Eyes 把这件事变成一行命令**
它是一个 Agent 初始化脚手架——把社区里最好的开源工具选好、粘在一起,让你的 Agent 一次安装就具备访问主流社媒平台的能力。
```
帮我安装 Agent Eyeshttps://raw.githubusercontent.com/Panniantong/agent-eyes/main/docs/install.md
```
### 你可能关心的几件事
复制给你的 Agent30 秒后它就能读推特、搜 Reddit、看 B站了。
- 💰 **完全免费。** 所有工具都是开源的,所有 API 都是免费的。唯一可能花钱的是服务器代理($1/月),而且本地电脑根本不需要。
- 🔒 **Cookie 只存在你本地。** 不上传、不外传,只用来访问你自己的账号。代码开源,随时可以审查。
- 🔄 **持续跟进上游更新。** 底层工具yt-dlp、birdx、Jina Reader 等)我们会定期追踪更新到最新版,你不用自己盯。
- 🤖 **适配所有主流 Agent。** Claude Code、OpenClaw、Cursor、Windsurf……任何能跑命令行的 Agent 都能用。
- 🩺 **出问题一眼就知道。** `agent-eyes doctor` 一条命令告诉你哪个渠道通、哪个不通、怎么修。
### ✅ 在你用之前,你可能想知道
| | |
|---|---|
| 💰 **完全免费** | 所有工具开源、所有 API 免费。唯一可能花钱的是服务器代理($1/月),本地电脑不需要 |
| 🔒 **隐私安全** | Cookie 只存在你本地,不上传不外传。代码完全开源,随时可审查 |
| 🔄 **持续更新** | 底层工具yt-dlp、birdx、Jina Reader 等)定期追踪更新到最新版,你不用自己盯 |
| 🤖 **兼容所有 Agent** | Claude Code、OpenClaw、Cursor、Windsurf……任何能跑命令行的 Agent 都能用 |
| 🩺 **自带诊断** | `agent-eyes doctor` 一条命令告诉你哪个通、哪个不通、怎么修 |
---
@ -28,18 +61,16 @@ AI Agent 已经能访问互联网了——但只是"能上网"而已。
|------|------|:--------:|------|
| 🌐 **网页** | 阅读 | 零配置 | 任意 URL → 干净 Markdown[Jina Reader](https://github.com/jina-ai/reader) ⭐9.8K 驱动) |
| 🐦 **Twitter/X** | 阅读 · 搜索 | 零配置 / Cookie | 单条推文零配置可读。配置 Cookie 可解锁搜索、时间线、发推([birdx](https://github.com/runesleo/birdx) 驱动) |
| 📕 **小红书** | 阅读 · 搜索 · **发帖 · 评论 · 点赞 · 收藏** | Cookie | 配置 Cookie 即可使用全部功能:发图文/视频笔记、回复评论、查看用户主页 |
| 🔍 **全网搜索** | 搜索 | 免费 Key | AI 语义搜索,一个 Key 搜全网 + Reddit + Twitter[Exa](https://exa.ai) 驱动) |
| 📦 **GitHub** | 阅读 · 搜索 | 零配置 | 公开仓库直接可用。配置 `gh` CLI 或 Token 后可解锁 Fork、Issue、PR、Review 等完整操作 |
| 📕 **小红书** | 阅读 · 搜索 · **发帖 · 评论 · 点赞** | Cookie | 配置 Cookie 即可使用全部功能 |
| 🔍 **全网搜索** | 搜索 | 免费 Key | 一个 Key 搜全网 + Reddit + Twitter[Exa](https://exa.ai) 驱动,免费 1000 次/月 |
| 📦 **GitHub** | 阅读 · 搜索 | 零配置 | 公开仓库直接可用。配置 `gh` CLI 或 Token 后可解锁 Fork、Issue、PR 等完整操作 |
| 📺 **YouTube** | 阅读 | 零配置 | 1800+ 视频网站字幕提取([yt-dlp](https://github.com/yt-dlp/yt-dlp) ⭐148K 驱动) |
| 📺 **B站** | 阅读 | 零配置 / 代理 | 视频信息 + 字幕。本地直接用,服务器配个代理即可 |
| 📡 **RSS** | 阅读 | 零配置 | 任意 RSS/Atom 源([feedparser](https://github.com/kurtmckee/feedparser) ⭐2.3K 驱动) |
| 📖 **Reddit** | 搜索 · 阅读 | 免费 / 代理 | 搜索通过 Exa 免费直接可用。读帖子配个代理即可。配置 OAuth Bot 可解锁高级搜索和发帖 |
| 📖 **Reddit** | 搜索 · 阅读 | 免费 / 代理 | 搜索通过 Exa 免费直接可用。读帖子配个代理即可。配置 OAuth Bot 可解锁发帖 |
> **配置难度说明:** 零配置 = 装好即用 · 免费 Key = 30 秒注册 · Cookie = 从浏览器导出 · 代理 = $1/月
[English](docs/README_en.md)
---
## 30 秒上手
@ -108,7 +139,7 @@ $ agent-eyes doctor
✅ 装好即用:
✅ GitHub 仓库和代码 — 公开仓库可读可搜。配置 gh CLI 或 Token 可解锁 Fork、Issue、PR 等操作
✅ Twitter/X 推文 — 可读取推文。安装 birdx + 配置 Cookie 可解锁搜索和发推
✅ Twitter/X 推文 — 可读取推文。配置 Cookie 可解锁搜索和发推
✅ YouTube 视频字幕 — yt-dlp
⚠️ B站视频信息和字幕 — 服务器 IP 可能被封,配置代理即可解决
✅ RSS/Atom 订阅源 — feedparser
@ -119,7 +150,7 @@ $ agent-eyes doctor
🔧 配置后可用:
⬜ Reddit 帖子和评论 — 搜索用 Exa 免费可用。读帖子需配个代理
⬜ 小红书笔记 — 需要配置 Cookie 才能访问。导入浏览器 Cookie 即可
⬜ 小红书笔记 — 需要配置 Cookie。导入浏览器 Cookie 即可
状态6/9 个渠道可用
```
@ -134,13 +165,18 @@ $ agent-eyes doctor
Agent Eyes 做的事情很简单:**帮你把这些选型和配置的活儿做完了。**
- 读网页 → 选了 [Jina Reader](https://github.com/jina-ai/reader)9.8K Star免费不需要 API Key
- 读推特 → 选了 [birdx](https://github.com/runesleo/birdx)Cookie 登录,不用花 $100/月买官方 API
- 提字幕 → 选了 [yt-dlp](https://github.com/yt-dlp/yt-dlp)148K Star支持 1800+ 视频网站)
- 搜全网 → 选了 [Exa](https://exa.ai)(语义搜索,免费 1000 次/月)
- 读 RSS → 选了 [feedparser](https://github.com/kurtmckee/feedparser)Python 生态标准选择)
| 场景 | 选型 | 为什么选它 |
|------|------|-----------|
| 读网页 | [Jina Reader](https://github.com/jina-ai/reader) | 9.8K Star免费不需要 API Key |
| 读推特 | [birdx](https://github.com/runesleo/birdx) | Cookie 登录,不用花 $100/月买官方 API |
| 提字幕 | [yt-dlp](https://github.com/yt-dlp/yt-dlp) | 148K Star支持 1800+ 视频网站 |
| 搜全网 | [Exa](https://exa.ai) | AI 语义搜索,免费 1000 次/月 |
| 读 RSS | [feedparser](https://github.com/kurtmckee/feedparser) | Python 生态标准选择2.3K Star |
每个平台一个文件,每个文件 ~50 行代码。后端工具随时可以换——比如哪天出了比 Jina Reader 更好的读网页工具,改一个文件就行,其他地方不用动。
每个平台一个文件,每个文件 ~50 行代码。后端工具随时可以换——哪天出了更好的工具,改一个文件就行,其他不用动。
<details>
<summary>项目结构</summary>
```
agent_eyes/channels/
@ -154,9 +190,20 @@ agent_eyes/channels/
├── rss.py → feedparser
└── exa_search.py → Exa Search API
```
</details>
---
## 贡献
欢迎提 [Issue](https://github.com/Panniantong/agent-eyes/issues) 和 [PR](https://github.com/Panniantong/agent-eyes/pulls)。
想加新平台?复制任意一个 channel 文件,改改就行——每个文件只有 ~50 行。
## 致谢
[Jina Reader](https://github.com/jina-ai/reader) · [yt-dlp](https://github.com/yt-dlp/yt-dlp) · [birdx](https://github.com/runesleo/birdx) · [Exa](https://exa.ai) · [feedparser](https://github.com/kurtmckee/feedparser)
MIT License
## License
[MIT](LICENSE)