Blockingmachine


Description

Blockingmachine CLI is a powerful command-line tool that streamlines the process of collecting, analyzing, and exporting ad-blocking and privacy filter lists. It aggregates rules from multiple trusted sources, intelligently deduplicates entries, categorizes blocking rules, and exports to various formats including AdGuard, hosts files, dnsmasq, and more. Designed for flexibility, the tool allows for custom filtering by category, priority, and tags, enabling both automated workflows and personalized filter list creation.

$3

- Blockingmachine Core - Core functionality library
- Blockingmachine Desktop - Desktop application for managing filter lists

---

Quick Start

``bash


Install globally

`bash
blockingmachine export --categories privacy,security
blockingmachine export --exclude advertising,gaming
`

- Priority System:

`bash
blockingmachine export --min-priority 80
`

- Tag-Based Filtering:

`bash
blockingmachine export --tags mobile,trusted
`

$3

- DNS-Based Formats:
- Hosts files (hosts)
- dnsmasq configuration (dnsmasq)
- Unbound configuration (unbound)
- BIND configuration (bind)
- Browser-Based Formats:
- AdGuard (adguard)
- ABP format (abp)
- Application-Specific:
- Privoxy rules (privoxy)
- Shadowrocket configuration (shadowrocket)

$3

`bash


Import and process rules

`json
{
"mongodb": {
"uri": "mongodb://localhost:27017/blockingmachine",
"options": {
"maxPoolSize": 10
}
},
"output": {
"directory": "./filters/output"
},
"sources": [
{
"name": "EasyPrivacy",
"url": "https://easylist.to/easylist/easyprivacy.txt",
"category": "privacy",
"enabled": true,
"priority": 90
}
]
}
`

$3

- Detailed Logging:

`bash
blockingmachine --debug import
`

- Log Files:
- logs/error.log: Error-level messages
- logs/combined.log: All log levels

$3

`mermaid
graph TD
A[Download Rules] --> B[Parse & Classify]
B --> C[Apply Modifiers]
C --> D[Deduplication]
D --> E[Store in MongoDB]
E --> F[Export Filters]
`

$3

- Caching System:

`bash
# Enable caching in .blockingmachinerc.json
{
"caching": {
"enabled": true,
"ttl": 3600,
"maxSize": "100mb"
}
}
`

- Batch Processing: Rules are processed in configurable batch sizes
- Parallel Processing: Multi-threaded rule processing for better performance

$3

`bash


View detailed error logs

`bash
# Fork and clone the repository
git clone https://github.com/yourusername/blockingmachine-cli.git

# Install dependencies
cd blockingmachine
npm install

# Run tests
npm test

# Start in development mode
npm run dev
`

- Running Tests:

`bash
# Run all tests
npm test

# Run specific test suite
npm test -- --grep "rule processing"

# Run with coverage
npm run test:coverage
`

$3

`bash


Development mode

`bash
# Check MongoDB status
brew services list | grep mongodb

# Start MongoDB if needed
brew services start mongodb-community
`

2. Permission Issues

`bash
# Fix output directory permissions
chmod 755 ./filters/output
`

3. Memory Issues

`bash
# Increase Node.js memory limit
export NODE_OPTIONS="--max-old-space-size=4096"
`

$3

#### Command Context

`typescript
interface CommandContext {
config: AppConfig;
debug: boolean;
logger: Logger;
}
`

#### Export Options

`typescript
interface ExportOptions {
formats?: SupportedFormat[];
categories?: string[];
excludeCategories?: string[];
minPriority?: number;
tags?: string[];
outputPath?: string;
}
`

$3

- All downloaded content is validated and sanitized
- HTTPS-only for rule downloads
- Input validation for all command parameters
- Safe file system operations

Please read our Contributing Guide for more details.

$3

We use ESLint and Prettier to maintain code quality. Before submitting a pull request:

`bash


Run linter

# Fix linting issues automatically
npm run lint:fix
``

$3

- Electron: Cross-platform desktop application framework
- React: UI library for building interactive interfaces
- TypeScript: Type-safe JavaScript
- Recharts: Responsive charting library
- Electron Store: Persistent settings storage
- @blockingmachine/core: Core rule processing functionality

License

This project is licensed under the BSD-3-Clause License.