Skip to content

Commit 85b3d7d

Browse files
committed
docs: add README smoke test
1 parent f751e1a commit 85b3d7d

2 files changed

Lines changed: 22 additions & 2 deletions

File tree

README.ko.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,16 @@ CommandCode Bridge는 CommandCode 계정을 OpenAI-compatible HTTP API로 노출
3535
| 운영 | bind, routing, credential, model toggle, diagnostics, save, restart를 다루는 모바일 우선 dashboard. |
3636
| 안전 경계 | upstream secret은 번들하지 않으며 localhost 또는 신뢰하는 VPN/tailnet/private proxy에서만 노출합니다. |
3737

38+
설치 후 one-shot smoke test:
39+
40+
```bash
41+
BRIDGE=http://127.0.0.1:9992; \
42+
curl -fsS "$BRIDGE/health" && echo && \
43+
curl -fsS "$BRIDGE/v1/models" | head -c 400
44+
```
45+
46+
정상 상태에서는 JSON health/version 정보와 비어 있지 않은 OpenAI-compatible model list가 반환됩니다. 실제 chat completion은 CommandCode 계정에 사용 가능한 credit이 있는지 확인한 뒤 실행하세요.
47+
3848
## 이 브리지가 하는 일
3949

4050
- OpenAI-compatible 엔드포인트 제공:
@@ -588,7 +598,7 @@ npm run verify
588598
- 이 브리지는 CommandCode account limits, billing, rate limits, terms를 우회하지 않습니다.
589599
- 이 브리지는 일반 public proxy service가 아닙니다.
590600
591-
자세한 내용은 `docs/SECURITY.md`를 참고하십시오. 비공개 보안 제보는 가능한 경우 GitHub security advisory를 사용하거나 `yelixir.dev@gmail.com`으로 연락하세요.
601+
자세한 내용은 `docs/SECURITY.md`를 참고하십시오. 비공개 보안 제보는 GitHub Security Advisory form(`https://github.com/yelixir-dev/commandcode-bridge/security/advisories/new`)을 사용하거나 `yelixir.dev@gmail.com`으로 연락하세요.
592602
593603
## 문제 해결
594604

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,16 @@ CommandCode Bridge is a trusted-environment HTTP bridge that exposes a small Ope
3535
| Operations | Mobile-first dashboard for bind settings, routing, credentials, model toggles, diagnostics, save, and restart. |
3636
| Safety boundary | No upstream secrets are bundled; expose only on localhost or a trusted VPN/tailnet/private proxy. |
3737

38+
One-shot smoke test after install:
39+
40+
```bash
41+
BRIDGE=http://127.0.0.1:9992; \
42+
curl -fsS "$BRIDGE/health" && echo && \
43+
curl -fsS "$BRIDGE/v1/models" | head -c 400
44+
```
45+
46+
A healthy bridge returns JSON health/version data and a non-empty OpenAI-compatible model list. Run a chat completion only after confirming your CommandCode account has usable credits.
47+
3848
## What this bridge does
3949

4050
- Provides OpenAI-compatible endpoints:
@@ -588,7 +598,7 @@ npm run verify
588598
- The bridge does not bypass CommandCode account limits, billing, rate limits, or terms.
589599
- The bridge is not a general public proxy service.
590600
591-
See `docs/SECURITY.md` for more details. For private security reports, use GitHub security advisories when available or contact `yelixir.dev@gmail.com`.
601+
See `docs/SECURITY.md` for more details. For private security reports, use the GitHub Security Advisory form at `https://github.com/yelixir-dev/commandcode-bridge/security/advisories/new` or email `yelixir.dev@gmail.com`.
592602
593603
## Troubleshooting
594604

0 commit comments

Comments
 (0)