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
What is this?Devika is an open-source agentic AI software engineer that takes a high-level task description, plans and researches it, browses the web for information, and writes the code needed to complete it. It's built as an open alternative to Cognition AI's Devin.
Is this a CLI tool or does it have its own interface?Devika runs as a local web app: a Python backend server plus a separate frontend you open in a browser, not a command-line tool or IDE plugin.
How do I get it running?Clone the repo, create a Python virtual environment and install dependencies with uv, install Playwright for browsing, start the Devika server, then separately start the frontend from the ui directory with bun and open it in your browser.
What do I need installed before I start?You need uv for the Python backend and bun for the frontend. If you want local models you also set up Ollama; otherwise you add API keys for services like OpenAI, Claude, Gemini, Mistral or Groq through the settings UI.
Is this stable enough to rely on?No - the project explicitly warns it's in a very early, experimental stage with a lot of unimplemented or broken features.
Which AI models work best with Devika?The project recommends the Claude 3 family for optimal performance, though GPT-4, Gemini, Mistral, Groq, and local Ollama models are also supported.
Why was Devika created?It was built as an open-source alternative to Devin, with the ambitious goal of eventually matching or beating Devin's score on the SWE-bench benchmark.
Do I need search API keys too?Yes - for web research Devika needs a Bing or Google Search API key (plus a Google Search Engine ID), configured on the settings page alongside your model API keys.
Creator
stitionai
Size
5.7 MB
Stars
19.6K
Updated
CommitSep 25
Age
2y
Commits · 90 Days