← Back to Integrations

IDE Integration Guide

1. Install the Cursor Plugin

Download the SyntaxValid plugin (.vsix file) from the Integrations page or directly from:

https://cdn.syntaxvalid.com/plugin/vscode/syntaxvalid-latest.vsix

In Cursor IDE, open the Command Palette (Ctrl+Shift+P / Cmd+Shift+P) and run:

Extensions: Install from VSIX...

Select the downloaded .vsix file to install the plugin.

2. Paste API Key

After installation, open the plugin settings. You'll need your SyntaxValid API key:

  1. Go to your project's Integrations page in the dashboard
  2. Click "Reveal" on the API Key field
  3. Copy the API key
  4. Paste it into the plugin's API Key setting

⚠️ Keep your API key secure. Never commit it to version control.

3. Optional: PROJECT_ID Setting

If you want to associate analyses with a specific project, you can optionally set the PROJECT_ID:

  1. Go to your project's Overview page
  2. Copy the Project ID
  3. Paste it into the plugin's PROJECT_ID setting (optional)

If PROJECT_ID is not set, analyses will still work but won't be associated with a specific project.

4. Run "SyntaxValid: Check" in Editor

To analyze your code:

  1. Open a file or select code in your editor
  2. Open Command Palette (Ctrl+Shift+P / Cmd+Shift+P)
  3. Run: SyntaxValid: Check

The plugin will analyze the selected code or current file and display results in a panel.

5. Reading the Score & Violations

After analysis, you'll see:

  • TrustScore: A number from 0-100 indicating code quality and security
  • Violations: List of issues found, grouped by severity (critical, high, medium, low)
  • File & Line: Exact location of each violation
  • Fix Suggestions: Recommended changes to address violations

Click on any violation to jump to the relevant line in your code.

6. Troubleshooting

Token Invalid

If you see "Invalid token" or "Unauthorized" errors:

  • Verify your API key is correct (check for extra spaces)
  • Generate a new API key in Settings if needed
  • Restart Cursor IDE after updating the API key

Network Errors

If you see connection errors:

  • Check your internet connection
  • Verify the API endpoint is accessible
  • Check if your firewall is blocking the connection
  • Try the "Test Connection" button on the Integrations page

Large Diff

If analysis fails for large files:

  • The plugin automatically sends only risky diff blocks
  • For very large files, try analyzing smaller sections
  • Consider using the manual diff upload option for large changes