PHPackages                             andygrunwald/gerrie - 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. [Utility &amp; Helpers](/categories/utility)
4. /
5. andygrunwald/gerrie

AbandonedArchivedLibrary[Utility &amp; Helpers](/categories/utility)

andygrunwald/gerrie
===================

A data crawler for Googles code review tool 'Gerrit'

v0.2.0(11y ago)11303[5 PRs](https://github.com/andygrunwald/Gerrie/pulls)MITPHPPHP &gt;=5.4.0CI passing

Since Dec 27Pushed 3y ago1 watchersCompare

[ Source](https://github.com/andygrunwald/Gerrie)[ Packagist](https://packagist.org/packages/andygrunwald/gerrie)[ Docs](http://andygrunwald.github.io/Gerrie)[ RSS](/packages/andygrunwald-gerrie/feed)WikiDiscussions master Synced today

READMEChangelog (2)Dependencies (5)Versions (13)Used By (0)

Gerrie
======

[](#gerrie)

[![Build Status](https://camo.githubusercontent.com/b5e1b77a74eca6837e622c310b4230497d7da0cbd802e246d4050aef8a770765/68747470733a2f2f7365637572652e7472617669732d63692e6f72672f616e64796772756e77616c642f4765727269652e706e67)](http://travis-ci.org/andygrunwald/Gerrie)[![Dependency Status](https://camo.githubusercontent.com/3b603ebf4f96070e9bca43f33d228e125ab0d2d07334608eee99f953ec4078ad/68747470733a2f2f7777772e76657273696f6e6579652e636f6d2f757365722f70726f6a656374732f3533353534653437666530643037386137363030303030322f62616467652e706e67)](https://www.versioneye.com/user/projects/53554e47fe0d078a76000002)[![Scrutinizer Code Quality](https://camo.githubusercontent.com/67294c45499cdc04cec9e759a08fa1e292fbeae2a8621afb8bd64557ce14245c/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f616e64796772756e77616c642f4765727269652f6261646765732f7175616c6974792d73636f72652e706e673f733d38663130643334373031386135363466366461636331623861373936663031353039343136393162)](https://scrutinizer-ci.com/g/andygrunwald/Gerrie/)[![Code Coverage](https://camo.githubusercontent.com/9dc45b8b5285977b68efaa19b4fb5c9987fd4d9742a2af2bc13fd0c2aa448f9a/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f616e64796772756e77616c642f4765727269652f6261646765732f636f7665726167652e706e673f733d61623163636262363037656532643030663937633332653837623733393565663564366461613732)](https://scrutinizer-ci.com/g/andygrunwald/Gerrie/)[![Documentation Status](https://camo.githubusercontent.com/2a8de2566e12f279e5028eb2a5eded21b7c8a3307eeb27441a4a51949cc3b787/68747470733a2f2f72656164746865646f63732e6f72672f70726f6a656374732f6765727269652f62616467652f3f76657273696f6e3d6c6174657374)](https://readthedocs.org/projects/gerrie/?badge=latest)

*[Gerrie](https://andygrunwald.github.io/Gerrie/)* is a data and information crawler for *[Gerrit](https://code.google.com/p/gerrit/)*, a code review system developed by Google.

*Gerrie* uses the SSH and REST-APIs offered by *Gerrit* to transform the data from Gerrit into a RDBMS. Currently only MySQL is supported. After the transformation the data can be used to start simple queries or complex analysis. One usecase is to analyze communites which use *Gerrit* like [TYPO3](https://review.typo3.org/), [Wikimedia](https://gerrit.wikimedia.org/), [Android](https://android-review.googlesource.com/), [Qt](https://codereview.qt-project.org/), [Eclipse](https://git.eclipse.org/r/) and [many more](http://en.wikipedia.org/wiki/Gerrit_(software)#Notable_users).

- Website: [andygrunwald.github.io/Gerrie](https://andygrunwald.github.io/Gerrie/)
- Source code: [Gerrie @ GitHub](https://github.com/andygrunwald/Gerrie)
- Documentation: [*Gerrie* @ Read the Docs](https://gerrie.readthedocs.org/en/latest/)

**Gerrie is deprecated**: [watson](https://github.com/andygrunwald/watson) will be replace *Gerrie*. Watson benefits from our learnings of developing and maintaing Gerrie in a larger (crawling) scale. Checkout [\#17](https://github.com/andygrunwald/Gerrie/pull/17) for some more information. **Neverless we still merge and support contributions to Gerrie**.

Features
--------

[](#features)

- Full imports
- Incremental imports
- Full support of SSH API
- Command line interface
- MySQL as storage backend
- Debugging functionality
- Logging functionality
- Full documented

Getting started
---------------

[](#getting-started)

Download application and install dependencies:

```
$ git clone https://github.com/andygrunwald/Gerrie.git .
$ composer install
```

Copy config file and adjust configuration (*Database*, *SSH*, *Gerrit*):

```
$ cp Config.yml.dist Config.yml
$ vim Config.yml
```

A minimalistic configuration for the *TYPO3 Gerrit instance* with the user *max.mustermann* can look like:

```
Database:
  Host: 127.0.0.1
  Username: root
  Password:
  Port: 3306
  Name: gerrie

SSH:
  KeyFile: /Users/max/.ssh/id_rsa_gerrie

Gerrit:
  TYPO3:
    - ssh://max.mustermann@review.typo3.org:29418/
```

Create a new database in your database with name *gerrie* and setup database scheme:

```
$ mysql -u root -e "CREATE DATABASE gerrie;"
$ ./gerrie gerrie:setup-database --config-file="./Config.yml"
```

Create an account (e.g. *max.mustermann*) in the Gerrit instance you want to crawl (e.g. *review.typo3.org:29418*), add your SSH public key to the Gerrit instance and execute the *gerrie:check* command to check your environment:

```
$ ./gerrie gerrie:check --config-file="./Config.yml"
```

> **Important:**If your SSH key is protected by a passphrase this check will ask you to enter your passphrase to use the private key for this connection. Gerrie does not save or transfer this passphrase to any foreign server. The private key is only necessary to authenticate against the Gerrit instance.

If everything is fine start crawling:

```
$ ./gerrie gerrie:crawl --config-file="./Config.yml"
```

Now the crawler starts and is doing its job 🍺

You reading can continue in the documentation in the chapters [Installation](https://gerrie.readthedocs.org/en/latest/installation/index.html), [Configuration](https://gerrie.readthedocs.org/en/latest/configuration/index.html), [Commands](https://gerrie.readthedocs.org/en/latest/commands/index.html), [Database](https://gerrie.readthedocs.org/en/latest/database/index.html) or [Contributing](https://gerrie.readthedocs.org/en/latest/contributing/index.html).

Documentation
-------------

[](#documentation)

The complete and detailed documentation can be found at [*Gerrie* @ Read the Docs](https://gerrie.readthedocs.org/en/latest/). The documentation is written in [reStructuredText](http://en.wikipedia.org/wiki/ReStructuredText) and shipped with the source code and can be found in the [*docs/*](https://github.com/andygrunwald/Gerrie/tree/master/docs) folder.

Source code
-----------

[](#source-code)

The source code can be found at [*andygrunwald/Gerrie @ GitHub*](https://github.com/andygrunwald/Gerrie).

Contributing
------------

[](#contributing)

Contribution is welcome at every time.

Contribution is not limited to source code. Also documentation, issues (bugs, new features, nice improvements), talks at usergroups or conferences and so on. In our documentation you can find more detailed information about contribution.

See [*Gerrie: Contribution* @ Read the Docs](http://gerrie.readthedocs.org/en/latest/contributing/).

License
-------

[](#license)

This project is released under the terms of the [MIT license](http://en.wikipedia.org/wiki/MIT_License).

Support, contact or feedback
----------------------------

[](#support-contact-or-feedback)

If you got questions, got feedback, getting crazy with setting up or using this project or want to drink a 🍺 and talk about this project **just contact me**.

Write me an email (see [*Andy @ GitHub*](https://github.com/andygrunwald)) or tweet me ([@andygrunwald](http://twitter.com/andygrunwald)). And of course, you can just open an issue in the [*Gerrie* tracker](https://github.com/andygrunwald/Gerrie/issues).

###  Health Score

28

—

LowBetter than 52% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity16

Limited adoption so far

Community14

Small or concentrated contributor base

Maturity55

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 97.9% 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 ~56 days

Recently: every ~37 days

Total

7

Last Release

4228d ago

PHP version history (2 changes)v0.0.1PHP &gt;=5.3.0

v0.0.2PHP &gt;=5.4.0

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/320064?v=4)[Andy Grunwald](/maintainers/andygrunwald)[@andygrunwald](https://github.com/andygrunwald)

---

Top Contributors

[![andygrunwald](https://avatars.githubusercontent.com/u/320064?v=4)](https://github.com/andygrunwald "andygrunwald (323 commits)")[![sschuberth](https://avatars.githubusercontent.com/u/349154?v=4)](https://github.com/sschuberth "sschuberth (5 commits)")[![dependabot-preview[bot]](https://avatars.githubusercontent.com/in/2141?v=4)](https://github.com/dependabot-preview[bot] "dependabot-preview[bot] (1 commits)")[![mehrmoudi](https://avatars.githubusercontent.com/u/3028290?v=4)](https://github.com/mehrmoudi "mehrmoudi (1 commits)")

---

Tags

googlegitreviewgerrit

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/andygrunwald-gerrie/health.svg)

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

###  Alternatives

[friendsoftypo3/content-blocks

TYPO3 CMS Content Blocks - Content Types API | Define reusable components via YAML

103519.9k53](/packages/friendsoftypo3-content-blocks)[oro/platform

Business Application Platform (BAP)

645143.5k114](/packages/oro-platform)[altis/local-server

Local Server module for Altis

18221.6k3](/packages/altis-local-server)[concrete5/core

Concrete core subtree split

20166.1k50](/packages/concrete5-core)[aeliot/todo-registrar

Register TODOs from source code in issue tracker

153.0k](/packages/aeliot-todo-registrar)

PHPackages © 2026

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