dof-dss/maestro-shell

Shell for working with Maestro projects.

10.1.5 2024-11-12 14:34 UTC

Requires

• ext-json: *
• composer/ca-bundle: ^1.3
• dof-dss/maestro-core: ^1.0
• romaricdrigon/metayaml: dev-master
• stecman/symfony-console-completion: ^0.12
• symfony/cache: ^6.3
• symfony/config: ^6.3
• symfony/console: ^6.3
• symfony/dependency-injection: ^6.3
• symfony/event-dispatcher: ^6.3
• symfony/filesystem: ^6.3
• symfony/finder: ^6.3
• symfony/http-client: ^5.4
• symfony/process: ^6.3
• symfony/yaml: ^6.3
• webflo/drupal-finder: ^1.2

Suggests

• drush/drush: For Drupal projects

MIT

README

Maestro is a command line tool to manage multi-site projects.

Requirements

• PHP 8.1+ CLI
• Composer 2.1+

PHP

To see which version of PHP you have installed, from the Mac shell run:

php --version

If you don't have PHP installed or are using an older version I would recommend using Brew (https://brew.sh)
With Brew installed run:

brew install php

Composer

To see which version of Composer you have installed, from the Mac shell run:

composer --version

If you don't have Composer installed, using brew run:

brew install composer

If you do have Composer installed run:

composer self-update

Installing

Add the Maestro shell and hosting packages to your project dev dependencies

composer require --dev dof-dss/maestro-shell dof-dss/maestro-hosting 

To allow use of the Maestro command from the root directory of your project without having to directly reference the Maestro executable (e.g. vendor/bin/maestro) I recommend adding the vendor/bin directory to your shell $PATH.
As an example I'm using zsh which is the default shell for MacOS.

Edit .zshrc in your home directory and add the following line:

# Maestro Shell (allow vendor bin execution from project root)
export PATH="vendor/bin:${COMPOSER_HOME}/vendor/bin:${PATH}"

Once saved you will need to run

source ~/.zshrc

Drupal composer file requirements

You must ensure the following script is included in the project composer file when using Maestro Shell.

"scripts": {
        "post-package-update": [
            "Maestro\\Shell\\Events\\ComposerEventListener::postPackageUpdate"
        ]
    }