Archive notice: replaced by official Anthropic solutions

Claude Code Web, Remote Control, and Cowork Dispatch now cover
all of cui's use cases. Updating README to reflect archived status
and provide migration guidance.

Author: wbopan

docs/README.md

@@ -1,103 +1,29 @@
-<div align="center" style="margin-bottom: 40px;">
-  <img src="assets/logo.png" alt="cui logo" width="150">
-</div>
+# cui: Common Agent UI (Archived)
 
-# cui: Common Agent UI
+> **This fork is archived.** Anthropic now offers official alternatives that cover all of cui's use cases. See below for migration guidance.
 
-[![npm version](https://badge.fury.io/js/cui-server.svg)](https://www.npmjs.com/package/cui-server)
-[![Node.js Version](https://img.shields.io/badge/node-%3E%3D20.0.0-brightgreen.svg)](https://nodejs.org/)
-[![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
-[![Built with React](https://img.shields.io/badge/React-20232A?logo=react&logoColor=61DAFB)](https://reactjs.org/)
-[![codecov](https://codecov.io/gh/BMPixel/cui/branch/main/graph/badge.svg)](https://codecov.io/gh/BMPixel/cui)
-[![CI](https://github.com/BMPixel/cui/actions/workflows/ci.yml/badge.svg)](https://github.com/BMPixel/cui/actions/workflows/ci.yml)
+## What was cui?
 
-A modern web UI for your agents. Start the server and access your agents anywhere in your browser. Common Agent UI is powered by [Claude Code SDK](https://claude.ai/code) and supports all kind of LLMs with the most powerful agentic tools.
+A modern web UI for Claude Code agents, powered by [Claude Code SDK](https://claude.ai/code). It provided browser-based access to agent sessions, parallel background tasks, push notifications, and multi-model support.
 
-<div align="center">
-  <img src="assets/demo.gif" alt="Demo" width="100%">
-</div>
+The upstream project lives at [BMPixel/cui](https://github.com/BMPixel/cui).
 
-## Highlights
+## Why archived?
 
-- **🎨 Modern Design**: Polished, responsive UI that works anywhere
-- **⚡ Parallel Background Agents**: Stream multiple sessions simultaneously
-- **📋 Manage Tasks**: Access all your conversations and fork/resume/archive them
-- **🤖 Multi-Model Support**: Enjoy power of agentic workflows with any model
-- **🔧 Claude Code Parity**: Familiar autocompletion and interaction with CLI
-- **🔔 Push Notifications**: Get notified when your agents are finished
-- **🎤 Dictation**: Precise dictation powered by Gemini 2.5 Flash
+Anthropic has released official products that supersede cui's functionality:
 
-## Getting Started
+| Need | Official Solution |
+|------|-------------------|
+| Browser-based coding without local setup | [Claude Code Web](https://claude.ai/code) -- cloud VM execution, async tasks, built-in diff view, parallel sessions |
+| Access a local Claude Code session from phone/browser | [Remote Control](https://code.claude.com/docs/en/remote-control) -- `claude remote-control` or `/rc`, encrypted bridge, local execution |
+| Long-running desktop tasks with mobile dispatch | [Cowork Dispatch](https://www.anthropic.com/products/claude-code) -- Claude Desktop persistent agent, phone-to-desktop task dispatch |
 
+## Migration
 
-1. With Node.js >= 20.19.0, start the server:
+- **Claude Code Web**: Go to [claude.ai/code](https://claude.ai/code), connect GitHub, submit tasks. Use `claude --remote` from terminal to start cloud sessions.
+- **Remote Control**: Run `claude remote-control` in your project directory, scan the QR code with the Claude mobile app or open the session URL in a browser.
+- **Cowork Dispatch**: Use Claude Desktop app, pair with your phone via QR code, dispatch tasks remotely.
 
-    ```bash
-    npx cui-server
-    ```
-    or install it globally:
-    ```bash
-    npm install -g cui-server
-    ```
+## License
 
-2. Open http://localhost:3001/#your-token in your browser (the token will be displayed in the cui-server command output).
-3. Choose a model provider:
-    - cui works out of the box with if you have logged in to Claude Code or have a valid Anthropic API key in your environment.
-    - Or you can go to `settings -> provider` and choose a model provider. cui use [claude-code-router](https://github.com/musistudio/claude-code-router) configurations, supporting different model providers from openrouter to ollama.
-4. (Optional) Configure the settings for notifications and dictation.
-
-## Usage
-
-### Tasks
-
-- **Start a New Task**
-
-  cui automatically scans your existing Claude Code history in `~/.claude/` and displays it on the home page, allowing you to resume any of your previous tasks. The dropdown menu in the input area shows all your previous working directories.
-
-- **Fork a Task**
-
-  To create a branch from an existing task (only supported for tasks started from cui), navigate to the "History" tab on the home page, find the session you want to fork, and resume it with new messages.
-
-- **Manage Tasks**
-
-  Feel free to close the page after starting a task—it will continue running in the background. When running multiple tasks (started from cui), you can check their status in the "Tasks" tab. You can also archive tasks by clicking the "Archive" button. Archived tasks remain accessible in the "Archived" tab.
-
-### Dictation
-
-cui uses [Gemini 2.5 Flash](https://deepmind.google/models/gemini/flash/) to provide highly accurate dictation, particularly effective for long sentences. To enable this feature, you'll need a [Gemini API key](https://aistudio.google.com/apikey) with generous free-tier usage. Set the `GOOGLE_API_KEY` environment variable before starting the server. Note that using this feature will share your audio data with Google.
-
-### Notifications
-
-You can receive push notifications when your task is finished or when Claude is waiting for your permission to use tools. Notifications are sent using either [ntfy](https://ntfy.sh/) or native [web-push](https://www.npmjs.com/package/web-push). To receive them, follow the instructions in the settings.
-
-### Keyboard Shortcuts
-
-More keyboard shortcuts are coming. Currently available:
-
-- `Enter`: Enter a new line
-- `Command/Ctrl + Enter`: Send message
-- `/`: List all commands
-- `@`: List all files in the current working directory
-
-All inline syntaxes like `/init` or `@file.txt` are supported just like in the CLI.
-
-### Remote Access
-
-1. Open `~/.cui/config.json` to set the `server.host` (0.0.0.0) and `server.port`. Alternatively, you can use `--host` and `--port` flags when starting the server.
-2. Ensure you use a secure auth token if accessing the server from outside your local network. The auth token is generated when you start the server and can be changed in the `~/.cui/config.json` file.
-3. Recommended: Use HTTPS to access the server. You can use a reverse proxy like [Caddy](https://caddyserver.com/) to set this up. On iOS, the dictation feature is only available when using HTTPS.
-
-### Configuration
-
-All configuration and data are stored in `~/.cui/`.
-
-- `config.json` - Server and interface settings
-- `session-info.db` - Session metadata
-
-To uninstall cui, simply delete the `~/.cui/` directory and remove the package with `npm uninstall -g cui-server`.
-
-## Contributing
-
-The best way to contribute is to suggest improvements or report bugs in the [issues](https://github.com/BMPixel/cui/issues) and give us a star ⭐!
-
-Before submitting a PR, please make sure you (or your fellow AI) have read [CONTRIBUTING.md](CONTRIBUTING.md).
+[MIT](LICENSE)