ProxyAI/DESCRIPTION.md
2025-06-02 12:59:38 +01:00

126 lines
5.2 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!-- Plugin description -->
ProxyAI is an AI-powered code assistant designed to help you with various programming activities.
It's a powerful alternative to Cursor, Windsurf, GitHub Copilot, AI Assistant, and other JetBrains plugins.
## Highly Configurable
Access top-tier language models (LLMs) with your own API key or use privately hosted models within your corporate network.
- **Cloud Providers & Custom Setups:** Integrate top-tier models from OpenAI, Anthropic, Azure, Mistral, or use self-hosted models for offline use.
- **Bring Your Own Key:** Connect with your preferred provider using your API key.
- **Custom Setup:** Integrate privately hosted models with OpenAI API-compatible configuration.
## Build Your Own Local AI Assistant
ProxyAI is the leading open-source extension for connecting your locally running LLM with JetBrains IDEs. Enjoy full AI assistance without sending data externally or needing an internet connection.
- **Ollama Integration:** Automatically detect and utilize Ollama-managed models.
- **GGUF Support:** Easily connect custom models.
- **LLaMA C/C++ Integration:** Run various open-source LLMs without third-party software.
## Core Features
ProxyAI offers a wide range of features to enhance your development experience:
### Chat
Get instant coding advice through a ChatGPT-like interface that accepts image input. Ask questions, share screenshots, seek explanations, or get guidance on your projects without leaving your IDE.
**Auto Apply**
Stream AI-suggested code changes directly into your editor. Preview modifications in diff view and
approve or reject them with a single click.
![Auto apply](https://d90fxihmgd9lz.cloudfront.net/images/jetbrains/features/auto-apply-w800.png)
**Use images**
Chat with your images. Upload manually or let ProxyAI auto-detect your screenshots.
![Use images](https://d90fxihmgd9lz.cloudfront.net/images/jetbrains/features/use-images-w800.png)
**Reference your files and folders**
Quickly access and reference your project files and folders for context-aware coding assistance.
![Reference files and folders](https://d90fxihmgd9lz.cloudfront.net/images/jetbrains/features/reference-files-w800.png)
**Reference web documentations**
Easily pull in relevant web documentation into your chat for quick reference—whether its API docs, library guides, framework manuals, or something else.
![Reference files and folders](https://d90fxihmgd9lz.cloudfront.net/images/jetbrains/features/reference-docs-w800.png)
**Search the web**
Connect your favourite LLM to the web. ProxyAI will search for the most relevant information to answer your questions.
![Web search](https://d90fxihmgd9lz.cloudfront.net/images/jetbrains/features/web-search-w800.png)
**Customize your assistant**
Choose between multiple different personas for your specific needs, whether you're looking to learn, write or proofread.
![Customize your assistant](https://d90fxihmgd9lz.cloudfront.net/images/jetbrains/features/persona-suggestions-w800.png)
### Code
Get helpful code completions as you type, edit your code using natural language, create clear and
concise commit messages automatically, and more. ProxyAI equips you with cutting-edge tools to
streamline your workflow.
**Next edits**
Get multi-line edits based on your recent activity as you type.
![Code assistant](https://d90fxihmgd9lz.cloudfront.net/images/jetbrains/features/code-assistant-w800.png)
**Autocomplete your code**
Receive single-line or whole-function autocomplete suggestions as you type.
![Autocomplete your code](https://d90fxihmgd9lz.cloudfront.net/images/jetbrains/features/inline-completion-w800.png)
**Edit code in natural language**
Highlight the code you want to modify, describe the desired changes, and watch ProxyAI work its magic.
![Edit code](https://d90fxihmgd9lz.cloudfront.net/images/jetbrains/features/edit-code-w800.png)
**Get name suggestions**
Get context-aware naming suggestions for methods, variables, and more.
![Name suggestions](https://d90fxihmgd9lz.cloudfront.net/images/jetbrains/features/name-suggestions-w800.png)
**Generate commit messages**
Generate concise and descriptive commit messages based on the changes made in your codebase.
![Generate commit messages](https://d90fxihmgd9lz.cloudfront.net/images/jetbrains/features/generate-commit-message-w800.png)
**Offline Development Support (llama.cpp and Ollama)**
Integrate local open-source language models into your coding environment and enjoy a full experience without sending your data anywhere or needing an internet connection.
![Offline Development Support](https://github.com/carlrobertoh/CodeGPT-docs/blob/main/images/plugin-description/old/llama-settings-resized.png?raw=true)
## Privacy
**Your data stays yours.** ProxyAI **does not** collect or store any sensitive information. With users' consent, we collect anonymous usage data to understand how users interact with the extension, including the most-used features and preferred providers.
## License
ProxyAI's code is open source under the Apache License 2.0.
## Feedback
Your input helps us grow. Reach out through:
- [Homepage](https://proxyai.ee)
- [Issue Tracker](https://github.com/carlrobertoh/ProxyAI/issues)
- [Discord](https://discord.gg/8dTGGrwcnR)
- [Email](mailto:carlrobertoh@gmail.com)
<!-- Plugin description end -->