🛠️ o1-engineer

一款命令行工具，旨在帮助开发者高效地管理和交互他们的项目。o1-engineer 利用 OpenAI 的 API 功能，提供代码生成、文件编辑、项目规划和代码审查等功能，以简化您的开发工作流程。

新增

已在仓库中添加 Grok Engineer。请确保在您的 .env 文件中添加 XAI_API_KEY。 新增了流式传输功能。

🛠️ 更新的功能

• 增强的文件和文件夹管理：/add 和 /edit 命令现在支持添加和修改文件及文件夹，从而在管理项目结构时提供更大的灵活性。
• 项目规划：引入了 /planning 命令，允许用户创建全面的项目计划，这些计划可用于系统地生成文件和目录。
• 高级工作流：新的示例展示了如何集成规划和创建命令，以实现高效的项目设置。

✨ 功能

• 自动化代码生成：轻松为您的项目生成代码。
• 文件管理：直接从命令行添加、编辑和管理项目文件。
• 交互式控制台：用户友好的界面，支持富文本，提升可读性。
• 对话历史：根据需要保存和重置对话历史。
• 代码审查：分析和审查代码文件的质量及改进建议。
• 增强的文件和文件夹管理：/add 和 /edit 命令现在支持添加和修改文件及文件夹，从而在管理项目结构时提供更大的灵活性。
• 项目规划：引入了 /planning 命令，允许用户创建全面的项目计划，这些计划可用于系统地使用 /create 命令生成文件和目录。

💡 脚本的工作原理

1. 初始化：脚本初始化全局变量，并使用提供的 API 密钥设置 OpenAI 客户端。
2. 处理用户命令：它监听用户的命令，如 /edit、/create、/add、/review 以及新的 /planning 命令，并相应地进行处理。
3. 处理文件和文件夹的修改：根据用户的指示，脚本会修改文件和文件夹，添加新内容，或根据需要创建新的文件和文件夹。/add 和 /edit 命令已增强，支持文件和文件夹的操作，从而在项目管理中提供更大的灵活性。
4. 项目规划：新引入的 /planning 命令允许用户创建全面的项目计划，脚本可以使用该计划通过 /create 命令系统地生成文件和目录。
5. AI 生成的指令：该工具与 OpenAI 的 API 交互，以生成代码生成、编辑、项目规划和审查的指令和建议。
6. 应用更改：根据 AI 生成的指令，将更改应用到项目文件和文件夹中，确保项目保持最新并得到良好维护。
7. 管理对话历史和已添加的文件：脚本管理对话历史，并跟踪已添加到上下文中的文件和文件夹，允许用户根据需要重置或修改历史。

📥 安装

先决条件

• Python：确保已安装 Python 3.7 或更高版本。下载 Python
• OpenAI API 密钥：从 OpenAI 获取 API 密钥。

🔧 步骤

1. 克隆仓库：

   git clone https://github.com/doriandarko/o1-engineer.git
   

2. 进入项目目录：

   cd o1-engineer
   

3. 安装依赖：

   pip install -r requirements.txt
   

4. 配置 API：

   在脚本顶部添加您的 API 密钥

   client = OpenAI(api_key="YOUR API")
   

📚 使用方法

使用以下命令启动应用程序：

python o1-eng.py

🎮 可用命令

• /edit：编辑文件或文件夹（后接文件或文件夹路径）
• /create：创建文件或文件夹（后接指令）
• /add：将文件或文件夹添加到上下文中（后接文件或文件夹路径）
• /planning：规划项目结构和任务（后接指令）
• /debug：打印最近一次的 AI 响应
• /reset：重置聊天上下文并清除已添加的文件
• /review：审查和分析代码文件的质量及潜在改进（后接文件或文件夹路径）
• /quit：退出程序

🚀 高级工作流

以下是一个演示如何使用 /planning 后接 /create 来根据所创建的计划生成文件的工作流程示例：

1. 规划项目：

   您：/planning 创建一个基本的 Web 应用程序，其结构如下：
   
   - 前端文件夹，包含 HTML、CSS 和 JavaScript 文件。
   
   - 后端文件夹，包含服务器端脚本。
   
   - 一个 README.md 文件，用于项目文档。
   

2. 根据计划创建项目结构：

   您：/create 根据上述计划生成项目结构。
   

这展示了如何使用新的 /planning 命令定义项目结构，然后使用 /create 命令相应地生成文件和文件夹。

📝 示例

您：/add src/main.py src/utils/helper.py src/models/

您：/planning 概述一个 RESTful API 项目，其中模型、视图和控制器分别位于不同的文件夹中。

您：/create 设置一个 RESTful API 项目的初步结构，包括模型、视图和控制器文件夹以及初始文件。

您：/edit src/main.py src/models/user.py src/views/user_view.py

🤝 贡献

我们欢迎贡献！请按照以下步骤操作：

1. 分支仓库。
2. 创建新分支 (git checkout -b feature/YourFeature)。
3. 提交更改 (git commit -m '添加某项功能')。
4. 推送到分支 (git push origin feature/YourFeature)。
5. 打开拉取请求。

🙏 致谢

• OpenAI 提供的强大 API。

星标历史

o1-engineer 快速上手指南

o1-engineer 是一款基于命令行的 AI 开发助手，利用 OpenAI API（及新增的 Grok/XAI API）帮助开发者高效管理项目。它支持代码生成、文件编辑、项目规划、代码审查等功能，并能通过流式输出提供实时反馈。

环境准备

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

• 操作系统：Windows / macOS / Linux
• Python 版本：Python 3.7 或更高版本
  • 下载地址：https://www.python.org/downloads/
  • 国内用户建议：安装时勾选 "Add Python to PATH"，或使用国内镜像源加速 pip 安装。
• API 密钥：
  • OpenAI API Key：用于核心功能（获取地址）
  • XAI API Key（可选）：如需使用新增的 Grok Engineer 功能，需准备 XAI 密钥。

安装步骤

1. 克隆仓库

打开终端（Terminal 或 CMD），执行以下命令下载项目：

git clone https://github.com/doriandarko/o1-engineer.git

提示：如果下载速度慢，可使用国内镜像加速： git clone https://gitee.com/mirror/github-doriandarko-o1-engineer.git (需确认是否有对应镜像) 或使用代理。

2. 进入项目目录

cd o1-engineer

3. 安装依赖

使用 pip 安装所需库。国内用户强烈建议使用清华或阿里镜像源以加快下载速度：

pip install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple

4. 配置 API 密钥

使用文本编辑器打开主脚本文件 o1-eng.py，找到初始化 client 的部分，将 "YOUR API" 替换为您的实际密钥。

对于 OpenAI：

client = OpenAI(api_key="sk-你的 OpenAI API Key")

对于 Grok (如需使用)： 请确保在项目根目录创建 .env 文件，并添加：

XAI_API_KEY=你的 XAI API Key

基本使用

启动工具

在终端中运行以下命令启动交互式控制台：

python o1-eng.py

启动后，您将进入一个支持富文本显示的交互界面。

常用命令示例

以下是几个最核心的操作示例，帮助您快速上手：

1. 项目规划 (/planning)

让 AI 为您生成详细的项目结构和任务计划。

You: /planning 创建一个基础的 Web 应用，包含前端文件夹（HTML/CSS/JS）、后端文件夹和 README 文档。

2. 基于计划生成文件 (/create)

根据上一步生成的计划，自动创建对应的文件和目录结构。

You: /create 根据上述计划生成项目结构。

3. 添加文件到上下文 (/add)

将现有文件加入对话上下文，以便 AI 了解当前项目状态。

You: /add src/main.py src/utils/

4. 编辑文件或文件夹 (/edit)

指示 AI 修改指定文件或文件夹的内容。

You: /edit src/main.py 添加用户登录功能的代码逻辑。

5. 代码审查 (/review)

分析代码质量并提供改进建议。

You: /review src/models/user.py

6. 其他控制命令

• /reset：重置聊天上下文并清除已添加的文件记录。
• /debug：打印最后一次 AI 的原始响应内容。
• /quit：退出程序。

进阶工作流示例

结合规划与生成命令，实现自动化项目搭建：

1. 定义需求：

   You: /planning 设计一个 RESTful API 项目，分离 models, views, controllers 文件夹。
   

2. 执行生成：

   You: /create 基于上述规划，初始化包含基础文件的目录结构。
   

现在您可以开始使用 o1-engineer 提升您的开发效率了！