browser-web-search 0.1.0

package/README.md

@@ -0,0 +1,132 @@
+# Browser Web Search (BWS)
+
+**把任何网站变成命令行 API**
+
+## 项目特点
+
+### 🎯 专为 OpenClaw 设计
+- **零配置**：无需 Chrome Extension、无需 Daemon，开箱即用
+- **深度集成**：直接使用 OpenClaw 浏览器，与其他 Skill 共享登录态
+- **轻量精简**：核心代码仅 22KB，无运行时依赖
+
+### 🔐 复用登录态
+- **无需 API Key**：使用你在浏览器中的登录状态
+- **绕过反爬**：请求来自真实浏览器，不会被封禁
+- **隐私安全**：数据在本地处理，不经过第三方服务器
+
+### 📦 内置 Adapter
+- **13 个平台，41 个命令**：开箱即用
+- **可扩展**：支持添加私有 adapter 到 `~/.bws/sites/`
+- **易维护**：adapter 是简单的 JS 文件，易于修改和调试
+
+### 🤖 AI Agent 友好
+- **结构化输出**：所有命令返回 JSON，便于 AI 解析
+- **jq 过滤**：内置 jq 支持，精确提取所需数据
+- **错误提示**：清晰的错误信息和修复建议
+
+## 安装
+
+```bash
+npm install -g browser-web-search
+```
+
+## 快速开始
+
+```bash
+# 查看所有可用命令
+bws site list
+
+# 运行
+bws site zhihu/hot                    # 知乎热榜
+bws site xiaohongshu/search "旅行"    # 小红书搜索
+bws site github/repo owner/repo       # GitHub 仓库信息
+bws site bilibili/popular             # B站热门视频
+```
+
+## 内置平台
+
+| 分类 | 平台 | 命令数 |
+|-----|-----|-------|
+| **搜索** | Google, Baidu, Bing | 3 |
+| **社交** | 小红书, 知乎 | 10 |
+| **新闻** | 36kr, 今日头条 | 3 |
+| **开发** | GitHub, CSDN, 博客园 | 8 |
+| **视频** | Bilibili | 9 |
+| **娱乐** | 豆瓣 | 6 |
+| **招聘** | BOSS直聘 | 2 |
+
+## 命令
+
+```bash
+bws site list                      # 列出所有 adapter
+bws site search <query>            # 搜索 adapter
+bws site info <name>               # 查看 adapter 详情
+bws site <name> [args...]          # 运行 adapter
+```
+
+## 选项
+
+```bash
+--json               # JSON 格式输出
+--jq <expr>          # jq 过滤表达式
+```
+
+## 示例
+
+```bash
+# 获取知乎热榜
+bws site zhihu/hot
+
+# 搜索小红书并过滤标题
+bws site xiaohongshu/search "美食" --jq '.notes[].title'
+
+# 获取 B站热门视频
+bws site bilibili/popular --json
+
+# 搜索 GitHub 仓库
+bws site github/repo facebook/react
+```
+
+## 登录态管理
+
+adapter 运行在 OpenClaw 浏览器中。如果网站需要登录：
+
+1. 命令会返回 401/403 错误
+2. 在 OpenClaw 浏览器中打开网站并登录：
+   ```bash
+   openclaw browser open https://xiaohongshu.com
+   ```
+3. 重试命令
+
+## 添加私有 Adapter
+
+将自定义 adapter 放到 `~/.bws/sites/` 目录：
+
+```javascript
+/* @meta
+{
+  "name": "mysite/search",
+  "description": "搜索我的网站",
+  "domain": "mysite.com",
+  "args": { "query": { "required": true, "description": "搜索关键词" } },
+  "example": "bws site mysite/search 关键词"
+}
+*/
+async function(args) {
+  // 在浏览器上下文中执行
+  const results = document.querySelectorAll('.result');
+  return Array.from(results).map(el => ({
+    title: el.querySelector('.title').textContent,
+    url: el.querySelector('a').href
+  }));
+}
+```
+
+## 环境要求
+
+- Node.js >= 18
+- OpenClaw 环境
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1 @@
+#!/usr/bin/env node