Skip to content

Devika is the first open-source implementation of an Agentic Software Engineer. Initially started as an open-source alternative to Devin.

Python

Update README.md

ayush rajgorc9445180f83d
diff --git a/README.md b/README.md
index 3671c22..0f5717b 100644
--- a/README.md
+++ b/README.md
@@ -15,12 +15,12 @@
- [Key Features](#key-features)
- [System Architecture](#system-architecture)
- [Getting Started](#getting-started)
- - [Requirements](#Requirements)
+ - [Requirements](#requirements)
- [Installation](#installation)
- [How to use](#how-to-use)
- [Configuration](#configuration)
-- [Community Discord Server](#community-discord-server)
- [Contributing](#contributing)
+- [Help and Support](#help-and-support)
- [License](#license)
## About
@@ -38,7 +38,7 @@ https://github.com/stitionai/devika/assets/26198477/cfed6945-d53b-4189-9fbe-6696
## Key Features
-- 🤖 Supports **Claude 3**, **GPT-4**, **GPT-3.5**, and **Local LLMs** via [Ollama](https://ollama.com). For optimal performance: Use the **Claude 3** family of models.
+- 🤖 Supports **Claude 3**, **GPT-4**, **Gemini**, **Mistral** , **Groq** and **Local LLMs** via [Ollama](https://ollama.com). For optimal performance: Use the **Claude 3** family of models.
- 🧠 Advanced AI planning and reasoning capabilities
- 🔍 Contextual keyword extraction for focused research
- 🌐 Seamless web browsing and information gathering
@@ -57,12 +57,18 @@ Read [**README.md**](docs/architecture) for the detailed documentation.
### Requirements
```
-- Linux, MacOS, or Windows
-- Python >= 3.9 and < 3.12
-- NodeJs >= 18
-- bun
+Version's requirements
+ - Python >= 3.9 and < 3.12
+ - NodeJs >= 18
+ - bun
```
+- Install uv - Python Package manager [download](https://github.com/astral-sh/uv)
+- Install bun - JavaScript runtime [download](https://bun.sh/docs/installation)
+- For ollama [ollama setup guide](docs/Installation/ollama.md) (optinal: if you don't want to use the local models then you can skip this step)
+- For API models, configure the API keys via setting page in UI.
+
+
### Installation
To install Devika, follow these steps:
@@ -78,13 +84,19 @@ To install Devika, follow these steps:
3. Create a virtual environment and install the required dependencies (you can use any virtual environment manager):
```bash
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:
```bash
playwright install --with-deps # installs browsers in playwright (and their deps) if required
```
-5. (optional step) for setting up the ollama, you can follow the [ollama setup guide](docs/Installation/ollama.md)
5. Start the Devika server:
```bash
python devika.py
@@ -93,20 +105,20 @@ To install Devika, follow these steps:
```bash
root: INFO : Devika is up and running!
```
-6. Now, for frontend, open a new terminal and navigate to the `ui` directory:
+7. Now, for frontend, open a new terminal and navigate to the `ui` directory:
```bash
cd ui/
bun install
- bun run dev
+ bun run start
```
-8. Access the Devika web interface by opening a browser and navigating to `http://127.0.0.1:3000`
+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. for creating a project, click on 'select project' and then click on 'new project'.
+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.
@@ -123,7 +135,7 @@ when you first time run Devika, it will create a `config.toml` file for you in t
- API KEYS
- `BING`: Your Bing Search API key for web searching capabilities.
- `GOOGLE_SEARCH`: Your Google Search API key for web searching capabilities.
- - `GOOGLE_SEARCH_ENGINE_ID`: Your Google Search Engine Id for web searching using google.
+ - `GOOGLE_SEARCH_ENGINE_ID`: Your Google Search Engine ID for web searching using Google.
- `OPENAI`: Your OpenAI API key for accessing GPT models.
- `GEMINI`: Your Gemini API key for accessing Gemini models.
- `CLAUDE`: Your Anthropic API key for accessing Claude models.