# codux
**Repository Path**: duxweb/codux
## Basic Information
- **Project Name**: codux
- **Description**: ⬛ A native connected terminal for AI agent development. 为 AI Agent 开发而生的原生互联终端。
- **Primary Language**: Rust
- **License**: GPL-3.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 1
- **Created**: 2026-07-15
- **Last Updated**: 2026-09-16
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
Codux
为 AI 编程而生的高性能终端 —— 桌面、手机、服务器,一套工作区
用 Rust + GPUI 原生打造,统一 Codex、Claude Code 等 8+ AI 编程 CLI,整合实时状态、Token 统计、本地记忆与凭证隔离的 SSH / 数据库访问,并用加密链路连通桌面、手机和主机端,让你随时随地接管长时间运行的 agent 任务。
官网 ·
文档 ·
下载 ·
移动端 ·
反馈
English | 简体中文 | 日本語 | 한국어
---

https://github.com/user-attachments/assets/cabf21a9-8649-4e65-9e8a-db27ccaccdf3
▶ 观看演示视频
## 为什么用 Codux
AI 编程 CLI 很强——也极其容易失控。真正干活时,工作会散落到项目、Git worktree、终端、历史会话、Token、远程 shell,和你只记得一半的上下文里。**Codux 把这片混乱收进一个稳定的原生工作台,专为认真做 AI 编程的人打造。**
| AI 编程哪里容易乱 | Codux 给你什么 |
| :---------------- | :------------- |
| 每个 AI CLI 各管各的状态 | 一个按项目组织的视图,统一 Codex、Claude Code、OpenCode、Kiro CLI、Kimi Code、CodeWhale、MiMo Code、Agy。 |
| 长 agent 任务难恢复 | 实时运行状态、本地历史、会话恢复,还有跟着 worktree 走的上下文。 |
| 并行任务互相打架 | 以 worktree 为核心:每个任务保留自己的终端、Git 状态、文件和 AI 会话。 |
| Token 花销是个黑盒 | 按工具、模型、项目、worktree、日期统计用量——不用再记账。 |
| 会话之间上下文蒸发 | 本地记忆保存习惯、项目画像、模块笔记,并自动注入回支持的 CLI。 |
| 凭证被贴进提示词 | 已保存、已测试的 SSH 与数据库配置,加 `codux-ssh` / `codux-db` 两个 **凭证永不外泄** 的命令给 agent 用。 |
| 任务跑一半离开电脑 | 用手机通过 P2P / 中继链路配对,随时随地接着控制会话。 |
| 代码在另一台机器上 | 连上一台 Codux 主机——服务器、闲置的 Mac 或 Linux——像操作本地一样驱动它的终端、Git 和 AI。 |
| Windows 项目放在 WSL 里 | 将已安装的 WSL 发行版作为 Codux 原生运行环境,文件、Git、worktree、终端和 AI 会话都留在 Linux 内。 |
Codux **不是** 又一个编辑器。它是给重度泡在 AI 编程 CLI 里的开发者的控制台,让多项目、长会话的 agent 工作稳得住。
## 三步上手
macOS —— 用 [Homebrew](https://brew.sh) 安装:
```bash
brew install --cask duxweb/tap/codux
```
1. **打开一个项目。** Git worktree、项目状态和会话按项目自动就位。
2. **在内置终端里启动你的 AI CLI** —— `codex`、`claude`、`opencode` 都行。非侵入 wrapper 自动点亮实时状态、Token 统计和记忆注入,零配置。
3. **起身走人。** 手机或主机端配对一次,之后在任何地方接管同一个正在运行的会话。
Windows 或不用 Homebrew:见[下载](#下载)。
## 凭证永远不进 AI 的上下文
Agent 干活离不开服务器和数据库——但把密码贴进提示词、或让模型去读你的配置文件,正是凭证泄露的常见方式。Codux 把连接配置存在本地,只给 agent 两个安全命令:
- **`codux-ssh`** —— agent 运行 `codux-ssh list` 只能看到配置名和主机,连接由 wrapper 代为完成。密码和密钥在 Codux 的辅助进程内部注入,永远不会进入模型上下文、会话记录或 shell 历史。
- **`codux-db`** —— 对 MySQL / PostgreSQL / SQLite 做同样的隔离:在 Codux 里保存一次,agent 按配置名查询。只读配置由 wrapper 强制执行单语句白名单,模型无法自行提权。
- **零项目配置。** 所有支持的 CLI 都会通过 Codux 环境指令自动知道这两个命令的存在。

## AI CLI 支持
Codux 使用非侵入式 wrapper 和各工具适配器。为了注入 Codux 上下文,它不会写入项目提示词文件,也不会修改你的全局 AI CLI 配置。
| AI CLI | 实时状态 | Token 用量 | 模型设置 | 完全权限模式 | 环境指令注入 |
| :--- | :---: | :---: | :---: | :---: | :--- |
| Codex | ✓ | ✓ | ✓ | ✓ | ✓,通过 developer instructions |
| Claude Code / reclaude | ✓ | ✓ | ✓ | ✓ | ✓,通过 `--append-system-prompt` |
| OpenCode | ✓ | ✓ | ✓ | ✓ | ✓,通过 Codux 托管的 plugin 配置 |
| MiMo Code | ✓ | ✓ | ✓ | ✓ | ✓,通过 Codux 托管的 plugin 配置 |
| Kimi Code | ✓ | ✓ | ✓ | — | ✓,通过 Codux 托管的 `--agent-file` |
| Kiro CLI | ✓ | ✓ | ✓ | ✓ | 不注入;暂无已确认的非侵入提示词通道 |
| CodeWhale | ✓ | ✓ | ✓ | ✓ | 不注入交互式会话 |
| Agy | ✓ | ✓ | ✓ | ✓ | 不注入;暂无已确认的非侵入提示词通道 |
环境指令包含 Codux 记忆,以及 `codux-ssh`、`codux-db` 等运行时命令说明。对暂不支持注入的工具,Codux 仍会尽可能追踪会话状态,但不会为了提示词注入去强写项目文件或用户级配置。
## 一套工作区,多端互联
> **Beta。** 连接主机端会先在本次版本里以 beta 形式上线——连接、配对、主机侧数据链路都还在持续测试中,可能会有粗糙的地方,欢迎反馈。
桌面端、手机、主机端互为 **peer**,经端到端加密的 **P2P / 中继链路** 连通,让你随时随地接着跑长 agent 任务。
- **能直连就直连。** Codux 优先走 P2P,网络环境不允许时自动回落到中继。
- **不是 SSH 远程桌面。** 设备配对一次,之后就是直接连到 Codux 自己。
- **不需要公网 IP。** 桌面、手机和主机端都可以在家庭、公司和移动网络下完成配对与重连。
```mermaid
flowchart LR
subgraph drivers["从这里操控"]
P["📱 手机"]
D["💻 桌面端"]
end
subgraph hosts["活儿跑在这里(主机)"]
D2["💻 另一台桌面"]
H["🖥️ 主机端
服务器 · 闲置 Mac · Linux"]
end
P -->|"🔒 P2P / 中继"| D2
P -->|"🔒 P2P / 中继"| H
D -->|"🔒 P2P / 中继"| D2
D -->|"🔒 P2P / 中继"| H
```
任意操控端——**桌面**或**手机**——都能连接任意主机——**另一台桌面**或**主机端**。桌面端既能托管自己的项目,也能去操控别人;手机只负责操控。真正的工作始终留在主机上,所以换设备不会打断会话。
- **手机接力。** 几秒完成配对,在手机上继续同一批终端、历史和 AI 会话。
- **主机端。** 把 `codux` 跑在服务器、闲置 Mac 或 Linux 上,像本地一样驱动它的终端、Git 和 AI。详见 [`apps/agent/README.md`](apps/agent/README.md)。
- **会话不断。** 断线重连后,恢复的是同一批正在运行的 shell 和 agent 会话。
## 你的终端宠物
Agent 烧掉的每一个 Token,都会喂养一只住在工作区里的像素宠物。孵化它、给它起名,看它随着你写代码一路升级——智慧、混沌、夜行、体力、共情五维属性,长自你真实的工作方式和作息。还可以安装自定义像素宠,或让老伙计光荣退役、进入传承名册。
毫无用处,但不可或缺。

## 本地优先
- **数据是你的。** 项目、终端、会话、记忆、Token 统计和凭证全都留在你自己的机器上——没有 Codux 云端,也不需要注册账号。
- **链路加密。** 桌面 ⇄ 手机 ⇄ 主机之间端到端加密;走不通 P2P 时,中继也只转发密文。
- **原则性非侵入。** Codux 不会往你的仓库里写提示词文件,也不会改 AI CLI 的全局配置——所有上下文注入都经由可审查的 wrapper 和各工具适配器完成。
## 下载
**桌面端**
macOS —— 用 [Homebrew](https://brew.sh) 安装:
```bash
brew install --cask duxweb/tap/codux
```
或直接下载:
| 平台 | 下载 |
| :--- | :--- |
| macOS · Apple 芯片 | [⬇ `codux-macos-aarch64.dmg`](https://github.com/duxweb/codux/releases/latest/download/codux-macos-aarch64.dmg) |
| macOS · Intel | [⬇ `codux-macos-x86_64.dmg`](https://github.com/duxweb/codux/releases/latest/download/codux-macos-x86_64.dmg) |
| Windows 11 · x64 | [⬇ `codux-windows-x86_64-setup.exe`](https://github.com/duxweb/codux/releases/latest/download/codux-windows-x86_64-setup.exe) |
macOS 打开 `.dmg` 拖进「应用程序」;Windows 双击安装。装好后打开一个项目、在终端启动 AI CLI 就行。
**Windows + WSL。** 打开「设置 → WSL」启用集成,可直接安装或选择发行版,并一键安装、更新 Codux Runtime。新建项目时选择该 WSL 发行版内的目录,之后文件、Git、worktree、终端与 AI 会话都会自动通过 WSL 运行。
**移动端**
从 [Codux Mobile 最新版本](https://github.com/duxweb/codux-flutter/releases/latest) 下载 Android APK,iOS 版见 [App Store](https://apps.apple.com/cn/app/codux/id6772156906)。
> **为什么 iOS 版收费?** Codux 完全开源(GPL-3.0),桌面端与 Android 版免费。iOS 定价仅用于覆盖苹果每年 99 美元的开发者费用与收入抽成,支持项目持续开发,无订阅、无内购。不想付费?可从本仓库的 [`apps/mobile`](apps/mobile) 获取源码自行编译,功能完全一致。
**主机端(无界面 · `codux-agent`)** —— Beta,随 2.0 发布
macOS / Linux —— 一行装好(自动识别系统/架构,装成 `codux` 放进 `PATH`):
```bash
curl -fsSL https://raw.githubusercontent.com/duxweb/codux/main/apps/agent/scripts/install.sh | sh
```
参数:`--beta` · `--version ` · `--dir <路径>` · `--setup` · `--mirror <前缀>`(GitHub 慢时走镜像)· `--uninstall`。或直接下载二进制:
| 平台 | 下载 |
| :--- | :--- |
| macOS · Apple 芯片 | [⬇ `codux-macos-aarch64`](https://github.com/duxweb/codux/releases/latest/download/codux-macos-aarch64) |
| macOS · Intel | [⬇ `codux-macos-x86_64`](https://github.com/duxweb/codux/releases/latest/download/codux-macos-x86_64) |
| Linux · arm64 | [⬇ `codux-linux-aarch64`](https://github.com/duxweb/codux/releases/latest/download/codux-linux-aarch64) |
| Linux · x64 | [⬇ `codux-linux-x86_64`](https://github.com/duxweb/codux/releases/latest/download/codux-linux-x86_64) |
| Windows · x64 | [⬇ `codux-windows-x86_64.exe`](https://github.com/duxweb/codux/releases/latest/download/codux-windows-x86_64.exe) |
把二进制放到 `PATH` 上(命名为 `codux`),然后 `codux config` → `codux install` → `codux qrcode`。
运行 `codux <命令> --help` 查看详情,或见 [`apps/agent/README.md`](apps/agent/README.md)。
主机端全部命令
| 命令 | 作用 |
| :--- | :--- |
| `codux config` | 交互式初始化(设备名、中继),写入 `codux.toml`。 |
| `codux install` | 安装为开机自启服务(launchd / `systemd --user` / 任务计划程序)。 |
| `codux start` / `stop` | 前台启动 / 停止主机端。 |
| `codux status` | 是否在运行、节点 id、已配对设备数。 |
| `codux qrcode` / `link` | 显示配对二维码 / 打印配对 ticket,粘到桌面端。 |
| `codux device` | 列出已配对设备;`device:del ` / `device:rename ` / `device:clear` 管理。 |
| `codux update` | 下载、校验并替换当前二进制,再重启主机端。 |
| `codux uninstall` | 停止并移除该服务。 |
## Web 隧道浏览器
当桌面端连接到已配对的主机端后,工具栏里的地球图标 **Web Tunnel Browser** 会打开一个独立代理的 Chromium 浏览器,**以主机的身份**上网:主机端跑着 Vite `http://127.0.0.1:5173/`,在隧道浏览器里输入这个地址,就会通过加密的 Codux 链路打开——HTTPS、WebSocket、HMR、局域网地址、`.local` 和 VPN 路由都支持。
诊断与说明
- `localhost` 等地址在主机端解析,而不是在当前桌面端解析。
- 每个 `codux-agent` 都内置诊断页 `http://127.0.0.1:8765/`。通过 Web 隧道浏览器打开它,可以检查隧道健康状态和实时往返延迟。
- 在同一台电脑上测试也会走同一套隧道链路;但要验证跨机器网络可达性,仍应把 Codux 主机端跑在另一台机器上。
## 快捷键
| 操作 | 快捷键 |
| :--- | :----- |
| 新建分屏 | `⌘T` |
| 切换 Git 面板 | `⌘G` |
| 切换 AI 面板 | `⌘Y` |
| 切换项目 | `⌘1` – `⌘9` |
所有快捷键都能在 **设置 → 快捷键** 里自定义。
## 系统要求
**桌面端**
- macOS 14.0 (Sonoma) 或更高
- Windows 11
**主机端(`codux-agent`)**
- macOS、Linux、Windows(x86_64 与 arm64)
## 反馈
发现 Bug 或有功能建议?欢迎在 [GitHub Issues](https://github.com/duxweb/codux/issues) 提出。
提交 Bug 时,推荐用 **帮助 → 导出诊断包**,把生成的 `.zip` 附上——里面有运行日志、轮转日志、性能摘要、应用状态、无效状态备份,以及可匹配到的 macOS 诊断报告。
手动日志路径:
- `~/Library/Application Support/Codux/logs/runtime-rust.log`
- `~/Library/Application Support/Codux/logs/performance-summary.json`
- `%APPDATA%\Codux\logs\runtime-rust.log`
---
## 社区支持
Codux 认可并支持 [LINUX DO](https://linux.do) 社区。
## 贡献者
感谢所有为 Codux 贡献代码、Issue、测试和反馈的朋友。
## GitHub Star 趋势
如果 Codux 救回过你哪次跑了一半的 agent 任务,点个 ⭐ 能让更多人找到它。
[](https://star-history.com/#duxweb/codux&Date)
本来想叫 dmux,可惜名字被占了,那就叫 Codux 吧——中文谐音刚好是「酷 Dux」。
codux.work