Adguard Assistant userscript

README.md

Adguard Assistant Build Status

Disclaimer

  • We believe that all free products should be open source, and AdGuard Assistant is not an exception. Its code can be found in this repository.

AdGuard Assistant is a userscript that helps you manage filtering right from the browser. With its aid you are able to manually block any element, whitelist or report the page, or see the website's security report — all without having to leave the current page.

To get more information on AdGuard Assistant, visit our website https://adguard.com/.

How to report an issue?

GitHub can be used to report a bug or to submit a feature request. To do so, go to this page and click the New issue button.

Our plans

To see the 'big picture', to watch current progress and to get an idea of approximate dates for upcoming AdGuard Assistant releases, see this page: https://github.com/AdguardTeam/AdguardAssistant/milestones

Releases

You can find all AdGuard Assistant releases here: https://github.com/AdguardTeam/AdguardAssistant/releases

Development build

Built automatically on every new commit:

Version to be used as userscript:

assistant.user.js -- AdGuard Assistant userscript

Version to be used in the browser extension:

assistant.embed.js -- Embedded version of AdGuard Assistant. We use it to provide Assistant's features in browser extensions.

assistant.embed.min.js -- Minified version of AdGuard Assistant.

Embedded version run as:

adguardAssistant().start(null, callback);

Сallback returns a rule string.

Unit test page for dev build is here.

How to build

For development build run:

$ npm run dev

This will compile assistant.user.js file without minification.

For development build with watcher on file changes and debugging from local server run:

$ npm run watch

This will open http://localhost:3000 in browser for debugging with extensions (e.g. Tampermonkey). Local server will serve from build directory. To apply the script, you must specify the script in the address, e.g. http://localhost:3000/assistant.user.js.

To run the task of downloading the localization files, put the .keys.json configuration file in the config directory.

The configuration file looks like:

{
    "url": "url of localizations",
    "project_id": "some id",
    "secret_key": "some key",
    "api_key": "some api key"
}

For security reasons, this file is ignored by .gitignore settings.

To download and append localizations run:

$ npm run locales

Localization list is in options in gulpfile.js.