MyCoder

一款基于命令行的人工智能编码工具。完整详情请访问主MyCoder.ai 网站和官方 MyCoder.Ai 文档网站。

功能特性

• 🤖 AI 驱动：利用 Anthropic 的 Claude、OpenAI 模型以及 Ollama 提供智能编码辅助
• 🛠️ 可扩展工具系统：模块化架构，支持多种工具类别
• 🔄 并行执行：能够生成子代理以并发处理任务
• 📝 自我修改：可以修改自身代码；它由自身编写并测试而成
• 🔍 智能日志记录：分层、带颜色编码的日志系统，输出清晰明了
• 👤 人类友好：通过 README.md、项目文件和 Shell 命令构建自身上下文
• 🌐 GitHub 集成：支持 GitHub 模式，可将问题和 PR 作为工作流的一部分进行处理
• 📄 模型上下文协议：支持 MCP 协议，用于访问外部上下文源
• 🧠 消息压缩：自动管理上下文窗口，适用于长时间运行的代理

如需支持，请加入 MyCoder.ai 的 Discord 社区：https://discord.gg/5K6TYrHGHt

安装

npm install -g mycoder

有关 macOS 和 Linux 的详细安装说明，包括如何使用 NVM 安装 Node.js，请参阅我们的入门指南。

使用方法

# 交互模式
mycoder -i

# 带提示词运行
mycoder "实现一个显示项目列表的 React 组件"

# 从文件读取提示词运行
mycoder -f prompt.txt

# 启用执行过程中的交互式修正（按 Ctrl+M 发送修正）
mycoder --interactive "实现一个显示项目列表的 React 组件"

# 禁用用户提示，实现完全自动化运行
mycoder --userPrompt false "生成一个基础的 Express.js 服务器"

# 在自动化环境中禁用用户同意警告和版本升级检查
mycoder --upgradeCheck false "生成一个基础的 Express.js 服务器"

配置

MyCoder 使用项目中的配置文件进行配置。其配置文件位置和格式与 ESLint 等现代 JavaScript 工具类似，支持多种位置和格式。

配置文件位置

MyCoder 将按优先级顺序在以下位置查找配置文件：

1. 项目根目录下的 mycoder.config.js
2. 项目根目录下的 .mycoder.config.js
3. 项目根目录下的 .config/mycoder.js
4. 项目根目录下的 .mycoder.rc
5. 用户主目录下的 .mycoder.rc
6. package.json 中的 mycoder 字段
7. ~/.config/mycoder/config.js（遵循 XDG 标准的用户配置）

支持的文件扩展名包括：.js、.ts、.mjs、.cjs、.json、.jsonc、.json5、.yaml、.yml 和 .toml。

创建配置文件

在您选择的位置创建配置文件：

// mycoder.config.js
export default {
  // GitHub 集成
  githubMode: true,

  // 浏览器设置
  headless: true,
  userSession: false,

  // 系统浏览器检测设置
  browser: {
    // 是否使用系统浏览器或 Playwright 自带浏览器
    useSystemBrowsers: true,

    // 优先使用的浏览器类型（chromium、firefox、webkit）
    preferredType: 'chromium',

    // 自定义浏览器可执行文件路径（覆盖自动检测）
    // executablePath: null, // 例如 '/path/to/chrome'
  },

  // 模型设置
  provider: 'anthropic',
  model: 'claude-3-7-sonnet-20250219',
  maxTokens: 4096,
  temperature: 0.7,

  // 自定义设置
  customPrompt: '',
  // 多行自定义提示示例：
  // customPrompt: [
  //   '自定义指令第1行',
  //   '自定义指令第2行',
  //   '自定义指令第3行',
  // ],
  profile: false,

  // 基础 URL 配置（适用于需要该配置的提供商）
  baseUrl: 'http://localhost:11434', // 例如 Ollama 的配置

  // MCP 配置
  mcp: {
    servers: [
      {
        name: 'example',
        url: 'https://mcp.example.com',
        auth: {
          type: 'bearer',
          token: 'your-token-here',
        },
      },
    ],
    defaultResources: ['example://docs/api'],
    defaultTools: ['example://tools/search'],
  },
};

CLI 参数会覆盖配置文件中的设置。

交互式修正

MyCoder 支持在主代理运行时发送修正信息。当您发现代理偏离方向或需要更多信息时，此功能非常有用。

使用方法

1. 使用 --interactive 标志启动 MyCoder：

   mycoder --interactive "实现一个 React 组件"
   

2. 在代理运行期间，按下 Ctrl+M 进入修正模式。

3. 输入您的修正内容或补充上下文。

4. 按 Enter 将修正发送给代理。

代理会接收您的消息，并将其纳入决策过程，类似于父代理向子代理发送消息的方式。

配置

您可以在配置文件中启用交互式修正：

// mycoder.config.js
export default {
  // 其他选项...
  interactive: true,
};

GitHub 评论命令

MyCoder 可以直接通过 GitHub 问题评论中的灵活 /mycoder 命令触发：

/mycoder [您的指令在这里]

示例：

• /mycoder 为该问题实现一个 PR
• /mycoder 创建一个实施方案
• /mycoder 为该功能建议测试用例

了解更多关于 GitHub 评论命令的信息

软件包

• mycoder - MyCoder 的命令行界面
• mycoder-agent - MyCoder 的代理模块
• mycoder-docs - MyCoder 的文档网站

开发

# 克隆仓库
git clone https://github.com/drivecore/mycoder.git
cd mycoder

# 安装依赖
pnpm install

# 构建所有包
pnpm build

# 运行测试
pnpm test

# 使用交互式提示创建提交
pnpm commit

发布流程

MyCoder 遵循 Conventional Commits 规范来编写提交信息。我们的发布流程完全自动化：

1. 按照 Conventional Commits 格式提交更改
2. 创建 PR 并获得审核与批准
3. 当合并到主分支时，我们的 CI/CD 流水线将：
   • 根据提交信息确定下一个版本号
   • 生成变更日志
   • 创建 GitHub Release
   • 打上标签
   • 发布到 NPM

更多详情请参阅贡献指南。

浏览器自动化

MyCoder 使用 Playwright 进行浏览器自动化，sessionStart 和 sessionMessage 工具均依赖于此。默认情况下，Playwright 需要通过 npx playwright install 单独安装浏览器。

系统浏览器检测

MyCoder 现在包含系统浏览器检测功能，允许它使用您已安装的浏览器，而无需单独安装 Playwright 浏览器。这在 MyCoder 被全局安装时尤为有用。

系统浏览器检测功能：

1. 自动检测 Windows、macOS 和 Linux 上已安装的浏览器
2. 支持 Chrome、Edge、Firefox 等浏览器
3. 保持无头模式和干净会话的能力
4. 如果未找到系统浏览器，则回退到 Playwright 自带的浏览器

配置

您可以在 mycoder.config.js 中配置浏览器检测：

export default {
  // 其他配置...

  // 系统浏览器检测设置
  browser: {
    // 是否使用系统浏览器或 Playwright 自带的浏览器
    useSystemBrowsers: true,

    // 优先使用的浏览器类型（chromium、firefox、webkit）
    preferredType: 'chromium',

    // 自定义浏览器可执行文件路径（覆盖自动检测）
    // executablePath: null, // 例如：'/path/to/chrome'
  },
};

贡献

有关如何为本项目做出贡献的详细信息，请参阅 CONTRIBUTING.md。

许可证

本项目采用 MIT 许可证授权——详情请参阅 LICENSE 文件。

MyCoder 快速上手指南

MyCoder 是一款基于命令行的 AI 编程助手，支持调用 Claude、OpenAI 及 Ollama 等模型，具备并行执行、代码自修改及 GitHub 工作流集成等强大功能。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统：macOS、Linux 或 Windows
• Node.js：需安装 Node.js (推荐最新 LTS 版本)
  • 建议：使用 nvm (Node Version Manager) 管理 Node.js 版本，以避免权限问题。
• 包管理器：npm (随 Node.js 自动安装)
• API Key：根据您选择的模型提供商（如 Anthropic, OpenAI），需提前准备好对应的 API Key 并配置到环境变量中。

注意：国内用户若访问 npm 源较慢，可临时切换至淘宝镜像源： npm config set registry https://registry.npmmirror.com

安装步骤

通过 npm 全局安装 MyCoder：

npm install -g mycoder

安装完成后，可通过运行 mycoder --version 验证安装是否成功。

基本使用

1. 交互式模式 (推荐新手)

启动交互界面，MyCoder 将引导您输入需求并进行多轮对话：

mycoder -i

2. 直接执行任务

直接在命令行传入指令，让 AI 自动完成编码任务：

mycoder "Implement a React component that displays a list of items"

3. 从文件读取提示词

如果任务描述较长，可将其保存为文本文件后执行：

mycoder -f prompt.txt

4. 高级用法：交互式修正

在任务执行过程中，若发现 AI 偏离方向，可使用 --interactive 标志。运行中按下 Ctrl+M 即可随时发送修正指令或补充上下文：

mycoder --interactive "Implement a React component that displays a list of items"

5. 全自动模式

适用于脚本或 CI/CD 环境，禁用所有用户确认提示：

mycoder --userPrompt false --upgradeCheck false "Generate a basic Express.js server"

---

更多详细配置（如模型选择、GitHub 集成、MCP 协议支持等）请参考官方文档或查看项目根目录下的配置文件示例。