You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+44-7Lines changed: 44 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,6 +16,23 @@ Codeoff Mobile is a Flutter client for the local Codeoff desktop bridge. Pair it
16
16
17
17
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.
18
18
19
+
## Screenshots
20
+
21
+
<tablealign="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
+
19
36
## How it works
20
37
21
38
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
27
44
28
45
### Use
29
46
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
31
59
32
60
Download the latest `app-release.apk` from the [Releases](https://github.com/MaimoryLab/codeoff/releases/latest) page and install it on an Android device.
33
61
34
-
#### iOS
62
+
#####iOS
35
63
36
64
Install the current build through [TestFlight](https://testflight.apple.com/join/zyAzftVb).
37
65
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.
39
79
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.
0 commit comments