Devika 开源项目使用教程

1. 项目目录结构及介绍

Devika 项目的目录结构如下：

devika/
├── assets/
├── benchmarks/
├── docs/
├── src/
├── ui/
├── .gitignore
├── ARCHITECTURE.md
├── CONTRIBUTING.md
├── LICENSE
├── Makefile
├── README.md
├── ROADMAP.md
├── app.dockerfile
├── devika.dockerfile
├── devika.py
├── docker-compose.yaml
├── requirements.txt
├── sample_config.toml
└── setup.sh

目录介绍

• assets/: 存放项目相关的静态资源文件。
• benchmarks/: 存放性能测试相关的文件。
• docs/: 存放项目的文档文件。
• src/: 存放项目的源代码文件。
• ui/: 存放项目的前端界面文件。
• .gitignore: Git 忽略文件配置。
• ARCHITECTURE.md: 项目架构文档。
• CONTRIBUTING.md: 贡献指南文档。
• LICENSE: 项目许可证文件。
• Makefile: 项目构建文件。
• README.md: 项目介绍文档。
• ROADMAP.md: 项目路线图文档。
• app.dockerfile: Docker 构建文件。
• devika.dockerfile: Devika 的 Docker 构建文件。
• devika.py: Devika 的主启动文件。
• docker-compose.yaml: Docker Compose 配置文件。
• requirements.txt: Python 依赖包列表。
• sample_config.toml: 示例配置文件。
• setup.sh: 项目安装脚本。

2. 项目启动文件介绍

devika.py

devika.py 是 Devika 项目的主启动文件。它负责初始化项目环境、加载配置、启动服务等核心功能。以下是该文件的主要功能模块：

• 初始化环境: 加载必要的依赖包和配置文件。
• 启动服务: 启动 Devika 的服务，监听指定端口，处理用户请求。
• 处理请求: 接收用户的高级指令，分解任务，执行代码生成等操作。

启动步骤

1. 克隆项目仓库：

   git clone https://github.com/stitionai/devika.git
   

2. 进入项目目录：

   cd devika
   

3. 创建虚拟环境并安装依赖：

   uv venv
   source venv/bin/activate  # macOS 和 Linux
   venv\Scripts\activate  # Windows
   uv pip install -r requirements.txt
   

4. 安装 Playwright 浏览器：

   playwright install --with-deps
   

5. 启动 Devika 服务：

   python devika.py
   

6. 启动前端界面：

   cd ui/
   bun install
   bun run start
   

7. 访问 Devika 的 Web 界面：

   http://127.0.0.1:3001
   

3. 项目的配置文件介绍

sample_config.toml

sample_config.toml 是 Devika 项目的示例配置文件。它包含了项目运行所需的各项配置参数，如 API 密钥、API 端点等。以下是该文件的主要配置项：

[API_KEYS]
BING = "Your Bing Search API key"
GOOGLE_SEARCH = "Your Google Search API key"
GOOGLE_SEARCH_ENGINE_ID = "Your Google Search Engine ID"
OPENAI = "Your OpenAI API key"
GEMINI = "Your Gemini API key"
CLAUDE = "Your Anthropic API key"
MISTRAL = "Your Mistral API key"
GROQ = "Your Groq API key"
NETLIFY = "Your Netlify API key"

[API_ENDPOINTS]
BING = "The Bing API endpoint"
GOOGLE = "The Google API endpoint"
OLLAMA = "The Ollama API endpoint"
OPENAI = "The OpenAI API endpoint"

配置步骤

1. 复制 sample_config.toml 文件并重命名为 config.toml。
2. 根据实际需求，填写相应的 API 密钥和端点信息。
3. 保存配置文件，确保 Devika 服务能够正确加载配置。

通过以上步骤，您可以顺利启动 Devika 项目并进行配置，开始使用这个强大的 AI 软件工程师工具。