Documentation

Learn how to install, configure, and use WebQ for domain reconnaissance and security analysis.

Installation

Linux

Download the AppImage from the latest GitHub release and make it executable.

Shell Commands
chmod +x WebQ-x86_64.AppImage
./WebQ-x86_64.AppImage

macOS & Windows

Download the .dmg or .msi installer and follow the standard installation wizard instructions.

Usage Guide

  • 1 Launch WebQ from your application menu or terminal.
  • 2 Enter a target domain (e.g., example.com) into the scan input.
  • 3 Select the analysis modules you want to run (Domain Info, Security, SEO, etc.).
  • 4 Click "Analyze" to begin the scan — results stream in real-time.
  • 5 Export reports in JSON, Markdown, or PDF format.

Architecture Overview

WebQ is a Tauri v2 hybrid application. The backend processing engine is pure Rust, powered by the web-analyzer crate—a 15-module security analysis toolkit built on tokio for fully asynchronous scanning operations.

The frontend leverages Svelte 5 Runes for a reactive, data-dense interface rendering scan results, vulnerability reports, and domain intelligence in real-time without blocking the UI thread.

Need more details?

Explore our GitHub repository for advanced usage examples, API documentation, and contribution guidelines.

Go to GitHub