OpenHands

OpenHands 是一款开源的 AI 软件工程师 Agent，支持自主规划、编写代码、调试测试及执行 DevOps 自动化流程。适用于快速原型开发、代码重构、自动化测试与 CI/CD 流水线集成。通过沙箱环境安全运行，兼容主流大语言模型，可无缝对接 GitHub/GitLab，显著提升研发效率与自动化水平。

## 工作流概述 OpenHands（前身为 OpenDevin）是一个开源的自主 AI 编程 Agent 工作流框架。它能够在隔离的沙箱环境中自主解析需求、生成代码、执行终端命令、运行单元测试，并支持多轮迭代优化。本工作流旨在帮助开发者将 OpenHands 接入现有研发管线，实现从需求输入到代码提交、测试验证及自动化部署的全链路 DevOps 闭环。 ## 分步骤操作说明 ### 1. 环境部署与初始化 - 使用 Docker Compose 拉取官方镜像并启动服务：`docker compose up -d` - 访问本地 Web UI（默认端口 3000），完成基础账号注册与权限配置。 - 确认沙箱容器网络策略，确保 Agent 具备读写挂载目录及访问外部 Git 仓库的网络权限。 ### 2. 配置大模型与 API 密钥 - 进入 Settings 面板，在 `LLM Provider` 中选择目标模型供应商（如 OpenAI、Anthropic、Ollama 或本地部署模型）。 - 填入对应的 API Key 或配置本地推理服务地址。建议优先选用上下文窗口较大、代码理解能力强的模型。 - 启用 `LiteLLM Proxy` 以实现多模型路由、统一接口调用与成本管控。 ### 3. 关联代码仓库与定义任务 - 在主页点击 `New Session`，粘贴目标 GitHub/GitLab 仓库 URL。 - 配置 SSH Key 或 Personal Access Token (PAT)，授权 Agent 读取与推送代码。 - 在 Prompt 输入框中明确任务指令，例如：“分析 `src/utils.py` 的性能瓶颈，重构核心逻辑并补充 pytest 单元测试，最终提交至 develop 分支。” ### 4. 启动 Agent 并监控执行过程 - 点击 `Run` 启动工作流。Agent 将自动拆解任务为子步骤（Planning -> Coding -> Terminal Execution -> Testing）。 - 实时查看 Console 日志与文件变更 Diff。若遇到报错，可直接在对话栏追加修正指令，Agent 会自动回滚错误操作并重新尝试。 - 利用内置的 File Tree 与 Browser View 跟踪页面渲染或后端服务状态。 ### 5. 结果验证与 CI/CD 集成 - 任务完成后，检查生成的 Pull Request 或 Commit 记录，确认代码质量与测试覆盖率。 - 将 OpenHands 工作流封装为 GitHub Action 或 GitLab CI Job，设置定时触发或 PR 创建事件监听。 - 配置自动化门禁（Quality Gate），仅在测试通过率达标且无严重漏洞时自动合并代码。 ## 注意事项与最佳实践 - **安全隔离**：始终在生产环境使用前关闭 Agent 的写权限，或使用只读沙箱模式，防止恶意代码执行或数据泄露。 - **成本控制**：开启 Token 用量统计，设置每日最大请求上限；复杂任务建议采用 `CodeAct` 模式逐步收敛。 - **Prompt 工程**：提供清晰的上下文、依赖版本要求及失败重试机制描述，可显著提升单次执行成功率。 - **版本管理**：定期同步上游 `main` 分支更新，避免旧版 Agent 与新版 LLM API 不兼容。 ## 常见问题提示 - **Q: Agent 频繁陷入循环或无法停止？** A: 检查任务复杂度是否超出当前模型上下文限制；在设置中调低 `max_iterations`，或手动终止会话后拆分任务。 - **Q: 如何切换不同的 LLM 提供商？** A: 无需重装，直接在 UI 的 Environment Variables 中修改 `OPENAI_API_KEY` 或 `ANTHROPIC_API_KEY`，重启容器即可生效。 - **Q: 生成的代码与现有项目风格冲突？** A: 在初始 Prompt 中附加 `.editorconfig` 或 `prettier/eslint` 配置路径，引导 Agent 遵循既定规范。 - **Q: 沙箱内无法安装系统级依赖？** A: 自定义 Dockerfile 预装常用工具链（如 `gcc`, `nodejs`, `python-dev`），并通过 `DOCKER_MOUNT` 映射宿主机缓存目录加速构建。