Skip to content

Commit 8e199dd

Browse files
lidge-junclaude
andcommitted
docs: dashboard screenshot hero + collapsible bun-install
- Add a real screenshot of the redesigned dashboard (assets/dashboard.png) as a hero in all three READMEs and on the docs homepage (Astro optimizes it to a 35kB webp). - Add a collapsible "Don't have bun? install it first" <details> next to the install command in each README (macOS/Linux + Windows scripts), since the ocx bin is bun-native. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent f9d30b0 commit 8e199dd

6 files changed

Lines changed: 65 additions & 0 deletions

File tree

README.ko.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@
1515

1616
</div>
1717

18+
<p align="center">
19+
<img src="assets/dashboard.png" alt="opencodex 대시보드 — 프록시 상태·프로바이더·모델을 보여주는 다크 컨트롤 패널" width="820">
20+
</p>
21+
1822
Codex는 오직 Responses API(`/v1/responses`)만 사용합니다. opencodex는 Codex와 여러분의 LLM
1923
프로바이더 사이에 위치하여, 프로토콜을 실시간으로 변환합니다 — streaming, tool 호출, reasoning, 이미지까지
2024
모두 포함해서 — 양방향으로 동작합니다.
@@ -42,6 +46,23 @@ ocx start
4246
codex "Write a hello world in Rust"
4347
```
4448

49+
<details>
50+
<summary><b><a href="https://bun.sh">bun</a>이 없으신가요?</b> — 먼저 설치하세요 (opencodex는 bun에서 실행됩니다)</summary>
51+
52+
<br/>
53+
54+
```bash
55+
# macOS / Linux / WSL
56+
curl -fsSL https://bun.sh/install | bash
57+
58+
# Windows (PowerShell)
59+
powershell -c "irm bun.sh/install.ps1 | iex"
60+
```
61+
62+
설치 후 `bun install -g opencodex`를 다시 실행하세요. (`ocx` 바이너리는 bun 기반이라 bun이 `PATH`에 있어야 합니다.)
63+
64+
</details>
65+
4566
`provider/model` 형식으로 라우팅된 특정 모델을 지정할 수 있습니다:
4667

4768
```bash

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@
1515

1616
</div>
1717

18+
<p align="center">
19+
<img src="assets/dashboard.png" alt="opencodex dashboard — a dark provider control panel showing live proxy status, routed providers, and available models" width="820">
20+
</p>
21+
1822
Codex only speaks the Responses API (`/v1/responses`). opencodex sits between Codex and your LLM
1923
provider, translating the protocol on the fly — streaming, tool calls, reasoning, and images included
2024
— in both directions.
@@ -42,6 +46,23 @@ ocx start
4246
codex "Write a hello world in Rust"
4347
```
4448

49+
<details>
50+
<summary><b>Don't have <a href="https://bun.sh">bun</a>?</b> — install it first (opencodex runs on bun)</summary>
51+
52+
<br/>
53+
54+
```bash
55+
# macOS / Linux / WSL
56+
curl -fsSL https://bun.sh/install | bash
57+
58+
# Windows (PowerShell)
59+
powershell -c "irm bun.sh/install.ps1 | iex"
60+
```
61+
62+
Then re-run `bun install -g opencodex`. (The `ocx` binary is bun-native, so bun must be on your `PATH`.)
63+
64+
</details>
65+
4566
Target a specific routed model with the `provider/model` form:
4667

4768
```bash

README.zh-CN.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@
1515

1616
</div>
1717

18+
<p align="center">
19+
<img src="assets/dashboard.png" alt="opencodex 控制台 —— 展示代理状态、provider 与可用模型的深色控制面板" width="820">
20+
</p>
21+
1822
Codex 只能使用 Responses API(`/v1/responses`)。opencodex 位于 Codex 与你的 LLM
1923
provider 之间,实时翻译两者之间的协议 —— 包括 streaming、工具调用、推理(reasoning)和图像
2024
—— 并且是双向的。
@@ -42,6 +46,23 @@ ocx start
4246
codex "Write a hello world in Rust"
4347
```
4448

49+
<details>
50+
<summary><b>没有 <a href="https://bun.sh">bun</a>?</b> —— 先安装它(opencodex 运行在 bun 上)</summary>
51+
52+
<br/>
53+
54+
```bash
55+
# macOS / Linux / WSL
56+
curl -fsSL https://bun.sh/install | bash
57+
58+
# Windows (PowerShell)
59+
powershell -c "irm bun.sh/install.ps1 | iex"
60+
```
61+
62+
然后重新运行 `bun install -g opencodex`。(`ocx` 可执行文件是 bun 原生的,因此 bun 必须在你的 `PATH` 中。)
63+
64+
</details>
65+
4566
使用 `provider/model` 形式指定一个具体的已路由模型:
4667

4768
```bash

assets/dashboard.png

304 KB
Loading

docs-site/src/assets/dashboard.png

304 KB
Loading

docs-site/src/content/docs/index.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,8 @@ Codex CLI / App / SDK ──/v1/responses──▶ opencodex ──▶ Any provi
3232
OpenRouter · Azure · DeepSeek · GLM · …and OpenAI itself
3333
```
3434

35+
![The opencodex dashboard — a dark provider control panel showing live proxy status, routed providers, and available models](../../assets/dashboard.png)
36+
3537
<CardGrid stagger>
3638
<Card title="Any provider" icon="puzzle">
3739
Five adapters cover Anthropic Messages, Google Gemini, Azure, the OpenAI Responses passthrough,

0 commit comments

Comments
 (0)