https://github.com/pixelastic/gilmore
Glorious git and GitHub toolbox
https://github.com/pixelastic/gilmore
git github
Last synced: 11 months ago
JSON representation
Glorious git and GitHub toolbox
- Host: GitHub
- URL: https://github.com/pixelastic/gilmore
- Owner: pixelastic
- License: mit
- Created: 2021-08-17T19:24:33.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2025-06-03T23:53:19.000Z (about 1 year ago)
- Last Synced: 2025-06-04T07:18:04.353Z (about 1 year ago)
- Topics: git, github
- Language: JavaScript
- Homepage: https://projects.pixelastic.com/gilmore/
- Size: 1.73 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gilmore
Gilmore is a toolbox for git and GitHub.
## Installation
```sh
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:
```javascript
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/