Skip to content

Commit e14b873

Browse files
committed
docs: clarify upstream origins and fork-specific session management
1 parent 2d752ae commit e14b873

5 files changed

Lines changed: 619 additions & 38 deletions

File tree

‎README.md‎

Lines changed: 70 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,69 @@
1-
# lark-channel-bridge — Local Codex Session Handoff Extension
1+
# lark-channel-bridge — Windows Codex Session Remote Management Extension
22

33
**English** | [简体中文](./README.zh-CN.md)
44

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.
66
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.
867

968
## Remote Codex session management from Lark
1069

@@ -169,6 +228,12 @@ Do not replace the local build with `npm install -g lark-channel-bridge@latest`;
169228
- [Lark / Bridge / Codex architecture](./local-docs/02-lark-bridge-codex-architecture.md)
170229
- [Codex session management](./local-docs/03-codex-session-management.md)
171230

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)
173238

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.

‎README.zh-CN.md‎

Lines changed: 70 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,69 @@
1-
# lark-channel-bridge — Local Codex Session Handoff Extension
1+
# lark-channel-bridge — Windows Codex Session 远程管理扩展
22

33
[English](./README.md) | **简体中文**
44

5-
> 本仓库是在上游 `lark-channel-bridge` 基础上维护的 Windows 本地增强版本,重点解决 **Codex CLI Session 的远程监控、安全 handoff / handback、多 Session ownership 管理,以及通过 Lark/飞书进行远程操作**。
5+
> 本仓库是在上游 **`lark-channel-bridge`** 基础上维护的 Windows / Codex 增强版本,重点增加本地 Codex CLI Session 的发现与监控、Windows 与 Lark 之间的安全 ownership transfer,以及通过 Lark Mobile App / Lark Web 远程管理多个 Codex Session 的能力。
66
7-
本次增强的重点之一,是让这些 Session 操作在 **Lark Mobile App** 和 **Lark Web** 中都更容易完成。通过 Interactive Card,可以直接查看当前 Lark binding、Windows runtime Session 以及全局 Codex Session inventory,并通过按钮完成常见远程操作,不必在手机上反复输入较长的 Session ID,也不需要为了切换 Session 专门连接远程桌面。
7+
## 上游项目 — `lark-channel-bridge`
8+
9+
本仓库建立在上游 **`lark-channel-bridge`** 项目之上。上游项目名称是 `lark-channel-bridge`,其 GitHub 仓库为 [`zarazhangrui/lark-coding-agent-bridge`](https://github.com/zarazhangrui/lark-coding-agent-bridge)。
10+
11+
上游项目提供了本 fork 所依赖的核心基础:把 **飞书/Lark** 与本地 **Claude Code 或 Codex CLI** 连接起来,并提供 Chat / Topic 独立 Session、Workspace 切换、文件与图片传递、Streaming / Interactive Card、任务排队、权限控制、Profile 和后台运行机制等能力。
12+
13+
关于原版 Bridge 的安装、支持的 Agent、基础配置和通用行为,请以上游文档为准:
14+
15+
- **上游仓库:** [`zarazhangrui/lark-coding-agent-bridge`](https://github.com/zarazhangrui/lark-coding-agent-bridge)
16+
- **原版英文 README:** [Upstream `README.md`](https://github.com/zarazhangrui/lark-coding-agent-bridge/blob/main/README.md)
17+
- **原版中文 README:** [Upstream `README.zh.md`](https://github.com/zarazhangrui/lark-coding-agent-bridge/blob/main/README.zh.md)
18+
19+
本 fork 在主 README 中明确保留上游来源和 README 链接,是为了说明下面这些能力均建立在 `lark-channel-bridge` 之上,而不是对原项目的替代。
20+
21+
## 本 fork 新增了什么
22+
23+
上游 bridge 已经能够让一个 Lark Chat / Group / Topic 与本地 Coding Agent 交互。本 fork 进一步增加了一个面向 Windows 的 **Codex Session 控制层**,用于管理那些直接在 Windows Terminal 中启动、并不一定由当前 Lark scope 创建的 Codex Session。
24+
25+
| 能力 | 上游 `lark-channel-bridge` | 本 fork 新增 |
26+
|---|---|---|
27+
| Lark/飞书 ↔ Claude Code / Codex Bridge | 上游核心能力 | 直接复用 |
28+
| Chat / Topic 独立 Session | 上游核心能力 | 保留 |
29+
| Workspace 切换与保存 | 上游核心能力 | 保留 |
30+
| Streaming / Interactive Card | 上游核心能力 | 增加 Session 控制 Action |
31+
| 独立从 Windows 启动的 Codex Session | 不是原 Lark scope 模型的主要关注点 | 自动发现与监控 |
32+
| Windows Runtime 视图 | — | `/windows status` |
33+
| 安全释放 Windows writer | — | `/windows release` + Release Agent |
34+
| 跨运行时 Session inventory | — | `/session list` |
35+
| Detached Session → 当前 Lark scope | — | `/session use` |
36+
| Windows → Lark ownership transfer | — | `/session handoff` |
37+
| Lark → Windows-ready handback | — | `/session handback` |
38+
| Session ownership 模型 | Lark scope binding | Windows / Lark / Detached + 单 writer 规则 |
39+
| Mobile / Web 远程 Session 管理 | 通用 Lark 交互 | 针对 **Lark Mobile App** / **Lark Web** 优化 Session 切换与 ownership Action |
40+
| Action 身份 | 随命令而定 | UI 优先显示 Thread Name;底层执行始终使用 exact full Session ID |
41+
42+
### 为什么增加这些能力
43+
44+
一个典型场景是在 Windows 工作站中直接启动多个 Codex CLI Session,然后离开电脑。新增的 Observer、Monitor、Release 和 Ownership 层可以把这些已经存在的 Session 暴露给 Lark:
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+
这样无需连接 Remote Desktop,就可以从 Lark 查看 Windows Session、release Waiting 状态的 Windows writer、把 Session handoff 到当前 Lark scope、接管 Detached Session,并在之后 handback 给 Windows。
867

968
## 从 Lark 远程管理 Codex Session
1069

@@ -177,6 +236,12 @@ lark-channel-bridge start --profile codex
177236
- [Lark / Bridge / Codex 架构](./local-docs/02-lark-bridge-codex-architecture.zh-CN.md)
178237
- [Codex Session 管理](./local-docs/03-codex-session-management.zh-CN.md)
179238

180-
## 上游
239+
## 上游与致谢
240+
241+
本项目扩展自 **`lark-channel-bridge`**,基础架构与运行机制来自上游项目。
242+
243+
- [上游仓库](https://github.com/zarazhangrui/lark-coding-agent-bridge)
244+
- [上游英文 README](https://github.com/zarazhangrui/lark-coding-agent-bridge/blob/main/README.md)
245+
- [上游中文 README](https://github.com/zarazhangrui/lark-coding-agent-bridge/blob/main/README.zh.md)
181246

182-
基于 `zarazhangrui/lark-coding-agent-bridge`。
247+
关于基础安装、支持的 Agent、上游命令、飞书/Lark App 配置和通用 Bridge 行为,请以上游 README 为准。本仓库文档重点记录新增的 Windows Codex 监控、远程 Session 控制、安全 release、handoff/handback 和跨运行时 ownership 能力。

0 commit comments

Comments
 (0)