gilmore

Installation

yarn add gilmore

Usage

You need to create an instance of Gilmore for a given repository. Then you can call all of Gilmore methods on this instance:

const Gilmore = require('gilmore');
const repo = new Gilmore('/path/to/repo');

(async () => {
  const head = await repo.currentCommit();
  console.info(`The HEAD hash is ${head}`);
})();

Options

In addition to the repository root as first argument, you can also pass an option object as the second argument.

The accepted options are as follow:

| Name | Default value | Description | | -------------- | ------------- | ------------------------------------------------- | | globalConfig | true | Set to false to not inherit from ~/.gitconfig |

Documentation

The complete documentation can be found on https://projects.pixelastic.com/gilmore/