QodeAssist

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.

Supported LLM Providers

QodeAssist currently supports the following LLM (Large Language Model) providers:

• Ollama
• LM Studio
• OpenAI compatible providers

Supported Models

QodeAssist has been tested with the following language models, all trained for Fill-in-theMiddle:

Ollama:

• starcoder2
• codellama
• DeepSeek-Coder-V2-Lite-Base

LM studio:

• second-state/StarCoder2-7B-GGUF
• TheBloke/CodeLlama-7B-GGUF

Please note that while these models have been specifically tested and confirmed to work well with QodeAssist, other models compatible with the supported providers may also work. We encourage users to experiment with different models and report their experiences. If you've successfully used a model that's not listed here, please let us know by opening an issue or submitting a pull request to update this list.

Development Progress

• Basic plugin with code autocomplete functionality
• Improve and automate settings
• Add chat functionality
• Support for more providers and models

Plugin installation using Ollama as an example

1. Install QtCreator 14.0
2. Install Ollama. Make sure to review the system requirements before installation.
3. Install a language model in Ollama. For example, you can run:

ollama run starcoder2:7b

4. Download the QodeAssist plugin.
5. 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 Plugin

1. Open Qt Creator settings
2. Navigate to the "Qode Assist" tab
3. Choose your LLM provider (e.g., Ollama)
4. Select the installed model by the "Select Model" button
   • For LM Studio you will see current load model
5. Choose the prompt template that corresponds to your model
6. Apply the settings

You're all set! QodeAssist is now ready to use in Qt Creator.

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
• To insert the full suggestion, you can use the TAB key
• To insert line by line, you can use the "Move cursor word right" shortcut:
  • On Mac: Option + Right Arrow
  • On Windows: Alt + Right Arrow

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. Check the endpoint:

Make sure the endpoint in the settings matches the one required by your provider - For Ollama, it should be /api/generate - For LM Studio and OpenAI compatible providers, it's usually /v1/chat/completions

3. 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

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 "Qode Assist" tab
3. Click on the "Reset 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 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:

   • Buy me a coffee
   • 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.