You.com Web Search & Research API

🔍 AI Agent 的实时搜索与内容提取利器

面向 Bash 环境的 You.com 搜索 CLI 工具,支持实时爬取与内容提取,适合 Claude Code、Codex 等 AI Agent 集成,提供可验证引用与 JSON 管道输出。

收藏
4.9k
安装
1.9k
版本
2.0.2
CLS 安全扫描中
预计需要 3 分钟...

使用说明

核心用法

youdotcom-cli 是 You.com 官方为 Bash 环境开发的 CLI 工具,面向 Claude Code、Codex、Cursor 等 AI Agent 场景设计。核心功能分为两条命令线:

  • search:Web 搜索,支持 livecrawl 参数在单次调用中完成搜索+页面内容提取
  • contents:针对已知 URL 进行多格式内容提取(markdown/html/metadata)

所有交互通过 --json 参数传递 JSON 配置,输出为紧凑 JSON(无 .data 包装),可直接管道到 jqgrepawk 等工具。CLI 要求 Node.js 18+ 或 Bun 1.0+ 运行时,API 认证通过 YDC_API_KEY 环境变量完成。

典型工作流示例:

# 搜索并实时爬取内容
npx @youdotcom-oss/api search --json '{
  "query":"AI safety",
  "livecrawl":"web",
  "livecrawl_formats":"markdown"
}' --client ClaudeCode

显著优点

1. Livecrawl 一体化:搜索与内容提取合并为单次 API 调用,相比传统"先搜索再 fetch"模式显著降低延迟与代码复杂度
2. Schema 驱动--schema 参数暴露完整 JSON Schema,Agent 可程序化发现参数,提升自适应性

3. 管道友好:stdout 直接输出 JSON,stderr 分离错误信息,退出码规范(0/1/2),与 Unix 工具链无缝集成

4. 可验证引用:每个搜索结果附带 citation URL,支持学术与商业场景的溯源需求

5. 运行时灵活:同时支持 Node.js 与 Bun,Bun 路径性能更优

潜在缺点与局限性

1. 预发布版本风险:当前版本 0.3.0 处于 pre-1.0 阶段,官方明确提示 minor 版本(0.3→0.4)可能引入破坏性变更,需使用 ~0.3.0 锁定策略
2. 依赖外部运行时:非原生二进制,需预装 Node.js/Bun,在受限容器或离线环境部署成本较高

3. API 成本与配额:You.com API 按调用计费,高频 Agent 场景需自行实现配额监控与熔断机制

4. 内容安全风险livecrawl 返回的原始 HTML/Markdown 可能包含恶意脚本,文档明确警告需后处理 sanitization

5. 国内网络可达性:You.com 服务在全球部分区域访问质量不稳定,生产环境需评估网络延迟与可用性

适合人群

  • AI Agent 开发者:需要将实时 Web 搜索能力集成到 Claude Code、Codex、Cursor 等 Bash-based Agent 工作流
  • RAG 系统构建者:需要可溯源、带引用的网页内容作为知识库补充
  • 自动化脚本工程师:偏好 JSON-First、管道友好的 CLI 接口,而非传统 REST SDK

常规风险

| 风险类别 | 描述 | 缓解建议 |
|---------|------|---------|
| 供应链安全 | 包版本未锁定或来源未验证 | 使用 `~0.3.0` 锁定,验证 `dist.integrity`,提交 lockfile |
| 凭证泄露 | `YDC_API_KEY` 硬编码或日志暴露 | 环境变量隔离,日志脱敏,定期轮换 |
| 输入注入 | 用户输入直接拼接 JSON 导致语法错误或注入 | 使用 `jq -Rs` 转义,URL 正则校验 |
| 速率限制 | 高频调用触发 429 | 指数退避重试,配额监控面板 |
| 内容安全 | 爬取内容含恶意脚本 | 优先使用 markdown 输出,HTML 渲染前 sanitization |

You.com Web Search & Research API 内容

手动下载zip · 8.0 kB
SKILL.mdtext/markdown
请选择文件