-
Notifications
You must be signed in to change notification settings - Fork 261
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Docs: simplify README.md, split instructions in separate docs/* md files. #66
Open
cyborgmarina
wants to merge
2
commits into
entropy-research:main
Choose a base branch
from
cyborgmarina:chore/improve-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
|
|
||
| # Features | ||
| - Multi-file editing | ||
| - Codebase exploration | ||
| - Config writing | ||
| - Test writing | ||
| - Bug fixing | ||
| - Architecture exploration | ||
| - Local Model Support | ||
|
|
||
| ### Limitations | ||
| - Minimal functionality for non-Python languages | ||
| - Sometimes have to specify the file where you want the change to happen | ||
| - Local mode is not good right now. Please try to avoid using it. | ||
|
|
||
| # Progress | ||
|
|
||
| ### This project is still super early and <ins>we would love your help</ins> to make it great! | ||
|
|
||
| ### Current goals | ||
| - Multi-model support | ||
| - [x] Claude 3 Opus | ||
| - [x] GPT4-o | ||
| - [x] Groq llama3-70b | ||
| - [x] Ollama deepseek-6.7b | ||
| - [ ] Google Gemini 1.5 Pro | ||
| - Launch plugin system for tool and agent builders | ||
| - Create self-hostable Electron app | ||
| - Set SOTA on [SWE-bench Lite](https://www.swebench.com/lite.html) | ||
|
|
||
| > View our current thoughts on next steps [**here**](https://docs.google.com/document/d/e/2PACX-1vTjLCQcWE_n-uUHFhtBkxTCIJ4FFe5ftY_E4_q69SjXhuEZv_CYpLaQDh3HqrJlAxsgikUx0sTzf9le/pub) | ||
|
|
||
|
|
||
| ### Past milestones | ||
|
|
||
| - [x] **May 19, 2024** - GPT4o support + better interface support v0.1.7 | ||
| - [x] **May 10, 2024** - Complete interactive agent v0.1.0 | ||
| - [x] **May 10, 2024** - Add steerability features | ||
| - [x] **May 8, 2024** - Beat AutoCodeRover on SWE-Bench Lite | ||
| - [x] **Mid April, 2024** - Add repo level code search tooling | ||
| - [x] **April 2, 2024** - Begin development of v0.1.0 interactive agent | ||
| - [x] **March 17, 2024** - Launch non-interactive agent v0.0.1 | ||
|
|
||
|
|
||
| ## Current development priorities | ||
|
|
||
| 1. Improve context gathering and code indexing abilities ex: | ||
| - Adding memory modules | ||
| - Improved code indexing | ||
| 2. Add alternative models and agents to: | ||
| - a) Reduce end user cost and | ||
| - b) Reduce end user latency | ||
| 3. Introduce Electron app and new UI | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| # Installation | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| 1. `node.js` and `npm` | ||
| 2. `pipx`, if you don't have this go [here](https://pipx.pypa.io/stable/installation/) | ||
| 3. API Key <samp>(just one is required)</samp> | ||
| - [**Anthropic**](https://console.anthropic.com/settings/keys) | ||
| - [**OpenAI**](https://platform.openai.com/api-keys) | ||
| - [**Groq**](https://console.groq.com/keys) (not released in package yet, run locally) | ||
| > We're currently working on supporting Windows! (Let us know if you can help) | ||
|
|
||
| ## Installation commands | ||
|
|
||
| To install, simply run: | ||
|
|
||
| ```bash | ||
| curl -sSL https://raw.githubusercontent.com/entropy-research/Devon/main/install.sh | bash | ||
| ``` | ||
|
|
||
|
|
||
| *Or to install using `pipx` + `npm`:* | ||
|
|
||
| ```bash | ||
| pipx install devon_agent | ||
| npm install -g devon-tui | ||
| ``` | ||
|
|
||
| This installs the Python backend, and the cli command to run the tool | ||
|
|
||
| --- | ||
|
|
||
|
|
||
| For a list of all commands available: | ||
| ```bash | ||
| devon --help | ||
| ``` | ||
|
|
||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
|
|
||
| # Running the agent with a *local* model | ||
|
|
||
| > [!WARNING] | ||
| > The current version of local model support is not mature, proceed with caution, and expect the performance to degrade significantly compared to the other options. | ||
|
|
||
| 1. Get deepseek running with [ollama](https://ollama.com/library/deepseek-coder:6.7b) | ||
|
|
||
| 2. Start the local ollama server by running | ||
| ``` | ||
| ollama run deepseek-coder:6.7b | ||
| ``` | ||
|
|
||
| 4. Then configure devon to use the model | ||
| ```bash | ||
| devon configure | ||
|
|
||
| Configuring Devon CLI... | ||
| ? Select the model name: | ||
| claude-opus | ||
| gpt4-o | ||
| llama-3-70b | ||
| ❯ ollama/deepseek-coder:6.7b | ||
| ``` | ||
|
|
||
| 4. And finally, run it with: | ||
| ``` | ||
| devon --api_key=FOSS | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| # Running the agent | ||
| Navigate to your project folder and open the terminal. | ||
|
|
||
| Set your provider's API key as an environment variable: | ||
|
|
||
| ```bash | ||
| export ANTHROPIC_API_KEY=sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | ||
|
|
||
| #OR | ||
|
|
||
| export OPENAI_API_KEY=sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | ||
|
|
||
| #OR | ||
|
|
||
| export GROQ_API_KEY=sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | ||
| ``` | ||
|
|
||
| Then to *run*, the command is: | ||
| ```bash | ||
| devon | ||
| ``` | ||
|
|
||
| It's as easy as that. | ||
|
|
||
| > [!NOTE] | ||
| > Don't worry, the agent will be able to only access files and folders in the directory you started it from. You can also correct it while it's performing actions. | ||
|
|
||
| --- | ||
|
|
||
| To run in *debug* mode, the command is: | ||
| ```bash | ||
| devon --debug | ||
| ``` | ||
|
|
||
| --- | ||
| To disable telemetry, set the environment variable `DEVON_TELEMETRY_DISABLED` to `true` | ||
| ```bash | ||
| export DEVON_TELEMETRY_DISABLED=true | ||
| ``` |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What do you think about add a section with instructions about how to update the packages?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
good idea!