Skip to content

Commit 853d481

Browse files
committed
docs: add multilingual dashboard documentation
1 parent d27e9e2 commit 853d481

4 files changed

Lines changed: 437 additions & 18 deletions

File tree

README.ko.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<p align="right">
2-
🌐 <a href="README.md">English</a> · 한국어
2+
🌐 <a href="README.md">English</a> · 한국어 · <a href="README.zh.md">中文</a>
33
</p>
44

55
# CommandCode Bridge
@@ -27,13 +27,13 @@ CommandCode Bridge는 CommandCode 계정을 OpenAI-compatible HTTP API로 노출
2727
2828
## 한눈에 보기
2929

30-
| 영역 | 요약 |
31-
| --------- | ----------------------------------------------------------------------------------------------------- |
32-
| API 표면 | `/health`, `/dashboard`, `/v1/models`, `/v1/chat/completions`, redacted admin diagnostics. |
33-
| 핵심 가치 | OpenAI-compatible client가 요청마다 `cmd`를 실행하지 않고 CommandCode-backed model을 호출합니다. |
34-
| 라우팅 | daily-burn, balance-priority, round-robin, drain-first 정책 기반 multi-key credential 선택. |
35-
| 운영 | bind, routing, credential, model toggle, diagnostics, save, restart를 다루는 모바일 우선 dashboard. |
36-
| 안전 경계 | upstream secret은 번들하지 않으며 localhost 또는 신뢰하는 VPN/tailnet/private proxy에서만 노출합니다. |
30+
| 영역 | 요약 |
31+
| --------- | --------------------------------------------------------------------------------------------------------------------------- |
32+
| API 표면 | `/health`, `/dashboard`, `/v1/models`, `/v1/chat/completions`, redacted admin diagnostics. |
33+
| 핵심 가치 | OpenAI-compatible client가 요청마다 `cmd`를 실행하지 않고 CommandCode-backed model을 호출합니다. |
34+
| 라우팅 | daily-burn, balance-priority, round-robin, drain-first 정책 기반 multi-key credential 선택. |
35+
| 운영 | bind, routing, credential, model toggle, diagnostics, save, restart와 한국어/영어/중국어 UI를 다루는 모바일 우선 dashboard. |
36+
| 안전 경계 | upstream secret은 번들하지 않으며 localhost 또는 신뢰하는 VPN/tailnet/private proxy에서만 노출합니다. |
3737

3838
설치 후 one-shot smoke test:
3939

@@ -62,7 +62,7 @@ curl -fsS "$BRIDGE/v1/models" | head -c 400
6262
- visible output 없이 `finish_reason: length`로 끝난 응답은 기본적으로 빈 성공이 아니라 fail-closed 오류로 반환합니다.
6363
- CommandCode upstream credential을 CLI auth file, 단일 API key, multi-key env, JSON credentials file에서 로드합니다.
6464
- 여러 CommandCode key를 안전하게 돌려 쓰는 multi-key credential router를 포함합니다.
65-
- 서버 bind, routing policy, key 관리, model toggle, diagnostics, JSON 저장, restart를 관리하는 모바일 우선 `/dashboard`를 포함합니다.
65+
- 서버 bind, routing policy, key 관리, model toggle, diagnostics, JSON 저장, restart와 한국어/영어/중국어 localization을 관리하는 모바일 우선 `/dashboard`를 포함합니다.
6666
- 선택적 balance alert와, 여러 bridge host를 묶는 선택적 `commandcode-router` 프로세스를 포함합니다.
6767

6868
## 버전
@@ -310,6 +310,14 @@ http://<host-or-tailnet-ip>:9992/dashboard
310310

311311
대시보드는 의도적으로 모바일 우선입니다. 같은 trusted tailnet의 휴대폰에서도 운영하기 좋게 설계되어 있습니다.
312312

313+
### 대시보드 언어
314+
315+
- 대시보드는 한국어, 영어, 중국어 UI 문구를 내장합니다.
316+
- 한국어가 hard fallback 언어입니다. 첫 로드 시 브라우저 locale이 `en`으로 시작하면 영어, `zh`로 시작하면 중국어를 선택하고, 그 외에는 한국어를 사용합니다.
317+
- 좌상단의 작은 `CommandCode Bridge` 제목 옆 국기 버튼으로 수동 전환할 수 있습니다: 🇰🇷 한국어, 🇺🇸 영어, 🇨🇳 중국어.
318+
- 선택한 언어는 브라우저 `localStorage`에 저장되어 다음 방문에도 유지됩니다.
319+
- 활성 언어 국기는 컬러로, 비활성 언어 국기는 desaturated/grayscale로 표시됩니다.
320+
313321
### 대시보드 섹션
314322

315323
- **Header**

README.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<p align="right">
2-
🌐 English · <a href="README.ko.md">한국어</a>
2+
🌐 English · <a href="README.ko.md">한국어</a> · <a href="README.zh.md">中文</a>
33
</p>
44

55
# CommandCode Bridge
@@ -27,13 +27,13 @@ CommandCode Bridge is a trusted-environment HTTP bridge that exposes a small Ope
2727
2828
## At a glance
2929

30-
| Area | Summary |
31-
| --------------- | -------------------------------------------------------------------------------------------------------------- |
32-
| API surface | `/health`, `/dashboard`, `/v1/models`, `/v1/chat/completions`, and redacted admin diagnostics. |
33-
| Core value | OpenAI-compatible clients can use CommandCode-backed models without spawning `cmd` per request. |
34-
| Routing | Multi-key credential selection with daily-burn, balance-priority, round-robin, and drain-first policies. |
35-
| Operations | Mobile-first dashboard for bind settings, routing, credentials, model toggles, diagnostics, save, and restart. |
36-
| Safety boundary | No upstream secrets are bundled; expose only on localhost or a trusted VPN/tailnet/private proxy. |
30+
| Area | Summary |
31+
| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
32+
| API surface | `/health`, `/dashboard`, `/v1/models`, `/v1/chat/completions`, and redacted admin diagnostics. |
33+
| Core value | OpenAI-compatible clients can use CommandCode-backed models without spawning `cmd` per request. |
34+
| Routing | Multi-key credential selection with daily-burn, balance-priority, round-robin, and drain-first policies. |
35+
| Operations | Mobile-first dashboard for bind settings, routing, credentials, model toggles, diagnostics, save, restart, and Korean/English/Chinese UI. |
36+
| Safety boundary | No upstream secrets are bundled; expose only on localhost or a trusted VPN/tailnet/private proxy. |
3737

3838
One-shot smoke test after install:
3939

@@ -62,7 +62,7 @@ A healthy bridge returns JSON health/version data and a non-empty OpenAI-compati
6262
- Fails closed on empty visible `finish_reason: length` responses by default instead of returning a blank success.
6363
- Loads CommandCode upstream credentials from a CLI auth file, a single API key, a multi-key env var, or a JSON credentials file.
6464
- Includes a multi-key credential router with routing policies designed for rotating multiple CommandCode keys safely.
65-
- Includes a mobile-first `/dashboard` for server bind settings, routing policy, key management, model toggles, diagnostics, JSON save, and restart.
65+
- Includes a mobile-first `/dashboard` for server bind settings, routing policy, key management, model toggles, diagnostics, JSON save, restart, and Korean/English/Chinese localization.
6666
- Includes optional balance alerts and an optional `commandcode-router` process for routing across multiple bridge hosts.
6767

6868
## Version
@@ -310,6 +310,14 @@ http://<host-or-tailnet-ip>:9992/dashboard
310310
311311
The dashboard is intentionally mobile-first. It is useful from a phone on the same trusted tailnet.
312312
313+
### Dashboard languages
314+
315+
- The dashboard ships with Korean, English, and Chinese UI strings.
316+
- Korean is the hard fallback language. On first load, the dashboard chooses English or Chinese when the browser locale starts with `en` or `zh`; otherwise it uses Korean.
317+
- Use the flag buttons beside the compact `CommandCode Bridge` title to switch manually: 🇰🇷 Korean, 🇺🇸 English, 🇨🇳 Chinese.
318+
- The selected language is stored in browser `localStorage`, so subsequent dashboard visits keep the operator preference.
319+
- Active language flags render in color; inactive language flags are desaturated/grayscale.
320+
313321
### Dashboard sections
314322
315323
- **Header**

0 commit comments

Comments
 (0)