选一条路径。
官方脚本会从 build.stencil.so 拉取预编译包,并在安装前校验 SHA-256。
curl -fsSL https://omp.sh/install | sh
# 固定版本
curl -fsSL https://omp.sh/install \
| sh -s -- --binary --ref v18.20.3
brew install can1357/tap/omp
# 升级
brew upgrade omp
bun install -g @oh-my-pi/pi-coding-agent
# 需要 Bun ≥ 1.4.4
bun --version
# 直接运行
nix run github:can1357/oh-my-pi
# 安装到当前 profile
nix profile add github:can1357/oh-my-pi
irm https://omp.sh/install.ps1 | iex
# 安装完成后
omp --version
mise use -g github:can1357/oh-my-pi
# 版本跟随 mise 配置
omp --version
libstdc++ 与 libgcc,先执行 apk add libstdc++ libgcc。三条命令进入状态。
检查安装
omp --version 应输出版本号。若无命令,检查 PATH 是否包含安装目录。
初始化与登录
omp setup 引导选择默认模型;omp login 登录供应商。也可以直接设置 ANTHROPIC_API_KEY、OPENAI_API_KEY 等环境变量。
在项目里启动
cd your-repo && omp。首个会话会读取 AGENTS.md / CLAUDE.md、规则、技能与项目 MCP。
$ omp --version
omp/18.20.3
$ omp setup
# 选择默认模型与登录方式
$ cd ~/work/acme-api
$ omp "先读 AGENTS.md,再解释鉴权链路"
omp "...";未配置模型时会提示登录或选择。常用模型可用 omp --model opus "..." 临时覆盖。配置在磁盘上,
不在黑盒里。
| 路径 | 作用 |
|---|---|
~/.omp/agent/config.yml | 全局设置、模型角色、重试与界面选项 |
~/.omp/agent/models.yml | 自定义供应商与模型能力 |
~/.omp/agent/mcp.json | 用户级 MCP 服务器 |
.omp/mcp.json | 项目级 MCP 服务器 |
~/.omp/agent/sessions/ | 会话 JSONL 与子代理转录 |
~/.omp/profiles/<name>/ | 命名 profile 的独立认证、会话与配置 |
AGENTS.md、CLAUDE.md、.cursor/rules/ | 项目上下文与规则(按原格式读取) |
隔离工作身份
omp --profile work --alias omp-work 创建独立认证、会话和配置的快捷命令。
按次覆盖
--config overlay.yml 在本次运行叠加设置,适合临时关闭项目 MCP 或切换模型。
补全
eval "$(omp completions zsh)";bash、fish 同样支持,子命令与模型名都能补。
最常用的命令。
| 想要 | 命令 |
|---|---|
| 交互式会话 | omp |
| 带初始任务 | omp "修复 CI 失败" |
| 非交互执行 | omp -p "总结最近一次提交" |
| 机器可读事件 | omp -p --mode json "..." |
| 继续 / 恢复 / 派生 | omp -c、omp -r、omp --fork <session> |
| 附加文件或图片 | omp @prompt.md @screen.png "看这个" |
| 成本上限 | omp --max-cost 20 "..." |
| 审批模式 | omp --approval-mode write "..." |
| 导出会话 | omp --export <session.jsonl> |
| 用量统计 | omp stats |
| 更新 | omp update |
安装前后,常被问到的。
需要预先安装 Node.js 或 Bun 吗?
预编译二进制已自带运行时,不需要 Node 或 Bun。只有走 bun install -g 或从源码构建时需要 Bun ≥ 1.4.4;源码开发还需要 Rust 工具链来构建原生插件。
Windows 需要 WSL 吗?
不需要。omp 提供 win32-x64 与 win32-arm64 原生构建,自带 shell 引擎,不依赖 WSL 桥接。
omp 和 Pi 是什么关系?
omp 基于 Mario Zechner 的 Pi 衍生,重写为面向编码的完整作业面,加入会话、子代理、命令、扩展与原生核心。项目由 Stencil Labs 维护,MIT 许可。
必须使用付费模型吗?
不必须。可接本地 Ollama、LM Studio、llama.cpp、vLLM,也可用带配额的计划或免费层。实际可用性取决于供应商政策与你的账号。
为什么打开仓库就加载了它的扩展?
这是设计:项目设置、扩展、hooks、技能与 MCP 都属于项目输入。对不可信仓库使用 --no-extensions、--trusted-extension <abs-path>,或用 YAML overlay 关闭 mcp.enableProjectConfig。
数据存在哪里?可以清理吗?
会话与配置在 ~/.omp/agent/,统计数据库默认 ~/.omp/stats.db。用 omp gc 做存储垃圾回收;删除前请先导出需要保留的会话。
如何卸载?
按安装方式反向操作:Homebrew 用 brew uninstall omp,Bun 用 bun remove -g @oh-my-pi/pi-coding-agent,Nix 从 profile 移除;再按需删除 ~/.omp。
“A coding agent with the IDE wired in.”