Search by

realodix / haiku

KeiJR

A tool to manage and maintain Adblock filter lists.

Package info

github.com/realodix/haiku

Type:project

pkg:composer/realodix/haiku

Statistics

Installs: 1 275 019

Dependents: 0

Suggesters: 0

Stars: 3

Open Issues: 0


README

DeepWiki

Realodix Haiku

Haiku is a powerful command-line tool for managing adblock filter lists efficiently. It automates repetitive tasks such as merging sources, optimizing, and tidying up filter lists effortlessly.

Built with a deep understanding of the syntaxes of Adblock Plus, AdGuard, and uBlock Origin.

# Three capabilities, one tool

🔍 01/Linter

Analyze your filter lists to perform intelligent redundancy analysis, while catching syntax errors and invalid options or modifiers before they affect users.

📝 02/Formatter

A deterministic formatter that sorts, combines, and deduplicates rules for a leaner, faster-loading filter list. No manual formatting roulette; drop in, automate it, and move on.

📦 03/Bundler

Combines multiple filter list files (local and/or remote URLs) into a single file. Automatically regenerates header metadata, strips unnecessary lines such as comments, and delivers a production-ready deployment.

# Three steps to first run

  1. Install - Install the package via Composer

    composer require realodix/haiku
  2. Initialize - Run vendor/bin/haiku init in your project root.

    The command writes a haiku.yml configuration file. If you want to override settings locally, create and commit to VCS haiku.yml.dist but locally use haiku.yml which should be ignored (e.g. in .gitignore).

  3. Run

    Use vendor/bin/haiku lint, vendor/bin/haiku format, or vendor/bin/haiku build. Wire it into pre-commit, CI, or your editor. For detailed command usage, available options, and more examples, see docs/usage.md.

# Configuration

See configuration file documentation or AdBlockID-src/haiku.yml for a production configuration example.

Contributing

Contributions are welcome! Please:

  1. Fork the repo and create a feature branch.
  2. Add tests for new features.
  3. Ensure code passes composer check.
  4. Submit a PR with a clear description.

Report bugs or suggest features via Issues.

License

This project is licensed under the MIT License.