@mattkotsenas/uplink 0.1.0 → 0.1.1

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2026 Copilot Uplink Contributors
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2026 Copilot Uplink Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,211 +1,211 @@
-# ⬆ Copilot Uplink
-
-**Remote control for GitHub Copilot CLI from your phone or any browser.**
-
-[![Build](https://img.shields.io/github/actions/workflow/status/MattKotsenas/uplink/ci.yml?branch=main)](https://github.com/MattKotsenas/uplink/actions)
-[![npm](https://img.shields.io/npm/v/@mattkotsenas/uplink)](https://www.npmjs.com/package/@mattkotsenas/uplink)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
-
-## What Is This?
-
-Copilot Uplink gives you a full chat interface to GitHub Copilot CLI — from
-your phone, a tablet, or any browser. Think of it like Claude Code's
-"Remote Control", but for Copilot CLI.
-
-A lightweight Node.js bridge spawns `copilot --acp --stdio` as a child
-process, translates between WebSocket and NDJSON (the ACP wire format), and
-serves a Progressive Web App that renders streaming responses, tool calls,
-permissions, and agent plans. Add a Microsoft Dev Tunnel and the whole thing
-is reachable from anywhere.
-
-```mermaid
-graph LR
-    PWA["PWA Client<br/>(browser)"] <-->|"HTTPS / WSS<br/>via devtunnel"| Bridge["Bridge Server<br/>(Node.js)"]
-    Bridge <-->|"stdio / NDJSON<br/>child process"| Copilot["copilot --acp<br/>--stdio"]
-    Bridge -.-|"Serves PWA static files<br/>+ WebSocket endpoint"| PWA
-```
-
-## Quick Start
-
-```bash
-npx @mattkotsenas/uplink
-
-# With remote access via devtunnel
-npx @mattkotsenas/uplink --tunnel
-```
-
-## How It Works
-
-1. **Copilot CLI** runs locally in ACP mode (`copilot --acp --stdio`),
-   speaking newline-delimited JSON-RPC over stdin/stdout.
-2. **Bridge server** spawns the CLI as a child process and bridges messages
-   between its stdin/stdout and a WebSocket endpoint — acting as a dumb pipe
-   that never interprets ACP messages.
-3. **PWA** connects over WebSocket, drives the full ACP lifecycle
-   (`initialize` → `session/new` → `session/prompt`), and renders the
-   streaming response.
-4. **Dev Tunnel** (optional) exposes the bridge server over HTTPS so you can
-   reach it from your phone or any remote browser.
-
-### Message Flow
-
-```mermaid
-sequenceDiagram
-    participant PWA
-    participant Bridge
-    participant Copilot as Copilot (stdio)
-
-    PWA->>Bridge: WS connect
-    Bridge->>Copilot: spawn copilot --acp --stdio
-
-    PWA->>Bridge: WS: initialize
-    Bridge->>Copilot: stdin: initialize\n
-    Copilot->>Bridge: stdout: result\n
-    Bridge->>PWA: WS: result
-
-    PWA->>Bridge: WS: session/prompt
-    Bridge->>Copilot: stdin: session/prompt\n
-    loop Streaming
-        Copilot->>Bridge: stdout: session/update\n
-        Bridge->>PWA: WS: session/update
-    end
-
-    Copilot->>Bridge: stdout: request_permission\n
-    Bridge->>PWA: WS: request_permission
-    PWA->>Bridge: WS: permission response
-    Bridge->>Copilot: stdin: permission response\n
-
-    Copilot->>Bridge: stdout: result\n
-    Bridge->>PWA: WS: prompt result
-```
-
-## Features
-
-- 💬 **Chat** with streaming responses
-- 🔧 **Tool call visibility** — see reads, edits, executes, and more with kind icons and status
-- 🔐 **Permission approve / deny** — surface permission requests with option buttons
-- 📋 **Agent plan tracking** — view plan entries with priority and status
-- 📱 **PWA** — installable on your phone's home screen
-- 🌐 **Remote access** via Microsoft Dev Tunnel
-- 🔄 **Auto-reconnect** with exponential backoff (1 s → 30 s max)
-- 🌙 **Dark / light theme**
-
-## Installing Dev Tunnels
-
-Dev Tunnels are required for remote access (`--tunnel`). Install for your platform:
-
-**macOS:**
-```bash
-brew install --cask devtunnel
-```
-
-**Linux:**
-```bash
-curl -sL https://aka.ms/DevTunnelCliInstall | bash
-```
-
-**Windows:**
-```powershell
-winget install Microsoft.devtunnel
-```
-
-After installing, authenticate once:
-```bash
-devtunnel user login
-```
-
-## Getting the PWA on Your Phone
-
-1. **Start with tunnel:**
-   ```bash
-   npx @mattkotsenas/uplink --tunnel
-   ```
-2. **Scan the QR code**printed in your terminal with your phone's camera.
-3. **Add to Home Screen** — your browser will offer an "Install" or
-   "Add to Home Screen" prompt because the app ships a Web App Manifest and
-   Service Worker.
-4. **(Optional) Use a persistent tunnel** so the URL stays the same across
-   restarts:
-   ```bash
-   # One-time setup
-   devtunnel create my-uplink
-   devtunnel port create my-uplink -p 3000
-
-   # Reuse every time
-   npx @mattkotsenas/uplink --tunnel-id my-uplink
-   ```
-
-With a persistent tunnel the installed PWA always connects to the same URL.
-If the bridge is offline the cached app shell still opens instantly; it shows
-a reconnection banner and retries automatically.
-
-## CLI Reference
-
-```
-npx @mattkotsenas/uplink [options]
-```
-
-| Flag | Description | Default |
-|---|---|---|
-| `--port <n>` | Port for the bridge server | `3000` |
-| `--tunnel` | Start a devtunnel for remote access | off |
-| `--no-tunnel` | Explicitly disable tunnel | — |
-| `--tunnel-id <name>` | Use a persistent devtunnel (implies `--tunnel`) | — |
-| `--cwd <path>` | Working directory for the Copilot subprocess | current dir |
-| `--help` | Show help and exit | — |
-
-## Contributing
-
-See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup, build, and testing instructions.
-
-## Architecture Deep Dive
-
-### The Bridge (Dumb Pipe)
-
-The bridge **intentionally does not parse ACP messages**. It reads
-newline-delimited JSON from the subprocess stdout and sends each line as a
-WebSocket text message; in the other direction it writes incoming WebSocket
-messages to stdin with a trailing `\n`.
-
-Benefits:
-
-- **Simple** — the bridge is ~100 lines of logic, easy to audit.
-- **Testable** — you can verify framing without any ACP knowledge.
-- **Protocol-agnostic** — if ACP evolves, only the PWA client needs updating.
-
-### ACP Protocol
-
-The [Agent Client Protocol](https://agentclientprotocol.com) defines how
-AI-powered tools communicate with host applications. The wire format is
-JSON-RPC 2.0 delimited by newlines (NDJSON).
-
-Key message types the PWA handles:
-
-| Method | Direction | Purpose |
-|---|---|---|
-| `initialize` | Client → Agent | Negotiate capabilities |
-| `session/new` | Client → Agent | Create a conversation session |
-| `session/prompt` | Client → Agent | Send a user prompt |
-| `session/update` | Agent → Client | Streaming chunks, tool calls, plan updates |
-| `session/request_permission` | Agent → Client | Ask user to approve a tool action |
-| `session/cancel` | Client → Agent | Cancel a running prompt |
-
-## Limitations (v1)
-
-- **Single session only** — one browser client at a time.
-- **No session resume** across bridge restarts.
-- **No file system / terminal proxying** — the PWA does not provide
-  client-side FS or terminal capabilities back to the agent.
-- **No authentication** beyond devtunnel's built-in defaults.
-
-## Roadmap Ideas
-
-- Session persistence and resume across restarts
-- Multi-session support (multiple browser tabs / devices)
-- File explorer integration
-- Push notifications for long-running tasks
-- Syntax-highlighted diffs in tool call output
-
-## License
-
-[MIT](LICENSE)
+# ⬆ Copilot Uplink
+
+**Remote control for GitHub Copilot CLI from your phone or any browser.**
+
+[![Build](https://img.shields.io/github/actions/workflow/status/MattKotsenas/uplink/ci.yml?branch=main)](https://github.com/MattKotsenas/uplink/actions)
+[![npm](https://img.shields.io/npm/v/@mattkotsenas/uplink)](https://www.npmjs.com/package/@mattkotsenas/uplink)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
+## What Is This?
+
+Copilot Uplink gives you a full chat interface to GitHub Copilot CLI — from
+your phone, a tablet, or any browser. Think of it like Claude Code's
+"Remote Control", but for Copilot CLI.
+
+A lightweight Node.js bridge spawns `copilot --acp --stdio` as a child
+process, translates between WebSocket and NDJSON (the ACP wire format), and
+serves a Progressive Web App that renders streaming responses, tool calls,
+permissions, and agent plans. Add a Microsoft Dev Tunnel and the whole thing
+is reachable from anywhere.
+
+```mermaid
+graph LR
+    PWA["PWA Client<br/>(browser)"] <-->|"HTTPS / WSS<br/>via devtunnel"| Bridge["Bridge Server<br/>(Node.js)"]
+    Bridge <-->|"stdio / NDJSON<br/>child process"| Copilot["copilot --acp<br/>--stdio"]
+    Bridge -.-|"Serves PWA static files<br/>+ WebSocket endpoint"| PWA
+```
+
+## Quick Start
+
+```bash
+npx @mattkotsenas/uplink
+
+# With remote access via devtunnel
+npx @mattkotsenas/uplink --tunnel
+```
+
+## How It Works
+
+1. **Copilot CLI** runs locally in ACP mode (`copilot --acp --stdio`),
+   speaking newline-delimited JSON-RPC over stdin/stdout.
+2. **Bridge server** spawns the CLI as a child process and bridges messages
+   between its stdin/stdout and a WebSocket endpoint — acting as a dumb pipe
+   that never interprets ACP messages.
+3. **PWA** connects over WebSocket, drives the full ACP lifecycle
+   (`initialize` → `session/new` → `session/prompt`), and renders the
+   streaming response.
+4. **Dev Tunnel** (optional) exposes the bridge server over HTTPS so you can
+   reach it from your phone or any remote browser.
+
+### Message Flow
+
+```mermaid
+sequenceDiagram
+    participant PWA
+    participant Bridge
+    participant Copilot as Copilot (stdio)
+
+    PWA->>Bridge: WS connect
+    Bridge->>Copilot: spawn copilot --acp --stdio
+
+    PWA->>Bridge: WS: initialize
+    Bridge->>Copilot: stdin: initialize\n
+    Copilot->>Bridge: stdout: result\n
+    Bridge->>PWA: WS: result
+
+    PWA->>Bridge: WS: session/prompt
+    Bridge->>Copilot: stdin: session/prompt\n
+    loop Streaming
+        Copilot->>Bridge: stdout: session/update\n
+        Bridge->>PWA: WS: session/update
+    end
+
+    Copilot->>Bridge: stdout: request_permission\n
+    Bridge->>PWA: WS: request_permission
+    PWA->>Bridge: WS: permission response
+    Bridge->>Copilot: stdin: permission response\n
+
+    Copilot->>Bridge: stdout: result\n
+    Bridge->>PWA: WS: prompt result
+```
+
+## Features
+
+- 💬 **Chat** with streaming responses
+- 🔧 **Tool call visibility** — see reads, edits, executes, and more with kind icons and status
+- 🔐 **Permission approve / deny** — surface permission requests with option buttons
+- 📋 **Agent plan tracking** — view plan entries with priority and status
+- 📱 **PWA** — installable on your phone's home screen
+- 🌐 **Remote access** via Microsoft Dev Tunnel
+- 🔄 **Auto-reconnect** with exponential backoff (1 s → 30 s max)
+- 🌙 **Dark / light theme**
+
+## Installing Dev Tunnels
+
+Dev Tunnels are required for remote access (`--tunnel`). Install for your platform:
+
+**macOS:**
+```bash
+brew install --cask devtunnel
+```
+
+**Linux:**
+```bash
+curl -sL https://aka.ms/DevTunnelCliInstall | bash
+```
+
+**Windows:**
+```powershell
+winget install Microsoft.devtunnel
+```
+
+After installing, authenticate once:
+```bash
+devtunnel user login
+```
+
+## Getting the PWA on Your Phone
+
+1. **Start with tunnel:**
+   ```bash
+   npx @mattkotsenas/uplink --tunnel
+   ```
+2. **Scan the QR code**printed in your terminal with your phone's camera.
+3. **Add to Home Screen** — your browser will offer an "Install" or
+   "Add to Home Screen" prompt because the app ships a Web App Manifest and
+   Service Worker.
+4. **(Optional) Use a persistent tunnel** so the URL stays the same across
+   restarts:
+   ```bash
+   # One-time setup
+   devtunnel create my-uplink
+   devtunnel port create my-uplink -p 3000
+
+   # Reuse every time
+   npx @mattkotsenas/uplink --tunnel-id my-uplink
+   ```
+
+With a persistent tunnel the installed PWA always connects to the same URL.
+If the bridge is offline the cached app shell still opens instantly; it shows
+a reconnection banner and retries automatically.
+
+## CLI Reference
+
+```
+npx @mattkotsenas/uplink [options]
+```
+
+| Flag | Description | Default |
+|---|---|---|
+| `--port <n>` | Port for the bridge server | `3000` |
+| `--tunnel` | Start a devtunnel for remote access | off |
+| `--no-tunnel` | Explicitly disable tunnel | — |
+| `--tunnel-id <name>` | Use a persistent devtunnel (implies `--tunnel`) | — |
+| `--cwd <path>` | Working directory for the Copilot subprocess | current dir |
+| `--help` | Show help and exit | — |
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup, build, and testing instructions.
+
+## Architecture Deep Dive
+
+### The Bridge (Dumb Pipe)
+
+The bridge **intentionally does not parse ACP messages**. It reads
+newline-delimited JSON from the subprocess stdout and sends each line as a
+WebSocket text message; in the other direction it writes incoming WebSocket
+messages to stdin with a trailing `\n`.
+
+Benefits:
+
+- **Simple** — the bridge is ~100 lines of logic, easy to audit.
+- **Testable** — you can verify framing without any ACP knowledge.
+- **Protocol-agnostic** — if ACP evolves, only the PWA client needs updating.
+
+### ACP Protocol
+
+The [Agent Client Protocol](https://agentclientprotocol.com) defines how
+AI-powered tools communicate with host applications. The wire format is
+JSON-RPC 2.0 delimited by newlines (NDJSON).
+
+Key message types the PWA handles:
+
+| Method | Direction | Purpose |
+|---|---|---|
+| `initialize` | Client → Agent | Negotiate capabilities |
+| `session/new` | Client → Agent | Create a conversation session |
+| `session/prompt` | Client → Agent | Send a user prompt |
+| `session/update` | Agent → Client | Streaming chunks, tool calls, plan updates |
+| `session/request_permission` | Agent → Client | Ask user to approve a tool action |
+| `session/cancel` | Client → Agent | Cancel a running prompt |
+
+## Limitations (v1)
+
+- **Single session only** — one browser client at a time.
+- **No session resume** across bridge restarts.
+- **No file system / terminal proxying** — the PWA does not provide
+  client-side FS or terminal capabilities back to the agent.
+- **No authentication** beyond devtunnel's built-in defaults.
+
+## Roadmap Ideas
+
+- Session persistence and resume across restarts
+- Multi-session support (multiple browser tabs / devices)
+- File explorer integration
+- Push notifications for long-running tasks
+- Syntax-highlighted diffs in tool call output
+
+## License
+
+[MIT](LICENSE)

package/dist/bin/cli.js

@@ -18,25 +18,27 @@ function hasFlag(name) {
     return args.includes(`--${name}`);
 }
 const port = parseInt(getArg('port') ?? '3000', 10);
+// TODO: Pass --model flag through to the bridge server when CLI gains a --model option.
+// Currently, model selection is handled client-side via localStorage and the WS URL parameter.
 const tunnelId = getArg('tunnel-id');
 const useTunnel = hasFlag('tunnel') || !!tunnelId;
 const noTunnel = hasFlag('no-tunnel');
 const allowAnonymous = hasFlag('allow-anonymous');
 const cwd = getArg('cwd') ?? process.cwd();
 if (hasFlag('help')) {
-    console.log(`
-Copilot Uplink — Remote control for GitHub Copilot CLI
-
-Usage: uplink [options]
-
-Options:
-  --port <n>          Port for bridge server (default: 3000)
-  --tunnel            Start a devtunnel for remote access
-  --no-tunnel         Don't start a devtunnel
-  --tunnel-id <name>  Use a persistent devtunnel
-  --allow-anonymous   Allow anonymous tunnel access (no GitHub auth)
-  --cwd <path>        Working directory for Copilot
-  --help              Show this help
+    console.log(`
+Copilot Uplink — Remote control for GitHub Copilot CLI
+
+Usage: uplink [options]
+
+Options:
+  --port <n>          Port for bridge server (default: 3000)
+  --tunnel            Start a devtunnel for remote access
+  --no-tunnel         Don't start a devtunnel
+  --tunnel-id <name>  Use a persistent devtunnel
+  --allow-anonymous   Allow anonymous tunnel access (no GitHub auth)
+  --cwd <path>        Working directory for Copilot
+  --help              Show this help
 `);
     process.exit(0);
 }
@@ -59,7 +61,7 @@ async function listen(server, desiredPort) {
     });
 }
 async function main() {
-    console.log('⬆ Copilot Uplink starting...');
+    console.log('🛰 Copilot Uplink starting...');
     console.log();
     const staticDir = resolveStaticDir();
     const { server, close } = startServer({
@@ -115,7 +117,13 @@ async function main() {
         });
         setTimeout(() => process.exit(1), 5000);
     };
-    process.on('SIGINT', shutdown);
+    process.on('SIGINT', () => {
+        shutdown();
+        // Exit after synchronous cleanup to avoid "Terminate batch job?" on Windows.
+        // The shutdown() call above synchronously kills child processes and sends
+        // WS close frames; the async server.close() callback is best-effort.
+        setImmediate(() => process.exit(0));
+    });
     process.on('SIGTERM', shutdown);
 }
 main().catch((err) => {

package/dist/client/assets/icon-B_iz-Vtl.svg

@@ -0,0 +1,6 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512">
+  <rect width="512" height="512" rx="64" fill="#6366f1" />
+  <g transform="translate(56, 456) scale(0.4167)" fill="#ffffff">
+    <path d="M240-100q-58 0-99-41t-41-99q0-58 41-99t99-41q58 0 99 41t41 99q0 22-6.5 42.5T354-159v-27q30 13 62 19.5t64 6.5q134 0 227-93t93-227h80q0 83-31.5 156T763-197q-54 54-127 85.5T480-80q-45 0-88-9.5T309-118q-16 9-33.5 13.5T240-100Zm42.5-97.5Q300-215 300-240t-17.5-42.5Q265-300 240-300t-42.5 17.5Q180-265 180-240t17.5 42.5Q215-180 240-180t42.5-17.5ZM480-340q-58 0-99-41t-41-99q0-58 41-99t99-41q58 0 99 41t41 99q0 58-41 99t-99 41ZM80-480q0-83 31.5-156T197-763q54-54 127-85.5T480-880q45 0 88 9.5t83 28.5q16-9 33.5-13.5T720-860q58 0 99 41t41 99q0 58-41 99t-99 41q-58 0-99-41t-41-99q0-22 6.5-42.5T606-801v27q-30-13-62-19.5t-64-6.5q-134 0-227 93t-93 227H80Zm640-180q25 0 42.5-17.5T780-720q0-25-17.5-42.5T720-780q-25 0-42.5 17.5T660-720q0 25 17.5 42.5T720-660ZM240-240Zm480-480Z"/>
+  </g>
+</svg>