Skip to content

Commit 5a9e416

Browse files
committed
docs: update README and add screenshots
1 parent 8de42f5 commit 5a9e416

10 files changed

Lines changed: 88 additions & 14 deletions

File tree

README.md

Lines changed: 44 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,23 @@ Codeoff Mobile is a Flutter client for the local Codeoff desktop bridge. Pair it
1616

1717
The client talks to the bridge with Dart's standard `HttpClient` and a WebSocket session. No third-party networking or state-management package is required.
1818

19+
## Screenshots
20+
21+
<table align="center">
22+
<tr>
23+
<td><img src="docs/screenshots/recents.png" alt="Codeoff Mobile recent threads" width="603"></td>
24+
<td><img src="docs/screenshots/sidebar.png" alt="Codeoff Mobile sidebar" width="603"></td>
25+
<td><img src="docs/screenshots/conversation.png" alt="Codeoff Mobile conversation" width="603"></td>
26+
<td><img src="docs/screenshots/workdir.png" alt="Codeoff Mobile workspace files" width="603"></td>
27+
</tr>
28+
<tr>
29+
<td><img src="docs/screenshots/preview-code.png" alt="Codeoff Mobile code preview" width="603"></td>
30+
<td><img src="docs/screenshots/preview-image.png" alt="Codeoff Mobile image preview" width="603"></td>
31+
<td><img src="docs/screenshots/diff.png" alt="Codeoff Mobile diff preview" width="603"></td>
32+
<td><img src="docs/screenshots/approval.png" alt="Codeoff Mobile approval request" width="603"></td>
33+
</tr>
34+
</table>
35+
1936
## How it works
2037

2138
1. Codeoff Server starts the local Codex app-server and publishes its control API through a Cloudflare Tunnel.
@@ -27,20 +44,40 @@ The client talks to the bridge with Dart's standard `HttpClient` and a WebSocket
2744

2845
### Use
2946

30-
#### Android
47+
#### 1. Install and configure Codeoff Server
48+
49+
Install and launch [Codeoff Server](https://github.com/MaimoryLab/codeoff-server) first:
50+
51+
1. Install Node.js and the Codex CLI.
52+
2. Install `cloudflared` when the phone will connect from outside the local network; it is optional for local-network use.
53+
3. Start the Codex app-server in Codeoff Server. Start the Cloudflare Tunnel for remote access, or configure a custom domain when a stable URL is needed.
54+
4. Enable **Prevent system sleep** from the Codeoff Server menu bar item when long-running work must continue unattended.
55+
56+
#### 2. Install Codeoff Mobile
57+
58+
##### Android
3159

3260
Download the latest `app-release.apk` from the [Releases](https://github.com/MaimoryLab/codeoff/releases/latest) page and install it on an Android device.
3361

34-
#### iOS
62+
##### iOS
3563

3664
Install the current build through [TestFlight](https://testflight.apple.com/join/zyAzftVb).
3765

38-
#### Pair a device
66+
#### 3. Pair and connect
67+
68+
The recommended method is QR pairing:
69+
70+
1. In Codeoff Server, click **Bind new device**.
71+
2. In Codeoff Mobile, tap the QR scanner and scan the pairing QR code.
72+
3. The app reads the server address and one-time pairing code, pairs the device, and connects automatically.
73+
74+
For manual pairing:
75+
76+
1. Copy a listening address or Tunnel address and the pairing code from Codeoff Server.
77+
2. In Codeoff Mobile, enter the address and tap **Connect**.
78+
3. Enter the pairing code and device name when prompted.
3979

40-
1. Start Codeoff Server and enable its Cloudflare Tunnel.
41-
2. Copy the tunnel endpoint and one-time pairing code from the desktop panel.
42-
3. Enter both values in Codeoff Mobile and tap **Pair**.
43-
4. Keep the returned device token for later reconnects. The app stores it in secure device storage.
80+
After pairing, the device token is stored in secure storage for later reconnects.
4481

4582
### Develop
4683

README.zh-CN.md

Lines changed: 44 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,23 @@ Codeoff Mobile 是一个 Flutter 移动客户端,用于连接本地 Codeoff
1616

1717
客户端使用 Dart 标准库 `HttpClient` 和 WebSocket 会话与桥接服务通信,不依赖第三方网络或状态管理框架。
1818

19+
## 截图
20+
21+
<table align="center">
22+
<tr>
23+
<td><img src="docs/screenshots/recents.png" alt="Codeoff Mobile 最近对话" width="603"></td>
24+
<td><img src="docs/screenshots/sidebar.png" alt="Codeoff Mobile 侧边栏" width="603"></td>
25+
<td><img src="docs/screenshots/conversation.png" alt="Codeoff Mobile 对话" width="603"></td>
26+
<td><img src="docs/screenshots/workdir.png" alt="Codeoff Mobile 工作区文件" width="603"></td>
27+
</tr>
28+
<tr>
29+
<td><img src="docs/screenshots/preview-code.png" alt="Codeoff Mobile 代码预览" width="603"></td>
30+
<td><img src="docs/screenshots/preview-image.png" alt="Codeoff Mobile 图片预览" width="603"></td>
31+
<td><img src="docs/screenshots/diff.png" alt="Codeoff Mobile 差异预览" width="603"></td>
32+
<td><img src="docs/screenshots/approval.png" alt="Codeoff Mobile 审批请求" width="603"></td>
33+
</tr>
34+
</table>
35+
1936
## 工作原理
2037

2138
1. Codeoff Server 启动本地 Codex app-server,并通过 Cloudflare Tunnel 发布控制 API。
@@ -27,20 +44,40 @@ Codeoff Mobile 是一个 Flutter 移动客户端,用于连接本地 Codeoff
2744

2845
### 使用
2946

30-
#### Android
47+
#### 1. 安装并配置 Codeoff Server
48+
49+
先安装并启动 [Codeoff Server](https://github.com/MaimoryLab/codeoff-server)
50+
51+
1. 安装 Node.js 和 Codex CLI。
52+
2. 需要从局域网外连接手机时安装 `cloudflared`;仅在局域网内使用时可以跳过。
53+
3. 在 Codeoff Server 中启动 Codex app-server。需要远程访问时启动 Cloudflare Tunnel;需要固定地址时再配置自定义域名。
54+
4. 需要让长时间运行的任务不因系统休眠中断时,在 Codeoff Server 菜单栏菜单中启用 **防止系统休眠**
55+
56+
#### 2. 安装 Codeoff Mobile
57+
58+
##### Android
3159

3260
[Releases](https://github.com/MaimoryLab/codeoff/releases/latest) 页面下载最新的 `app-release.apk`,并安装到 Android 设备。
3361

34-
#### iOS
62+
##### iOS
3563

3664
通过 [TestFlight](https://testflight.apple.com/join/zyAzftVb) 安装当前版本。
3765

38-
#### 配对设备
66+
#### 3. 配对并连接
67+
68+
推荐使用二维码配对:
69+
70+
1. 在 Codeoff Server 中点击 **绑定新设备**
71+
2. 在 Codeoff Mobile 中点击二维码扫描按钮,扫描配对二维码。
72+
3. 应用会自动读取服务地址和一次性配对码,完成设备配对并自动连接。
73+
74+
手动配对:
75+
76+
1. 从 Codeoff Server 复制监听地址或 Tunnel 地址以及配对码。
77+
2. 在 Codeoff Mobile 中输入地址并点击 **连接**
78+
3. 按提示输入配对码和设备名称。
3979

40-
1. 启动 Codeoff Server,并启用 Cloudflare Tunnel。
41-
2. 从桌面面板复制 Tunnel 地址和一次性配对码。
42-
3. 在 Codeoff Mobile 中输入这两项并点击 **Pair**
43-
4. 保存返回的设备令牌,后续重新连接时会使用它。令牌会保存在设备安全存储中。
80+
配对完成后,设备令牌会保存在安全存储中,后续可以直接重新连接。
4481

4582
### 开发
4683

docs/screenshots/approval.png

247 KB
Loading

docs/screenshots/conversation.png

113 KB
Loading

docs/screenshots/diff.png

360 KB
Loading

docs/screenshots/preview-code.png

355 KB
Loading

docs/screenshots/preview-image.png

224 KB
Loading

docs/screenshots/recents.png

113 KB
Loading

docs/screenshots/sidebar.png

138 KB
Loading

docs/screenshots/workdir.png

157 KB
Loading

0 commit comments

Comments
 (0)