Skip to content

duxweb/codux

Repository files navigation

Codux

Codux

A cross-platform AI development workstation with projects, terminals, Git, AI stats, memory, mobile control, and desktop companions.
Built for Claude Code, Codex, Gemini CLI, and OpenCode.

Website · Download · Mobile · Relay Service · Feedback

English | 简体中文

The cross-platform desktop app now lives on main. The original macOS app is preserved on the swift-macos branch.


Codux

AI Stats
AI Stats & Session Restore
Daily Level
Daily Level
Built-in Git
Built-in Git
Pet Companion
Pet Companion

Demo Video

GitHub README does not render third-party iframe players. Watch the demo on Bilibili.

10 Highlights

# Feature What it does
1 Live AI Activity Real-time status + system notifications for every running AI terminal (Claude Code, Codex, Gemini CLI, OpenCode). The tab indicator, project tile, and desktop notification all light up the moment a turn finishes — no more watching the cursor blink.
2 AI Stats & Session Restore Token totals split by tool / model / project, daily and trend views, and one-click resume of any past session back into the original tool. Scattered AI runs turn into a usable history.
3 Daily Level A daily ladder powered by real token usage. One snapshot tells you what you ran, how much, and how today compares to a normal day — easy to glance at, hard to fudge.
4 Pet Companion An optional pet in the title bar that grows with your AI coding habits. It supports Codex-format custom pet imports, so compatible pet.json + spritesheet.png packages can be installed from Petdex, renamed, validated, adopted, archived, and restored alongside the bundled pets. Fully optional, one-click mute.
5 Built-in Git A first-class Git panel — not an embedded webview. Branch checkout / create / rename / delete, staging with line-level diffs, full commit history, and push / pull / sync with sane defaults and clear conflict resolution.
6 Project File Browser Per-project native file manager. Edit code inline, preview images and other assets, and drag any file straight into the terminal so your AI tool gets the right path on the first try.
7 Multi-Project Workspaces Every project is its own room — up to 6 split terminals for parallel work plus unlimited tabs when 6 is not enough. Each project keeps its own layout, sessions, AI tool selection, and state across restarts.
8 Three-Layer AI Memory Local memory.sqlite3 extracts long-term memory from completed sessions, layered as user / project / tool. App-private CLAUDE.md, AGENTS.md, GEMINI.md are generated so Codex / Claude / Gemini / OpenCode no longer forget what you did last session — and nothing is written into your repo.
9 Mobile Handoff Step away from the desktop and keep going on your phone. Codux Mobile pairs with the desktop host to drive AI CLI sessions remotely with end-to-end encrypted relay traffic. See the Mobile Handoff section below.
10 Terminal Engine & Themes A WebView terminal with GPU-accelerated rendering, split panes, tabs, and curated light / dark themes that follow the selected app appearance.

Custom Pets

Codux can import custom companions built with the same flat Codex pet package format: one pet.json manifest plus one spritesheet.png atlas. Open the Petdex marketplace from the pet claim or Petdex flow, paste a Petdex pet page URL, preview the metadata, adjust the display name, and install it into Codux. Installed custom pets appear with the bundled companions and keep the same adoption, archive, restore, animation, bubble, and growth behavior.

Creators can use the Codex pet atlas guide to generate compatible 8 x 9 atlases and package them for import.

Mobile Handoff

Codux Mobile + Codux Service are a separate stack so the relay can be self-hosted while the desktop app stays the real terminal host.

Component Purpose Download
Codux Desktop Main desktop app: projects, terminals, Git, stats, memory, remote host. Desktop Releases
Codux Mobile Android client: pair with the desktop host, run AI CLI sessions remotely, browse files, upload images. Mobile Releases
Codux Service Lightweight Go relay for device pairing and encrypted WebSocket forwarding. Service Releases

For a quick trial, enter one of the official trial relays in Settings > Remote:

Node URL
China relay direct https://codux-service.dux.plus
Global transit acceleration https://codux-node.dux.plus

Terminal input, output, file payloads, project lists, and AI stats are end-to-end encrypted between Codux Desktop and Codux Mobile. The relay sees only routing metadata (host ID, device ID, pairing state, online state) — never decrypted terminal content. For long-term use, self-hosting codux-service is recommended.

Getting Started

Install from Release

  1. Download the latest macOS or Windows build from GitHub Releases or codux.dux.cn
  2. Install Codux:
    • macOS: open the .dmg and drag Codux to Applications
    • Windows: run the .msi installer
  3. Open Codux, click New Project or Open Folder, and pick a directory
  4. Start typing — you're ready to go

Codux uses the built-in updater. Stable releases and beta releases are published from GitHub Releases, and the app checks the configured channel automatically.

"Cannot be opened because the developer cannot be verified"

Since Codux is not yet notarized by Apple, macOS may block the first launch. To fix this:

sudo xattr -rd com.apple.quarantine /Applications/Codux.app

Or go to System Settings > Privacy & Security, scroll down and click Open Anyway next to the Codux warning.

Development

pnpm install
pnpm tauri dev

Useful checks before submitting changes:

pnpm exec tsc --noEmit
pnpm run lint
cargo check --manifest-path src-tauri/Cargo.toml

Release

Desktop releases are created by pushing a desktop release tag:

git tag v1.0.0-beta.1
git push origin v1.0.0-beta.1

The release workflow reads the tag, writes the app version into the desktop/package manifests, extracts the matching CHANGELOG.md section, builds macOS and Windows artifacts, publishes a GitHub Release, and updates the beta or stable updater channel.

Keyboard Shortcuts

Action Shortcut
New Split ⌘T
New Tab ⌘D
Toggle Git Panel ⌘G
Toggle AI Panel ⌘Y
Switch Project ⌘1 - ⌘9

All shortcuts can be customized in Settings > Shortcuts.

System Requirements

  • macOS 14.0 (Sonoma) or later
  • Windows 10 / 11 with Microsoft WebView2 Runtime

Feedback

Found a bug or have a feature request? Open an issue on GitHub.

When reporting a bug, the easiest path is Help -> Export Diagnostics… — save the generated .zip and attach it to your GitHub issue. The archive bundles runtime logs, rotated logs, performance summaries, saved app state, invalid state backups, and any matching macOS crash / hang / spin reports.

If you need to collect logs manually, Codux writes runtime logs to:

  • ~/Library/Application Support/Codux/logs/runtime.log
  • ~/Library/Application Support/Codux/logs/runtime.previous.log
  • ~/Library/Application Support/Codux/logs/performance-summary.json
  • %APPDATA%\Codux\logs\runtime.log

Notes:

  • Codux clears the previous app session logs on each launch
  • runtime.previous.log only appears once the current session log rotates
  • performance-summary.json covers recent performance spikes / main-thread stalls

Open the macOS log folder directly:

open ~/Library/Application\ Support/Codux/logs

If the app crashes or hangs right after launch, macOS may write a system crash report to ~/Library/Logs/DiagnosticReports/ (look for Codux-*.ips or dmux-*.ips). Attach the file whose timestamp is closest to the crash.

open ~/Library/Logs/DiagnosticReports

When opening an issue, please include: OS version + Codux version, repro steps, runtime.log, runtime.previous.log (if present), performance-summary.json (if present), and the matching crash report (if any).


GitHub Star Trend

Star History Chart

Wanted to be dmux, but that name was taken. So it's Codux now, which sounds like "Cool Dux" in Chinese.

codux.dux.cn

About

⬛ Cross-platform AI terminal work desktop software, specially designed for AI programming tools - multi-project management, built-in Git, real-time AI usage tracking. 跨平台AI 终端工作桌面软件,专为 AI 编程工具打造 — 多项目管理、内置 Git、实时 AI 用量追踪。

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors