Refact

🚀 Refact Project

Refact is a tool designed to enhance development efficiency through artificial intelligence technology. Whether you're a novice or an experienced developer, Refact can simplify your daily tasks and make coding more efficient and enjoyable.

🚀 Quick Start

Refact is a tool aiming to boost development efficiency with AI technology. It caters to both beginners and seasoned developers, streamlining daily tasks and making coding a breeze.

✨ Features

• Code Generation: Generate high-quality code from natural language descriptions.
• Code Refactoring: Optimize code structure for better readability and maintainability.
• Code Explanation: Quickly understand complex or unfamiliar code logic.
• Debugging Assistance: Automatically detect and fix common errors.
• Unit Test Generation: Automatically generate reliable test cases for your code.
• Code Review: Provide AI-assisted suggestions for code improvement.
• Documentation Generation: Keep project documentation up-to-date.
• API Documentation Expansion: Automatically generate detailed API documentation.

📦 Installation

To quickly get started with Refact, follow these steps:

Quick Installation

Install directly without Docker:

pip install .

Use GPU Acceleration

If you have an NVIDIA graphics card supporting CUDA 8.0 or higher and want to leverage Flash Attention v2 technology for better performance, run the following command:

FLASH_ATTENTION_FORCE_BUILD=TRUE MAX_JOBS=4 INSTALL_OPTIONAL=TRUE pip install .

💻 Usage Examples

Use in VS Code

1. Install the Refact Plugin: Search for and install "Refact.ai Assistant" in the VS Code Extension Marketplace.
2. Configure Plugin Settings:
   • Open VS Code settings (File > Settings or Code > Preferences).
   • Select Extensions in the left sidebar and find the Refact plugin.
   • Click the gear icon to enter the settings page and enter the following in the Address URL field:

     http://127.0.0.1:8008
     

Use in JetBrains

1. Install the Refact Plugin: Visit https://plugins.jetbrains.com/plugin/ and search for "Refact" to download and install.
2. Configure Plugin Settings:
   • Open the settings of IntelliJ IDEA or other JetBrains tools (File > Settings).
   • Select Tools in the left sidebar and then find the Refact.ai option.
   • Click the Advanced tab and enter the following in the Inference URL input box:

     http://127.0.0.1:8008
     

📚 Documentation

For a deeper understanding of Refact's advanced features and best practices, please refer to our official documentation.

🤝 Contribution Guidelines

If you're interested in contributing to the Refact project, please refer to our CONTRIBUTING.md file for details on how to get involved. Every contribution helps shape the future of programming!

👥 Join the Community

We firmly believe in the power of open source and are committed to providing developers with powerful AI tools. Join us in driving technological progress!

📢 Join our Discord server now to exchange experiences with other developers and stay updated.

Thank you for your support! We hope Refact will be a valuable assistant in your development journey.