Back to Documentation
Quickstart Guide
Get DeepSweep running in under 60 seconds
Editor Extension Available
Get real-time validation as you code — VS Code, Cursor, and Windsurf.
Install Extension →1. Install the DeepSweep CLI
Install using pip (Python 3.10+ required). The package is named deepsweep-ai and installs the deepsweep command:
pip install deepsweep-ai 2. Install the Editor Extension (Recommended)
For real-time reviews as you code, add the extension in VS Code, Cursor, or Windsurf:
# VS Code: download the .vsix from Open VSX, then
# Extensions panel (Ctrl+Shift+X) > "..." > Install from VSIX...
# Full walkthrough: https://deepsweep.ai/install/vs-code
#
# Cursor / Windsurf: search "DeepSweep" in the Extensions panel (Open VSX) 3. Run Your First Validation
Navigate to your project directory and run validation:
cd your-project
deepsweep validate . 4. Review Results
DeepSweep analyzes your AI assistant configs and reports any security issues found, with a grade and plain-English fixes.
# Example output (deepsweep-ai 1.0.2):
DeepSweep v1.0.2
Checking ....
[INFO] Loaded 16 security rules
[INFO] Reviewing AI assistant configurations
[CRITICAL] .cursorrules:1
Your AI assistant can be tricked into ignoring safety rules.
Grade: C (75/100)
1 files checked • 1 issue found