ompweb/README.zh-CN.md

ompweb

English | 简体中文 | 日本語

社区：加入 OMPWEB Discord

oh-my-pi (omp) 编程智能体的现代 Web UI。它读取本地的 omp 会话，在浏览器中提供实时对话、项目会话浏览、配置管理和文件预览等功能。

截图（浅色 / 深色主题）

环境要求

• 已安装 omp 且在 PATH 中（或通过 OMP_WEB_OMP_BIN 指定路径）
• Node.js >= 22.19.0

快速开始

免安装直接运行：

npx @kahme247/ompweb@latest

或全局安装：

npm install -g @kahme247/ompweb
ompweb

在浏览器中打开 http://127.0.0.1:30177。

CLI 选项

ompweb --port 8080                         # 自定义端口
ompweb --hostname 0.0.0.0                  # 监听网络地址
ompweb --password "your-password"          # 启用密码保护
ompweb --no-open                           # 不自动打开浏览器

功能特性

• 实时对话：与本地 omp 智能体进行低延迟流式交互。
• 队列删除确认：从队列面板移除后续消息或引导消息前，先预览内容并确认。此操作不会取消 OMP 内部已排队消息的发送。
• 会话管理：按项目浏览历史会话，支持会话分叉与分支回溯。
• 草稿恢复：未发送的文本按会话或新会话的工作区分别保存；浏览器存储可用时，在同一标签页后退、前进或重新加载后可恢复（最多 50 份草稿）。图片和文件附件仅保留在内存中。
• 实时任务与子智能体：可折叠面板实时展示任务清单（todo）与子智能体进度，并支持查看完整转录。
• 文件管理与预览：与对话并排浏览文件，支持代码、Markdown、图片、音频及 PDF 预览。
• Git Worktree 支持：直接在侧边栏切换与管理 Git 工作树。
• 可视化设置：在 Web 界面中直接配置模型、API 密钥、MCP 服务器、技能、插件及 OMP 原生设置。
• 快捷指令与命令面板：内置常用指令（/plan、/review、/fix、/test 等）及 ⌘K / Ctrl+K 全局面板。
• 主题与多语言：温暖纸感深浅主题，完整支持英语、简体中文及日本語。

环境变量

变量	说明	默认值
PORT	服务端口	30177
OMP_WEB_HOSTNAME	绑定主机名	127.0.0.1
OMP_WEB_PASSWORD	可选的 Web 访问密码	无（未启用验证）
OMP_WEB_NO_OPEN	设为 1 时禁止自动打开浏览器	0
OMP_WEB_OMP_BIN	omp 二进制路径（未在 PATH 时使用）	自动检测
PI_CODING_AGENT_DIR	自定义 omp agent 目录	~/.omp/agent
OMP_WEB_STT_ENDPOINT	OpenAI 兼容的语音转文字接口 URL	无（默认禁用）
OMP_WEB_STT_KEY	STT 接口对应的 API Key	无
OMP_WEB_STT_MODEL	STT 接口的模型名称	无

本地开发

git clone https://github.com/kahme247/ompweb.git
cd ompweb
npm install
npm run dev

本地开发服务器运行在 http://127.0.0.1:30178。

代码检查

npm run typecheck   # TypeScript 类型检查
npm run lint        # ESLint 检查
npm test            # 运行测试套件

注意：本地开发期间请勿运行 npm run build，以免污染 .next/ 导致开发服务器异常。

致谢与许可证

• 分叉自 agegr/pi-web（MIT），针对 can1357/oh-my-pi 进行适配。
• 采用 MIT 许可证 开源。