/init-proj 命令用于初始化一个新项目,包括创建 AGENTS.md 文件和配置 虚拟环境:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
| --- description: 初始化项目,创建 AGENTS.md 并配置虚拟环境 argument-hint: "" ---
# 任务: 初始化项目
请按照以下步骤初始化项目:
**第一步: 收集项目信息**
在执行任何操作之前,必须先向用户询问以下信息:
1. 请用户提供关于此项目的简单介绍(用途、主要功能等) 2. 询问用户希望使用哪种工具管理 Python 环境: - `uv`:现代化的 Python 包管理工具 - `conda`:传统的环境管理工具 3. 询问用户需要的 Python 版本(默认为 3.12)
同时,获取当前所在文件夹的名称作为默认的环境名称,告知用户并询问是否需要修改。
等待用户回复并确认后,再继续执行后续步骤。
**第二步: 创建 AGENTS.md 文件**
根据用户提供的项目介绍,对其进行整理和优化(用户提供的介绍可能比较口语化或不完整,需要重新组织语言使其更加规范和清晰),然后在项目根目录创建 `AGENTS.md` 文件,内容如下:
```markdown # 项目开发规范
## 项目介绍
<用户提供的项目介绍的优化版本>
## 基本原则 - 项目开发中始终使用中文与用户交流
---
## 文档规范
### Markdown 规范 - 使用 `-` 而不是 `*` 创建无序列表 - 尽量避免使用粗体 `**` 格式 - 代码块必须指定语言(如 ```python, ```bash)
### 文档职责分工 - `AGENTS.md`(本文档) - 面向开发者(编程智能体),定义项目开发规范 - `README.md` - 面向使用者,提供项目介绍、安装步骤和使用指南 - 目录级`README.md` - 只记录当前目录文件夹或文件的作用
### README.md 层级管理 - 每个 `README.md` 只描述当前目录的内容和直接子目录的简要概述,不详细描述下级目录的具体内容 - 当子目录已有自己的 `README.md` 时,父目录的 `README.md` 仅需简要说明该子目录的用途 - 避免文档内容重复和越级管理,保持职责清晰
### 文档编写原则 - 保持简洁:文档应直接、简洁,只包含必要信息,不需要添加"常见问题"、"故障排查"、"FAQ"等无关紧要的章节 - 避免重复:子文件夹的 README.md 中的内容,不需要在母文件夹的 README.md 中重复书写 - 严禁创建额外的说明文档:在完成代码任务后,禁止创建额外文档,例如 QUICKSTART.md, USAGE.md, GUIDE.md, TUTORIAL.md, .lessons_learned.md, MIGRATION_*.md 等
---
## 版本控制
- 本项目使用 git 进行版本控制 - 注意:除非要求,在每次修改完代码后不需要自动进行 git add, git commit 等操作
---
## 临时文件管理规范 - 当用户询问需要执行代码才能回答的问题时,应在项目根目录下的 `tmp/` 文件夹中创建临时脚本或其他临时文件 - 注意:使用项目根目录下的 `tmp/` 文件夹,而非系统根目录下的 `/tmp/` 文件夹 - 在回答问题时,应明确报告创建的临时文件路径及其作用,便于用户了解和后续清理 ```
**第三步: 添加环境管理配置**
根据用户选择的环境管理工具,在 `AGENTS.md` 文件末尾追加相应的环境管理配置:
如果用户选择 `conda`,追加:
```markdown ---
## 环境管理 - 本项目使用conda管理环境。在运行代码或者安装依赖之前,如果当前不在conda环境中,需要先使用`conda activate`激活环境
### 依赖安装规范 - 添加新的Python包依赖时,使用pip安装 - pip的安装镜像源设置为阿里云镜像:`https://mirrors.aliyun.com/pypi/simple/` - 安装命令示例: ```bash pip install 包名 -i https://mirrors.aliyun.com/pypi/simple/ ``` ```
如果用户选择 `uv`,追加:
```markdown ---
## 环境管理 - 项目使用 uv 管理所有 Python 包。 - 使用 `uv add` ,而非手动编辑 requirements.txt - 使用 `uv run` 执行 python脚本 - 现代化的依赖管理方式: ```bash uv add package_name # 添加生产依赖 uv sync # 安装所有依赖 uv remove package_name # 移除依赖 uv pip list # 查看已安装的包 ``` ```
**第四步: 创建 Python 环境**
根据用户选择的环境管理工具和确认的环境名称,创建 Python 环境:
如果用户选择 `conda`: ```bash conda create -n <环境名称> python=<Python版本> -y ```
如果用户选择 `uv`: ```bash uv init --python <Python版本> uv venv ```
**第五步: 确认完成**
报告所有操作的结果: 1. `AGENTS.md` 文件已创建 2. Python 环境已创建,并告知用户如何激活环境
请开始执行。
|