@bitkyc08/opencodex 2.1.1 → 2.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.ko.md CHANGED
@@ -36,12 +36,15 @@ Codex CLI / App / SDK ──/v1/responses──▶ opencodex ──▶ Any provi
36
36
  # 설치
37
37
  npm install -g @bitkyc08/opencodex # 또는: bun install -g @bitkyc08/opencodex
38
38
 
39
- # 대화형 설정 (config 작성 + Codex 자동 주입)
39
+ # 대화형 설정 (config 작성 + Codex 주입 + 자동 시작 shim 설치 선택)
40
40
  ocx init
41
41
 
42
42
  # 프록시 시작
43
43
  ocx start
44
44
 
45
+ # init에서 건너뛰었다면 나중에 온디맨드 자동 시작 shim 설치
46
+ ocx codex-shim install
47
+
45
48
  # Codex를 평소처럼 사용하세요 — opencodex를 통해 라우팅됩니다
46
49
  codex "Write a hello world in Rust"
47
50
  ```
@@ -122,15 +125,17 @@ codex -m "xai/grok-4" "이 PR을 리뷰해 줘"
122
125
 
123
126
  ```bash
124
127
  ocx init # 대화형 설정
125
- ocx start [--port 10100] # 프록시 시작
128
+ ocx start [--port 10100] # 프록시 시작; 포트가 사용 중이면 빈 포트로 자동 전환
126
129
  ocx stop # 프록시 중지 + Codex 원래 설정 복원
127
130
  ocx restore # 중지 없이 복원 (별칭: ocx eject)
131
+ ocx uninstall # service/shim/config 제거 + Codex 원본 복원
132
+ ocx ensure # 필요 시 시작 + Codex config/cache 갱신
128
133
  ocx sync # 모델 갱신 + Codex에 재주입
129
134
  ocx status # 프록시 실행 중인지 확인
130
135
  ocx login <xai|anthropic|kimi> # OAuth 로그인
131
136
  ocx logout <provider> # 저장된 로그인 정보 삭제
132
137
  ocx gui # 웹 대시보드 열기
133
- ocx codex-shim install # codex 실행 시 프록시 자동 시작
138
+ ocx codex-shim install # codex 실행 시 `ocx ensure` 실행
134
139
  ocx service <install|start|stop|status|uninstall> # 백그라운드 서비스 (launchd/systemd/schtasks)
135
140
  ocx update # opencodex를 최신 버전으로 업데이트
136
141
  ```
@@ -142,12 +147,26 @@ opencodex에는 프록시를 자동 시작하는 두 가지 방법이 있습니
142
147
  | | `ocx service install` | `ocx codex-shim install` |
143
148
  |---|---|---|
144
149
  | **방식** | OS 서비스 관리자 (launchd / systemd / schtasks) | `codex` 바이너리를 래퍼 스크립트로 교체 |
145
- | **시점** | 로그인 후 항상 실행 | 온디맨드 — `codex` 실행 시에만 시작 |
150
+ | **시점** | 로그인 후 항상 실행 | 온디맨드 — `codex` 실행 `ocx ensure` 실행 |
146
151
  | **재시작** | 크래시 시 자동 재시작 | `codex` 호출마다 한 번 시작 |
147
152
  | **Codex 업데이트** | 영향 없음 | `ocx codex-shim install` 또는 `ocx update` 시 복구 |
148
153
  | **제거** | `ocx service uninstall` | `ocx codex-shim uninstall` |
149
154
 
150
155
  항상 프록시를 켜두려면 **service** (개발 머신 권장), 가볍게 온디맨드로 쓰려면 **shim**을 사용하세요.
156
+ shim 자동 시작은 기본으로 켜져 있으며 GUI 대시보드에서 끌 수 있습니다. 설정된 프록시 포트가 이미 사용
157
+ 중이면 `ocx start`가 자동으로 다른 빈 로컬 포트를 고르고 Codex 설정도 그 포트로 갱신합니다.
158
+
159
+ ### 삭제
160
+
161
+ npm/bun 패키지를 지우기 전에 로컬 상태를 먼저 정리하세요:
162
+
163
+ ```bash
164
+ ocx uninstall
165
+ npm uninstall -g @bitkyc08/opencodex # 또는: bun remove -g @bitkyc08/opencodex
166
+ ```
167
+
168
+ `ocx uninstall`은 프록시 중지, 설치된 service 제거, Codex shim 제거, Codex config/catalog/history
169
+ 원복, `~/.opencodex` 삭제를 처리합니다.
151
170
 
152
171
  ## 설정
153
172
 
@@ -210,6 +229,12 @@ bun x tsc --noEmit # 타입 체크
210
229
 
211
230
  **[기여하기](https://lidge-jun.github.io/opencodex/ko/contributing/)** 를 참고하세요.
212
231
 
232
+ ## 면책 조항
233
+
234
+ opencodex는 독립적인 커뮤니티 프로젝트이며, **OpenAI, Anthropic 등 어떤 제공업체와도 제휴하거나 보증을 받지 않습니다.**
235
+
236
+ 일부 제공업체 — 특히 Anthropic (Claude) — 는 서드파티 프록시를 통한 API 트래픽 라우팅 시 계정을 정지하거나 제한할 수 있습니다. **사용에 따른 책임은 본인에게 있습니다 (UAYOR).** 제공업체를 연결하기 전에 해당 서비스 약관에서 프록시 기반 접근이 허용되는지 확인하세요. opencodex 유지보수자는 업스트림 제공업체의 계정 조치에 대해 책임을 지지 않습니다.
237
+
213
238
  ## 라이선스
214
239
 
215
240
  MIT
package/README.md CHANGED
@@ -40,12 +40,15 @@ Requires [Bun](https://bun.sh) 1.1+. All three platforms work natively (no WSL n
40
40
  # Install
41
41
  npm install -g @bitkyc08/opencodex # or: bun install -g @bitkyc08/opencodex
42
42
 
43
- # Interactive setup (writes config + injects into Codex)
43
+ # Interactive setup (writes config, injects into Codex, and offers autostart shim install)
44
44
  ocx init
45
45
 
46
46
  # Start the proxy
47
47
  ocx start
48
48
 
49
+ # If you skipped it during init, install the on-demand autostart shim later
50
+ ocx codex-shim install
51
+
49
52
  # Use Codex normally — it now routes through opencodex
50
53
  codex "Write a hello world in Rust"
51
54
  ```
@@ -144,11 +147,13 @@ Plus DeepSeek, Groq, OpenRouter, Together, Fireworks, Cerebras, Mistral, Hugging
144
147
 
145
148
  ```bash
146
149
  ocx init # interactive setup
147
- ocx start [--port 10100] # start the proxy
150
+ ocx start [--port 10100] # start the proxy; falls back to a free port if busy
148
151
  ocx stop # stop + restore native Codex
149
152
  ocx restore # restore without stopping (alias: ocx eject)
153
+ ocx uninstall # remove service/shim/config and restore native Codex
154
+ ocx ensure # start if needed + refresh Codex config/cache
150
155
  ocx sync # refresh models + re-inject into Codex
151
- ocx codex-shim install # auto-start the proxy whenever `codex` is launched
156
+ ocx codex-shim install # run `ocx ensure` whenever `codex` is launched
152
157
  ocx status # is the proxy running?
153
158
  ocx login <xai|anthropic|kimi> # OAuth login
154
159
  ocx logout <provider> # remove a stored login
@@ -164,13 +169,27 @@ opencodex has two ways to auto-start the proxy:
164
169
  | | `ocx service install` | `ocx codex-shim install` |
165
170
  |---|---|---|
166
171
  | **How** | OS service manager (launchd / systemd / schtasks) | Replaces the `codex` binary with a wrapper script |
167
- | **When** | Always running after login | On-demand — starts only when `codex` is launched |
172
+ | **When** | Always running after login | On-demand — runs `ocx ensure` when `codex` is launched |
168
173
  | **Restart** | Auto-restarts on crash | Starts once per `codex` invocation |
169
174
  | **Codex updates** | Unaffected | Repairs on next `ocx codex-shim install` or `ocx update` |
170
175
  | **Remove** | `ocx service uninstall` | `ocx codex-shim uninstall` |
171
176
 
172
177
  Use the **service** for always-on proxy (recommended for development machines). Use the **shim** for
173
- lightweight, on-demand proxy startup without a background daemon.
178
+ lightweight, on-demand proxy startup without a background daemon. Shim autostart is enabled by default
179
+ and can be disabled from the GUI dashboard. If the configured proxy port is already busy, `ocx start`
180
+ automatically picks another free local port and updates Codex to use it.
181
+
182
+ ### Uninstall
183
+
184
+ Before removing the npm/bun package, clean up local state:
185
+
186
+ ```bash
187
+ ocx uninstall
188
+ npm uninstall -g @bitkyc08/opencodex # or: bun remove -g @bitkyc08/opencodex
189
+ ```
190
+
191
+ `ocx uninstall` stops the proxy, removes any installed service, removes the Codex shim, restores
192
+ native Codex config/catalog/history, and deletes `~/.opencodex`.
174
193
 
175
194
  ## Configuration
176
195
 
@@ -244,6 +263,12 @@ bun x tsc --noEmit # typecheck
244
263
 
245
264
  See **[Contributing](https://lidge-jun.github.io/opencodex/contributing/)**.
246
265
 
266
+ ## Disclaimer
267
+
268
+ opencodex is an independent, community-maintained project and is **not affiliated with or endorsed by OpenAI, Anthropic, or any other provider**.
269
+
270
+ Some providers — notably Anthropic (Claude) — may suspend or restrict accounts that route API traffic through third-party proxies. **Use at your own risk (UAYOR).** Before connecting a provider, review its Terms of Service to confirm that proxy-based access is permitted. The opencodex maintainers are not responsible for any account actions taken by upstream providers.
271
+
247
272
  ## License
248
273
 
249
274
  MIT
package/README.zh-CN.md CHANGED
@@ -214,6 +214,12 @@ bun x tsc --noEmit # 类型检查
214
214
 
215
215
  参阅 **[贡献指南](https://lidge-jun.github.io/opencodex/zh-cn/contributing/)**。
216
216
 
217
+ ## 免责声明
218
+
219
+ opencodex 是一个独立的社区维护项目,**与 OpenAI、Anthropic 或任何其他提供商无关,也未获得其认可。**
220
+
221
+ 某些提供商——尤其是 Anthropic (Claude)——可能会对通过第三方代理路由 API 流量的账户进行暂停或限制。**使用风险自负 (UAYOR)。** 在连接提供商之前,请查阅其服务条款以确认是否允许基于代理的访问。opencodex 维护者不对上游提供商采取的任何账户操作承担责任。
222
+
217
223
  ## 许可证
218
224
 
219
225
  MIT