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

added web_search configuration, google search api

nalaso741a3e212183
diff --git a/README.md b/README.md
index 191f41d..2b5718d 100644
--- a/README.md
+++ b/README.md
@@ -153,13 +153,27 @@ Devika requires certain configuration settings and API keys to function properly
- `PROJECTS_DIR`: The directory where Devika's projects will be stored.
- `LOGS_DIR`: The directory where Devika's logs will be stored.
- `REPOS_DIR`: The directory where Git repositories cloned by Devika will be stored.
+- `WEB_SEARCH`: This determines the default web search method for browsing the web. Accepted values are: google, bing, or ddgs.
- `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.
- `CLAUDE`: Your Anthropic API key for accessing Claude models.
- `NETLIFY`: Your Netlify API key for deploying and managing web projects.
- `OPENAI`: Your OpenAI API key for accessing GPT models.
Make sure to keep your API keys secure and do not share them publicly.
+### Configuring web search method
+
+Deviak currently supports bing, google, and ddgs(DuckDuckGo) for web searches. You can configure the web search method using the following options:
+
+1. **Using config.toml**: Modify the value of WEB_SEARCH in config.toml to your preferred method.
+2. **Using CLI**: Change the web search method using the command line interface by specifying the --websearch attribute when starting the server.
+```bash
+ python devika.py --websearch bing
+```
+3. **Using rest api**: Change the web search method through the REST API. Simply include the web_search parameter in the /api/execute-agent endpoint.
+
## Under The Hood
Let's dive deeper into some of the key components and techniques used in Devika: