VulnZap Documentation
Comprehensive documentation for VulnZap Server API and CLI tools. Integrate vulnerability scanning into your development workflow with real-time security analysis.
Quick Start
Get up and running with VulnZap in under 5 minutes. Install CLI, connect to your IDE, and start scanning.
Start hereCLI Tools
Command-line interface with MCP protocol integration for real-time vulnerability scanning.
Explore CLIQuick Start
VulnZap provides security-first AI development with real-time vulnerability detection and automated security fixes.
Complete Onboarding (Recommended)
The fastest way to get started with VulnZap. This command handles authentication, API key setup, and IDE integration automatically.
What this does:
- • Guides you through authentication setup
- • Configures your API key
- • Sets up IDE integration automatically
- • Enables real-time vulnerability scanning
Manual Setup (Advanced)
If you prefer manual configuration, you can set up VulnZap step by step.
1. Configure API key:
2. Connect to your IDE:
Get your API key from the dashboard
Available Commands
Once configured, these commands are available for manual security scanning and management.
init
Complete VulnZap setup with authentication and IDE integration
setup
Configure VulnZap with your API key
connect
Connect VulnZap to your AI-powered IDE
check <package>
Check a package for vulnerabilities
batch-scan
Scan all packages in current directory
status
Check VulnZap server health
account
View account information
help
Display help information
Usage Examples
Complete setup (recommended):
Check individual packages:
Manual API key setup:
Connect to IDE:
Scan entire project:
Check status and account:
Automatic Security Layer
Once configured, VulnZap automatically protects your AI development workflow.
How it works:
- Your AI assistant suggests a package installation
- VulnZap automatically scans the package for vulnerabilities
- You receive security recommendations before installation
- Make informed decisions about package safety
Need Help?
- • Documentation: vulnzap.com/docs
- • Support: vulnzap.com/support
- • Dashboard: vulnzap.com/dashboard
Installation
VulnZap provides comprehensive vulnerability scanning across multiple ecosystems with native IDE integration.
System Requirements
Prerequisites
- • Node.js 16+ or compatible runtime
- • VulnZap API key
- • Compatible IDE (optional but recommended)
Supported Operating Systems
- • Windows 10/11
- • macOS 10.15+
- • Linux (Ubuntu, CentOS, etc.)
Installation Methods
VulnZap can be installed through your preferred package manager.
Using npm (recommended):
Using yarn:
Using pnpm:
Ecosystem Support
VulnZap supports vulnerability scanning across multiple programming ecosystems.
npm
JavaScript/Node.js
package.json
pip
Python
requirements.txt
go
Go
go.mod
rust
Rust
Cargo.toml
maven
Java
pom.xml
gradle
Java/Kotlin
build.gradle
nuget
.NET
*.csproj
composer
PHP
composer.json
IDE Integration
VulnZap integrates with AI-powered IDEs using the Model Context Protocol (MCP) for seamless vulnerability scanning.
Cursor IDE
Native MCP integration with automatic configuration.
Windsurf IDE
Seamless integration with Codeium's AI IDE.
Cline (Claude Dev)
Full compatibility with Claude-based development tools.
Generic MCP
Compatible with any MCP-enabled environment.
Installation Verification
Verify that VulnZap is correctly installed and configured:
Check installation:
Verify server connectivity:
Test basic functionality:
Success indicators:
- • Version number displays correctly
- • Server status shows "online"
- • Test scan returns vulnerability data
Authentication
All API requests require authentication using VulnZap API keys. Learn how to obtain and use them securely.
Obtaining API Keys
API keys are automatically generated during account creation and can be managed from your dashboard.
Steps to get your API key:
- Sign up at vulnzap.com
- Navigate to API Keys in your dashboard
- Your default API key is automatically created
- Copy the key for use in your applications
API Key Format
VulnZap API keys follow a structured format for identification and security purposes.
Prefix: vz_
Identifies the key as a VulnZap API key
Token: 24 characters
Cryptographically secure unique identifier
Using API Keys
Include your API key in the Authorization header of all HTTP requests using Bearer authentication.
HTTP Header Authentication
cURL Example
JavaScript/Node.js Example
Python Example
Security Best Practices
Use Environment Variables
Store API keys in environment variables, never hardcode them in source code.
Rotate Keys Regularly
Generate new API keys periodically and revoke unused keys.
Restrict Access
Only share API keys with authorized team members who require access.
Never Commit Keys
Add API keys to your .gitignore
file and never commit them to version control.
Rate Limits
API usage is rate-limited by subscription tier to ensure service reliability and fair usage.
Free Tier
100
requests/hour
Core Tier
1,000
requests/hour
Pro Tier
10,000
requests/hour
Rate limit response headers:
VulnZap CLI Tools
Security-first CLI tool that integrates with AI-powered IDEs like Cursor, Cline, and Windsurf to provide real-time vulnerability scanning using the Model Context Protocol (MCP).
CLI Overview
VulnZap is a security-first CLI tool that integrates with AI-powered IDEs like Cursor, Cline, and Windsurf to provide real-time vulnerability scanning for packages before they are installed.
Real-time Scanning
Automatically scans packages before installation
Multi-Ecosystem
npm, pip, go, rust, maven, gradle, composer, nuget
MCP Integration
Native Model Context Protocol support
Installation
Global Installation
From Source
Key Commands
vulnzap init
Complete onboarding and configuration with interactive prompts.
vulnzap check
Analyze a specific package for security vulnerabilities.
vulnzap batch-scan
Scan all packages in the current directory.
Examples
Production-ready examples demonstrating VulnZap integration across different platforms and workflows.
GitHub Actions CI/CD
Integrate VulnZap into your GitHub Actions workflow for automated security scanning on pull requests and deployments. Full CI/CD integration available now!
Node.js Application Integration
Implement a comprehensive security monitoring service for automated dependency scanning and reporting.
Docker Integration
Integrate security scanning into your Docker build process to fail builds on critical vulnerabilities.
Python Integration
Integrate VulnZap API into Python applications for programmatic security scanning and automation.
IDE Integrations
VulnZap integrates with AI-powered IDEs using the Model Context Protocol (MCP) for seamless vulnerability scanning.
Ready to get started?
Install VulnZap in under 5 minutes and start protecting your applications from vulnerabilities.