BloqrCore

Getting Started

This guide will help get started with the Bloqr Core 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

At least one of these is required:

  • Deno 2.0+ for TypeScript compiler
  • .NET 10 SDK for .NET compiler and Dashboard
  • Python 3.9+ for Python compiler
  • Rust 1.85+ for Rust compiler and tools
  • PowerShell 7+ for PowerShell scripts

All compilers dogfood @bloqr/compiler-core, this repository's own open-source, dependency-free compilation engine published to JSR.

Installation Steps

  1. Clone the repository:
    git clone https://github.com/BloqrAI/bloqr-core.git
    cd bloqr-core
  2. 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
  3. Compile filter rules: Choose your preferred method:
    # TypeScript
    cd src/adblock-compiler-core && 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.

@bloqr/compiler-core

Learn about the open-source compilation engine that powers every compiler in this repository.

Need Help?

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