AgentHarness 课程

第四十四课:实战:新项目脚手架

1.4K字·4分钟·
从零创建项目AGENTS.md初始化首次提交

学习目标

  • 学会使用 Codex 创建新项目
  • 掌握 AGENTS.md 初始化
  • 完成首次提交
  • 了解项目初始化最佳实践

一、创建项目

1.1 创建目录

mkdir my-project && cd my-project

1.2 启动 Codex

codex "创建一个 TypeScript 项目,使用 Express 框架"

1.3 代理执行

代理会:

  1. 初始化 package.json
  2. 安装依赖
  3. 创建项目结构
  4. 配置 TypeScript
  5. 创建入口文件

二、AGENTS.md 初始化

2.1 使用 /init

在 Codex 中输入 /init,自动生成 AGENTS.md。

2.2 生成内容

/init 会检测:

  • 项目类型和框架
  • 包管理器
  • 测试框架
  • 构建工具

2.3 手动优化

根据项目需求补充:

  • 项目背景
  • 开发规范
  • 部署流程
  • 常见问题

三、首次提交

3.1 初始化 Git

git init

3.2 创建 .gitignore

让 Codex 生成 .gitignore 文件。

3.3 提交代码

git add .
git commit -m "Initial commit"

四、项目结构

4.1 推荐结构

my-project/
├── src/
│   ├── index.ts
│   ├── routes/
│   ├── controllers/
│   └── utils/
├── tests/
├── docs/
├── AGENTS.md
├── package.json
├── tsconfig.json
└── .gitignore

4.2 配置文件

  • package.json:项目配置和依赖
  • tsconfig.json:TypeScript 配置
  • .eslintrc.js:ESLint 配置
  • .prettierrc:Prettier 配置

五、最佳实践

5.1 项目初始化

  • 使用 TypeScript 严格模式
  • 配置 ESLint 和 Prettier
  • 设置测试框架
  • 配置 CI/CD

5.2 AGENTS.md

  • 包含项目概述
  • 列出常用命令
  • 定义代码规范
  • 说明测试方法

5.3 版本控制

  • 使用 .gitignore
  • 提交 AGENTS.md
  • 使用语义化提交信息

六、本课小结

要点说明
创建项目mkdir + codex 命令
AGENTS.md/init 自动生成 + 手动优化
首次提交git init + commit
最佳实践TypeScript、ESLint、测试

下一步

下一课我们将学习 Bug 修复工作流。