https://github.com/Kikobeats/git-authors-cli

It detects project contributors; add contributors into `package.json`
https://github.com/Kikobeats/git-authors-cli

Last synced: 3 months ago
JSON representation

It detects project contributors; add contributors into `package.json`

• Host: GitHub
• URL: https://github.com/Kikobeats/git-authors-cli
• Owner: Kikobeats
• License: mit
• Created: 2018-06-20T16:45:57.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-01-24T22:55:50.000Z (10 months ago)
• Last Synced: 2024-04-25T04:45:18.006Z (7 months ago)
• Language: JavaScript
• Homepage:
• Size: 364 KB
• Stars: 109
• Watchers: 4
• Forks: 7
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# git-authors-cli

![Last version](https://img.shields.io/github/tag/Kikobeats/git-authors-cli.svg?style=flat-square)

[![NPM Status](https://img.shields.io/npm/dm/git-authors-cli.svg?style=flat-square)](https://www.npmjs.org/package/git-authors-cli)

![](demo.png)

> Detects project contributors and add it into `package.json`

Add credits for people that help you ship code is important, but it is a task easy to forget. This tool makes it easy to integrate as part of your release process, so your contributors are always up to date ✨.

## Install

```bash

$ npm install git-authors-cli --global

```

## CLI

```

$ git-authors-cli --help

  Print all contributors and add it into package.json

  Usage

    $ git-authors-cli [options]

  Options

    --cwd    Specify the path for running the command (defaults to process.cwd())

    --save   Write contributors into package.json if it exists (defaults to true)

    --print  Show information from the terminal (defaults to true)

    --ignore-pattern  Skip authors if their name or email match pattern (allow multiple)

  Examples

    $ git-authors-cli # Get contributors for the current path project.

    $ git-authors-cli ~/Projects/metascraper # Get contributors for a specific path project.

    $ git-authors-cli --ignore-pattern noreply.github.com # Ignore github public surrogate emails.

```

## License

**git-authors-cli** © [Kiko Beats](https://kikobeats.com), released under the [MIT](https://github.com/Kikobeats/git-authors-cli/blob/master/LICENSE.md) License.


Authored and maintained by Kiko Beats with help from [contributors](https://github.com/Kikobeats/git-authors-cli/contributors).

> [kikobeats.com](https://kikobeats.com) · GitHub [Kiko Beats](https://github.com/Kikobeats) · Twitter [@Kikobeats](https://twitter.com/Kikobeats)