devika README

The project's README from github.com/stitionai/devika. As one markdown file: README.md.

Checkout Opcode, the second iteration of Devika. New version out soon!


Devika Logo

🚀 Devika - Agentic AI Software Engineer 👩‍💻

devika screenshot

[!IMPORTANT]
This project is currently in a very early development/experimental stage. There are a lot of unimplemented/broken features at the moment. Contributions are welcome to help out with the progress!

Table of Contents

About

Devika is an advanced AI software engineer that can understand high-level human instructions, break them down into steps, research relevant information, and write code to achieve the given objective. Devika utilizes large language models, planning and reasoning algorithms, and web browsing abilities to intelligently develop software.

Devika aims to revolutionize the way we build software by providing an AI pair programmer who can take on complex coding tasks with minimal human guidance. Whether you need to create a new feature, fix a bug, or develop an entire project from scratch, Devika is here to assist you.

[!NOTE] Devika is modeled after Devin by Cognition AI. This project aims to be an open-source alternative to Devin with an "overly ambitious" goal to meet the same score as Devin in the SWE-bench Benchmarks... and eventually beat it?

Demos

https://github.com/stitionai/devika/assets/26198477/cfed6945-d53b-4189-9fbe-669690204206

Key Features

System Architecture

Read README.md for the detailed documentation.

Getting Started

Requirements

Version's requirements
  - Python >= 3.10 and < 3.12
  - NodeJs >= 18
  - bun

Installation

To install Devika, follow these steps:

  1. Clone the Devika repository:
    git clone https://github.com/stitionai/devika.git
    
  2. Navigate to the project directory:
    cd devika
    
  3. Create a virtual environment and install the required dependencies (you can use any virtual environment manager):
    uv venv
    
    # On macOS and Linux.
    source .venv/bin/activate
    
    # On Windows.
    .venv\Scripts\activate
    
    uv pip install -r requirements.txt
    
  4. Install the playwright for browsering capabilities:
    playwright install --with-deps # installs browsers in playwright (and their deps) if required
    
  5. Start the Devika server:
    python devika.py
    
  6. if everything is working fine, you see the following output:
    root: INFO   : Devika is up and running!
    
  7. Now, for frontend, open a new terminal and navigate to the ui directory:
    cd ui/
    bun install
    bun run start
    
  8. Access the Devika web interface by opening a browser and navigating to http://127.0.0.1:3001

how to use

To start using Devika, follow these steps:

  1. Open the Devika web interface in your browser.
  2. To create a project, click on 'select project' and then click on 'new project'.
  3. Select the search engine and model configuration for your project.
  4. In the chat interface, provide a high-level objective or task description for Devika to work on.
  5. Devika will process your request, break it down into steps, and start working on the task.
  6. Monitor Devika's progress, view generated code, and provide additional guidance or feedback as needed.
  7. Once Devika completes the task, review the generated code and project files.
  8. Iterate and refine the project as desired by providing further instructions or modifications.

Configuration

Devika requires certain configuration settings and API keys to function properly:

when you first time run Devika, it will create a config.toml file for you in the root directory. You can configure the following settings in the settings page via UI:

Make sure to keep your API keys secure and do not share them publicly. For setting up the Bing and Google search API keys, follow the instructions in the search engine setup

Contributing

We welcome contributions to enhance Devika's capabilities and improve its performance. To contribute, please see the CONTRIBUTING.md file for steps.

Help and Support

If you have any questions, feedback, or suggestions, please feel free to reach out to us. you can raise an issue in the issue tracker or join the discussions for general discussions.

We also have a Discord server for the Devika community, where you can connect with other users, share your experiences, ask questions, and collaborate on the project. To join the Devika community Discord server, click here.

License

Devika is released under the MIT License. See the LICENSE file for more information.

Star History

Star History Chart

We hope you find Devika to be a valuable tool in your software development journey. If you have any questions, feedback, or suggestions, please don't hesitate to reach out. Happy coding with Devika!

devika (stitionai/devika)

Searching Database…

19.6K ·GitHub
这是什么?Devika 是一个开源的智能体 AI 软件工程师。它能接收高层级的任务描述,对任务进行规划和调研,上网搜索信息,并编写完成任务所需的代码。它是作为 Cognition AI 旗下 Devin 的开源替代品而构建的。
这是命令行工具,还是有自己的界面?Devika 以本地网页应用的形式运行:由一个 Python 后端服务器和一个单独的前端组成,你在浏览器中打开前端即可使用。它不是命令行工具,也不是 IDE 插件。
我该怎么把它跑起来?克隆代码仓库,用 uv 创建 Python 虚拟环境并安装依赖,安装 Playwright 用于网页浏览,然后启动 Devika 服务器;接着在 ui 目录下用 bun 单独启动前端,并在浏览器中打开。
开始之前我需要装什么?Python 后端需要 uv,前端需要 bun。如果想使用本地模型,还需要设置 Ollama;否则,就需要在设置界面中添加 OpenAI、Claude、Gemini、Mistral 或 Groq 等服务的 API 密钥。
这个项目稳定,能放心用吗?不能。项目明确提示,它仍处于非常早期的实验阶段,有大量功能尚未实现或无法正常工作。
哪些 AI 模型与 Devika 配合效果最好?项目推荐使用 Claude 3 系列以获得最佳性能,不过也支持 GPT-4、Gemini、Mistral、Groq 以及本地的 Ollama 模型。
Devika 为什么被创建?它是作为 Devin 的开源替代品而构建的,其远大目标是最终在 SWE-bench 基准测试中达到甚至超过 Devin 的分数。
我还需要搜索 API 密钥吗?需要。Devika 进行网络调研时需要 Bing 或 Google Search API 密钥(另外还需要 Google Search Engine ID),需要在设置页面中与模型 API 密钥一起配置。
Creator
stitionai
Size
5.7 MB
Stars
19.6K
Updated
CommitSep 25
Age
2y
Commits · 90 Days