Getting Started

Welcome! This guide will help you get up and running with the Ad-Blocking Toolkit in just a few minutes.

Quick Start Options

🚀 Interactive Launcher (Recommended)

The easiest way to get started. Choose your platform:

Linux/macOS: Run ./launcher.sh
Windows: Run .\launcher.ps1

The launcher provides a guided menu system for all tools and tasks.

📦 Choose Your Language

Pick the compiler that fits your environment:

TypeScript/Deno: Secure by default, no build step
.NET: Cross-platform with excellent tooling
Python: Easy installation via pip
Rust: Single binary, no runtime dependencies

Compare compilers →

Prerequisites

You'll need at least one of these installed:

Deno 2.0+ for TypeScript compiler
.NET 10 SDK for .NET compiler and API client
Python 3.9+ for Python compiler
Rust 1.83+ for Rust compiler and tools
PowerShell 7+ for PowerShell scripts

All compilers also need @adguard/hostlist-compiler installed.

Installation Steps

Clone the repository:

git clone https://github.com/jaypatrick/ad-blocking.git
cd ad-blocking

Install dependencies: Run the build script for your chosen language(s):

# Build all projects
./build.sh

# Or specific language
./build.sh --typescript
./build.sh --dotnet
./build.sh --python
./build.sh --rust

Compile filter rules: Choose your preferred method:

# TypeScript
cd src/rules-compiler-typescript && deno task compile

# .NET
cd src/rules-compiler-dotnet && dotnet run --project src/RulesCompiler.Console

# Python
cd src/rules-compiler-python && rules-compiler

# Rust
cargo run --release -p rules-compiler

Next Steps

Explore Documentation

Learn about advanced features, configuration options, and API integration.

Read the Guides

Step-by-step tutorials for common tasks and deployment scenarios.

Join the Community

Contribute, report issues, or ask questions on GitHub.

Need Help?

For detailed installation instructions and troubleshooting, see the complete Getting Started guide in the documentation.