mirror of
https://github.com/carlrobertoh/ProxyAI.git
synced 2026-04-28 11:41:28 +00:00
45908e69df
* Initial implementation of integrating llama.cpp to run LLaMA models locally * Move submodule * Copy llama submodule to bundle * Support for downloading models from IDE * Code cleanup * Store port field * Replace service selection radio group with dropdown * Add quantization support + other fixes * Add option to override host * Fix override host handler * Disable port field when override host enabled * Design updates * Fix llama settings configuration, design changes, clean up code * Improve You.com coupon design * Add new Phind model and help tooltip * Fetch you.com subscription * Add CodeBooga model, fix downloadable model selection * Chat history support * Code refactoring, minor bug fixes * UI updates, several bug fixes, removed code llama python model * Code cleanup, enable llama port only on macOS * Change downloaded gguf models path * Move some of the labels to codegpt bundle * Minor fixes * Remove ToRA model, add help texts * Fix test * Modify description
100 lines
4.4 KiB
Markdown
100 lines
4.4 KiB
Markdown
<!-- Plugin description -->
|
|
|
|
## Introducing CodeGPT: Your Free, Open-Source AI Copilot for Coding
|
|
|
|
CodeGPT is your go-to AI assistant, designed to enhance your coding skills and optimize your programming time.
|
|
Access state-of-the-art LLMs like GPT-4, Code LLama and more, all for free.
|
|
|
|
## Quick Start Guide
|
|
|
|
1. **Download the Plugin**: Get started by downloading the plugin from the [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/21056-codegpt?preview=true).
|
|
|
|
2. **Choose Your Preferred Service**:
|
|
|
|
a) **OpenAI** - Requires authentication via OpenAI API key.
|
|
|
|
b) **Azure** - Requires authentication via Active Directory or API key.
|
|
|
|
c) **You.com** - A free, web-connected service with an optional upgrade to You⚡Pro for enhanced features..
|
|
|
|
d) **LLaMA C/C++ Port** - Run Code Llama, WizardCoder, and other state-of-the-art models locally for free.
|
|
|
|
3. **Start Using the Features**: You're all set! Start exploring the features of our plugin.
|
|
|
|
### OpenAI
|
|
|
|
After successful installation, configure your API key. Navigate to the plugin's settings via **File | Settings/Preferences | Tools | CodeGPT**. Paste your OpenAI API key into the field and click `Apply/OK`.
|
|
|
|
### Azure
|
|
|
|
For Azure OpenAI services, you'll need to input three additional fields:
|
|
* `Resource name`: The name of your Azure OpenAI Cognitive Services.
|
|
* `Deployment ID`: The name of your Deployment.
|
|
* `API version`: The most recent non-preview version.
|
|
|
|
Also, input one of the two provided API keys.
|
|
|
|
### You.com (Free)
|
|
|
|
**You**.com is a search engine that summarizes the best parts of the internet for **you**, with private ads and with privacy options.
|
|
|
|
**You⚡Pro**
|
|
|
|
Use the **CodeGPT** coupon for a free month of unlimited GPT-4 usage.
|
|
|
|
Check out the full [feature list](https://about.you.com/hc/youpro/what-features-are-included-in-youpro/) for more details.
|
|
|
|
### LLaMA C/C++ Port (Free, Local)
|
|
|
|
> **Note**: This feature is currently supported only on Linux and MacOS.
|
|
|
|
The main goal of `llama.cpp` is to run the LLaMA model using 4-bit integer quantization on a MacBook.
|
|
|
|
#### Getting Started
|
|
|
|
1. **Select the Model**: Depending on your hardware capabilities, choose the appropriate model from the provided list. Once selected, click on the `Download Model` link. A progress bar will appear, indicating the download process.
|
|
|
|
2. **Start the Server**: After successfully downloading the model, initiate the server by clicking on the `Start Server` button. A status message will be displayed, indicating that the server is starting up.
|
|
|
|
3. **Apply Settings**: With the server running, you can now apply the settings to start using the features. Click on the `Apply/OK` button to save your settings and start using the application.
|
|
|
|
<img alt="animated" style="max-width: 100%; width: 600px;" src="https://github.com/carlrobertoh/CodeGPT/raw/master/docs/assets/llama_settings.png" />
|
|
|
|
> **Note**: If you're already running a server and wish to configure the plugin against that, then simply select the port and click `Apply/OK`.
|
|
|
|
## Features
|
|
|
|
The plugin provides several key features, such as:
|
|
|
|
### Ask Anything
|
|
|
|
Ask anything you'd like.
|
|
|
|
<img alt="animated" style="max-width: 100%; width: 800px;" src="https://github.com/carlrobertoh/CodeGPT/raw/master/docs/assets/gif/ask-anything.gif" />
|
|
|
|
### Select and Ask
|
|
|
|
Ask anything related to your selected code.
|
|
|
|
<img alt="animated" style="max-width: 100%; width: 800px;" src="https://github.com/carlrobertoh/CodeGPT/raw/master/docs/assets/gif/custom-prompt.gif" />
|
|
|
|
### Replace Generated Code
|
|
|
|
Instantly replace a selected code block in the editor with suggested code generated by AI.
|
|
|
|
<img alt="animated" style="max-width: 100%; width: 800px;" src="https://github.com/carlrobertoh/CodeGPT/raw/master/docs/assets/gif/replace-code.gif" />
|
|
|
|
### Regenerate Response
|
|
|
|
Expected a different answer? Re-generate any response of your choosing.
|
|
|
|
<img alt="animated" style="max-width: 100%; width: 800px;" src="https://github.com/carlrobertoh/CodeGPT/raw/master/docs/assets/gif/regenerate.gif" />
|
|
|
|
## Other features
|
|
|
|
- **Conversation History** - View recent conversation history and restore previous sessions, making it easy to pick up where you left off
|
|
- **Concurrent conversations** - Chat with the AI in multiple tabs simultaneously
|
|
- **Seamless conversations** - Chat with the AI regardless of the maximum token limitations
|
|
- **Predefined Actions** - Create your own editor actions or override the existing ones, saving time rewriting the same prompt repeatedly
|
|
|
|
<!-- Plugin description end -->
|