betahi-copilot-bridge 0.20.3 → 0.20.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,7 +1,7 @@
1
1
  <h1 align="center">copilot-bridge</h1>
2
2
 
3
3
  <p align="center">
4
- <a href="https://www.npmjs.com/package/betahi-copilot-bridge"><img src="https://img.shields.io/npm/v/betahi-copilot-bridge.svg?v=0.20.3" alt="npm version"></a>
4
+ <a href="https://www.npmjs.com/package/betahi-copilot-bridge"><img src="https://img.shields.io/npm/v/betahi-copilot-bridge.svg?v=0.20.5" alt="npm version"></a>
5
5
  <a href="https://github.com/betahi/copilot-bridge/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/betahi-copilot-bridge.svg" alt="license"></a>
6
6
  </p>
7
7
 
@@ -11,6 +11,19 @@
11
11
  > This is an unofficial bridge for the GitHub Copilot API and may break if the
12
12
  > upstream API changes.
13
13
 
14
+ ## Contents
15
+ - [Demo](#demo)
16
+ - [Install & run](#install--run)
17
+ - [Configure Codex CLI](#configure-codex-cli)
18
+ - [Configure Claude Code](#configure-claude-code)
19
+ - [Web Search](#web-search)
20
+ - [Start flags](#start-flags)
21
+ - [Environment overrides](#environment-overrides)
22
+ - [Supported models](#supported-models)
23
+ - [Development](#development)
24
+ - [Acknowledgements](#acknowledgements)
25
+ - [License](#license)
26
+
14
27
  ## Demo
15
28
 
16
29
  ### Codex CLI
@@ -128,6 +141,38 @@ project-local `.claude/settings.json` and `.claude/settings.local.json` and
128
141
  applied to Claude requests only when the model supports reasoning. If it is not
129
142
  configured, Claude requests do not infer or attach a reasoning effort.
130
143
 
144
+ ## Web Search
145
+
146
+ Not every Copilot model can run web search. If web search is not configured or
147
+ the selected backend cannot search, the bridge tells the client how to configure
148
+ `COPILOT_WEB_SEARCH_BACKEND` and does not switch models automatically.
149
+
150
+ For Claude Code, configure web search in the user-level
151
+ `~/.claude/settings.json`:
152
+
153
+ ```json
154
+ {
155
+ "env": {
156
+ "COPILOT_WEB_SEARCH_BACKEND": "gpt-5.5"
157
+ }
158
+ }
159
+ ```
160
+
161
+ For Codex CLI, configure the same backend as a top-level key in
162
+ `~/.codex/config.toml`:
163
+
164
+ ```toml
165
+ COPILOT_WEB_SEARCH_BACKEND = "gpt-5.5"
166
+ ```
167
+
168
+ | Value | Search path | Requirement |
169
+ | ----- | ----------- | ----------- |
170
+ | Copilot model id, for example `gpt-5.5` | Copilot HTTP `/responses` + `web_search_preview` | The model must support Copilot Responses web search. |
171
+ | `searxng`, use `"COPILOT_WEB_SEARCH_BACKEND": "searxng"` | Local SearXNG at `http://localhost:8080` | Start SearXNG yourself. Setup guide: https://github.com/betaHi/openclaw-searxng-search. |
172
+ | `copilot-cli` or `copilot`, use `"COPILOT_WEB_SEARCH_BACKEND": "copilot-cli"` | GitHub Copilot CLI `web_search` tool, using the current request model | Install and sign in to GitHub Copilot CLI yourself. |
173
+
174
+ The bridge never installs Docker, SearXNG, or Copilot CLI automatically.
175
+
131
176
  ## Start flags
132
177
 
133
178
  Common: