mergestat <a href="https://docs.mergestat.com/"><img align="right" src="https://github.com/mergestat/mergestat/raw/main/docs/logo.png" alt="MergeStat Logo" height="100"></a>

<picture> <source media="(prefers-color-scheme: dark)" srcset="docs/banner-dark-mode.png"> <img alt="Banner describing MergeStat" src="docs/banner-light-mode.png"> </picture>

MergeStat enables SQL queries for data in git repositories (and related sources, such as the GitHub API). It allows you to ask questions about the history and contents of your source code.

If you are looking for our CLI, which runs SQL queries against local git repositories, it's now called mergestat-lite

See our documentation for additional context.

<img alt="MergeStat Queries" src="docs/queries.gif"/>

Running Locally

Try MergeStat locally with docker-compose by cloning this repository and running

docker-compose up

Now if you visit http://localhost:3300/ you should be able to access our management UI where you can begin adding repositories and syncing data.

NOTE if you'd like to make use of GitHub API data (any sync type that uses the GitHub API including repo auto imports) or any private GitHub repos you will need to supply a GitHub personal access token. We are working on GitHub auth alternatives, but for now a PAT is your best bet.

<img alt="MergeStat GitHub PAT Management UI" src="docs/github-pat-local.jpg" />

You can manage a single PAT for your instance in the Settings area of the management UI.

Examples

Take a look at all of our examples

Resetting a Local Instance

If you'd like to "start from scratch" (i.e. reset the DB and start with a fresh deployment), run the following:

docker-compose down

docker volume rm mergestat_db_data

<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=31b68c46-eba1-48b1-a5a8-1898f268e866" />