From e4b1b12b266137839ee8d573a7532f916b97d1f8 Mon Sep 17 00:00:00 2001 From: "Paul Gauthier (aider)" Date: Wed, 19 Mar 2025 21:19:22 -0700 Subject: [PATCH] docs: Update README with polished content from index.html --- README.new.md | 95 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 95 insertions(+) diff --git a/README.new.md b/README.new.md index e69de29bb..dfabcee6a 100644 --- a/README.new.md +++ b/README.new.md @@ -0,0 +1,95 @@ +# Aider - AI Pair Programming in Your Terminal + +

+ GitHub Stars + PyPI Downloads + Tokens per week + OpenRouter Ranking + Singularity +

+ +Aider lets you pair program with LLMs to start a new project or build on your existing codebase. Aider works best with Claude 3.7 Sonnet, DeepSeek R1 & Chat V3, OpenAI o1, o3-mini & GPT-4o, but can [connect to almost any LLM, including local models](https://aider.chat/docs/llms.html). + +

+ aider screencast +

+ +## Features + +- **Cloud and local LLMs** - Aider works best with Claude 3.7 Sonnet, DeepSeek R1 & Chat V3, OpenAI o1, o3-mini & GPT-4o, but can connect to almost any LLM, including local models. +- **Maps your codebase** - Aider makes a map of your entire codebase, which helps it work well in larger projects. +- **100+ code languages** - Aider works with most popular programming languages: python, javascript, rust, ruby, go, cpp, php, html, css, and dozens more. +- **Git integration** - Aider automatically commits changes with sensible commit messages. Use familiar git tools to easily diff, manage and undo AI changes. +- **Use in your IDE** - Use aider from within your favorite IDE or editor. Ask for changes by adding comments to your code and aider will get to work. +- **Images & web pages** - Add images and web pages to the chat to provide visual context, screenshots, reference docs, etc. +- **Voice-to-code** - Speak with aider about your code! Request new features, test cases or bug fixes using your voice and let aider implement the changes. +- **Linting & testing** - Automatically lint and test your code every time aider makes changes. Aider can fix problems detected by your linters and test suites. +- **Copy/paste to web chat** - Work with any LLM via its web chat interface. Aider streamlines copy/pasting code context and edits back and forth with a browser. + +## Getting Started + +```bash +python -m pip install aider-install +aider-install + +# Change directory into your codebase +cd /to/your/project + +# DeepSeek +aider --model deepseek --api-key deepseek= + +# Claude 3.7 Sonnet +aider --model sonnet --api-key anthropic= + +# o3-mini +aider --model o3-mini --api-key openai= +``` + +See the [installation instructions](https://aider.chat/docs/install.html) and [usage documentation](https://aider.chat/docs/usage.html) for more details. + +## Top Tier Performance + +[Aider has one of the top scores on SWE Bench](https://aider.chat/2024/06/02/main-swe-bench.html). SWE Bench is a challenging software engineering benchmark where aider solved *real* GitHub issues from popular open source projects like django, scikitlearn, matplotlib, etc. + +## More Information + +### Documentation +- [Installation Guide](https://aider.chat/docs/install.html) +- [Usage Guide](https://aider.chat/docs/usage.html) +- [Tutorial Videos](https://aider.chat/docs/usage/tutorials.html) +- [Connecting to LLMs](https://aider.chat/docs/llms.html) +- [Configuration Options](https://aider.chat/docs/config.html) +- [Troubleshooting](https://aider.chat/docs/troubleshooting.html) +- [FAQ](https://aider.chat/docs/faq.html) + +### Community & Resources +- [LLM Leaderboards](https://aider.chat/docs/leaderboards/) +- [GitHub Repository](https://github.com/Aider-AI/aider) +- [Discord Community](https://discord.gg/Tv2uQnR88V) +- [Blog](https://aider.chat/blog/) + +## Kind Words From Users + +- *"The best free open source AI coding assistant."* — [IndyDevDan](https://youtu.be/YALpX8oOn78) +- *"The best AI coding assistant so far."* — [Matthew Berman](https://www.youtube.com/watch?v=df8afeb1FY8) +- *"Aider ... has easily quadrupled my coding productivity."* — [SOLAR_FIELDS](https://news.ycombinator.com/item?id=36212100) +- *"It's a cool workflow... Aider's ergonomics are perfect for me."* — [qup](https://news.ycombinator.com/item?id=38185326) +- *"It's really like having your senior developer live right in your Git repo - truly amazing!"* — [rappster](https://github.com/Aider-AI/aider/issues/124) +- *"What an amazing tool. It's incredible."* — [valyagolev](https://github.com/Aider-AI/aider/issues/6#issue-1722897858) +- *"Aider is such an astounding thing!"* — [cgrothaus](https://github.com/Aider-AI/aider/issues/82#issuecomment-1631876700) +- *"It was WAY faster than I would be getting off the ground and making the first few working versions."* — [Daniel Feldman](https://twitter.com/d_feldman/status/1662295077387923456) +- *"THANK YOU for Aider! It really feels like a glimpse into the future of coding."* — [derwiki](https://news.ycombinator.com/item?id=38205643) +- *"It's just amazing. It is freeing me to do things I felt were out my comfort zone before."* — [Dougie](https://discord.com/channels/1131200896827654144/1174002618058678323/1174084556257775656) +- *"This project is stellar."* — [funkytaco](https://github.com/Aider-AI/aider/issues/112#issuecomment-1637429008) +- *"Amazing project, definitely the best AI coding assistant I've used."* — [joshuavial](https://github.com/Aider-AI/aider/issues/84) +- *"I absolutely love using Aider ... It makes software development feel so much lighter as an experience."* — [principalideal0](https://discord.com/channels/1131200896827654144/1133421607499595858/1229689636012691468) +- *"I have been recovering from multiple shoulder surgeries ... and have used aider extensively. It has allowed me to continue productivity."* — [codeninja](https://www.reddit.com/r/OpenAI/s/nmNwkHy1zG) +- *"I am an aider addict. I'm getting so much more work done, but in less time."* — [dandandan](https://discord.com/channels/1131200896827654144/1131200896827654149/1135913253483069470) +- *"After wasting $100 on tokens trying to find something better, I'm back to Aider. It blows everything else out of the water hands down, there's no competition whatsoever."* — [SystemSculpt](https://discord.com/channels/1131200896827654144/1131200896827654149/1178736602797846548) +- *"Aider is amazing, coupled with Sonnet 3.5 it's quite mind blowing."* — [Josh Dingus](https://discord.com/channels/1131200896827654144/1133060684540813372/1262374225298198548) +- *"Hands down, this is the best AI coding assistant tool so far."* — [IndyDevDan](https://www.youtube.com/watch?v=MPYFPvxfGZs) +- *"[Aider] changed my daily coding workflows. It's mind-blowing how a single Python application can change your life."* — [maledorak](https://discord.com/channels/1131200896827654144/1131200896827654149/1258453375620747264) +- *"Best agent for actual dev work in existing codebases."* — [Nick Dobos](https://twitter.com/NickADobos/status/1690408967963652097?s=20)