Welcome to Quantum Viper

🚀 Quick Start

Get started with Quantum Viper in just a few steps:

Open a code file - Any JavaScript, TypeScript, Python, or other supported file

Press Ctrl+Shift+S or click "Analyze File" in the sidebar

Review vulnerabilities in the sidebar and apply fixes with one click

Export reports and integrate with your security workflow

✨ Key Features

🔍 Real-Time Analysis

Instant security vulnerability detection with AI-powered analysis and real-time feedback.

🛠️ One-Click Fixes

Apply security fixes directly from the sidebar with intelligent suggestions.

📊 Comprehensive Reports

Export detailed security reports with severity levels and recommendations.

🔗 GitHub Integration

Create issues, security advisories, and workflows directly from VS Code.

🌐 Multi-Language Support

Supports JavaScript, TypeScript, Python, Java, PHP, C#, and more.

🤖 AI-Powered

Advanced AI analysis with multiple LLM providers for comprehensive security insights.

⌨️ Keyboard Shortcuts

Ctrl+Shift+S - Analyze Current File
Ctrl+Shift+W - Analyze Workspace  
Ctrl+Shift+C - Clear Results
Ctrl+Shift+E - Export Report
Ctrl+Shift+P → "Quantum Viper" - All Commands
            

🎯 What Quantum Viper Detects

🔐 Authentication Issues

Hardcoded API keys and passwords
Weak authentication mechanisms
Session management flaws

💉 Injection Attacks

SQL injection vulnerabilities
XSS (Cross-Site Scripting)
Command injection flaws

🔒 Cryptographic Issues

Weak encryption algorithms
Poor random number generation
Certificate validation issues

📁 File System Security

Path traversal vulnerabilities
Unsafe file operations
Directory listing exposures

⚙️ Configuration

Customize Quantum Viper to fit your workflow:

💡 Tip: Access settings via Ctrl+, and search for "Quantum Viper"

Essential Settings:

{
  "quantumViper.enabled": true,
  "quantumViper.autoScan": false,
  "quantumViper.scanOnSave": true,
  "quantumViper.severityLevel": "medium",
  "quantumViper.showInlineDecorations": true,
  "quantumViper.showStatusBar": true
}
            

Ignoring Files and Directories:

Create a .qv-ignore file in your project root to exclude files and directories from security analysis:

# Ignore specific files
node_modules/
dist/
build/
*.min.js
*.min.css

# Ignore directories
.cache/
.coverage/
test-results/

# Ignore file patterns
**/*.test.js
**/*.spec.ts
**/vendor/**

# Ignore by file extension
*.log
*.tmp
*.bak
            

💡 Tip: Use the "Create Ignore File" button in the sidebar to generate a basic .qv-ignore file

🚨 Understanding Severity Levels

🔴 Critical

Immediate security threats that could lead to system compromise. Fix immediately.

🟠 High

Serious vulnerabilities that pose significant risk. Should be fixed soon.

🟡 Medium

Moderate security issues that should be addressed in regular updates.

🟢 Low

Minor security concerns or best practice violations.

🔧 Troubleshooting

⚠️ Common Issues:

Sidebar not showing?

Press Ctrl+Shift+P → "View: Show Quantum Viper"
Check if the extension is enabled in Extensions panel
Reload VS Code window

No vulnerabilities detected?

Ensure you're analyzing supported file types
Check severity level settings
Try analyzing the demo file in demo/test-vulnerabilities.js

Backend server issues?

Check Python installation and dependencies
Verify port 8000 is available
Use "Start Backend" button in sidebar

🤝 Getting Help & Contributing

✅ Support Channels:

Documentation: GitHub Docs
Extension Issues: Report Extension Bugs
Discussions: Community Help
Contributing: Contribution Guide

🎉 What's Next?

Configure your settings - Customize Quantum Viper for your workflow

Integrate with CI/CD - Set up automated security scanning

Share feedback - Help us improve Quantum Viper