Refact
by smallcloudai
Refact Agent is a free, open-source AI Agent that handles engineering tasks end-to-end. It deeply understands your codebases and integrates with your tools, databases, and browsers to automate complex, multi-step tasks.
Last updated: N/A
<a name="readme-top"></a>
<div align="center"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://docs.refact.ai/_astro/logo-dark.CCzD55EA.svg"> <source media="(prefers-color-scheme: light)" srcset="https://docs.refact.ai/_astro/logo-light.CblxRz3x.svg"> <!-- Fallback if neither preference is set --> <img alt="Refact.ai logo" src="https://docs.refact.ai/_astro/logo-dark.CCzD55EA.svg" width="200"> </picture> <h1 align="center">Refact - Open Sourced AI Software Development Agent</h1> </div> <div align="center"> <a href="https://github.com/smallcloudai/refact/stargazers"><img src="https://img.shields.io/github/stars/smallcloudai/refact?style=for-the-badge&color=blue" alt="Stargazers"></a> <a href="https://discord.gg/Kts7CYg99R"><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> <a href="https://docs.refact.ai"><img src="https://img.shields.io/badge/documentation-blue?logo=googledocs&logoColor=FFE165&style=for-the-badge" alt="Check out the documentation"></a> </div>Refact Agent is a free, open-source AI Agent that handles engineering tasks end-to-end. It deeply understands your codebases and integrates with your tools, databases, and browsers to automate complex, multi-step tasks.
π Seamless Integration with Your Workflow
Refact Agent works effortlessly with the tools and databases you already use:
- π Version Control: GitHub, GitLab
- ποΈ Databases: PostgreSQL, MySQL
- π οΈ Debugging: Pdb
- π³ Containerization: Docker
β‘ Why Choose Refact Agent?
- β Deploy On-Premise: Maintain 100% control over your codebase.
- π§ Access State-of-the-Art Models: Supports Claude 3.7 Sonnet, GPT-4o, o3-mini, and more.
- π Bring Your Own Key (BYOK): Use your own API keys for external LLMs.
- π¬ Integrated IDE Chat: Stay in your workflow, no need to switch between tools!
- β‘ Free, Unlimited, Context-Aware Auto-Completion: Code faster with smart AI suggestions.
- π οΈ Supports 25+ Programming Languages: Python, JavaScript, Java, Rust, TypeScript, PHP, C++, C#, Go, and many more!
π Hear from our Community
Our Ambassadors shared remarkable stories of how they transform weeks of coding into minutes with Refact.ai Agent!
1οΈβ£ How Refact.ai built 99.9% of an IoT cloud app Read
2οΈβ£ How AI-coded prototypes help UX teams deliver real value Read
3οΈβ£ 80 hours of building from scratch β instead done in 30 minutes Read more
4οΈβ£ 3 weeks of waiting for a functional GUI? Built in just 14 minutes Read more
π View Full List of Supported Models
π’ Using AI for work? Letβs bring it to your company!
Fill out this form β Our AI Agent will be tailored to your companyβs data, learning from feedback, and helping organize knowledge for better collaboration with your team.
π Table of Contents
- π Core Features and Functionality
- π€ Which Tasks Can Refact Help You With?
- βοΈ QuickStart
- π³ Running Refact Self-Hosted in a Docker Container
- π Getting Started with Plugins
- π Documentation
- π₯ Contribution
- π Join the Community
π Core Features and Functionality
β Unlimited accurate auto-completion with context awareness β Powered by Qwen2.5-Coder-1.5B, utilizing Retrieval-Augmented Generation (RAG).
auto-completion
β Integrated in-IDE Chat β AI deeply understands your code and provides relevant, intelligent answers.
β Integrated with Tools β Works with GitHub, GitLab, PostgreSQL, MySQL, Pdb, Docker, and shell commands.
integrations
β State-of-the-Art Models β Supports Claude 3.7 Sonnet, GPT-4o, o3-mini, and more.
β Bring Your Own Key (BYOK) β Use your own API keys for external LLMs.
BYOK
π€ Which Tasks Can Refact Help You With?
-
π Generate code from natural language prompts (even with typos).
-
π Refactor code for better quality and readability.
-
π Explain code to quickly understand unfamiliar code.
-
π Debug code to detect and fix errors faster.
-
π§ͺ Generate unit tests for reliable code.
-
π Code Review with AI-assisted suggestions.
-
π Create Documentation to keep knowledge up to date.
-
π· Generate Docstrings for structured documentation.
βοΈ QuickStart
You can install the Refact repository without Docker:
pip install .
For GPU with CUDA capability >= 8.0 and flash-attention v2 support:
FLASH_ATTENTION_FORCE_BUILD=TRUE MAX_JOBS=4 INSTALL_OPTIONAL=TRUE pip install .
π³ Running Refact Self-Hosted in a Docker Container
The easiest way to run the self-hosted server is using a pre-built Docker image.
See CONTRIBUTING.md
for installation without a Docker container.
π Getting Started with Plugins
- Download Refact for VS Code or JetBrains.
- Set up a custom inference URL:
http://127.0.0.1:8008
- Configure the plugin settings:
- JetBrains: Settings > Tools > Refact.ai > Advanced > Inference URL
- VSCode: Extensions > Refact.ai Assistant > Settings > Address URL
π Documentation
For detailed guidance and best practices, check out our documentation.
π₯ Contribution
Want to contribute to our project? We're always open to new ideas and features!
- Check out GitHub Issues β See what we're working on or suggest your own ideas.
- Read our Contributing Guide β Check out
Contributing.md
to get started.
Your contributions help shape the future of Refact Agent! π
π Join the Community
We're all about open-source and empowering developers with AI tools. Our vision is to build the future of programming. Join us and be part of the journey!
π’ Join our Discord server β A community-run space for discussion, questions, and feedback.
Made with β€οΈ by developers who automate the boring, so you can focus on building the future.