QodeAssist - AI-powered coding assistant plugin for Qt Creator

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
2. Install Plugin
3. Configuration
4. Features
5. QtCreator Version Compatibility
6. Hotkeys
7. Troubleshooting
8. Development Progress
9. Support the Development
10. How to Build

Overview

QodeAssist enhances Qt Creator with AI-powered coding assistance:

• Code Completion: Intelligent, context-aware code suggestions for C++ and QML
• Chat Assistant: Multiple interface options (popup window, side panel, bottom panel)
• Quick Refactoring: AI-assisted code improvements and alternative suggestions
• File Context: Attach or link files for better AI understanding
• Tool Calling: AI can read project files, search code, and access diagnostics
• Multiple Providers: Support for Ollama, Claude, OpenAI, Google AI, Mistral AI, llama.cpp, and more
• Customizable: Project-specific rules and extensive model templates

Join our Discord Community to get support and connect with other users!

Code completion: (click to expand)

Quick refactor in code: (click to expand)

Multiline Code completion: (click to expand)

Chat with LLM models in side panels: (click to expand)

Chat with LLM models in bottom panel: (click to expand)

Chat in addtional window: (click to expand)

Automatic syncing with open editor files: (click to expand)

Example how tools works: (click to expand)

Install plugin to QtCreator

Method 1: Using QodeAssistUpdater (Beta)

QodeAssistUpdater is a command-line utility that automates plugin installation and updates with automatic Qt Creator version detection and checksum verification.

Features:

• Automatic Qt Creator version detection
• Install, update, or remove plugin with single command
• List all available plugin versions
• Install specific plugin version
• Checksum verification
• Non-interactive mode for CI/CD

Installation:

Download pre-built binary from QodeAssistUpdater releases or build from source

Usage:

# Check current status and available updates
./qodeassist-updater --status

# Install latest version
./qodeassist-updater --install

For more information, visit the QodeAssistUpdater repository.

Method 2: Manual Installation

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

Configuration

QodeAssist supports multiple LLM providers. Choose your preferred provider and follow the configuration guide:

Supported Providers

• Ollama - Local LLM provider
• llama.cpp - Local LLM server
• Anthropic Claude - Сloud provider
• OpenAI - Сloud provider
• Mistral AI - Сloud provider
• Google AI - Сloud provider
• LM Studio - Local LLM provider
• OpenAI-compatible - Custom providers (OpenRouter, etc.)

Additional Configuration

• Project Rules - Customize AI behavior for your project
• Ignoring Files - Exclude files from context using .qodeassistignore

Features

Code Completion

• AI-powered intelligent code completion
• Support for C++ and QML
• Context-aware suggestions
• Multiline completions

Chat Assistant

• Multiple chat panels: side panel, bottom panel, and popup window
• Chat history with auto-save and restore
• Token usage monitoring
• File Context - Attach or link files for better context
• Automatic syncing with open editor files (optional)

Quick Refactoring

• Fast code refactoring with AI assistance
• Selection-based improvements
• Alternative code suggestions
• Learn more

Tools & Function Calling

• Read project files
• List and search in project
• Access linter/compiler issues
• Enabled by default (can be disabled)

QtCreator Version Compatibility

Qt Creator Version	QodeAssist Version
17.0.0+	0.6.0 - 0.x.x
16.0.2	0.5.13 - 0.x.x
16.0.1	0.5.7 - 0.5.13
16.0.0	0.5.2 - 0.5.6
15.0.1	0.4.8 - 0.5.1
15.0.0	0.4.0 - 0.4.7
14.0.2	0.2.3 - 0.3.x
14.0.1	≤ 0.2.2

Hotkeys

All hotkeys can be customized in Qt Creator Settings. Default hotkeys:

Action	macOS	Windows/Linux
Open chat window	⌥⌘W	Ctrl+Alt+W
Close chat window	⌥⌘S	Ctrl+Alt+S
Manual code suggestion	⌥⌘Q	Ctrl+Alt+Q
Accept full suggestion	Tab	Tab
Accept word	⌥→	Alt+→
Quick refactor	⌥⌘R	Ctrl+Alt+R

Troubleshooting

Having issues with QodeAssist? Check our detailed troubleshooting guide for:

• Connection issues and provider URLs
• Model and template compatibility
• Platform-specific issues (Linux, macOS, Windows)
• Resetting settings to defaults
• Common problems and solutions

For additional support, join our Discord Community or check GitHub Issues.

Development Progress

• Code completion functionality
• Chat assistant with multiple panels
• Diff sharing with models
• Tools/function calling support
• Project-specific rules
• Full project source sharing
• Additional provider support
• MCP (Model Context Protocol) support

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:

   • 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

Prerequisites

• CMake 3.16+
• C++20 compatible compiler
• Qt Creator development files

Build Steps

1. Create a build directory:

mkdir build && cd build

2. Configure and build:

cmake -DCMAKE_PREFIX_PATH=<path_to_qtcreator> -DCMAKE_BUILD_TYPE=RelWithDebInfo <path_to_plugin_source>
cmake --build .

Path specifications:

• <path_to_qtcreator>:
  • Windows/Linux: Qt Creator build directory or combined binary package
  • macOS: Qt Creator.app/Contents/Resources/
• <path_to_plugin_source>: Path to this plugin directory

For Contributors

Code Style

• QML: Follow QML Coding Guide by @Furkanzmc
• C++: Use .clang-format configuration in the project root
• Run formatting before submitting PRs

Development Guidelines

For detailed development guidelines, architecture patterns, and best practices, see the project workspace rules.