Skip to content

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

License

Notifications You must be signed in to change notification settings

Kikobeats/git-authors-cli

Repository files navigation

git-authors-cli

Last version NPM Status

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

$ 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, released under the MIT License.
Authored and maintained by Kiko Beats with help from contributors.

kikobeats.com · GitHub Kiko Beats · X @Kikobeats

About

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

Resources

License

Stars

Watchers

Forks

Packages

No packages published