mirror of
https://github.com/Palm1r/QodeAssist.git
synced 2025-05-28 03:10:28 -04:00
371 lines
17 KiB
Markdown
371 lines
17 KiB
Markdown
# QodeAssist - AI-powered coding assistant plugin for Qt Creator
|
|
[](https://github.com/Palm1r/QodeAssist/actions/workflows/build_cmake.yml)
|
|
|
|
|
|
|
|
|
|
[](https://discord.gg/BGMkUsXUgf)
|
|
|
|
 QodeAssist is an AI-powered coding assistant plugin for Qt Creator. It provides intelligent code completion and suggestions for C++ and QML, leveraging large language models through local providers like Ollama. Enhance your coding productivity with context-aware AI assistance directly in your Qt development environment.
|
|
|
|
⚠️ **Important Notice About Paid Providers**
|
|
> When using paid providers like Claude, OpenRouter or OpenAI-compatible services:
|
|
> - These services will consume API tokens which may result in charges to your account
|
|
> - The QodeAssist developer bears no responsibility for any charges incurred
|
|
> - Please carefully review the provider's pricing and your account settings before use
|
|
|
|
## Table of Contents
|
|
1. [Overview](#overview)
|
|
2. [Install plugin to QtCreator](#install-plugin-to-qtcreator)
|
|
3. [Configure for Anthropic Claude](#configure-for-anthropic-claude)
|
|
4. [Configure for OpenAI](#configure-for-openai)
|
|
5. [Configure for Mistral AI](#configure-for-mistral-ai)
|
|
6. [Configure for Google AI](#configure-for-google-ai)
|
|
7. [Configure for Ollama](#configure-for-ollama)
|
|
8. [Configure for llama.cpp](#configure-for-llamacpp)
|
|
9. [System Prompt Configuration](#system-prompt-configuration)
|
|
10. [File Context Feature](#file-context-feature)
|
|
11. [Quick Refactoring Feature](#quick-refactoring-feature)
|
|
12. [QtCreator Version Compatibility](#qtcreator-version-compatibility)
|
|
13. [Development Progress](#development-progress)
|
|
14. [Hotkeys](#hotkeys)
|
|
15. [Ignoring Files](#ignoring-files)
|
|
14. [Troubleshooting](#troubleshooting)
|
|
15. [Support the Development](#support-the-development-of-qodeassist)
|
|
16. [How to Build](#how-to-build)
|
|
|
|
## Overview
|
|
|
|
- AI-powered code completion
|
|
- Sharing IDE opened files with model context (disabled by default, need enable in settings)
|
|
- Quick refactor code via fast chat command and opened files
|
|
- Chat functionality:
|
|
- Side and Bottom panels
|
|
- Chat history autosave and restore
|
|
- Token usage monitoring and management
|
|
- Attach files for one-time code analysis
|
|
- Link files for persistent context with auto update in conversations
|
|
- Automatic syncing with open editor files (optional)
|
|
- Support for multiple LLM providers:
|
|
- Ollama
|
|
- llama.cpp
|
|
- OpenAI
|
|
- Anthropic Claude
|
|
- LM Studio
|
|
- Mistral AI
|
|
- Google AI
|
|
- OpenAI-compatible providers(eg. llama.cpp, https://openrouter.ai)
|
|
- Extensive library of model-specific templates
|
|
- Easy configuration and model selection
|
|
|
|
Join our Discord Community: Have questions or want to discuss QodeAssist? Join our [Discord server](https://discord.gg/BGMkUsXUgf) to connect with other users and get support!
|
|
|
|
<details>
|
|
<summary>Code completion: (click to expand)</summary>
|
|
<img src="https://github.com/user-attachments/assets/255a52f1-5cc0-4ca3-b05c-c4cf9cdbe25a" width="600" alt="QodeAssistPreview">
|
|
</details>
|
|
|
|
<details>
|
|
<summary>Quick refactor in code: (click to expand)</summary>
|
|
<img src="https://github.com/user-attachments/assets/4a9092e0-429f-41eb-8723-cbb202fd0a8c" width="600" alt="QodeAssistPreview">
|
|
</details>
|
|
|
|
<details>
|
|
<summary>Multiline Code completion: (click to expand)</summary>
|
|
<img src="https://github.com/user-attachments/assets/c18dfbd2-8c54-4a7b-90d1-66e3bb51adb0" width="600" alt="QodeAssistPreview">
|
|
</details>
|
|
|
|
<details>
|
|
<summary>Chat with LLM models in side panels: (click to expand)</summary>
|
|
<img src="https://github.com/user-attachments/assets/ead5a5d9-b40a-4f17-af05-77fa2bcb3a61" width="600" alt="QodeAssistChat">
|
|
</details>
|
|
|
|
<details>
|
|
<summary>Chat with LLM models in bottom panel: (click to expand)</summary>
|
|
<img width="326" alt="QodeAssistBottomPanel" src="https://github.com/user-attachments/assets/4cc64c23-a294-4df8-9153-39ad6fdab34b">
|
|
</details>
|
|
|
|
<details>
|
|
<summary>Automatic syncing with open editor files: (click to expand)</summary>
|
|
<img width="600" alt="OpenedDocumentsSync" src="https://github.com/user-attachments/assets/08efda2f-dc4d-44c3-927c-e6a975090d2f">
|
|
</details>
|
|
|
|
## Install plugin to QtCreator
|
|
1. Install Latest Qt Creator
|
|
2. Download the QodeAssist plugin for your Qt Creator
|
|
- Remove old version plugin if already was installed
|
|
- on macOS for QtCreator 16: ~/Library/Application Support/QtProject/Qt Creator/plugins/16.0.0/petrmironychev.qodeassist
|
|
- on windows for QtCreator 16: C:\Users\<user>\AppData\Local\QtProject\qtcreator\plugins\16.0.0\petrmironychev.qodeassist\lib\qtcreator\plugins
|
|
3. Launch Qt Creator and install the plugin:
|
|
- Go to:
|
|
- MacOS: Qt Creator -> About Plugins...
|
|
- Windows\Linux: Help -> About Plugins...
|
|
- Click on "Install Plugin..."
|
|
- Select the downloaded QodeAssist plugin archive file
|
|
|
|
## Configure for Anthropic Claude
|
|
1. Open Qt Creator settings and navigate to the QodeAssist section
|
|
2. Go to Provider Settings tab and configure Claude api key
|
|
3. Return to General tab and configure:
|
|
- Set "Claude" as the provider for code completion or/and chat assistant
|
|
- Set the Claude URL (https://api.anthropic.com)
|
|
- Select your preferred model (e.g., claude-3-5-sonnet-20241022)
|
|
- Choose the Claude template for code completion or/and chat
|
|
<details>
|
|
<summary>Example of Claude settings: (click to expand)</summary>
|
|
<img width="823" alt="Claude Settings" src="https://github.com/user-attachments/assets/828e09ea-e271-4a7a-8271-d3d5dd5c13fd" />
|
|
</details>
|
|
|
|
## Configure for OpenAI
|
|
1. Open Qt Creator settings and navigate to the QodeAssist section
|
|
2. Go to Provider Settings tab and configure OpenAI api key
|
|
3. Return to General tab and configure:
|
|
- Set "OpenAI" as the provider for code completion or/and chat assistant
|
|
- Set the OpenAI URL (https://api.openai.com)
|
|
- Select your preferred model (e.g., gpt-4o)
|
|
- Choose the OpenAI template for code completion or/and chat
|
|
<details>
|
|
<summary>Example of OpenAI settings: (click to expand)</summary>
|
|
<img width="829" alt="OpenAI Settings" src="https://github.com/user-attachments/assets/4716f790-6159-44d0-a8f4-565ccb6eb713" />
|
|
</details>
|
|
|
|
## Configure for Mistral AI
|
|
1. Open Qt Creator settings and navigate to the QodeAssist section
|
|
2. Go to Provider Settings tab and configure Mistral AI api key
|
|
3. Return to General tab and configure:
|
|
- Set "Mistral AI" as the provider for code completion or/and chat assistant
|
|
- Set the OpenAI URL (https://api.mistral.ai)
|
|
- Select your preferred model (e.g., mistral-large-latest)
|
|
- Choose the Mistral AI template for code completion or/and chat
|
|
<details>
|
|
<summary>Example of Mistral AI settings: (click to expand)</summary>
|
|
<img width="829" alt="Mistral AI Settings" src="https://github.com/user-attachments/assets/1c5ed13b-a29b-43f7-b33f-2e05fdea540c" />
|
|
</details>
|
|
|
|
## Configure for Google AI
|
|
1. Open Qt Creator settings and navigate to the QodeAssist section
|
|
2. Go to Provider Settings tab and configure Google AI api key
|
|
3. Return to General tab and configure:
|
|
- Set "Google AI" as the provider for code completion or/and chat assistant
|
|
- Set the OpenAI URL (https://generativelanguage.googleapis.com/v1beta)
|
|
- Select your preferred model (e.g., gemini-2.0-flash)
|
|
- Choose the Google AI template
|
|
<details>
|
|
<summary>Example of Google AI settings: (click to expand)</summary>
|
|
<img width="829" alt="Google AI Settings" src="https://github.com/user-attachments/assets/046ede65-a94d-496c-bc6c-41f3750be12a" />
|
|
</details>
|
|
|
|
## Configure for Ollama
|
|
|
|
1. Install [Ollama](https://ollama.com). Make sure to review the system requirements before installation.
|
|
2. Install a language models in Ollama via terminal. For example, you can run:
|
|
|
|
For standard computers (minimum 8GB RAM):
|
|
```
|
|
ollama run qwen2.5-coder:7b
|
|
```
|
|
For better performance (16GB+ RAM):
|
|
```
|
|
ollama run qwen2.5-coder:14b
|
|
```
|
|
For high-end systems (32GB+ RAM):
|
|
```
|
|
ollama run qwen2.5-coder:32b
|
|
```
|
|
|
|
1. Open Qt Creator settings (Edit > Preferences on Linux/Windows, Qt Creator > Preferences on macOS)
|
|
2. Navigate to the "QodeAssist" tab
|
|
3. On the "General" page, verify:
|
|
- Ollama is selected as your LLM provider
|
|
- The URL is set to http://localhost:11434
|
|
- Your installed model appears in the model selection
|
|
- The prompt template is Ollama Auto FIM or Ollama Auto Chat for chat assistance. You can specify template if it is not work correct
|
|
4. Click Apply if you made any changes
|
|
|
|
You're all set! QodeAssist is now ready to use in Qt Creator.
|
|
<details>
|
|
<summary>Example of Ollama settings: (click to expand)</summary>
|
|
<img width="824" alt="Ollama Settings" src="https://github.com/user-attachments/assets/ed64e03a-a923-467a-aa44-4f790e315b53" />
|
|
</details>
|
|
|
|
## Configure for llama.cpp
|
|
1. Open Qt Creator settings and navigate to the QodeAssist section
|
|
2. Go to General tab and configure:
|
|
- Set "llama.cpp" as the provider for code completion or/and chat assistant
|
|
- Set the llama.cpp URL (e.g. http://localhost:8080)
|
|
- Fill in model name
|
|
- Choose template for model(e.g. llama.cpp FIM for any model with FIM support)
|
|
<details>
|
|
<summary>Example of llama.cpp settings: (click to expand)</summary>
|
|
<img width="829" alt="llama.cpp Settings" src="https://github.com/user-attachments/assets/8c75602c-60f3-49ed-a7a9-d3c972061ea2" />
|
|
</details>
|
|
|
|
## System Prompt Configuration
|
|
|
|
The plugin comes with default system prompts optimized for chat and instruct models, as these currently provide better results for code assistance. If you prefer using FIM (Fill-in-Middle) models, you can easily customize the system prompt in the settings.
|
|
|
|
## File Context Feature
|
|
|
|
QodeAssist provides two powerful ways to include source code files in your chat conversations: Attachments and Linked Files. Each serves a distinct purpose and helps provide better context for the AI assistant.
|
|
|
|
### Attached Files
|
|
|
|
Attachments are designed for one-time code analysis and specific queries:
|
|
- Files are included only in the current message
|
|
- Content is discarded after the message is processed
|
|
- Ideal for:
|
|
- Getting specific feedback on code changes
|
|
- Code review requests
|
|
- Analyzing isolated code segments
|
|
- Quick implementation questions
|
|
- Files can be attached using the paperclip icon in the chat interface
|
|
- Multiple files can be attached to a single message
|
|
|
|
### Linked Files
|
|
|
|
Linked files provide persistent context throughout the conversation:
|
|
|
|
- Files remain accessible for the entire chat session
|
|
- Content is included in every message exchange
|
|
- Files are automatically refreshed - always using latest content from disk
|
|
- Perfect for:
|
|
- Long-term refactoring discussions
|
|
- Complex architectural changes
|
|
- Multi-file implementations
|
|
- Maintaining context across related questions
|
|
- Can be managed using the link icon in the chat interface
|
|
- Supports automatic syncing with open editor files (can be enabled in settings)
|
|
- Files can be added/removed at any time during the conversation
|
|
|
|
## Quick Refactoring Feature
|
|
### Setup
|
|
Since this is actually a small chat with redirected output, the main settings of the provider, model and template are taken from the chat settings
|
|
### Using
|
|
The request to model consist of instructions to model, selection code and cursor position
|
|
The default instruction is: "Refactor the code to improve its quality and maintainability." and sending if text field is empty
|
|
Also there buttons to quick call instractions:
|
|
* Repeat latest instruction, will activate after sending first request in QtCreator session
|
|
* Improve current selection code
|
|
* Suggestion alternative variant of selection code
|
|
* Other instructions[TBD]
|
|
|
|
## QtCreator Version Compatibility
|
|
|
|
- QtCreator 16.0.2 - 0.5.13 - 0.x.x
|
|
- QtCreator 16.0.1 - 0.5.7 - 0.x.x
|
|
- QtCreator 16.0.0 - 0.5.2 - 0.5.6
|
|
- QtCreator 15.0.1 - 0.4.8 - 0.5.1
|
|
- QtCreator 15.0.0 - 0.4.0 - 0.4.7
|
|
- QtCreator 14.0.2 - 0.2.3 - 0.3.x
|
|
- QtCreator 14.0.1 - 0.2.2 plugin version and below
|
|
|
|
## Development Progress
|
|
|
|
- [x] Basic plugin with code autocomplete functionality
|
|
- [x] Improve and automate settings
|
|
- [x] Add chat functionality
|
|
- [x] Sharing diff with model
|
|
- [ ] Sharing project source with model
|
|
- [ ] Support for more providers and models
|
|
- [ ] Support MCP
|
|
|
|
## Hotkeys
|
|
|
|
- To call manual request to suggestion, you can use or change it in settings
|
|
- on Mac: Option + Command + Q
|
|
- on Windows: Ctrl + Alt + Q
|
|
- on Linux with KDE Plasma: Ctrl + Alt + Q
|
|
- To insert the full suggestion, you can use the TAB key
|
|
- To insert word of suggistion, you can use Alt + Right Arrow for Win/Lin, or Option + Right Arrow for Mac
|
|
- To call Quick Refactor dialog, select some code or place cursor and press
|
|
- on Mac: Option + Command + R
|
|
- on Windows: Ctrl + Alt + R
|
|
- on Linux with KDE Plasma: Ctrl + Alt + R
|
|
|
|
## Ignoring Files
|
|
QodeAssist supports the ability to ignore files in context using a .qodeassistignore file. This allows you to exclude specific files from the context during code completion and in the chat assistant, which is especially useful for large projects.
|
|
|
|
### How to Use .qodeassistignore
|
|
- Create a .qodeassistignore file in the root directory of your project near CMakeLists.txt or pro.
|
|
- Add patterns for files and directories that should be excluded from the context.
|
|
- QodeAssist will automatically detect this file and apply the exclusion rules.
|
|
|
|
### .qodeassistignore File Format
|
|
The file format is similar to .gitignore:
|
|
- Each pattern is written on a separate line
|
|
- Empty lines are ignored
|
|
- Lines starting with # are considered comments
|
|
- Standard wildcards work the same as in .gitignore
|
|
- To negate a pattern, use ! at the beginning of the line
|
|
```
|
|
# Ignore all files in the build directory
|
|
/build
|
|
*.tmp
|
|
# Ignore a specific file
|
|
src/generated/autogen.cpp
|
|
|
|
```
|
|
|
|
## Troubleshooting
|
|
|
|
If QodeAssist is having problems connecting to the LLM provider, please check the following:
|
|
|
|
1. Verify the IP address and port:
|
|
|
|
- For Ollama, the default is usually http://localhost:11434
|
|
- For LM Studio, the default is usually http://localhost:1234
|
|
|
|
2. Confirm that the selected model and template are compatible:
|
|
|
|
Ensure you've chosen the correct model in the "Select Models" option
|
|
Verify that the selected prompt template matches the model you're using
|
|
|
|
3. On Linux the prebuilt binaries support only ubuntu 22.04+ or simililliar os.
|
|
If you need compatiblity with another os, you have to build manualy. our experiments and resolution you can check here: https://github.com/Palm1r/QodeAssist/issues/48
|
|
|
|
If you're still experiencing issues with QodeAssist, you can try resetting the settings to their default values:
|
|
1. Open Qt Creator settings
|
|
2. Navigate to the "QodeAssist" tab
|
|
3. Pick settings page for reset
|
|
4. Click on the "Reset Page to Defaults" button
|
|
- The API key will not reset
|
|
- Select model after reset
|
|
|
|
## Support the development of QodeAssist
|
|
If you find QodeAssist helpful, there are several ways you can support the project:
|
|
|
|
1. **Report Issues**: If you encounter any bugs or have suggestions for improvements, please [open an issue](https://github.com/Palm1r/qodeassist/issues) on our GitHub repository.
|
|
|
|
2. **Contribute**: Feel free to submit pull requests with bug fixes or new features.
|
|
|
|
3. **Spread the Word**: Star our GitHub repository and share QodeAssist with your fellow developers.
|
|
|
|
4. **Financial Support**: If you'd like to support the development financially, you can make a donation using one of the following:
|
|
- Bitcoin (BTC): `bc1qndq7f0mpnlya48vk7kugvyqj5w89xrg4wzg68t`
|
|
- Ethereum (ETH): `0xA5e8c37c94b24e25F9f1f292a01AF55F03099D8D`
|
|
- Litecoin (LTC): `ltc1qlrxnk30s2pcjchzx4qrxvdjt5gzuervy5mv0vy`
|
|
- USDT (TRC20): `THdZrE7d6epW6ry98GA3MLXRjha1DjKtUx`
|
|
|
|
Every contribution, no matter how small, is greatly appreciated and helps keep the project alive!
|
|
|
|
## How to Build
|
|
|
|
Create a build directory and run
|
|
|
|
cmake -DCMAKE_PREFIX_PATH=<path_to_qtcreator> -DCMAKE_BUILD_TYPE=RelWithDebInfo <path_to_plugin_source>
|
|
cmake --build .
|
|
|
|
where `<path_to_qtcreator>` is the relative or absolute path to a Qt Creator build directory, or to a
|
|
combined binary and development package (Windows / Linux), or to the `Qt Creator.app/Contents/Resources/`
|
|
directory of a combined binary and development package (macOS), and `<path_to_plugin_source>` is the
|
|
relative or absolute path to this plugin directory.
|
|
|
|
## For Contributors
|
|
|
|
QML code style: Preferably follow the following guidelines https://github.com/Furkanzmc/QML-Coding-Guide, thank you @Furkanzmc for collect them
|
|
C++ code style: check use .clang-fortmat in project
|
|
|
|
|
|
|
|
|