https://github.com/kevinkhill/gitregator
GitRegater is a simple library to pull project information directly from your repos.
https://github.com/kevinkhill/gitregator
git github
Last synced: 3 months ago
JSON representation
GitRegater is a simple library to pull project information directly from your repos.
- Host: GitHub
- URL: https://github.com/kevinkhill/gitregator
- Owner: kevinkhill
- License: mit
- Created: 2021-03-06T14:49:09.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-03-21T13:57:27.000Z (over 5 years ago)
- Last Synced: 2025-09-27T09:47:32.730Z (9 months ago)
- Topics: git, github
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/gitregator
- Size: 1.04 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# GitRegator
[![NPM version][npm-version-image]][npm-url]
[![NPM downloads][npm-downloads-image]][npm-downloads-url]
[![MIT License][license-image]][license-url]
GitRegator is a simple utility to _ag-git-regate_ information from your projects on github.
## Install
`npm i gitregator`
## Usage
Drop a `.gitregator.yml` in the root of any project you want to get picked up.
Load some information in it
```yaml
icon: "fa fa-github"
name: "GitRegator"
description: "CLI tool for aggregating information from github projects."
```
Create your client
```javascript
const GitRegator = require("./gitregator");
const client = new GitRegator({
username: ,
apiKey:
});
```
Then fetch one
```javascript
(async () => {
const info = await client.getInfoFromRepo("");
console.log(info); // { "icon": "fa fa-github", "name": "GitRegator", "description": "CLI tool ..."
})();
```
Or fetch them all!
```javascript
(async () => {
const repos = await client.getUserRepoTitles();
if (repos.length > 0) {
for (const repo in repos) {
const info = await client.getInfoFromRepo(repo);
console.log(info);
}
}
})();
```
## Resources
- [Changelog](CHANGELOG.md)
## License
GitRegator is freely distributable under the terms of the [MIT license][license-url].
[license-image]: https://img.shields.io/badge/license-MIT-blue.svg?style=flat
[license-url]: LICENSE
[npm-url]: https://npmjs.org/package/gitregator
[npm-version-image]: https://img.shields.io/npm/v/gitregator.svg?style=flat
[npm-downloads-image]: https://img.shields.io/npm/dm/gitregator.svg?style=flat
[npm-downloads-url]: https://npmcharts.com/compare/gitregator?minimal=true