devcollaborative/module-hunter

Command line tool to easily search through all your Pantheon-hosted Drupal sites and identify active instances of a particular module.

2.0.0-alpha2 2024-02-29 20:14 UTC

Requires

• pantheon-systems/terminus: >=1.9 || ^3.0

MIT

• Jeffrey Hipp

• security
• modules
• drupal
• pantheon
• terminus
• d7
• d8

README

This command-line tool was created to help developers who maintain a large number of Pantheon-hosted Drupal 8+ sites to easily identify which sites have an active instance of a particular module or modules. The primary use case is for enabling a quick response to critical security advisories.

Dependencies

Requires command-line access to a properly configured instance of Pantheon's Terminus CLI tool.

Syntax

Use this script using the following syntax:

module-hunt module_name [module_name2]

If you need to search for additional modules, just keep appending their names as arguments. There is not limit.

Sandbox sites supported

Module Hunter checks for the module on the live environment, except when a site is on a Sandbox plan. In that is the case, Module Hunter instead checks the dev environment.

Stability: ALPHA Release

This script has thus far proven stable for our use cases, but has not been extensively tested.

Installation

With Composer

If you use composer global to install and maintain php tools and libraries, you may add Module Hunter to your command line via:

composer global require devcollaborative/module-hunter

NOTE: As this library is currently pre-release, your global composer.json must include a minimum-stability value of either "alpha" or "dev".

Without Composer

Download/clone this library and append run the command from it's parent directory as ./module-hunt

Todo

• Make this a terminus plug-in instead[?]