Home

Awesome

<!-- PROJECT LOGO --> <div align="center"> <h1 align="center">Devon: An open-source pair programmer</h1> </div> <div align="center"> <a href="https://github.com/entropy-research/Devon/graphs/contributors"><img src="https://img.shields.io/github/contributors/entropy-research/devon?style=for-the-badge&color=lime" alt="Contributors"></a> <a href="https://github.com/entropy-research/Devon/network/members"><img src="https://img.shields.io/github/forks/entropy-research/devon?style=for-the-badge&color=orange" alt="Forks"></a> <a href="https://github.com/entropy-research/Devon/stargazers"><img src="https://img.shields.io/github/stars/entropy-research/devon?style=for-the-badge&color=yellow" alt="Stargazers"></a> <a href="https://github.com/entropy-research/Devon/issues"><img src="https://img.shields.io/github/issues/entropy-research/devon?style=for-the-badge&color=red" alt="Issues"></a> <br/> <a href="https://github.com/entropy-research/Devon/blob/main/LICENSE"><img src="https://img.shields.io/github/license/entropy-research/devon?style=for-the-badge&color=blue" alt="Apache 2.0 License"></a> <a href="https://discord.gg/p5YpZ5vjd9"><img src="https://img.shields.io/badge/Discord-Join%20Us-purple?logo=discord&logoColor=white&style=for-the-badge" alt="Join our Discord community"></a> <br/>

https://github.com/entropy-research/Devon/assets/61808204/f3197a56-3d6d-479f-bc0e-9cffe69f159b

</div>

How do y'all ship so quickly?

<a href="https://discord.gg/p5YpZ5vjd9"><img src="https://img.shields.io/badge/Discord-Join%20Us-purple?logo=discord&logoColor=white&style=for-the-badge" alt="Join our Discord community"></a> ← We have a community-driven Dev Team for this repo. Come join us! It's great.

Installation

Prerequisites

  1. node.js and npm
  2. pipx, if you don't have this go here
  3. API Key <samp>(just one is required)</samp>

We're currently working on supporting Windows! (Let us know if you can help)

Installation commands

To install using pipx + npm:

# Step 1: Ensure directory where pipx stores apps is in your PATH environment variable
pipx ensurepath

# Step 2: For the backend
pipx install devon_agent

# Step 3: For the main UI (install and run)
npx devon-ui

If you already have devon_agent installed, update it by running: pipx install --force devon_agent

Thats it! Happy building :)

Running the agent

Then to run the main ui, the command is:

npx devon-ui

It's that simple.

Terminal UI

If you'd like to use the terminal interface, follow these steps:

Install

  1. Make sure you have the backend installed
# For the backend
pipx install devon_agent
  1. Install the tui
# For the tui
npm install -g devon-tui

[!NOTE] If you already have devon-tui installed, update it by running:

npm uninstall -g devon-tui
npm install -g devon-tui

Run

  1. Navigate to your project folder and open the terminal.
  2. Set your Anthropic API or OpenAI API key as an environment variable:
export ANTHROPIC_API_KEY=sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

#OR

export OPENAI_API_KEY=sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

#OR

export GROQ_API_KEY=sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
  1. Then to run the terminal-ui, the command is:
devon-tui

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:

devon-tui --debug

To run in local mode:

[!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

  2. Start the local ollama server by running

ollama run deepseek-coder:6.7b
  1. Then configure devon to use the model
devon-tui configure

Configuring Devon CLI...
? Select the model name: 
  claude-opus 
  gpt4-o 
  llama-3-70b 
❯ ollama/deepseek-coder:6.7b
  1. And finally, run it with:
devon-tui --api_key=FOSS

For a list of all commands available:

devon-tui --help

Features

Limitations

Progress

This project is still super early and <ins>we would love your help</ins> to make it great!

Current goals

View our current thoughts on next steps here

Star history

<p align="center"> <a href="https://star-history.com/#entropy-research/Devon&Date"> <img src="https://api.star-history.com/svg?repos=entropy-research/Devon&type=Date" width="500" alt="Star History Chart"> </a> </p>

Past milestones

[!NOTE] If you already have the tui installed, run a clean reinstall:

npm uninstall -g devon-tui
npm install -g devon-tui

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. Electron app
    • Save and load in project overviews for agent context
    • Revert & "step back" timeline interface
    • Better code diff view
    • Send user file events/changes to Devon

How can I contribute?

Devon and the entropy-research org are community-driven, and we welcome contributions from everyone! From tackling issues to building features to creating datasets, there are many ways to get involved:

For details, please check CONTRIBUTING.md.

If you would like to contribute to the project, please join the discord: Discord

Feedback

We would love feedback! Feel free to drop us a note on our Discord in the #feedback channel, or create issues!

We collect basic event type (i.e. "tool call") and failure telemetry to solve bugs and improve the user experience, but if you want to reach out, we would love to hear from you!

To disable telemetry, set the environment variable DEVON_TELEMETRY_DISABLED to true

export DEVON_TELEMETRY_DISABLED=true

Community

Join our Discord server and say hi! Discord

License

Distributed under the AGPL License. See LICENSE for more information.