|
13 | 13 | </p> |
14 | 14 |
|
15 | 15 | <p align="center"> |
16 | | - <a href="README.md">English</a> · <a href="README.ko.md">한국어</a> · <a href="README.zh-CN.md">简体中文</a> · <a href="README.ru.md">Русский</a> · <a href="README.ja.md">日本語</a> · 📖 <a href="https://lidge-jun.github.io/opencodex/"><b>Full documentation →</b></a> |
| 16 | + <a href="README.md">English</a> · <a href="README.ko.md">한국어</a> · <a href="README.zh-CN.md">简体中文</a> · <a href="README.ru.md">Русский</a> · <a href="README.ja.md">日本語</a> · 📖 <a href="https://opencodex.me/"><b>Full documentation →</b></a> |
17 | 17 | </p> |
18 | 18 |
|
19 | 19 | <p align="center"> |
@@ -260,7 +260,7 @@ next Codex session. opencodex keeps these behaviors: |
260 | 260 | | Ollama / vLLM / LM Studio (local) | `openai-chat` | key (usually blank) | |
261 | 261 | | Any OpenAI-compatible endpoint | `openai-chat` | key | |
262 | 262 |
|
263 | | -Plus DeepSeek, Groq, OpenRouter, Together, Fireworks, Cerebras, Mistral, Hugging Face, NVIDIA NIM, MiniMax, Qwen Cloud, Tencent Cloud Coding Plan, SiliconFlow, and more. See the full list with `ocx init` or in the [provider docs](https://lidge-jun.github.io/opencodex/reference/configuration/). |
| 263 | +Plus DeepSeek, Groq, OpenRouter, Together, Fireworks, Cerebras, Mistral, Hugging Face, NVIDIA NIM, MiniMax, Qwen Cloud, Tencent Cloud Coding Plan, SiliconFlow, and more. See the full list with `ocx init` or in the [provider docs](https://opencodex.me/reference/configuration/). |
264 | 264 |
|
265 | 265 | Cursor support is a staged experimental bridge: it appears in `ocx init` and the dashboard Add |
266 | 266 | Provider picker as a local config with Cursor's static public model catalog. Live |
@@ -305,14 +305,20 @@ opencodex has two ways to auto-start the proxy: |
305 | 305 | | **How** | OS service manager (launchd / systemd / schtasks) | Wraps script launchers for `codex`; real `codex.exe` is left untouched | |
306 | 306 | | **When** | Always running after login | On-demand — runs `ocx ensure` when `codex` is launched | |
307 | 307 | | **Restart** | Auto-restarts on crash | Starts once per `codex` invocation | |
308 | | -| **Codex updates** | Unaffected | Repairs on next `ocx codex-shim install` or `ocx update` | |
| 308 | +| **Codex updates** | Unaffected | A completed stable launcher replacement is repaired by the next ordinary `ocx` command | |
309 | 309 | | **Remove** | `ocx service uninstall` | `ocx codex-shim uninstall` | |
310 | 310 |
|
311 | 311 | Use the **service** for always-on proxy (recommended for development machines). Use the **shim** for |
312 | 312 | lightweight, on-demand proxy startup without a background daemon. Shim autostart is enabled by default |
313 | 313 | and can be disabled from the GUI dashboard. If the configured proxy port is already busy, `ocx start` |
314 | 314 | automatically picks another free local port and updates Codex to use it. |
315 | 315 |
|
| 316 | +If an external Codex update overwrites an installed shim, the next ordinary `ocx` command backs up |
| 317 | +the stable new launcher and restores the shim. A launcher that is still changing is left untouched |
| 318 | +and retried later. Repair failures warn without failing the requested command; use |
| 319 | +`ocx codex-shim install` as the manual fallback. Set `codexShimAutoRestore` to `false`, or set |
| 320 | +`OPENCODEX_CODEX_SHIM_AUTO_RESTORE=0` for a process-level opt-out. |
| 321 | + |
316 | 322 | ### Uninstall |
317 | 323 |
|
318 | 324 | Before removing the npm package, clean up local state: |
@@ -438,11 +444,11 @@ backup support existed, you can also run the explicit recovery command: |
438 | 444 | ocx recover-history --legacy-openai |
439 | 445 | ``` |
440 | 446 |
|
441 | | -See the **[Configuration reference](https://lidge-jun.github.io/opencodex/reference/configuration/)** for every field. |
| 447 | +See the **[Configuration reference](https://opencodex.me/reference/configuration/)** for every field. |
442 | 448 |
|
443 | 449 | ## Documentation |
444 | 450 |
|
445 | | -The public docs — install, providers, routing, sidecars, Codex integration, Codex App model picker, and CLI/config reference — are built from [`docs-site/`](./docs-site) and published to **[lidge-jun.github.io/opencodex](https://lidge-jun.github.io/opencodex/)**. |
| 451 | +The public docs — install, providers, routing, sidecars, Codex integration, Codex App model picker, and CLI/config reference — are built from [`docs-site/`](./docs-site) and published to **[opencodex.me](https://opencodex.me/)**. |
446 | 452 |
|
447 | 453 | Maintainer source-of-truth notes live under [`structure/`](./structure). Historical investigations remain under [`docs/`](./docs). |
448 | 454 | Contributor setup lives in [`CONTRIBUTING.md`](./CONTRIBUTING.md), and security reporting guidance |
|
0 commit comments