Getting Started

VS Code Extension Installation Guide

Get up and running with Agnech Security in under 5 minutes. This guide covers installation, configuration, and running your first security scan.

Install the Extension
Install from VS Code Marketplace or command palette
Configure Settings
Optional: Customize scan behavior and AI providers
Run Your First Scan
Use Ctrl+Shift+S for a quick scan
Review Findings
Analyze vulnerabilities in the Bloodhound panel

Installation

There are multiple ways to install the Agnech Security extension for VS Code.

Method 1: VS Code Marketplace

The easiest way to install is directly from the VS Code Marketplace.

  1. 1Open VS Code
  2. 2Go to Extensions (Ctrl+Shift+X)
  3. 3Search for "Agnech Security"
  4. 4Click Install

Method 2: Command Palette

Install directly using the VS Code command palette.

Command Palette (Ctrl+Shift+P)
Bash
ext install agnech.agnech-security

Method 3: Direct Download

Download the VSIX file and install manually.

Manual Installation
Bash
# Download the latest VSIX
# Then install via command palette:
# Extensions: Install from VSIX...

Marketplace Link

Visit marketplace.visualstudio.com/items?itemName=agnech.agnech-security to install directly from your browser.

System Requirements

Minimum Requirements

  • VS Code 1.85.0 or later
  • Node.js 18.0 or later
  • 4GB RAM minimum
  • 500MB disk space

Recommended

  • 8GB RAM or more
  • SSD storage
  • Multi-core processor
  • AI provider API key (optional)

100% Local Execution

Agnech Security runs entirely on your local machine. No code is ever sent to external servers. AI verification is optional and uses your own API keys.

Your First Scan

After installation, you're ready to run your first security scan.

Step 1: Open a Project

Open any project containing TypeScript, JavaScript, Python, Solidity, Rust, or C/C++ code.

Step 2: Run Quick Scan

Press Ctrl+Shift+S to run a quick scan on the current file.

example.ts
TypeScript
1// Example: Open a file with potential vulnerabilities
2async function getUser(req, res) {
3 const userId = req.params.id;
4
5 // SQL Injection vulnerability - Agnech will detect this!
6 const query = `SELECT * FROM users WHERE id = ${userId}`;
7
8 const result = await db.query(query);
9 return result;
10}

Agnech will highlight the SQL injection vulnerability on lines 5-6

Step 3: View Results

Results appear in the Bloodhound panel and as inline decorations in your code.

Results Panel Shows:
  • Critical/High severity findings
  • Medium severity findings
  • Low/Informational findings

Understanding Results

Each finding includes detailed information to help you understand and fix the vulnerability.

!
SQL Injection
CWE-89 • Confidence: 94%
Critical
User input is directly concatenated into SQL query without sanitization. This allows attackers to inject malicious SQL commands.
Detected by: Pattern Engine, SAST Analysis, Taint Analysis

Confidence Score

Higher scores (85%+) indicate high-confidence findings. Multi-engine consensus boosts scores.

CWE Reference

Each finding links to Common Weakness Enumeration for detailed vulnerability information.

Keyboard Shortcuts

Ctrl+Shift+S
Quick Scan
Scan current file with all engines
Ctrl+Shift+D
Deep Scan
Run all 7 engines including AI verification
Ctrl+Shift+W
Workspace Scan
Scan entire workspace
Ctrl+Shift+B
Toggle Dashboard
Open/close Bloodhound dashboard
Ctrl+Shift+R
Generate Report
Create security report

Next Steps