Skip to main content

No project description provided

Project description

Devon: An open-source pair programmer

How do y'all ship so quickly?

Join our Discord community ← 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 (just one is required)

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

  • 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 we would love your help to make it great!

Current goals

  • Multi-model support
    • Claude 3.5 Sonnet
    • GPT4-o
    • Groq llama3-70b
    • Ollama deepseek-6.7b
    • Google Gemini 1.5 Pro
  • Launch plugin system for tool and agent builders
  • Improve our self-hostable Electron app
  • Set SOTA on SWE-bench Lite

View our current thoughts on next steps here

Star history

Star History Chart

Past milestones

  • June 28, 2024 - File and code referencing, improve steerability, Claude Sonnet support v0.0.16
  • June 14, 2024 - Launch Electron UI v0.0.13
  • June 1, 2024 - Devon V2 Beta Electron UI
  • May 19, 2024 - GPT4o support + better interface support v0.1.7
  • May 12, 2024 - Complete interactive agent v0.1.0
  • May 10, 2024 - Add steerability features
  • May 8, 2024 - Beat AutoCodeRover on SWE-Bench Lite
  • Mid April, 2024 - Add repo level code search tooling
  • April 2, 2024 - Begin development of v0.1.0 interactive agent
  • March 17, 2024 - Launch non-interactive agent v0.0.1

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

  • Core functionality: Help us develop the core agents, user experience, tool integrations, plugins, etc.
  • Research: Help us research agent performance (including benchmarks!), build data pipelines, and finetune models.
  • Feedback and Testing: Use Devon, report bugs, suggest features, or provide feedback on usability.

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

devon_agent-0.1.21.tar.gz (116.6 kB view details)

Uploaded Source

Built Distribution

devon_agent-0.1.21-py3-none-any.whl (146.0 kB view details)

Uploaded Python 3

File details

Details for the file devon_agent-0.1.21.tar.gz.

File metadata

  • Download URL: devon_agent-0.1.21.tar.gz
  • Upload date:
  • Size: 116.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.11.6 Darwin/23.1.0

File hashes

Hashes for devon_agent-0.1.21.tar.gz
Algorithm Hash digest
SHA256 28cd5ca45b34e62ae8ba067ccc3d8482e2339a38d02d35a79df7a6b22083e531
MD5 bf170d8836f1f8c3c1dda5ddf9e22003
BLAKE2b-256 aa1e3fa00398991b77d60e0752468369a38bc4e9c5d437a5e742c4d17123d4b7

See more details on using hashes here.

File details

Details for the file devon_agent-0.1.21-py3-none-any.whl.

File metadata

  • Download URL: devon_agent-0.1.21-py3-none-any.whl
  • Upload date:
  • Size: 146.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.11.6 Darwin/23.1.0

File hashes

Hashes for devon_agent-0.1.21-py3-none-any.whl
Algorithm Hash digest
SHA256 79e9ebd90bad1d66fa343ba8f0a916905883be3880aa43156afa3c4af7a306a8
MD5 1e6c8bf6de7d193e50427f31da904108
BLAKE2b-256 e9bcb365bf5c4537b578ebafb98792f525441b37ea825702b253817304d1fe91

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page