mofox-code 0.1.1

Neo-MoFox Coding Agent TUI - Claude Code 风格的终端编程助手

mofox-code

Neo-MoFox Coding Agent 的终端前端（TUI），Claude Code 风格的终端编程助手。通过 WebSocket 连接到 Coding Agent 后端，在终端内提供交互式 AI 编程对话体验。

功能特性

• 终端内交互式 AI 编程对话 — 直接在终端与 AI 编程助手进行自然语言交流，完成代码生成、修改、分析等任务
• 流式 Markdown 实时渲染 — 增量渲染 Agent 回复，支持代码块语法高亮、行号显示，所见即所得
• Bash 命令审批系统 — Agent 执行 Shell 命令前需用户审批，支持自动审查模式，防止危险操作
• Checkpoint 回滚机制 — 每次代码变更自动生成检查点，支持 /undo 和 /rollback 快速恢复
• 三套配色主题 — 内置 dark / light / monokai 三套完整配色方案，适应不同终端环境
• 配置文件 + CLI 参数分层配置 — 通过 ~/.mofox-code/config.toml 持久化偏好，CLI 参数一键覆盖

环境要求

• Python >= 3.11

前置条件

mofox-code 是 Neo-MoFox Coding Agent 的前端客户端，使用前需要先部署后端。

后端仓库：Windpicker-owo/coding_agent

coding_agent 作为 Neo-MoFox 的插件运行，部署在 Neo-MoFox 框架上。简要部署步骤：

1. 按照 Neo-MoFox 文档部署框架
2. 在 plugins 目录下克隆 coding_agent 插件
3. 编辑 config/model.toml 配置 5 个模型任务（详见后端 README）：
   • coding_main — 主编排器（理解需求、制定计划）
   • coding_researcher — 模块研究员（分析代码）
   • coding_coder — 编码员（实施代码变更）
   • coding_reviewer — 命令安全审查
   • coding_title — 会话标题生成
4. 启动 Neo-MoFox，插件会在 ws://localhost:8765/coding-agent/ws 监听 WebSocket 连接

模型配置是后端的关键步骤，请务必参照后端 README 中的说明完成配置。

安装

git clone https://github.com/MoFox-Studio/MoFox-Code.git
cd mofox-code
pip install -e .

或使用 uv：

uv pip install -e .

配置

配置文件路径：~/.mofox-code/config.toml（首次运行自动生成）

[server]
url = "ws://localhost:8765/coding-agent/ws"

[preferences]
theme = "dark"
auto_review = false

配置项	说明	默认值
server.url	后端 WebSocket 地址	ws://localhost:8765/coding-agent/ws
preferences.theme	配色主题	dark
preferences.auto_review	是否启用自动审查	false

首次使用

以下是完整的首次使用流程，从零开始跑通 mofox-code：

1. 部署后端 — 按照前置条件中的步骤，部署 Neo-MoFox + coding_agent 插件，完成 5 个模型任务的配置
2. 克隆并安装 mofox-code — 执行安装中的命令
3. （可选）编辑配置文件 — 如果后端地址非默认，编辑 ~/.mofox-code/config.toml 中的 server.url
4. 启动 — 先启动 Neo-MoFox 后端，然后在终端运行：

   mofox-code
   # 或在特定项目目录下：
   mofox-code --project-dir .
   

5. 等待项目研究 — 首次进入项目时，Agent 会自动触发项目侦察（Scout）和深度研究（Researcher），完成后即可开始对话

CLI 参数

mofox-code [选项]

参数	说明	默认值
--server	后端 WebSocket 地址	ws://localhost:8765/coding-agent/ws
--auto-review	启用自动审查模式	false
--theme	配色主题（dark / light / monokai）	dark
--project-dir	项目根目录	当前目录
--verbose	输出详细调试信息	false

配置优先级：CLI 参数 > 配置文件 > 默认值

内置命令

在对话界面中，以 / 开头的输入会被识别为内置命令：

命令	功能
/exit / /quit	退出程序
/undo	回滚最近一步操作
/rollback	列出所有检查点，选择回滚到指定步骤
/history	查看操作历史
/status	查看当前会话状态（phase、项目名、检查点数量等）
/auto-review on	开启自动审查模式
/auto-review off	关闭自动审查模式
/clear	清屏
/help	显示帮助信息

命令审批

当 Agent 需要执行 Bash 命令时，会弹出审批面板，展示命令内容、工作目录和自动审查结果。此时按以下键做出决策：

按键	操作	说明
a	允许一次	仅本次放行
s	会话内允许	当前会话中对相同命令前缀自动放行
f	永久允许	写入配置文件，永久对该命令前缀放行
d	拒绝	拒绝执行本次命令
r	开启自动审查	切换到自动审查模式，后续命令自动评估

命令前缀指命令的第一个 token（如 git、uv、python），用于定义审批规则的生效范围。

许可

MIT License