# Flexpilot AI - Your Open-Source AI Assistant

> _"Open-Source, Native and a True GitHub Copilot Alternative for VS Code"_

> [!WARNING]  
> The **Flexpilot VS Code extension** is no longer actively maintained. We will still try to address any issues or pull requests, but will not be adding new features.
>
> We have created `Flexpilot IDE` as its successor - a fork of VS Code with the Flexpilot extension pre-installed, along with powerful new features such as multi-file editing, an online web IDE, and more.
>
> 🚀 Click [here](https://ide.flexpilot.ai/?folder=web-fs://github/flexpilot-ai/flexpilot-ide/main) to experience it instantly Online.
>
> 📥 Click [here](https://flexpilot.ai/docs/getting-started#downloading-the-ide) to download the latest version of Flexpilot Desktop IDE for the best experience.

![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/flexpilot-ai/vscode-extension/build.yml)
[![License](https://img.shields.io/badge/license-GNU%20GPLv3-blue.svg)](LICENSE)
![Visual Studio Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/flexpilot.flexpilot-vscode-extension)
[![Star on GitHub](https://img.shields.io/github/stars/flexpilot-ai/vscode-extension?style=social)](https://github.com/flexpilot-ai/vscode-extension)

Flexpilot is your gateway to truly flexible AI-powered development. Unlike other AI assistants, Flexpilot puts **you** in control, letting you use your preferred AI providers and models directly in VS Code. Native integration, unparalleled flexibility, and open-source freedom - all in one powerful package.

## 🚀 Getting Started

1. Install Flexpilot from the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=flexpilot.flexpilot-vscode-extension) and restart VS Code once installation is complete.
2. Configure your preferred Language model providers as explained [here](https://docs.flexpilot.ai/configuration.html) in the official documentation.
3. Start coding with AI-powered completions, chat, and more!

## ✨ Why Flexpilot?

- 🎯 **100% Native VS Code Experience** - No clunky webviews, just pure coding bliss
- 🔑 **Your Keys, Your Control** - Use your own API keys with top AI providers
- 🎨 **Ultimate Flexibility** - Mix and match AI models for different tasks
- 🌟 **Open Source Freedom** - Fully transparent, customizable, and community-driven
- 💎 **GitHub Copilot Compatible** - Leverage your existing skills seamlessly

## 🛠️ Supercharged Features

### 🤖 Code Completions

Effortlessly code with **AI-powered autocomplete** that provides context-aware suggestions and natural language guidance tailored to your project.

![Inline Completions](./assets/readme/inline-completion-dark.gif)

### 💬 Panel Chat

Experience **context-aware, interactive AI conversations** directly within your VSCode workspace. Flexpilot’s panel chat keeps you focused on problem-solving without ever leaving your codebase.

![Panel Chat](./assets/readme/panel-chat-dark.gif)

### ✍️ Inline Chat

Refactor, debug, or gain instant clarity with **Inline Chat**. Whether you need error handling suggestions or code explanations, Flexpilot’s inline chat feature lets you make changes directly in your editor.

![Inline Chat](./assets/readme/inline-chat-dark.gif)

### ⚡ Quick Chat

Stay in the zone with **Quick Chat** – instant answers from your AI assistant with a single shortcut. No more breaking your workflow to find answers; just quick solutions at your fingertips.

![Quick Chat](./assets/readme/quick-chat-dark.gif)

### 🎯 Smart Variables

Get precision in your AI interactions with **Smart Variables**. Flexpilot references elements from your code and editor data, allowing for more tailored and relevant assistance.

![Smart Variables](./assets/readme/panel-chat-dark.gif)

### 🎙️ Voice Chat

Have a question? Just ask! **Voice Chat** enables you to speak directly to your AI assistant and receive code suggestions in real time, allowing you to stay hands-free while coding.

![Voice Chat](./assets/readme/voice-chat-dark.gif)

### 📄 Dynamic Chat Titles

Maintain clarity in your AI-assisted conversations with **Dynamic Chat Titles**. Flexpilot automatically generates concise, relevant titles for each chat, making it easy to revisit previous conversations.

![Dynamic Chat Titles](./assets/readme/chat-title-dark.gif)

### 💻 Commit Messages

Simplify your workflow with **AI-generated commit messages** and PR descriptions. Flexpilot crafts detailed and context-aware commit messages to make your code contributions clearer and more descriptive.

![Commit Messages](./assets/readme/commit-message-dark.gif)

### 📊 Token Usage Insights

Gain transparency with **Token Usage Insights**. Track real-time token consumption across all AI interactions, helping you manage your usage and costs more effectively.

![Token Usage Insights](./assets/readme/token-usage-dark.gif)

## 🎯 Supported AI Providers

- Anthropic
- OpenAI
- Azure OpenAI
- Groq
- Google Gemini
- Mistral AI
- Ollama
- Anyscale
- KoboldCpp
- text-gen-webui
- FastChat
- LocalAI
- llama-cpp-python
- TensorRT-LLM
- vLLM
- _Any many more!_

## 🗺️ Roadmap

- ✨ **Multi-File Chat Edits** - Seamlessly manage AI-assisted changes across multiple files.
- 🧑‍💻 **@Workspace Agent** - Contextual AI support for your entire project workspace.
- 🔌 **Extended Copilot Extensions** - Integrate and leverage [GitHub Copilot Extensions](https://github.com/marketplace?type=apps&copilot_app=true).
- _Any many more!_

## 🤝 Open Source Community

Flexpilot is proudly open source under the GNU GPLv3 license. We believe in:

- 🌟 **Community-First Development**
- 🛠️ **Transparent Architecture**
- 🤝 **Collaborative Innovation**
- 🚀 **Continuous Improvement**

## 🤝 Contributing

We love contributions! Whether it's:

- 🐛 Bug Reports
- ✨ Feature Requests
- 📝 Documentation
- 💻 Code Contributions

Check our [Contributing Guide](CONTRIBUTING.md) to get started!

## 📜 License

Flexpilot is open source under the [GNU GPLv3 License](LICENSE).

## 🌟 Star Us on GitHub!

If you love Flexpilot, show your support [here](https://github.com/flexpilot-ai/vscode-extension) by starring us on GitHub! Every star motivates us to make Flexpilot even better.

<p align="center">
Made with ❤️ by developers, for developers
<br>
© 2024 Flexpilot AI Inc.
</p>