PHPackages                             mtholyoke/jorge - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [CLI & Console](/categories/cli)
4. /
5. mtholyoke/jorge

ActiveLibrary[CLI & Console](/categories/cli)

mtholyoke/jorge
===============

MHC’s command-line tool for automating development tasks

v0.6.9(6y ago)262MITPHPPHP >=7.1.0CI failing

Since Mar 5Pushed 2y ago1 watchersCompare

[ Source](https://github.com/mtholyoke/jorge)[ Packagist](https://packagist.org/packages/mtholyoke/jorge)[ Docs](https://www.mtholyoke.edu)[ RSS](/packages/mtholyoke-jorge/feed)WikiDiscussions master Synced 2mo ago

READMEChangelog (10)Dependencies (7)Versions (21)Used By (0)

Jorge
=====

[](#jorge)

Jorge is an experimental command-line tool for managing the complex interaction of Drush, Git, Lando, and Terminus to automate common tasks.

**Note:** Jorge stores no connection information about the various services and does not provide any additional permission; your account must already have access (ideally via SSH key or token) to the various projects on GitHub and Pantheon, and Jorge works on your behalf using those credentials.

Installation
------------

[](#installation)

### Recommended: Install with Composer/CGR

[](#recommended-install-with-composercgr)

This is not a thing to `require` within a project; it’s a tool for your workstation. Composer facilitates that with `composer global require`, but that command is somewhat flawed in the way it manages things, so we prefer [`cgr`](https://pantheon.io/blog/fixing-composer-global-command).

To install `cgr`, run `composer global require consolidation/cgr` and it will be added in the `.composer` directory off your home directory. You will also need to tell the system that you’re adding executables to a new place. In your home directory, there can be a file named `.bash_profile` or `.profile` which is run every time you log in. Edit that file (create one if neither exists) and add a line at the end:

```
export PATH="$PATH:~/.composer/vendor/bin"
```

In order for the new `PATH` to take effect, you can either log out and back in, or run `source .bash_profile` (or `source .profile`). You can test that it worked by running `cgr --help`; it should give you help instead of an error message.

After all that, you should be able to run `cgr mtholyoke/jorge:*`. If it is successfully installed, `jorge --version` will report “Can’t find project root” and a version. You can omit the `:*` if you only want the current version with no major upgrades, or replace the `*` with a specific version.

### For Development: Install with Git

[](#for-development-install-with-git)

You can also clone this repo for development and run Jorge directly from that copy. Rather than adding `~/Projects/jorge/bin` (or whatever your Projects directory is; run `pwd` to check) to your path, I recommend making a symlink to `bin/jorge` (the actual program) from `/usr/local/bin` or some other location already in your path:

```
ln -s ~/Projects/jorge/bin/jorge /usr/local/bin/jorge
```

Run `composer install` in the Jorge directory to get its dependencies.

If you're going to do any development, also run `bin/setup.sh` once to install the standard Git hooks.

Configuration
-------------

[](#configuration)

Jorge has no global configuration; it works on the project level only.

The project’s root directory should contain a subdirectory `.jorge`, which should have a file `config.yml`. Samples are included in Jorge’s own `.jorge` directory.

In `.jorge/config.yml`, you **must** have the key `appType`. Currently, only `drupal7`, `drupal8`, and `jorge` are recognized as values.

Optionally, you may also have the key `include_config`, which specifies a list of additional configuration files to include from the `.jorge` directory, to be loaded in the order specified. Values in those files will override any previously loaded settings, including the main `config.yml`. Note that `include_config` is only allowed in the main `config.yml` file.

### Drupal 7 or 8 Configuration

[](#drupal-7-or-8-configuration)

A config file may include the key `reset`, which contains a block that provides any of seven optional parameters to the `reset` command (described below):

- `auth    ` - A Terminus machine token to authenticate with Pantheon for the reset
- `branch  ` - Which Git branch to reset your current codebase to (default is `master`)
- `import  ` - Whether to run `drush config-import` after pulling the database (default is `FALSE`)
- `content ` - Which Pantheon environment to copy database and files from (default is `dev`)
- `database` - Which Pantheon environment to copy the database from (default matches `content`)
- `files   ` - Which Pantheon environment to copy the files from (default matches `database`)
- `rsync   ` - Whether Lando should use `rsync` to copy files (default is `TRUE`)
- `username` - A username (usually an admin) that needs a local password (no default)
- `password` - A local password for the username specified above (no default)

Commonly, the configuration committed to the project’s Git repo looks like this:

```
appType: drupal8
reset:
  branch: master
  content: dev
  rsync: TRUE
include_config:
  - local.yml
```

In `local.yml`, which is *not* committed to the project’s Git repo:

```
reset:
  auth: a1b2c3d4e5f6
  username: admin
  password: asdf1234
```

Commands
--------

[](#commands)

### `jorge drush `*`{drush-command}`*

[](#jorge-drush-drush-command)

In a Composer-powered Drupal 8 project, `lando drush `*`{drush-command}`* may need to be run inside the `web` directory (so it has access to Drupal), regardless of whether you’re currently in that directory. This command lets you run it from outside that directory, (after starting Lando if it’s not already running).

It accepts the `-y`/`--yes` and `-n`/`--no` option natively, but other Drush options need to be escaped. See `jorge help drush` for details. Note that `-n` is actually Symfony `--no-interaction`, which has approximately the same effect.

### `jorge reset`

[](#jorge-reset)

Sets up the local development environment as specified in the configuration file(s) described above.

**Note:** Your project must be in a clean state: if Git can’t change branches, the whole thing will fail. Lando versions starting with 3.0.0-rc.2 (released 1 Feb 2019) require a Terminus machine token be present in the `auth` parameter (command line or config file); without this, the whole thing will fail.

Starts Lando if it is not already running, then uses `lando pull` to fetch the site from Pantheon.

Optionally takes command-line switches which will override the settings described above (except `rsync`); see `jorge help reset` for details.

If you are resetting to a branch other than master (using `-b`), you may need to also use `-i` if the branch has config different from the database to be pulled.

If an admin account username is provided but no password is supplied, Jorge will prompt you for one. If you leave that blank also, the password will not be reset.

### *Not Implemented Yet*

[](#not-implemented-yet)

**`jorge save`** – Save the current state of the code, database, and files so that it can be restored by a later `reset`.

Future Work
-----------

[](#future-work)

- Make sure Drush is installed and working before relying on it.
- More tests (see also Symfony doc [Testing Commands](https://symfony.com/doc/current/console.html#testing-commands))

    - `Tool::exec()` uses the Symfony Process component when user interaction is required, and a first pass at testing by executing `read` with `-p "\nPress enter" x` did not provide the expected coverage. Possibly we need to do a full mock as in `ResetCommandTest::testInteract()` and adjust `Tool::exec()` to use an `InputInterface` instead of `STDIN`.
- Lando 3.0.0-rc.2 and later have an interactive auth system for commands that require it (such as `lando pull`, which is the heart of `jorge reset`). It would be nice to be able to pass this through to the user if they don’t have the token in their `local.yml` config file. These versions of Lando can also read the environment variable `TERMINUS_TOKEN`, so we should also check for that.
- Implement [Tools](src/Tool/) for Git, &c., using APIs or as service(s) within the container(s), for better awareness of initial/current state
- Lando may not be a *Tool*; it may be a new kind of thing. Possibly we need a plugin interface for “environment manager”.
- Option to stash or discard changes before a `git checkout`?
- Implement `jorge save` and refactor `jorge reset` to be able to use saved state
- Is it possible to check for Sass watcher (or similar idea) and suspend during Git operations?

###  Health Score

27

—

LowBetter than 49% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity11

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity57

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 99% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~47 days

Recently: every ~98 days

Total

17

Last Release

2227d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/5d54275df9852d369fd093a06dcf7e881c843c8d878517a57795c0238f956595?d=identicon)[jproctor](/maintainers/jproctor)

---

Top Contributors

[![jproctor](https://avatars.githubusercontent.com/u/363484?v=4)](https://github.com/jproctor "jproctor (207 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (2 commits)")

---

Tags

climtholyoke

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/mtholyoke-jorge/health.svg)

```
[![Health](https://phpackages.com/badges/mtholyoke-jorge/health.svg)](https://phpackages.com/packages/mtholyoke-jorge)
```

###  Alternatives

[shopware/platform

The Shopware e-commerce core

3.3k1.5M3](/packages/shopware-platform)[crunzphp/crunz

Schedule your tasks right from the code.

2292.0M6](/packages/crunzphp-crunz)[n98/magerun2

Tools for managing Magento projects and installations

928244.3k6](/packages/n98-magerun2)[shopware/core

Shopware platform is the core for all Shopware ecommerce products.

595.2M386](/packages/shopware-core)[ec-cube/ec-cube

EC-CUBE EC open platform.

78527.0k1](/packages/ec-cube-ec-cube)[crazywhalecc/static-php-cli

Build single static PHP binary, with PHP project together, with popular extensions included.

1.8k13.9k](/packages/crazywhalecc-static-php-cli)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)