Guard

Installing AIVory JetBrains Plugin

Get the AIVory plugin installed in your IntelliJ IDEA environment in just a few minutes.

  • Multiple installation methods - Install from IDE, website, or disk for enterprise environments
  • Wide IDE support - Works with IntelliJ IDEA, WebStorm, PyCharm, GoLand, and more
  • Quick setup - Complete installation and first scan in under 5 minutes
  • Automatic updates - Stay current with the latest compliance rules

System Requirements

Before installing, ensure your system meets these requirements:

JetBrains IDE
Version 2022.3 or higher (IntelliJ IDEA, WebStorm, PyCharm, GoLand, PhpStorm, RubyMine, CLion, Rider)
Java Runtime
JDK 17 or higher installed on your system
Internet Connection
Required for authentication and compliance scanning

Installation Methods

Choose the installation method that works best for your environment.

From IDE Recommended
Install directly from the JetBrains Marketplace within your IDE
From Website
Download from the JetBrains Marketplace website
From Disk
Manual installation for enterprise or offline environments

The easiest way to install AIVory is directly from your JetBrains IDE.

Step 1: Open Plugin Settings

Navigate to the Plugins settings in your IDE:

  • Windows/Linux: File → Settings → Plugins
  • macOS: IntelliJ IDEA → Preferences → Plugins

Step 2: Search for AIVory

  1. Click the Marketplace tab
  2. Search for “AIVory”
  3. Locate “AIVory - AI-Powered Compliance Guard”

Step 3: Install and Restart

  1. Click the Install button
  2. Wait for the download to complete
  3. Click Restart IDE when prompted
Note After restart, look for the AIVory icon in the status bar at the bottom of your IDE to confirm successful installation.

Install from Website

If you prefer to download the plugin manually:

  1. Visit the JetBrains Marketplace - AIVory Plugin
  2. Click Get and select your IDE version
  3. Download the plugin file (.zip)
  4. In your IDE, go to File → Settings → Plugins
  5. Click the gear icon and select Install Plugin from Disk…
  6. Select the downloaded .zip file and restart
Manual Installation for Enterprise

For enterprise environments or offline installations:

  1. Obtain the AIVory plugin package (.zip) from your administrator or download from AIVory releases
  2. Open File → Settings → Plugins
  3. Click the gear icon and select Install Plugin from Disk…
  4. Browse to and select the downloaded file
  5. Click OK and restart your IDE

First Launch Setup

After installation and restart, complete the initial setup.

Welcome Screen

The plugin displays a welcome dialog on first launch with two options:

Create Account
Sign up for a new AIVory account
Log In
Use your existing AIVory credentials

Authentication Flow

  1. Click your preferred option to open your browser
  2. Complete authentication at app.aivory.net
  3. Return to your IDE once authenticated

Initial Configuration

After authentication:

  1. Select your compliance standards (OWASP, GDPR, HIPAA, etc.)
  2. Choose your scan preferences
  3. Click Finish to complete setup
Note You can always change your compliance standards and scan preferences later in the plugin settings.

Verifying Installation

Confirm AIVory is properly installed with these checks:

Verification How to Check
Status Bar Look for the AIVory icon in the bottom status bar showing your authentication status
Dashboard Click View → Tool Windows → AIVory Dashboard or the AIVory tab at the bottom
Test Scan Open a project and run Tools → AIVory → Run Compliance Scan
Note Run a test scan on a small project first to verify everything is working correctly before scanning larger codebases.

Troubleshooting

Plugin Not Appearing After Installation

Issue: AIVory doesn’t appear after installation

Solutions:

  • Verify your IDE version is 2022.3 or higher
  • Check File → Settings → Plugins → Installed to confirm AIVory is listed
  • Try restarting your IDE again
  • Check IDE logs at Help → Show Log in Finder/Explorer
Installation Failed with Error

Issue: Plugin installation fails with error

Solutions:

  • Ensure you have a stable internet connection
  • Check that you have write permissions in the IDE plugins directory
  • Try clearing the plugin cache: File → Invalidate Caches / Restart
  • Manually download and install from disk
Cannot Log In or Create Account

Issue: Authentication not working

Solutions:

Updating the Plugin

Automatic Updates
AIVory checks for updates on IDE startup and notifies you when new versions are available
Manual Check
Go to File → Settings → Plugins → Installed, click the gear icon, and select “Check for Updates”

Uninstalling

How to Uninstall AIVory

To remove AIVory from your IDE:

  1. Go to File → Settings → Plugins
  2. Find “AIVory” in the Installed tab
  3. Click the dropdown next to AIVory and select Uninstall
  4. Confirm the action and restart your IDE

Complete Removal (optional): Plugin settings are preserved for reinstallation. To completely remove:

  • macOS/Linux: Delete ~/.aivory directory
  • Windows: Delete %USERPROFILE%\.aivory directory

Next Steps

Getting Started Guide
Create your account, run your first scan, and learn the basics
Configuration
Customize compliance standards and scan settings
Features
Explore all the capabilities of the AIVory plugin
Note Having installation issues? Contact Support, check the FAQ, or view the Troubleshooting Guide.