MyCoder 开源项目使用教程-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00911/article/details/147160859

MyCoder 开源项目使用教程

mycoder Simple to install, powerful command-line based AI agent system for coding. 项目地址: https://gitcode.com/gh_mirrors/my/mycoder

1. 项目目录结构及介绍

MyCoder 项目是一个命令行界面的 AI 助手，用于编码任务。项目的目录结构如下：

mycoder/
├── .github/              # GitHub 工作流和模板
├── .husky/               # Git 提交钩子配置
├── docs/                 # 文档目录
├── packages/             # 项目包目录
├── scripts/              # 脚本目录
├── .DS_Store             # macOS 系统文件
├── .gitignore            # Git 忽略文件
├── .gitmessage           # Git 提交消息配置
├── .npmignore            # npm 忽略文件
├── .nvmrc                # Node.js 版本管理配置
├── .prettierignore       # Prettier 忽略文件
├── .prettierrc           # Prettier 配置文件
├── CONTRIBUTING.md       # 贡献指南
├── LICENSE               # 开源协议文件
├── README.md             # 项目说明文件
├── commitlint.config.js  # 提交信息校验配置
├── eslint.config.js      # ESLint 配置文件
├── example-status-update.md # 示例状态更新文件
├── mycoder.config.js     # MyCoder 配置文件
├── package.json          # 项目包描述文件
├── pnpm-lock.yaml        # pnpm 锁文件
├── pnpm-workspace.yaml   # pnpm 工作空间配置
└── test_content.txt      # 测试内容文件

.github/：存放 GitHub 工作流和模板文件，如自动化的 pull request 检查。
.husky/：存放 Git 钩子脚本，用于在提交代码前进行一些检查或自动化操作。
docs/：存放项目文档。
packages/：存放项目中的包。
scripts/：存放项目脚本，用于执行各种自动化任务。
.DS_Store：macOS 系统生成的文件，用于存储目录信息。
.gitignore：定义 Git 应该忽略的文件和目录。
.gitmessage：定义 Git 提交时使用的默认消息。
.npmignore：定义 npm 发布时应该忽略的文件。
.nvmrc：定义 Node.js 的版本，用于版本控制。
.prettierignore：定义 Prettier 应该忽略的文件。
.prettierrc：定义 Prettier 的配置。
CONTRIBUTING.md：提供贡献指南，帮助外部贡献者了解如何参与项目。
LICENSE：项目使用的开源协议。
README.md：项目的自述文件，包含项目的基本信息和使用方法。
commitlint.config.js：配置提交信息校验规则。
eslint.config.js：配置 ESLint 的规则。
example-status-update.md：示例状态更新文件，用于展示状态更新的格式。
mycoder.config.js：MyCoder 的配置文件，用于定制化项目设置。
package.json：定义项目的元数据、脚本和依赖。
pnpm-lock.yaml：pnpm 的锁文件，用于确保依赖的一致性。
pnpm-workspace.yaml：pnpm 工作空间配置，用于管理多个项目。
test_content.txt：测试内容文件。

2. 项目的启动文件介绍

MyCoder 项目的启动主要是通过 package.json 文件中的脚本进行的。以下是一些常用的启动脚本：

npm install：安装项目依赖。
npm run build：构建项目。
npm test：运行测试。
npm commit：创建提交信息。

在 package.json 文件中，可以找到如下定义的脚本：

{
  "scripts": {
    "build": "pnpm build",
    "test": "pnpm test",
    "commit": "git-cz"
  }
}

这些脚本可以通过 npm 命令调用，例如，运行 npm run build 会执行 pnpm build。

3. 项目的配置文件介绍

MyCoder 项目的配置主要通过 mycoder.config.js 文件进行。以下是配置文件的基本结构：

export default {
  // GitHub 集成配置
  githubMode: true,
  // 浏览器配置
  headless: true,
  userSession: false,
  // 系统浏览器检测配置
  browser: {
    useSystemBrowsers: true,
    preferredType: 'chromium',
    // executablePath: null, // e.g., '/path/to/chrome'
  },
  // 模型配置
  provider: 'anthropic',
  model: 'claude-3-7-sonnet-20250219',
  maxTokens: 4096,
  temperature: 0.7,
  // 自定义设置
  customPrompt: '',
  // 示例多行自定义指令
  // customPrompt: [
  //   'Custom instruction line 1',
  //   'Custom instruction line 2',
  //   'Custom instruction line 3',
  // ],
  profile: false,
  // 基础 URL 配置
  baseUrl: 'http://localhost:11434',
  // 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',
    ],
  },
};

在这个配置文件中，可以定制化 GitHub 集成、浏览器设置、模型参数、自定义提示语、配置文件格式等。通过修改这些配置项，可以调整 MyCoder 的行为以满足不同用户的需求。

mycoder Simple to install, powerful command-line based AI agent system for coding. 项目地址: https://gitcode.com/gh_mirrors/my/mycoder