codex-to-im 0.1.0 → 0.1.2

package/README.md

@@ -38,7 +38,17 @@ Windows host installation guide: [docs/install-windows.md](D:/codex/Claude-to-IM
 ### Prerequisites
 
 - Node.js 20+
-- If you use the `codex` or `auto` runtime, install Codex CLI first
+- If you use the `codex` or `auto` runtime, complete Codex authentication under the same Windows user
+
+`codex-to-im` now ships with the required `@openai/codex-sdk` / Codex CLI platform dependency, so you do not need to install a separate global Codex CLI just to run the bridge.
+
+You still need Codex credentials to be available for the current user. Any of these is sufficient:
+
+- a logged-in Codex Windows App
+- an existing Codex CLI login state
+- `CTI_CODEX_API_KEY`, `CODEX_API_KEY`, or `OPENAI_API_KEY`
+
+If the machine does not have any Codex login state yet, the simplest path is still to install the global CLI once and log in:
 
 ```bash
 npm install -g @openai/codex
@@ -82,6 +92,18 @@ If you forget the current address, run:
 codex-to-im url
 ```
 
+Check the current local service state:
+
+```bash
+codex-to-im status
+```
+
+Stop the background UI and bridge:
+
+```bash
+codex-to-im stop
+```
+
 ## Main Workflow
 
 1. Open the workbench
@@ -117,6 +139,18 @@ If creating a new session fails with `Not inside a trusted directory`, either:
 - change the default working directory to a trusted Git repo, or
 - enable `Allow Codex outside trusted Git repos` in the basic settings and restart the bridge
 
+## Update
+
+On Windows, `npm update -g codex-to-im` can fail with `EBUSY` if the background UI or bridge is still running from the global install directory.
+
+Recommended update flow:
+
+```bash
+codex-to-im stop
+npm update -g codex-to-im
+codex-to-im
+```
+
 ## Optional Codex Integration
 
 The repo still includes a lightweight optional integration under `SKILL.md`.

package/README_CN.md

@@ -38,7 +38,17 @@ Windows 主机安装说明见：[docs/install-windows.md](D:/codex/Claude-to-IM-
 ### 依赖
 
 - Node.js 20+
-- 如果使用 `codex` 或 `auto` 运行时：先安装 Codex CLI
+- 如果使用 `codex` 或 `auto` 运行时：需要在同一 Windows 用户下完成 Codex 认证
+
+`codex-to-im` 当前已经随包带上运行所需的 `@openai/codex-sdk` / Codex CLI 平台依赖，正常使用 bridge 时不要求你额外再全局安装一份 Codex CLI。
+
+但你仍然需要让 Codex 在当前用户下可用。推荐满足以下任一条件：
+
+- 已安装并登录过 Codex Windows App
+- 已经有可用的 Codex CLI 登录态
+- 已配置 `CTI_CODEX_API_KEY`、`CODEX_API_KEY` 或 `OPENAI_API_KEY`
+
+如果你机器上还没有任何 Codex 登录态，最直接的做法仍然是临时安装一次全局 Codex CLI 并登录：
 
 ```bash
 npm install -g @openai/codex
@@ -82,6 +92,18 @@ http://127.0.0.1:4781
 codex-to-im url
 ```
 
+查看当前本地服务状态：
+
+```bash
+codex-to-im status
+```
+
+停止后台 UI 和 bridge：
+
+```bash
+codex-to-im stop
+```
+
 ## 主流程
 
 1. 打开工作台
@@ -117,6 +139,18 @@ codex-to-im url
 - 把默认工作目录改成一个你已经信任的 Git 仓库
 - 或在基础配置里打开“允许在未信任 Git 目录运行 Codex”，然后重启 Bridge
 
+## 更新
+
+Windows 上如果后台 UI 或 bridge 仍在运行，`npm update -g codex-to-im` 可能会因为安装目录被占用而报 `EBUSY`。
+
+推荐更新流程：
+
+```bash
+codex-to-im stop
+npm update -g codex-to-im
+codex-to-im
+```
+
 ## 可选 Codex 集成
 
 仓库里仍然保留了一个很薄的可选集成，定义在 `SKILL.md`。

package/config.env.example

@@ -2,16 +2,13 @@
 # Copy to ~/.codex-to-im/config.env and edit
 
 # Runtime backend: claude | codex | auto
-#   claude (default) — uses Claude Code CLI + @anthropic-ai/claude-agent-sdk
-#   codex  — uses @openai/codex-sdk (auth: codex auth login, or OPENAI_API_KEY)
+#   claude — uses Claude Code CLI + @anthropic-ai/claude-agent-sdk
+#   codex  (default) — uses @openai/codex-sdk (auth: codex auth login, or OPENAI_API_KEY)
 #   auto   — tries Claude first, falls back to Codex if CLI not found
-# If you plan to use the codex runtime, install Codex CLI first:
-#   npm install -g @openai/codex
-#   codex auth login
-CTI_RUNTIME=claude
-
-# Enabled channels (comma-separated: telegram,discord,feishu,qq,weixin)
-CTI_ENABLED_CHANNELS=telegram
+CTI_RUNTIME=codex
+
+# Enabled channels (comma-separated: telegram,discord,feishu,qq,weixin)
+CTI_ENABLED_CHANNELS=feishu
 
 # Default working directory for Codex / bridge sessions
 CTI_DEFAULT_WORKDIR=/path/to/your/project
@@ -39,13 +36,13 @@ CTI_DEFAULT_MODE=code
 # ANTHROPIC_BASE_URL=https://your-api-provider.com/v1
 # ANTHROPIC_AUTH_TOKEN=your-auth-token
 
-# ── Codex auth (optional — only if not using `codex auth login`) ──
-# Priority: CTI_CODEX_API_KEY > CODEX_API_KEY > OPENAI_API_KEY
-# CTI_CODEX_API_KEY=
-# CTI_CODEX_BASE_URL=
+# ── Codex auth (optional — only if not using `codex auth login`) ──
+# Priority: CTI_CODEX_API_KEY > CODEX_API_KEY > OPENAI_API_KEY
+# CTI_CODEX_API_KEY=
+# CTI_CODEX_BASE_URL=
 # Allow Codex to run when CTI_DEFAULT_WORKDIR is not inside a trusted Git repo.
-# Keep this off unless you intentionally want Codex to work in arbitrary folders.
-# CTI_CODEX_SKIP_GIT_REPO_CHECK=true
+# This project defaults it to true so first-time setup works more smoothly.
+CTI_CODEX_SKIP_GIT_REPO_CHECK=true
 
 # ── Telegram ──
 CTI_TG_BOT_TOKEN=your-telegram-bot-token

package/dist/cli.mjs

@@ -42,6 +42,15 @@ function readJsonFile(filePath, fallback) {
     return fallback;
   }
 }
+function readPid(filePath) {
+  try {
+    const raw = fs2.readFileSync(filePath, "utf-8").trim();
+    const pid = Number(raw);
+    return Number.isFinite(pid) ? pid : void 0;
+  } catch {
+    return void 0;
+  }
+}
 function isProcessAlive(pid) {
   if (!pid) return false;
   try {
@@ -62,6 +71,22 @@ function getCurrentUiServerUrl() {
   if (!status?.port) return void 0;
   return getUiServerUrl(status.port);
 }
+function getBridgeStatus() {
+  const status = readJsonFile(bridgeStatusFile, { running: false });
+  const pid = readPid(bridgePidFile) ?? status.pid;
+  if (!isProcessAlive(pid)) {
+    return {
+      ...status,
+      pid,
+      running: false
+    };
+  }
+  return {
+    ...status,
+    pid,
+    running: status.running ?? true
+  };
+}
 function getUiServerStatus() {
   const status = readJsonFile(uiStatusFile, { running: false, port: uiPort });
   if (!isProcessAlive(status.pid)) {
@@ -92,6 +117,33 @@ async function waitForUiServer(timeoutMs = 15e3) {
   }
   return getUiServerStatus();
 }
+async function stopBridge() {
+  const status = getBridgeStatus();
+  if (!status.pid || !isProcessAlive(status.pid)) {
+    return { ...status, running: false };
+  }
+  if (process.platform === "win32") {
+    await new Promise((resolve) => {
+      const killer = spawn("cmd", ["/c", "taskkill", "/PID", String(status.pid), "/T", "/F"], {
+        stdio: "ignore"
+      });
+      killer.on("exit", () => resolve());
+      killer.on("error", () => resolve());
+    });
+  } else {
+    try {
+      process.kill(status.pid, "SIGTERM");
+    } catch {
+    }
+  }
+  const startedAt = Date.now();
+  while (Date.now() - startedAt < 1e4) {
+    const next = getBridgeStatus();
+    if (!next.running) return next;
+    await sleep(300);
+  }
+  return getBridgeStatus();
+}
 async function ensureUiServerRunning() {
   ensureDirs();
   const current = getUiServerStatus();
@@ -118,6 +170,46 @@ async function ensureUiServerRunning() {
   }
   return status;
 }
+async function stopUiServer() {
+  const status = getUiServerStatus();
+  if (!status.pid || !isProcessAlive(status.pid)) {
+    const next2 = { ...status, running: false };
+    writeUiServerStatus(next2);
+    return next2;
+  }
+  if (process.platform === "win32") {
+    await new Promise((resolve) => {
+      const killer = spawn("cmd", ["/c", "taskkill", "/PID", String(status.pid), "/T", "/F"], {
+        stdio: "ignore"
+      });
+      killer.on("exit", () => resolve());
+      killer.on("error", () => resolve());
+    });
+  } else {
+    try {
+      process.kill(status.pid, "SIGTERM");
+    } catch {
+    }
+  }
+  const startedAt = Date.now();
+  while (Date.now() - startedAt < 1e4) {
+    const next2 = getUiServerStatus();
+    if (!next2.running) {
+      writeUiServerStatus({ ...next2, running: false });
+      return { ...next2, running: false };
+    }
+    await sleep(300);
+  }
+  const next = getUiServerStatus();
+  if (!next.running) {
+    writeUiServerStatus({ ...next, running: false });
+  }
+  return next;
+}
+function writeUiServerStatus(status) {
+  ensureDirs();
+  fs2.writeFileSync(uiStatusFile, JSON.stringify(status, null, 2), "utf-8");
+}
 function openBrowser(url) {
   if (process.platform === "win32") {
     const child2 = spawn("cmd", ["/c", "start", "", url], { detached: true, stdio: "ignore" });
@@ -171,8 +263,29 @@ async function main() {
 `);
       return;
     }
+    case "stop": {
+      const bridge = await stopBridge();
+      const ui = await stopUiServer();
+      process.stdout.write(
+        `Stopped services. UI running=${ui.running ? "yes" : "no"}, Bridge running=${bridge.running ? "yes" : "no"}
+`
+      );
+      return;
+    }
+    case "status": {
+      const ui = getUiServerStatus();
+      const bridge = getBridgeStatus();
+      const url = getCurrentUiServerUrl();
+      process.stdout.write(
+        [
+          `UI: ${ui.running ? "running" : "stopped"}${url ? ` (${url})` : ""}`,
+          `Bridge: ${bridge.running ? "running" : "stopped"}`
+        ].join("\n") + "\n"
+      );
+      return;
+    }
     default:
-      process.stdout.write("Usage: codex-to-im [open|url|share-feishu]\n");
+      process.stdout.write("Usage: codex-to-im [open|url|share-feishu|stop|status]\n");
   }
 }
 main().catch((error) => {