|
1 | | -# lark-channel-bridge — Local Codex Session Handoff Extension |
| 1 | +# lark-channel-bridge — Windows Codex Session Remote Management Extension |
2 | 2 |
|
3 | 3 | **English** | [简体中文](./README.zh-CN.md) |
4 | 4 |
|
5 | | -> A Windows-focused extension of `lark-channel-bridge` for remote Codex CLI monitoring, safe session handoff/handback, and multi-session ownership management through Lark/Feishu. |
| 5 | +> A Windows-focused downstream extension of **`lark-channel-bridge`** for discovering and monitoring local Codex CLI sessions, safely transferring session ownership between Windows and Lark, and remotely managing multiple Codex sessions from Lark Mobile App or Lark Web. |
6 | 6 |
|
7 | | -The extension is designed to make Codex session operations practical from both **Lark Mobile App** and **Lark Web**. Interactive cards expose the current Lark binding, Windows runtime sessions, and the global Codex session inventory, so common remote operations can be performed without typing long Session IDs or opening a remote desktop session. |
| 7 | +## Upstream project — `lark-channel-bridge` |
| 8 | + |
| 9 | +This repository is built on top of the upstream **`lark-channel-bridge`** project. The upstream project name is `lark-channel-bridge`; its GitHub repository is [`zarazhangrui/lark-coding-agent-bridge`](https://github.com/zarazhangrui/lark-coding-agent-bridge). |
| 10 | + |
| 11 | +The upstream project provides the foundation used by this fork: a local bridge between **Feishu/Lark** and **Claude Code or Codex CLI**, with per-chat/topic session continuity, workspace switching, file/image forwarding, streaming/interactive cards, queueing, access controls, profiles, and background runtime management. |
| 12 | + |
| 13 | +Please treat the upstream documentation as the authoritative reference for the original bridge behavior, installation, supported agents, and general configuration: |
| 14 | + |
| 15 | +- **Upstream repository:** [`zarazhangrui/lark-coding-agent-bridge`](https://github.com/zarazhangrui/lark-coding-agent-bridge) |
| 16 | +- **Original English README:** [Upstream `README.md`](https://github.com/zarazhangrui/lark-coding-agent-bridge/blob/main/README.md) |
| 17 | +- **Original Chinese README:** [Upstream `README.zh.md`](https://github.com/zarazhangrui/lark-coding-agent-bridge/blob/main/README.zh.md) |
| 18 | + |
| 19 | +This fork intentionally keeps the upstream project prominent in the documentation. The features below are **extensions built on top of `lark-channel-bridge`**, not a replacement for the original project. |
| 20 | + |
| 21 | +## What this fork adds |
| 22 | + |
| 23 | +The upstream bridge already lets a Lark Chat / Group / Topic interact with a local coding agent. This fork adds a Windows-focused **Codex Session control plane** for Codex sessions that may have been started independently in Windows Terminal rather than created only through the current Lark scope. |
| 24 | + |
| 25 | +| Area | Upstream `lark-channel-bridge` | This fork adds | |
| 26 | +|---|---|---| |
| 27 | +| Lark/Feishu ↔ Claude Code / Codex bridge | Core upstream feature | Reused as the foundation | |
| 28 | +| Per-chat/topic session continuity | Core upstream feature | Preserved | |
| 29 | +| Workspace switching and saved workspaces | Core upstream feature | Preserved | |
| 30 | +| Streaming and interactive cards | Core upstream feature | Extended with session-control actions | |
| 31 | +| Windows Codex sessions started independently of Lark | Not the focus of the original Lark scope model | Automatic local discovery and monitoring | |
| 32 | +| Windows runtime view | — | `/windows status` | |
| 33 | +| Safe Windows writer release | — | `/windows release` with Release Agent | |
| 34 | +| Cross-runtime session inventory | — | `/session list` | |
| 35 | +| Detached Session → current Lark scope | — | `/session use` | |
| 36 | +| Windows → Lark ownership transfer | — | `/session handoff` | |
| 37 | +| Lark → Windows-ready handback | — | `/session handback` | |
| 38 | +| Session ownership model | Lark scope binding | Windows / Lark / Detached with a single-writer rule | |
| 39 | +| Mobile/Web remote session control | General Lark interaction | Session switching and ownership actions optimized for **Lark Mobile App** and **Lark Web** | |
| 40 | +| Action identity | Command-specific | Readable Thread Name in UI; exact full Session ID for execution | |
| 41 | + |
| 42 | +### Why these extensions exist |
| 43 | + |
| 44 | +A common workflow is to start several Codex CLI sessions directly on a Windows workstation and later leave the computer. The additional Observer, monitor, release, and ownership layers let Lark become a remote control surface for those existing sessions: |
| 45 | + |
| 46 | +```text |
| 47 | +Windows Terminal / codex3 |
| 48 | + │ |
| 49 | + ├─ Session A |
| 50 | + ├─ Session B |
| 51 | + └─ Session C |
| 52 | + │ |
| 53 | + ▼ |
| 54 | + Windows Observer layer |
| 55 | + │ |
| 56 | + ▼ |
| 57 | + .codex-monitor |
| 58 | + │ |
| 59 | + ▼ |
| 60 | + lark-channel-bridge |
| 61 | + │ |
| 62 | + ▼ |
| 63 | + Lark Mobile / Lark Web |
| 64 | +``` |
| 65 | + |
| 66 | +From Lark you can inspect Windows sessions, safely release a waiting Windows writer, hand a session to the current Lark scope, use a detached session, and hand the current Lark-owned session back to Windows without requiring Remote Desktop. |
8 | 67 |
|
9 | 68 | ## Remote Codex session management from Lark |
10 | 69 |
|
@@ -169,6 +228,12 @@ Do not replace the local build with `npm install -g lark-channel-bridge@latest`; |
169 | 228 | - [Lark / Bridge / Codex architecture](./local-docs/02-lark-bridge-codex-architecture.md) |
170 | 229 | - [Codex session management](./local-docs/03-codex-session-management.md) |
171 | 230 |
|
172 | | -## Upstream |
| 231 | +## Upstream and attribution |
| 232 | + |
| 233 | +This project extends **`lark-channel-bridge`** and depends on the upstream project's architecture and runtime behavior. |
| 234 | + |
| 235 | +- [Upstream repository](https://github.com/zarazhangrui/lark-coding-agent-bridge) |
| 236 | +- [Upstream English README](https://github.com/zarazhangrui/lark-coding-agent-bridge/blob/main/README.md) |
| 237 | +- [Upstream Chinese README](https://github.com/zarazhangrui/lark-coding-agent-bridge/blob/main/README.zh.md) |
173 | 238 |
|
174 | | -Based on `zarazhangrui/lark-coding-agent-bridge`. |
| 239 | +For base installation, supported agents, upstream commands, Feishu/Lark app setup, and general bridge configuration, follow the upstream README. The documentation in this repository focuses on the additional Windows Codex monitoring, remote session control, safe release, handoff/handback, and cross-runtime ownership features. |
0 commit comments