rimi-itk/remote-commands

Run Drupal and Symfony cli commands via ssh

Maintainers

Details

github.com/rimi-itk/remote-commands

Source

Issues

Installs: 8

Dependents: 0

Suggesters: 0

Security: 0

Stars: 1

Watchers: 2

Forks: 0

Open Issues: 0

1.8 2023-10-25 08:38 UTC

Requires

Requires (Dev)

MIT 1c7994c7b1a420002876cc2f00b756b2e7fb52ec

This package is auto-updated.

Last update: 2024-10-25 10:56:24 UTC

README

Helps running commands on remote hosts accesible via ssh

Installation

composer global require rimi-itk/remote-commands

Completions

eval "$(remote-drupal-drush --completion)"

Helpers

@TODO

Usage

Run

bin/remote-command --help

Configuration

All configuration of hosts is done in your OpenSSH client configuration file (~/.ssh/config).

Assuming the following configuration is set in ~/.ssh/config

# https://man.openbsd.org/ssh_config#IgnoreUnknown
IgnoreUnknown DRUPAL_*,SYMFONY_*

Host drupal.example.com
  …
  DRUPAL_DRUSH_ROOT /data/www/drupal/htdocs/web
  DRUPAL_DRUSH_DRUSH ../vendor/bin/drush
  DRUPAL_DRUSH_URI https://drupal.example.com
  …

# Example with docker-compose
Host drupal.example.com
  …
  DRUPAL_DRUSH_DRUSH docker-compose --env-file .env.docker.local --file docker-compose.server.yml exec phpfpm vendor/bin/drush
  # The directory to change to before running the drush command
  DRUPAL_DRUSH_CWD /data/www/drupal/htdocs
  # Drush root inside docker container
  DRUPAL_DRUSH_ROOT /app
  …

Host symfony.example.com
  …
  SYMFONY_CONSOLE_ROOT /data/www/symfony/htdocs
  …

# Example with docker-compose
  …
  SYMFONY_CONSOLE_ROOT /data/www/symfony/htdocs
  SYMFONY_CONSOLE_CONSOLE itkdev-docker-compose-server exec phpfpm bin/console

then running remote-command drupal:drush drupal.example.com will be equivalent to running ssh -t drupal.example.com drush --root=/data/www/drupal/htdocs --uri=https://drupal.example.com.

Shortcuts

  • remote-drupal-drush is a shortcut for remote-command drupal:drush
  • remote-symfony-console is a shortcut for remote-command symfony:console

Adding the commands to your PATH

If you're using the bash shell, run

echo 'export PATH="'$(git rev-parse --show-toplevel)/bin:$PATH"' >> ~/.bashrc

to add the commands to your PATH. If you're running zsh, run

echo 'export PATH="'$(git rev-parse --show-toplevel)/bin:$PATH"' >> ~/.zshrc