Aladin - AI Assistant for IntelliJ

Template ToDo list

• Create a new IntelliJ Platform Plugin Template project.
• Get familiar with the template documentation.
• Adjust the pluginGroup and pluginName, as well as the id and sources package.
• Adjust the plugin description in README (see Tips)
• Review the Legal Agreements.
• Publish a plugin manually for the first time.
• Set the MARKETPLACE_ID in the above README badges. You can obtain it once the plugin is published to JetBrains Marketplace.
• Set the Plugin Signing related secrets.
• Set the Deployment Token.
• Click the Watch button on the top of the IntelliJ Platform Plugin Template to be notified about releases containing new features and fixes.

Aladin is an advanced AI assistant for IntelliJ-based IDEs that enhances your coding experience with intelligent, context-aware capabilities. Powered by modern AI technology, Aladin acts as your coding companion, helping you write, understand, and improve code faster and more efficiently.

Key Features

Agentic Capabilities

• Reading & Writing Code: Automatically inspects and modifies files in your editor through IntelliJ PSI or Document APIs
• Searching the Codebase: Scans project files using IntelliJ's indexing or custom text-based search to locate references and snippets
• Calling MCP Servers: Sends project context and user queries to external AI or custom endpoints for suggestions and completions
• Running Terminal Commands: Executes shell or CLI commands directly from the IDE, displaying output in a custom console view
• Automatic Web Search: Performs search queries against external search APIs to supplement AI prompts with up-to-date documentation
• Iterating on Lints: Integrates AI-based code inspections and QuickFix suggestions, allowing automated fixes or improvements

Context-Aware Chat

• Chat interface that leverages the agent to provide real-time Q&A based on the current file and recent conversation history
• References file names, line numbers, and code snippets in responses

Tab Autocomplete

• AI-driven code completion that surfaces multi-line suggestions as you type
• Predictive text based on agent-processed context around the caret

Linting & QuickFix Iteration

• Agent-driven inspections for common errors, security pitfalls, or style issues
• Automatic or one-click AI-generated fixes to maintain clean, consistent code

Plugin Configuration & User Settings

• Control which agentic features are active, including enabling or disabling web search, code scanning, or completion triggers
• Provide and manage credentials for external AI or custom endpoints

Installation

• Using the IDE built-in plugin system:

  Settings/Preferences > Plugins > Marketplace > Search for "aladin" > Install

• Using JetBrains Marketplace:

  Go to JetBrains Marketplace and install it by clicking the Install to ... button in case your IDE is running.

  You can also download the latest release from JetBrains Marketplace and install it manually using Settings/Preferences > Plugins > ⚙️ > Install plugin from disk...

• Manually:

  Download the latest release and install it manually using Settings/Preferences > Plugins > ⚙️ > Install plugin from disk...

Development Status

Aladin is currently under active development. The following features are being implemented:

• Core agent infrastructure
• Chat interface
• Code completion integration
• Codebase search capabilities
• Terminal command execution
• Web search integration
• Settings and configuration panel
• OpenAI API integration

Testing

Aladin includes a comprehensive test suite to ensure functionality and reliability. To run the tests:

./gradlew test

API Testing

Some tests interact with the OpenAI API to verify integration. To run these tests:

1. Copy the .env.example file to .env in the project root:

   cp .env.example .env

2. Edit the .env file and add your OpenAI API key:

   OPEN_AI_API_KEY=your_actual_api_key_here
   

3. Run the tests:

   ./gradlew test

Note: Tests that interact with the OpenAI API are designed to handle rate limiting gracefully. If you encounter rate limit errors, wait a few minutes and try again.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

---

Plugin based on the IntelliJ Platform Plugin Template.