pi-cliproxyapi-websearch

A native web search extension (web_search) tailored for the CLIProxyAPI provider in Pi.

Zero configuration, zero secondary authentication, no extra API keys or OAuth required — seamlessly reuses existing cliproxyapi connections and model credentials from Pi.

English | 中文说明

⚠️ Prerequisites:

• CLIProxyAPI Server: Version v7.3.5 or higher.
• Pi Provider Extension: Must be paired with @router-for-me/pi-cliproxyapi-provider.

Features

• Zero Config, No Re-authentication: Directly reuses the authenticated CLIProxyAPI credentials (BaseURL and API Key) from Pi's model runtime. No re-OAuth or manual API key configuration required.
• Dynamic Current Model / Automatic Fallback:
  • By default, uses the active cliproxyapi model from your current session to perform searches (supports gemini-3.8-flash-high, gpt-5.6-*, gpt-6-*, grok-*, gpt-5.5, etc.).
  • If the active session uses a model from another provider, the extension automatically selects an available search model from the registered cliproxyapi catalog.
• Isolated Sub-request Architecture: Dispatches lightweight sub-requests containing only the native web_search tool, completely isolated from local coding tools to prevent mixed-tool conflicts and server-side stripping issues.
• Model Switching Command: Built-in /websearch-model slash command to inspect, configure, or reset the search model anytime.
• Execution Time Display: Displays execution duration (Took X.Xs / Elapsed X.Xs) matching Pi's shell tool conventions.

Installation

# 1. Install the CLIProxyAPI Provider extension (if not already installed)
pi install npm:@router-for-me/pi-cliproxyapi-provider

# 2. Install this search extension
pi install npm:pi-cliproxyapi-websearch

Local development or testing: pi -e ./extensions/index.ts

Commands

Codemode

With Codemode enabled in Pi 1.0.0, scripts can call tools.web_search({ query }) and receive an object with:

• query: the trimmed search query.
• text: the same Markdown summary returned by a normal tool call.
• sources: all unique reported sources as { url, title? } (an empty array when none are reported).

To enable Codemode in Pi, add +codemode to defaultTools in ~/.pi/agent/settings.json:

{
  "defaultTools": ["+codemode"]
}

Example Codemode script:

const results = await Promise.all([
  tools.web_search({ query: "Node.js release notes" }),
  tools.web_search({ query: "TypeScript release notes" }),
]);
for (const result of results) {
  text(result.text);
  text(result.sources.map((source) => source.url));
}

The tool remains available for normal calls without Codemode; text output, progress updates, and terminal rendering are unchanged. Failed searches reject the script call rather than returning an empty success result.

Development

npm ci
npm run check  # TypeScript typecheck + unit tests (Node.js native test runner)

中文说明

专为 Pi 的 CLIProxyAPI Provider 打造的原生网络搜索插件（web_search）。

零配置、零二次认证、无需额外 API Key 或 OAuth，直接复用 Pi 中已有的 cliproxyapi 连接与模型凭据。

⚠️ 前置依赖：

• CLIProxyAPI 服务端：版本需为 v7.3.5 及以上。
• Pi Provider 插件：必须搭配 @router-for-me/pi-cliproxyapi-provider 使用。

特性

• 零配置、免二次认证：直接从 Pi 的模型运行时中复用已登录的 CLIProxyAPI 凭据（BaseURL 与 API Key），无需重新 OAuth，也无需手动配置 API Key。
• 直接使用当前模型 / 自动回退：
  • 默认跟随当前会话中的 cliproxyapi 模型执行搜索（支持 gemini-3.8-flash-high、gpt-5.6-*、gpt-6-*、grok-*、gpt-5.5 等系列）。
  • 若当前会话使用的是其他 Provider 模型，插件会自动从已注册的 cliproxyapi 目录中选取可用的搜索模型回退执行。
• 纯净子请求架构：后台发起仅包含原生 web_search 的纯净轻量请求，完全剥离本地编码工具，彻底杜绝混合工具冲突与服务端剥离问题。
• 模型切换命令：内置 /websearch-model 命令，随时查看、指定或重置搜索模型。
• 执行时间显示：显示执行耗时（Took X.Xs / Elapsed X.Xs），与 Pi 的终端工具规范一致。

安装

# 1. 安装 CLIProxyAPI Provider 插件（若未安装）
pi install npm:@router-for-me/pi-cliproxyapi-provider

# 2. 安装本搜索插件
pi install npm:pi-cliproxyapi-websearch

本地开发或测试加载：pi -e ./extensions/index.ts

命令

Codemode

在 Pi 1.0.0 中启用 Codemode 后，脚本可通过 tools.web_search({ query }) 获取结构化对象：

• query：去除首尾空白后的查询。
• text：与普通工具调用相同的 Markdown 搜索总结。
• sources：返回的全部去重来源，格式为 { url, title? }，无来源时为空数组。

要在 Pi 中启用 Codemode，推荐在 ~/.pi/agent/settings.json 的 defaultTools 中添加 +codemode：

{
  "defaultTools": ["+codemode"]
}

Codemode 脚本示例：

const results = await Promise.all([
  tools.web_search({ query: "Node.js 发布说明" }),
  tools.web_search({ query: "TypeScript 发布说明" }),
]);
for (const result of results) {
  text(result.text);
  text(result.sources.map((source) => source.url));
}

未启用 Codemode 时仍可正常调用，文本输出、进度通知和终端展示保持不变。搜索失败时脚本调用会抛出错误，不会返回空的成功结果。

开发

npm ci
npm run check  # TypeScript 类型检查 + 单元测试（Node.js 原生测试套件）