@codex-ultra/cxu

中文文档
0.2.194发布于 2026/10/21MITTypeScriptES Module近 30 天下载 4886

codex-ultra workbench launcher: server compiled locally with Bun + web UI (cxu starts it all).

原始使用文档
文档目录7 节
  1. Install
  2. Quick start
  3. Environment doctor
  4. Library: file + AST toolkit
  5. Platform support
  6. Build / publish check (maintainers)
  7. Links

@codex-ultra/cxu

One-command launcher for the Codex Ultra workbench: locally-compiled server + web UI. cxu starts it all.

Codex Ultra is a local-first workbench for Codex CLI (backed by codex app-server): React + MUI three-column UI (history, chat, composer, config/tools/files inspector), third-party relay channels, membership with per-member relay whitelists, usage & billing, sidechat tabs, SSH workspaces, real Codex slash commands (/review, /compact, /resume, /model, /skills, /plugins, /mcp, …), theme plugins, and an Electron desktop shell. This package ships the server binary (per-platform optional packages) together with the built web UI and starts them with a single command.

Install

npm i -g @codex-ultra/cxu

Requires Node >=18 and Bun >=1.1. No prebuilt binaries to download: cxu compiles the server for your machine with your local Bun on first run (one-time per version, cached under ~/.cxu/server/).

Quick start

cxu
# open http://127.0.0.1:43110/

The first run inspects your machine, offers to install what's missing, compiles the server locally if needed, then starts the workbench. No separate cxu doctor call needed.

cxu serve --port 43110 --data-dir ~/.codex-ultra
cxu --help
cxu --version

Environment doctor

cxu doctor

Checks Bun plus the codex / claude / agy / grok / pi / opencode CLIs. codex is REQUIRED; the rest are optional (Bun is only needed for TypeScript-track execution). For Codex the doctor also verifies the managed standalone daemon (~/.codex/packages/standalone/current/) that the workbench app-server boots from — an npm-only Codex install is flagged with a ⚠ plus the official installer command. Missing tools print their official install command, and on a TTY you get an interactive prompt:

  • [a] auto-install every missing tool with an official installer
  • [s] skip and start the workbench (default)
  • [m] show manual installation commands
cxu doctor --yes   # non-interactive one-click install (CI-friendly)
cxu doctor --no-prompt

Exit code is 2 when Codex CLI is absent.

cxu install [tool]        # print install command only, changes nothing
cxu install [tool] --yes  # run the official installer
cxu install --all --yes   # one-click: install every missing tool

Library: file + AST toolkit

The same package is importable as a pure-TypeScript toolkit (runs on plain Node.js, zero embedded binaries):

  • Single-step tools: read_file, edit_file, grep_search, apply_patch, find_files, file_outline, find_definition, find_references, rename_symbol, and 20+ more.
  • AST via portable WebAssembly (web-tree-sitter + tree-sitter-wasms): TypeScript, TSX, JavaScript, Python, Rust, Go, Zig, JSON, TOML, YAML, Bash. c / cpp / java / c_sharp fall back to the built-in regex outline with the same output shape.
  • Complex TypeScript tracks (run_bun) detect Bun on demand and print a cross-platform install hint instead of crashing.

Windows (PowerShell): powershell -c "irm bun.sh/install.ps1 | iex" macOS / Linux: curl -fsSL https://bun.sh/install | bash Other: use your system package manager, or see https://bun.sh

Platform support

Windows / Linux / macOS (Intel + Apple Silicon / ARM). The server is compiled on your machine with your local Bun (bun build --compile, current platform), so there are no per-platform packages to download; the file/AST library itself is pure TypeScript + .wasm and works everywhere Node >=18 runs.

Build / publish check (maintainers)

npm --workspace @codex-ultra/cxu run vendor
npm --workspace @codex-ultra/cxu run build
npm pack --dry-run --workspace @codex-ultra/cxu

scripts/build.mjs prefers bun build --minify (target node, ESM) and falls back to esbuild with minify: true when Bun is absent. prepack runs build and then scripts/obfuscate.mjs, so publishing ships a minified + obfuscated bundle.

Only dist/ (+ .d.ts), wasm/, web-dist/, server-bundle/ (the pre-bundled server JS compiled locally on first run), README.md, LICENSE ship. No .exe / .dll / .so / .dylib, no prebuilt binaries.

版本与发布记录

@codex-ultra/cxu 共发布 61 个版本,首次发布于 2026/09/12;过去 12 个月发布了 61 个版本。

版本发布日期距今
0.2.194latest2026/10/2119 天前
0.2.1932026/10/2119 天前
0.2.1922026/10/2119 天前
0.2.1742026/10/1822 天前
0.2.1692026/10/1724 天前
0.2.1632026/10/1526 天前

关于 @codex-ultra/cxu 的常见问题

@codex-ultra/cxu 是什么?

codex-ultra workbench launcher: server compiled locally with Bun + web UI (cxu starts it all).

如何安装 @codex-ultra/cxu?

在项目目录运行 npm install @codex-ultra/cxu,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 cxu,可以用 npx cxu 直接运行。

@codex-ultra/cxu 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@codex-ultra/cxu 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@codex-ultra/cxu 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=18。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@codex-ultra/cxu 可以商用吗?

@codex-ultra/cxu 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@codex-ultra/cxu 的下载量有多少?

根据 npm 官方下载统计,@codex-ultra/cxu 在 2026/10/10 – 2026/11/08 这 30 天内被下载 4,886 次,日均约 163 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@codex-ultra/cxu 还在维护吗?

最新版本 0.2.194 发布于 2026/10/21(19 天前);至今共发布 61 个版本,其中过去 12 个月发布了 61 个;首次发布于 2026/09/12。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。