Discord: https://discord.gg/uMaGSHNjzc

功能

• 🔓 安全。所有操作均在沙箱化的 Docker 环境中运行。
• 🤖 自主。自动检测下一步并执行。
• 🔍 内置浏览器。必要时从网上获取最新信息（教程、文档等）。
• 📙 内置文本编辑器。可在浏览器中直接查看所有已修改的文件。
• 🧠 所有历史命令和输出都会保存到 PostgreSQL 数据库中。
• 📦 根据用户任务自动选择 Docker 镜像。
• 🤳 自托管
• 💅 现代化 UI

快速开始

运行 Codel 的最简单方式是使用预构建的 Docker 镜像。您可以在 Github Container Registry 上找到最新镜像。

[!重要提示] 若要使用任何受支持的语言模型，您需要设置相应的环境变量。

您可以使用以下命令运行 Docker 镜像。请根据您的需求移除或更改环境变量。

docker run \
  -e OPEN_AI_KEY=your_open_ai_key \
  -e OPEN_AI_MODEL=gpt-4-0125-preview \
  -e OLLAMA_MODEL=llama2 \
  -p 3000:8080 \
  -v /var/run/docker.sock:/var/run/docker.sock \
  ghcr.io/semanser/codel:latest

或者，您也可以创建一个 .env 文件，并使用 --env-file 标志来运行 Docker 镜像。更多信息请参阅 这里。

现在，您可以在浏览器中访问 localhost:3000，开始使用 Codel。

* `OPEN_AI_KEY` - OpenAI API 密钥。您可在此处获取密钥：[https://platform.openai.com/account/api-keys](https://platform.openai.com/account/api-keys)。
* `OPEN_AI_MODEL` - OpenAI 模型（默认：gpt-4-0125-preview）。支持的 OpenAI 模型列表请参见：[https://pkg.go.dev/github.com/sashabaranov/go-openai#pkg-constants](https://pkg.go.dev/github.com/sashabaranov/go-openai#pkg-constants)。
* `OPEN_AI_SERVER_URL` - OpenAI 服务器地址（默认：https://api.openai.com/v1）。如果您使用的是兼容 OpenAI 的服务器，请更改此 URL。
* `OLLAMA_MODEL` - 本地托管的 Ollama 模型（默认：https://ollama.com/model）。支持的 Ollama 模型列表请参见：[https://ollama.com/models](https://ollama.com/models)。
* `OLLAMA_SERVER_URL` - Ollama 服务器地址（默认：https://host.docker.internal:11434）。如果您使用的是兼容 Ollama 的服务器，请更改此 URL。
更多详细信息请参阅后端的 [.env.example](./backend/.env.example)。

开发

有关更多信息，请查看 DEVELOPMENT.md。

路线图

项目的路线图请参见 这里。

致谢

本项目离不开以下资源的支持：

• https://arxiv.org/abs/2308.00352
• https://arxiv.org/abs/2403.08299
• https://www.cognition-labs.com/introducing-devin
• https://github.com/go-rod/rod
• https://github.com/semanser/JsonGenius

Codel 快速上手指南

Codel 是一个完全自主的 AI 智能体，能够在沙盒化的 Docker 环境中利用终端、浏览器和编辑器执行复杂的任务与项目。

环境准备

在开始之前，请确保您的系统满足以下要求：

• 操作系统：支持 Docker 的 Linux、macOS 或 Windows (WSL2)。
• 核心依赖：
  • Docker：必须已安装并正在运行。
  • Docker Compose（可选，但推荐）。
• API 密钥：您需要准备以下任一模型的访问凭证：
  • OpenAI：有效的 OPEN_AI_KEY（需支持 GPT-4 或更高版本以获得最佳效果）。
  • Ollama：本地部署的 Ollama 服务及模型（如 llama2），或兼容的远程服务器地址。

注意：由于 Codel 需要在容器内动态创建子容器来执行任务，宿主机必须挂载 Docker Socket。

安装步骤

最简便的方式是直接拉取预构建的 Docker 镜像运行。

方式一：命令行直接运行

复制以下命令，并将 your_open_ai_key 替换为您实际的 API 密钥。如果您使用 Ollama，请相应调整 OLLAMA_MODEL 变量。

docker run \
  -e OPEN_AI_KEY=your_open_ai_key \
  -e OPEN_AI_MODEL=gpt-4-0125-preview \
  -e OLLAMA_MODEL=llama2 \
  -p 3000:8080 \
  -v /var/run/docker.sock:/var/run/docker.sock \
  ghcr.io/semanser/codel:latest

方式二：使用 .env 文件管理配置（推荐）

为了安全地管理密钥，建议创建一个 .env 文件。

1. 创建名为 .env 的文件，内容如下：

   OPEN_AI_KEY=your_open_ai_key
   OPEN_AI_MODEL=gpt-4-0125-preview
   OLLAMA_MODEL=llama2
   # 如果使用国内兼容的 OpenAI 接口，可取消下行注释并修改 URL
   # OPEN_AI_SERVER_URL=https://api.your-provider.com/v1
   

2. 运行容器：

   docker run \
     --env-file .env \
     -p 3000:8080 \
     -v /var/run/docker.sock:/var/run/docker.sock \
     ghcr.io/semanser/codel:latest
   

国内用户提示：如果拉取 ghcr.io 镜像速度较慢，可尝试配置 Docker 镜像加速器，或使用代理网络。目前官方未提供专属中国镜像源，请根据实际网络环境优化 Docker 拉取策略。

基本使用

启动成功后，即可通过浏览器访问 Codel 的现代化界面。

1. 访问界面： 打开浏览器，访问地址：http://localhost:3000

2. 开始任务：

   • 在输入框中输入自然语言指令（例如：“创建一个简单的 Python Flask 应用，包含一个 Hello World 接口”）。
   • Codel 将自动分析任务，选择适合的 Docker 基础镜像，并在沙盒环境中执行以下步骤：
     • 编写代码（使用内置编辑器）。
     • 运行终端命令（安装依赖、启动服务）。
     • 联网搜索（如需查阅最新文档）。
     • 验证结果。

3. 查看结果：

   • 所有执行的历史命令、输出日志及修改的文件都会实时显示在 UI 中，并持久化保存到 PostgreSQL 数据库。
   • 您可以直接在浏览器中预览和编辑生成的代码文件。

现在，您已经成功部署并开始使用 Codel 进行自主开发了！