📖 使用文档

从安装到进阶，快速掌握 Oh My Coder 的全部能力。

安装

一行命令安装 Oh My Coder：

pip install oh-my-coder

或者从源码安装：

git clone https://github.com/VOBC/oh-my-coder.git cd oh-my-coder pip install -e .
💡
需要 Python 3.9+。推荐使用虚拟环境：python -m venv .venv && source .venv/bin/activate

第一个任务

安装完成后，启动 Web 界面：

omc server start

浏览器打开 http://localhost:8080，在任务输入框描述你的需求即可。

或者使用 CLI 直接执行：

omc run "实现一个用户认证系统"

配置 API Key

Oh My Coder 默认使用 DeepSeek 免费额度，零成本即可使用。配置 API Key 有两种方式：

方式一：Web 界面配置

进入 设置页面，在 API Keys 标签页填入你的 Key。

方式二：命令行配置

omc config set -k DEEPSEEK_API_KEY -v sk-your-key-here
🎉
DeepSeek 每天 4000 万 token 免费额度，大部分个人使用完全够用！

支持的模型

  • DeepSeek V4 — 低成本，64K上下文
  • GLM-4.7-Flash — 免费，128K上下文
  • MiMo Flash — 低成本，200K上下文
  • Kimi 128K — 低成本，128K上下文
  • Doubao-Pro — 低成本，32K上下文
  • 天工 3.0 — 低成本，128K上下文
  • 百川 4 — 低成本，128K上下文
  • Ollama 本地模型 — 零成本，隐私保护

工作流

工作流定义了 Agent 的协作流程。不同场景使用不同的工作流：

工作流用途Agent 链
build完整开发Explore → Analyst → Architect → Executor → Verifier
review代码审查Explore → CodeReviewer → Security
debug调试修复Explore → Debugger → Executor → Verifier
test测试生成Explore → TestEngineer → Verifier

Agent 体系

每个 Agent 专注于一个领域，像一个真实工程团队的成员：

  1. 🔍 Explorer
    探索项目结构，理解代码库，收集上下文
  2. 🧠 Analyst
    分析需求，拆解任务，制定执行计划
  3. 🏗️ Architect
    设计架构方案，确定技术选型和代码结构
  4. 💻 Executor
    编写代码，实现功能，修改文件
  5. ✅ Verifier
    验证结果，运行测试，确认代码质量
  6. 🐛 Debugger
    定位 Bug，分析错误，修复问题
  7. 🔎 CodeReviewer
    代码审查，发现潜在问题，提出改进建议
  8. 🛡️ Security
    安全扫描，检测漏洞，验证合规性

模型路由

Oh My Coder 根据任务复杂度自动路由到最合适的模型：

🧠
LOW → 简单查询（文件列表、格式化）
MEDIUM → 常规任务（功能实现、Bug 修复）
HIGH → 复杂任务（架构设计、全流程开发）

智能路由可节省 30-50% 的 Token 消耗，同时保证任务质量。

CLI 使用

# 启动 Web 界面 omc server start # 执行任务 omc run "任务描述" # 指定模型和工作流 omc run --model deepseek --workflow build "任务描述" # 查看历史 omc history # 查看配置 omc config list # 代码审查 omc review

插件系统

Oh My Coder 支持插件扩展，可以注册自定义 Agent、Skill 和 Hook。

# 创建插件 from src.plugins import register, PluginBase, PluginMetadata @register class MyPlugin(PluginBase): @property def metadata(self): return PluginMetadata( name="my-plugin", version="0.1.0", description="我的自定义插件", ) def on_load(self): print("插件已加载") def register_skills(self): return {"greet": lambda: "Hello!"}

本地模型 (Ollama)

使用 Ollama 运行本地模型，零成本且完全隐私：

  1. 安装 Ollama
    访问 ollama.ai 下载安装
  2. 拉取模型
    ollama pull qwen2:7b — 推荐 7B 参数模型
  3. 启动服务
    ollama serve — Oh My Coder 会自动检测
⚠️
本地模型需要至少 8GB 内存。7B 模型约需 4GB 显存，13B 约需 8GB。