Back to Documentation

Installation

Complete installation guide for all platforms

Editor Extension Available

Get real-time validation as you code — VS Code, Cursor, and Windsurf.

Install Extension →

System Requirements

The DeepSweep CLI requires Python 3.10+. Validation runs entirely locally - your code never leaves your machine.

Install via pip (Recommended)

The CLI ships as the deepsweep-ai package on PyPI and installs the deepsweep command:

pip install deepsweep-ai

# Verify installation
deepsweep --version

VS Code Extension

For real-time validation as you code, install our VS Code extension:

# VS Code: download the .vsix package from Open VSX
#   https://open-vsx.org/extension/deepsweep-ai/deepsweep
# 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)

Docker Installation

Run DeepSweep in a container:

docker run --rm -v $(pwd):/project python:3.12 \
  sh -c "pip install deepsweep-ai && deepsweep validate /project"