# @brimveyn/aimux 中文文档

规范地址：https://npmcn.com/package/%40brimveyn/aimux/

版本：1\.29\.0
npm 元数据更新时间：2026-10-25T13:56:01.462Z
中文译文更新时间：2026-11-08T15:36:45.637Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40brimveyn/aimux
原文对照：https://npmcn.com/package/%40brimveyn/aimux/?lang=original
项目主页：https://github.com/BrimVeyn/aimux#readme
源码仓库：https://github.com/BrimVeyn/aimux

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：3.1 MB，531 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：11 个
- 首次发布：2026-04-16T20:04:20.334Z
- 最新版本发布：2026-10-25T13:56:01.306Z
- 近 30 天下载量：2764（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：135（近 12 个月 135 个）

## 中文简介

AI CLIs的终端多路器. 运行 Claude, Codex, OpenCode, Kimi 并肩并肩并肩进行有标签的导航,分页,并持续会话.

## 安装

```sh
npm install @brimveyn/aimux
```

也可以使用：`pnpm add @brimveyn/aimux`、`yarn add @brimveyn/aimux`、`bun add @brimveyn/aimux`

## README

# 目标

AI CLIs的终端多路器. 运行 Claude、 Codex、 OpenCode 和正常 shell tab 在一个 TUI 中并列, 一次跨越多个项目, 与 每一分枝的活树, 一次应用的 diff 和拉取请求审查, 分裂的平板, 片段,主题,插件,以及完全可配置的密钥图.

![Built with Bun](https://img.shields.io/badge/runtime-Bun-f9f1e1) ![TypeScript](https://img.shields.io/badge/lang-TypeScript-3178c6) ![MIT License](https://img.shields.io/badge/license-MIT-blue)

![aimux demo](https://npmcn.com/package/%40brimveyn/aimux/assets/demo.gif)

## 特征

-   多项目工作流程,配备专用项目拾取器
-   选项卡 `claude`, (中文(简体) ), `codex`, (中文(简体) ), `opencode`, (中文(简体) ), `grok`, (中文(简体) ), `kimi`, (中文(简体) ), `antigravity`,以及 `terminal`
-   以窗格为焦点并调整快捷键的分割窗格
-   保存布局和标签状态的持久工程
-   profile-同化配置、目录、守护进程套接字和运行时状态
-   通过键盘映射定制 `@brimveyn/aimux-config`
-   片段目录和片段拾取器
-   可配置的平面板(嵌入边栏或作为独立的平面板)和a 专用 [git 模式](https://npmcn.com/package/%40brimveyn/aimux/docs/guide/git-mode.md) /阶段/承诺 以分割或堆叠的 diff 视图和 shiki 驱动加亮来推动
-   同样的窗帘 `github` 选项卡(`g`)读取分支的开放式拉力请求 结束 `gh` - 头衔、身体和每个CI检查其状态和期限
-   [工作树](https://npmcn.com/package/%40brimveyn/aimux/docs/guide/workspaces.md) 用于并行运行的代理 分支——建立每个分支的工作空间,对照其基础审查每个分支,以及 把工作空间的工作移到另一个地方
-   (单位:千美元) [插件系统](https://npmcn.com/package/%40brimveyn/aimux/docs/guide/plugins.md) 带有自己输入的 API, + `aimux plugin` 搜索、安装和链接
-   从已解析的密钥映射生成的内置帮助
-   带有67个内置主题(shiki catalog + goux house 主题)和 a 的主题拾取器 `/` 过滤器

## 安装

```bash
bun install -g @brimveyn/aimux
```

要求数 [阿宝](https://bun.sh/)。 。 。 .

贝壳完成(bash,zsh,fish) 首次发射时安装自己 tUI – 在您 shell 的完成目录中有一个文件, 没有点文件编辑 . 运行 `aimux doctor` 看它降落在哪里,或 `aimux completion install --shell zsh` 把它放在自己的位置。 选择退出 `AIMUX_NO_COMPLETION_INSTALL=1`。见 [文件/参考资料/目录](https://npmcn.com/package/%40brimveyn/aimux/docs/reference/cli.md#aimux-completion)。 。 。 .

## 快速启动

创建默认配置并安装输入的配置包 :

```bash
mkdir -p ~/.config/aimux/default
cd ~/.config/aimux/default
bun init -y
bun add -d @brimveyn/aimux-config
```

创建 `~/.config/aimux/default/aimux.config.ts`数字 :

```ts
import { defineConfig, actions } from '@brimveyn/aimux-config'

export default defineConfig({
  projectBar: {
    initialPosition: 'top',
    initialVisible: true,
  },

  keymaps: (k) =>
    k.mode('navigation', (m) => m.map('<C-g>', actions.projectPicker, 'Project picker')),
})
```

已打入的配置是启动意图, 而非应用管理的持续状态 。 字段类 `projectBar.initialVisible` 财务报告和审定财务报表 `projectBar.initialPosition` 重新应用于 每次发射,所以运行时这些字段的 UI 变化不粘接,而 配置条目仍然设定 .

然后启动应用程序 :

```bash
aimux
```

首次出道时,利用项目取料流程创建出您的第一个项目.

关于完整的设置路径,见 [`docs/getting-started.md`](https://npmcn.com/package/%40brimveyn/aimux/docs/getting-started.md)。 。 。 .

## 核心概念

### 简介

配置管理配置和目录在 :

```text
~/.config/aimux/<profile>/
```

活动配置文件选自:

1.  `AIMUX_PROFILE`
2.  `AIMUX_RUNTIME_PROFILE`
3.  `default`

运行时套接字生活在一个单独的运行时目录中,该目录取决于活动 简介。 见 [`docs/concepts/profiles.md`](https://npmcn.com/package/%40brimveyn/aimux/docs/concepts/profiles.md)。 。 。 .

### 配置对运行时状态

`aimux` 每个配置文件使用多个文件 :

-   `aimux.config.ts` 或者说 `aimux.config.js` - 输入用户配置
-   `aimux.json` - 应用管理的偏好和运行时态
-   `aimux-projects.json` - 项目目录和项目简介
-   `aimux-snippets.json` - 片段目录

拇指规则:

-   `aimux.config.ts` 宣布启动意图
-   `aimux.json` 存储应用程序管理的运行时间偏好
-   运行时间动作从不重写 `aimux.config.ts`

见 [`docs/concepts/config-and-state.md`](https://npmcn.com/package/%40brimveyn/aimux/docs/concepts/config-and-state.md)。 。 。 .

### 项目

一个工程是您通过选择文件夹添加的仓库 。 里面活下来了 工作空间(git worktrees),以及这些活页内——一个创建行动 每关: `Ctrl+G` 为一个项目, `Ctrl+P` 为工作空间, `Ctrl+N` (单位:千美元) 选项卡。 一个项目可以有:

-   名称
-   可选项目目录
-   持续的项目简介
-   项目栏和项目拾取器中的顺序

见 [`docs/guide/projects.md`](https://npmcn.com/package/%40brimveyn/aimux/docs/guide/projects.md)。 。 。 .

### 键盘图

通过 `@brimveyn/aimux-config` 与已运出 启动时默认值.

重要的运行时间:

-   运出的领导键为 `Ctrl+W`

见 [`docs/guide/keymaps.md`](https://npmcn.com/package/%40brimveyn/aimux/docs/guide/keymaps.md)。 。 。 .

## 默认每天快捷键

-   `?` - 打开帮助
-   `i` - 焦点终端, `Ctrl+Z` - 别管它了
-   `h` 编号 : `l` - 上/下个标签, `j` 编号 : `k` - 上/下个项目
-   `r` - 重命名标签, `d d` - 关闭标签, `S` - 闪光跳伞
-   `Ctrl+N` - 新的标签, `Ctrl+P` - 新的工作空间, `Ctrl+G` - 采取项目者
-   `Ctrl+S` - 拾片头, `Ctrl+T` - 主题拾取器
-   `Ctrl+B` - 切换侧边栏
-   `Ctrl+D` - 进入git模式, `G` - 切开被子板, `g` - 它的阴道/ github 标签
-   `Ctrl+W` 领导者是: `Ctrl+W b` 项目栏, `Ctrl+W u` 统计, `Ctrl+W ,` 设置, `Ctrl+W 1` . `Ctrl+W 9` 按索引切换标签
-   在终端中: `Ctrl+W |` 编号 : `Ctrl+W -` 分开, `Ctrl+W h j k l` 聚焦窗格

帮助模式反映了已解析的密钥映射, 因此它包括您的覆盖 .

## 国 际

```bash
aimux
aimux worker doctor
aimux worker run --name investigate --assistant claude "inspect this repository"
aimux project list
aimux tab create --assistant claude --new-workspace
aimux plugin search git
aimux profile list
aimux completion install --shell zsh
aimux version
aimux doctor
aimux update
aimux restart-daemon
aimux restart-terminal-manager
```

见 [`docs/reference/cli.md`](https://npmcn.com/package/%40brimveyn/aimux/docs/reference/cli.md) 关于行为细节.

对于代理管弦乐,更喜欢取名 `aimux worker` 命令。 他们结合 孤立的工作空间创建, 即时发送, 权威回合等待, 车队 检查,并严防清理 没有外壳包装或 `jq`锁定目标 与 `--project` (或 `AIMUX_PROJECT`) 对于任何长期运行的事物:默认 跟踪 UI 上次打开的工程 .

## 运行时模式

`aimux` 分为:

-   uI 应用程序
-   一个 IPC 守护进程
-   长寿终端管理器

此拆分允许守护进程重启, 并更新一些路径而不下降 每个活的PTY立刻.

见 [`docs/developer/architecture.md`](https://npmcn.com/package/%40brimveyn/aimux/docs/developer/architecture.md)。 。 。 .

## 文档地图

-   [`docs/getting-started.md`](https://npmcn.com/package/%40brimveyn/aimux/docs/getting-started.md)
-   [`docs/concepts/config-and-state.md`](https://npmcn.com/package/%40brimveyn/aimux/docs/concepts/config-and-state.md)
-   [`docs/concepts/profiles.md`](https://npmcn.com/package/%40brimveyn/aimux/docs/concepts/profiles.md)
-   [`docs/guide/projects.md`](https://npmcn.com/package/%40brimveyn/aimux/docs/guide/projects.md)
-   [`docs/guide/workspaces.md`](https://npmcn.com/package/%40brimveyn/aimux/docs/guide/workspaces.md)
-   [`docs/guide/git-mode.md`](https://npmcn.com/package/%40brimveyn/aimux/docs/guide/git-mode.md)
-   [`docs/guide/keymaps.md`](https://npmcn.com/package/%40brimveyn/aimux/docs/guide/keymaps.md)
-   [`docs/guide/themes.md`](https://npmcn.com/package/%40brimveyn/aimux/docs/guide/themes.md)
-   [`docs/guide/settings.md`](https://npmcn.com/package/%40brimveyn/aimux/docs/guide/settings.md)
-   [`docs/guide/snippets.md`](https://npmcn.com/package/%40brimveyn/aimux/docs/guide/snippets.md)
-   [`docs/guide/plugins.md`](https://npmcn.com/package/%40brimveyn/aimux/docs/guide/plugins.md)
-   [`docs/guide/claude-integration.md`](https://npmcn.com/package/%40brimveyn/aimux/docs/guide/claude-integration.md)
-   [`docs/guide/ai-usage-indicator.md`](https://npmcn.com/package/%40brimveyn/aimux/docs/guide/ai-usage-indicator.md)
-   [`docs/guide/usage-history.md`](https://npmcn.com/package/%40brimveyn/aimux/docs/guide/usage-history.md)
-   [`docs/reference/cli.md`](https://npmcn.com/package/%40brimveyn/aimux/docs/reference/cli.md)
-   [`docs/reference/config-reference.md`](https://npmcn.com/package/%40brimveyn/aimux/docs/reference/config-reference.md)
-   [`docs/reference/plugin-api.md`](https://npmcn.com/package/%40brimveyn/aimux/docs/reference/plugin-api.md)
-   [`docs/reference/runtime-paths.md`](https://npmcn.com/package/%40brimveyn/aimux/docs/reference/runtime-paths.md)
-   [`docs/developer/architecture.md`](https://npmcn.com/package/%40brimveyn/aimux/docs/developer/architecture.md)
-   [`docs/developer/plugins.md`](https://npmcn.com/package/%40brimveyn/aimux/docs/developer/plugins.md)
-   [`docs/developer/aimux-config-internals.md`](https://npmcn.com/package/%40brimveyn/aimux/docs/developer/aimux-config-internals.md)

## 发展

```bash
git clone https://github.com/BrimVeyn/aimux && cd aimux
bun install

bun run dev
bun run start
bun test
bun run check
bun run lint
bun run knip
```

顶部的GIF可以复制: `bun run demo` 种子丢弃 `demo` 简介和记录 [`assets/demo.tape`](https://npmcn.com/package/%40brimveyn/aimux/assets/demo.tape) 与 [数字](https://github.com/charmbracelet/vhs)磁带头上写着什么 需要帮助.

仓库 dev 脚本使用 `AIMUX_PROFILE=dev`因此,地方发展确实 不与安装全球的相撞 `aimux` 举个例子.

## 参考资料

-   [皮埃尔-diffs.com](https://diffs.com/) ——给" gi"的灵感 审查经验:分拆/堆叠布局,渐进上下文折叠, 并专注于文件的首个更改而不是顶部.
-   [志纪](https://shiki.style/) 用于 git diff 视图的语法加亮 和被捆绑的主题目录的来源.
-   [医生](https://github.com/ogulcancelik/herdr) 照片来自@ogulcancelik 每CLI 助理状态高压(工作/等待输入/闲置) 项目栏内使用的是草药 `detect.rs` 规则表.

## 许可证

麻省理工学院

## 常见问题

### @brimveyn/aimux 是什么？

AI CLIs的终端多路器\. 运行 Claude, Codex, OpenCode, Kimi 并肩并肩并肩进行有标签的导航,分页,并持续会话\.

### 如何安装 @brimveyn/aimux？

在项目目录运行 npm install @brimveyn/aimux，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 aimux，可以用 npx aimux 直接运行。

### @brimveyn/aimux 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/brimveyn\_\_aimux 是否存在。

### @brimveyn/aimux 支持 ESM 还是 CommonJS？

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

### @brimveyn/aimux 可以商用吗？

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

### @brimveyn/aimux 的下载量有多少？

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

### @brimveyn/aimux 还在维护吗？

最新版本 1\.29\.0 发布于 2026/10/25（14 天前）；至今共发布 135 个版本，其中过去 12 个月发布了 135 个；首次发布于 2026/04/17。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。