Skip to content

Commit 05151e8

Browse files
committed
docs: add README infographic and summary
1 parent 4b03ed3 commit 05151e8

3 files changed

Lines changed: 76 additions & 2 deletions

File tree

README.ko.md

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,40 @@
1+
<p align="right">
2+
🌐 <a href="README.md">English</a> · 한국어
3+
</p>
4+
15
# CommandCode Bridge
26

3-
[English README](./README.md)
7+
<p align="center">
8+
<img src="docs/assets/readme/commandcode-bridge-overview.png" alt="CommandCode Bridge 구조 개요" width="760">
9+
</p>
10+
11+
<p align="center">
12+
<strong>신뢰 환경에서 CommandCode를 OpenAI-compatible API로 쓰기 위한 게이트웨이.</strong>
13+
</p>
14+
15+
<p align="center">
16+
<a href=".github/workflows/ci.yml"><img src="https://img.shields.io/badge/CI-GitHub%20Actions-5865f2?style=flat-square" alt="CI workflow"></a>
17+
<a href="LICENSE"><img src="https://img.shields.io/badge/License-MIT-2ea44f?style=flat-square" alt="MIT License"></a>
18+
<img src="https://img.shields.io/badge/Node.js-20%2B-5fa04e?style=flat-square" alt="Node.js 20+">
19+
<img src="https://img.shields.io/badge/API-OpenAI--compatible-6b7280?style=flat-square" alt="OpenAI-compatible API">
20+
</p>
421

522
CommandCode Bridge는 CommandCode 계정을 OpenAI-compatible HTTP API로 노출하는 신뢰 환경용 브리지입니다. 로컬, LAN, VPN, tailnet 클라이언트가 표준 `/v1/models`, `/v1/chat/completions` 형식으로 CommandCode-backed 모델을 호출할 수 있게 해줍니다.
623

724
> **CommandCode가 필요합니다.** 이 프로젝트는 공개 독립형 DeepSeek 프록시가 아니며, CommandCode CLI 번들을 포함하거나 재배포하지 않습니다. 공식 CommandCode CLI/account 환경(`command-code` npm package의 `cmd`) 또는 동등한 CommandCode API credential이 필요합니다. 공식 설치/인증은 <https://commandcode.ai/install>에서 진행하십시오.
825
926
> **상태.** 내부/신뢰 환경용 브리지입니다. upstream CommandCode `/alpha/generate` 경로는 alpha/internal API 성격이므로 변경될 수 있습니다.
1027
28+
## 한눈에 보기
29+
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에서만 노출합니다. |
37+
1138
## 이 브리지가 하는 일
1239

1340
- OpenAI-compatible 엔드포인트 제공:
@@ -625,6 +652,16 @@ ss -ltnp '( sport = :9992 )'
625652
626653
충돌 process를 멈추거나 `PORT`를 바꾸십시오.
627654
655+
## Contributing
656+
657+
브리지의 신뢰 경계를 유지하는 변경은 환영합니다. Upstream secret을 번들하지 않고, public internet 기본 노출을 만들지 않으며, CommandCode CLI를 재배포하지 않는 방향이어야 합니다. 변경 전 다음을 실행하십시오.
658+
659+
```bash
660+
npm run verify
661+
```
662+
663+
보안에 민감한 변경은 먼저 `docs/SECURITY.md`를 읽고, issue/log/screenshot/fixture에 credential, local env file, private topology, billing detail이 들어가지 않게 하십시오.
664+
628665
## 문서 지도
629666
630667
- `README.md` — 영어 README.

README.md

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,40 @@
1+
<p align="right">
2+
🌐 English · <a href="README.ko.md">한국어</a>
3+
</p>
4+
15
# CommandCode Bridge
26

3-
[한국어 README](./README.ko.md)
7+
<p align="center">
8+
<img src="docs/assets/readme/commandcode-bridge-overview.png" alt="CommandCode Bridge architecture overview" width="760">
9+
</p>
10+
11+
<p align="center">
12+
<strong>OpenAI-compatible gateway for trusted CommandCode deployments.</strong>
13+
</p>
14+
15+
<p align="center">
16+
<a href=".github/workflows/ci.yml"><img src="https://img.shields.io/badge/CI-GitHub%20Actions-5865f2?style=flat-square" alt="CI workflow"></a>
17+
<a href="LICENSE"><img src="https://img.shields.io/badge/License-MIT-2ea44f?style=flat-square" alt="MIT License"></a>
18+
<img src="https://img.shields.io/badge/Node.js-20%2B-5fa04e?style=flat-square" alt="Node.js 20+">
19+
<img src="https://img.shields.io/badge/API-OpenAI--compatible-6b7280?style=flat-square" alt="OpenAI-compatible API">
20+
</p>
421

522
CommandCode Bridge is a trusted-environment HTTP bridge that exposes a small OpenAI-compatible API for a CommandCode account. It lets local, LAN, VPN, or tailnet clients call CommandCode-backed models through standard `/v1/models` and `/v1/chat/completions` endpoints.
623

724
> **CommandCode required.** This project is not a public standalone DeepSeek proxy and does not include or repackage CommandCode's CLI bundle. You need the official CommandCode CLI/account environment (`cmd` from the `command-code` npm package) or equivalent CommandCode API credentials. Install/authenticate CommandCode from the official site: <https://commandcode.ai/install>.
825
926
> **Status.** Internal/trusted-environment bridge. The upstream CommandCode `/alpha/generate` path behaves like an alpha/internal API and may change.
1027
28+
## At a glance
29+
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. |
37+
1138
## What this bridge does
1239

1340
- Provides OpenAI-compatible endpoints:
@@ -625,6 +652,16 @@ ss -ltnp '( sport = :9992 )'
625652
626653
Stop the conflicting process or change `PORT`.
627654
655+
## Contributing
656+
657+
Contributions are welcome when they preserve the bridge's trust boundary: no bundled upstream secrets, no public-internet-by-default exposure, and no CommandCode CLI redistribution. Before opening a change, run:
658+
659+
```bash
660+
npm run verify
661+
```
662+
663+
For security-sensitive changes, read `docs/SECURITY.md` first and avoid including credentials, local env files, private topology, or billing details in issues, logs, screenshots, or fixtures.
664+
628665
## Documentation map
629666
630667
- `README.ko.md` — Korean README.
2.82 MB
Loading

0 commit comments

Comments
 (0)