IntelliJ
AquilaX AppSec IntelliJ IDEA Plugin Documentation
The AquilaX AppSec plugin for IntelliJ IDEA brings powerful security analysis directly into your development workflow. It integrates seamlessly with the AquilaX platform to provide real-time vulnerability detection, detailed findings, and automated scanning capabilities right within your IDE.
Version: 1.0.2 Vendor: AquilaX
Key Features
🛡️ Real-time Security Analysis: Detect vulnerabilities as you code.
🔍 In-Editor Highlighting: Visual indicators for security findings directly in your source files.
📊 Comprehensive Dashboard: Manage organizations, groups, and scans from a dedicated tool window.
🤖 Automated Scanning: Trigger and monitor security scans without leaving IntelliJ.
📝 Detailed Reports: View severity, rule IDs, descriptions, and remediation recommendations.
🔗 Deep Integration: Direct links to the AquilaX web dashboard for in-depth analysis.
Installation
Option 1: JetBrains Marketplace
Open IntelliJ IDEA.
Navigate to Settings (or Preferences on macOS) → Plugins.
Select the Marketplace tab.
Search for "AquilaX AppSec".
Click Install.
Restart the IDE if prompted.
Option 2: Manual Installation
Download the plugin ZIP file from the AquilaX Releases Page.
Open Settings → Plugins.
Click the Gear Icon ⚙️ and select Install Plugin from Disk....
Select the downloaded ZIP file.
Restart the IDE.
Getting Started
1. Accessing the Tool Window
After installation, you will see a new tool window named "AquilaX AppSec" on the right sidebar of your IDE. Click it to open the dashboard.
2. Authentication
You can authenticate using one of two methods:
Method A: Sign In with Browser (Recommended)
Click the "Sign In with Browser" button in the tool window.
Your default web browser will open to the AquilaX login page.
Complete the authentication process.
You will be redirected back to IntelliJ IDEA automatically.
Method B: Personal Access Token (PAT)
Generate a Personal Access Token from your Aquilax Profile.
In the plugin tool window, enter your token in the "Enter Personal Access Token (PAT)" field.
Click "Connect with PAT".
Using the Plugin
Dashboard Configuration
Once logged in, you need to select your context:
Organization: Select your target organization from the dropdown.
Group: Select the specific project group you are working on.
Running a Scan
To initiate a new security scan:
Ensure an Organization and Group are selected.
Click the "Scan Now" button.
The status label will update to show "Scan in progress...".
You can monitor the status or click "Cancel Scan" if needed.
Viewing Findings
If a scan has already been completed, or once a new scan finishes:
Click "See Findings" (or "Fetch Findings").
The plugin will retrieve all vulnerabilities and display a summary in the console.
The Status Bar at the bottom of the IDE will update to show the total number of findings.
In-Editor Experience
Code Highlighting
The plugin automatically highlights vulnerable code segments in your open files:
🔴 Red Highlight: Confirmed True Positive vulnerabilities.
🟠 Orange Highlight: Unverified findings that may require review.
Tooltips & Details
Hover over any highlighted code to see a detailed tooltip containing:
Severity Icon: (🔴 High, 🟠 Medium, 🟢 Low)
Rule ID: The specific security rule violated.
Description: Explanation of the vulnerability.
Vulnerability Snippet: The specific code flagged.
Recommendation: How to fix the issue.
View Details Link: A direct link to the finding in the AquilaX Web Dashboard.
Project View Integration
Files containing security findings are marked with error indicators in the Project view, making it easy to identify which files need attention at a glance.
Troubleshooting
"Failed to load organizations"
Check your internet connection.
Your session may have expired. Click Logout and sign in again.
"No scan found"
Ensure you have selected the correct Organization and Group.
Click "Scan Now" to start a fresh analysis.
Highlights not appearing
Ensure the file is part of the scanned project.
Try closing and reopening the file to refresh the findings.
Support
For additional assistance, please contact our support team:
📧 Email: [email protected]
🌐 Website: https://aquilax.ai/
Last updated
Was this helpful?