2019-01-15 07:32:40 +00:00
> [There is now a GitHub Bot](https://github.com/all-contributors/all-contributors-bot) for automating the maintenance of your contributors table ✨<br />Say goodbye to command line tool dependencies and hello to the [@all-contributors bot 🤖](https://github.com/all-contributors/all-contributors-bot)
2019-01-15 05:39:01 +00:00
2017-11-22 18:09:06 +00:00
< h1 align = "center" >
2019-01-15 05:39:01 +00:00
all-contributors-cli
2017-11-22 18:09:06 +00:00
< / h1 >
< p align = "center" style = "font-size: 1.2rem;" > Automate acknowledging contributors to your open source projects< / p >
< hr / >
[![Build Status][build-badge]][build]
[![Code Coverage][coverage-badge]][coverage]
2019-01-17 08:54:41 +00:00
[![Greenkeeper badge ](https://badges.greenkeeper.io/all-contributors/all-contributors-cli.svg )](https://greenkeeper.io/)
2017-11-22 18:09:06 +00:00
[![version][version-badge]][package] [![downloads][downloads-badge]][downloads]
[![MIT License][license-badge]][license]
2019-01-07 07:55:57 +00:00
[![Chat on Slack][chat-badge]][chat]
2019-01-17 11:05:09 +00:00
[![Commitizen friendly ](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg )](http://commitizen.github.io/cz-cli/)
2016-02-29 00:48:55 +00:00
2019-01-14 16:37:17 +00:00
[![All Contributors ](https://img.shields.io/badge/all_contributors-28-orange.svg?style=flat-square )](#contributors)
2017-11-22 18:09:06 +00:00
[![PRs Welcome][prs-badge]][prs] [![Code of Conduct][coc-badge]][coc]
[![Watch on GitHub][github-watch-badge]][github-watch]
[![Star on GitHub][github-star-badge]][github-star]
[![Tweet][twitter-badge]][twitter]
## The problem
You want to implement the [All Contributors][all-contributors] spec, but don't
want to maintain the table by hand
## This solution
This is a tool to help automate adding contributor acknowledgements according to
2019-01-07 06:38:29 +00:00
the [all-contributors ](https://github.com/all-contributors/all-contributors )
2018-02-23 14:13:41 +00:00
specification for your GitHub or GitLab repository.
2017-11-22 18:09:06 +00:00
2019-01-23 22:05:33 +00:00
## Using the all-contributors-cli
2019-01-30 15:23:41 +00:00
If you're looking to use the cli, head over to [the cli docs on all-contributors.js.org ](https://all-contributors.js.org/docs/en/cli/overview ). The all-contributors website contains all the information required to install, configure and use the all-contributors-cli.
2018-12-28 15:35:53 +00:00
2016-02-29 22:50:30 +00:00
## Contributors
2017-11-22 18:09:06 +00:00
Thanks goes to these wonderful people
2019-01-07 06:38:29 +00:00
([emoji key](https://github.com/all-contributors/all-contributors#emoji-key)):
2016-02-29 22:50:30 +00:00
2016-03-06 15:49:46 +00:00
<!-- ALL - CONTRIBUTORS - LIST:START - Do not remove or modify this section -->
2017-11-22 18:09:06 +00:00
<!-- prettier - ignore -->
2019-01-07 06:38:29 +00:00
| [<img src="https://avatars.githubusercontent.com/u/3869412?v=3" width="100px;"/><br /><sub><b>Jeroen Engels</b></sub> ](https://github.com/jfmengels )< br /> [💻](https://github.com/all-contributors/all-contributors-cli/commits?author=jfmengels "Code") [📖 ](https://github.com/all-contributors/all-contributors-cli/commits?author=jfmengels "Documentation" ) [⚠️ ](https://github.com/all-contributors/all-contributors-cli/commits?author=jfmengels "Tests" ) | [<img src="https://avatars.githubusercontent.com/u/1500684?v=3" width="100px;"/><br /><sub><b>Kent C. Dodds</b></sub> ](http://kentcdodds.com/ )< br /> [📖](https://github.com/all-contributors/all-contributors-cli/commits?author=kentcdodds "Documentation") [💻 ](https://github.com/all-contributors/all-contributors-cli/commits?author=kentcdodds "Code" ) | [<img src="https://avatars.githubusercontent.com/u/14871650?v=3" width="100px;"/><br /><sub><b>João Guimarães</b></sub> ](https://github.com/jccguimaraes )< br /> [💻](https://github.com/all-contributors/all-contributors-cli/commits?author=jccguimaraes "Code") | [<img src="https://avatars.githubusercontent.com/u/1282980?v=3" width="100px;"/><br /><sub><b>Ben Briggs</b></sub> ](http://beneb.info )< br /> [💻](https://github.com/all-contributors/all-contributors-cli/commits?author=ben-eb "Code") | [<img src="https://avatars.githubusercontent.com/u/22768990?v=3" width="100px;"/><br /><sub><b>Itai Steinherz</b></sub> ](https://github.com/itaisteinherz )< br /> [📖](https://github.com/all-contributors/all-contributors-cli/commits?author=itaisteinherz "Documentation") [💻 ](https://github.com/all-contributors/all-contributors-cli/commits?author=itaisteinherz "Code" ) | [<img src="https://avatars.githubusercontent.com/u/5701162?v=3" width="100px;"/><br /><sub><b>Alex Jover</b></sub> ](https://github.com/alexjoverm )< br /> [💻](https://github.com/all-contributors/all-contributors-cli/commits?author=alexjoverm "Code") [📖 ](https://github.com/all-contributors/all-contributors-cli/commits?author=alexjoverm "Documentation" ) |
2017-12-25 12:41:22 +00:00
| :---: | :---: | :---: | :---: | :---: | :---: |
2019-01-07 06:38:29 +00:00
| [<img src="https://avatars3.githubusercontent.com/u/8212?v=3" width="100px;"/><br /><sub><b>Jerod Santo</b></sub> ](https://jerodsanto.net )< br /> [💻](https://github.com/all-contributors/all-contributors-cli/commits?author=jerodsanto "Code") | [<img src="https://avatars1.githubusercontent.com/u/574871?v=3" width="100px;"/><br /><sub><b>Kevin Jalbert</b></sub> ](https://github.com/kevinjalbert )< br /> [💻](https://github.com/all-contributors/all-contributors-cli/commits?author=kevinjalbert "Code") | [<img src="https://avatars3.githubusercontent.com/u/5038030?v=4" width="100px;"/><br /><sub><b>tunnckoCore</b></sub> ](https://i.am.charlike.online )< br /> [🔧](#tool-charlike "Tools") | [<img src="https://avatars2.githubusercontent.com/u/304450?v=4" width="100px;"/><br /><sub><b>Mehdi Achour</b></sub> ](https://machour.idk.tn/ )< br /> [💻](https://github.com/all-contributors/all-contributors-cli/commits?author=machour "Code") | [<img src="https://avatars1.githubusercontent.com/u/8344688?v=4" width="100px;"/><br /><sub><b>Roy Revelt</b></sub> ](https://codsen.com )< br /> [🐛](https://github.com/all-contributors/all-contributors-cli/issues?q=author%3Arevelt "Bug reports") | [<img src="https://avatars1.githubusercontent.com/u/422331?v=4" width="100px;"/><br /><sub><b>Chris Vickery</b></sub> ](https://github.com/chrisinajar )< br /> [💻](https://github.com/all-contributors/all-contributors-cli/commits?author=chrisinajar "Code") |
| [<img src="https://avatars2.githubusercontent.com/u/1026002?v=4" width="100px;"/><br /><sub><b>Bryce Reynolds</b></sub> ](https://github.com/brycereynolds )< br /> [💻](https://github.com/all-contributors/all-contributors-cli/commits?author=brycereynolds "Code") | [<img src="https://avatars3.githubusercontent.com/u/2322305?v=4" width="100px;"/><br /><sub><b>James, please</b></sub> ](http://www.jmeas.com )< br /> [🤔](#ideas-jmeas "Ideas, Planning, & Feedback") [💻 ](https://github.com/all-contributors/all-contributors-cli/commits?author=jmeas "Code" ) | [<img src="https://avatars3.githubusercontent.com/u/1057324?v=4" width="100px;"/><br /><sub><b>Spyros Ioakeimidis</b></sub> ](http://www.spyros.io )< br /> [💻](https://github.com/all-contributors/all-contributors-cli/commits?author=spirosikmd "Code") | [<img src="https://avatars3.githubusercontent.com/u/12335761?v=4" width="100px;"/><br /><sub><b>Fernando Costa</b></sub> ](https://github.com/fadc80 )< br /> [💻](https://github.com/all-contributors/all-contributors-cli/commits?author=fadc80 "Code") | [<img src="https://avatars0.githubusercontent.com/u/197404?v=4" width="100px;"/><br /><sub><b>snipe</b></sub> ](https://snipe.net )< br /> [📖](https://github.com/all-contributors/all-contributors-cli/commits?author=snipe "Documentation") | [<img src="https://avatars0.githubusercontent.com/u/997157?v=4" width="100px;"/><br /><sub><b>Gant Laborde</b></sub> ](http://gantlaborde.com/ )< br /> [💻](https://github.com/all-contributors/all-contributors-cli/commits?author=GantMan "Code") |
| [<img src="https://avatars2.githubusercontent.com/u/17708702?v=4" width="100px;"/><br /><sub><b>Md Zubair Ahmed</b></sub> ](https://in.linkedin.com/in/mzubairahmed )< br /> [📖](https://github.com/all-contributors/all-contributors-cli/commits?author=M-ZubairAhmed "Documentation") [🐛 ](https://github.com/all-contributors/all-contributors-cli/issues?q=author%3AM-ZubairAhmed "Bug reports" ) [💻 ](https://github.com/all-contributors/all-contributors-cli/commits?author=M-ZubairAhmed "Code" ) [⚠️ ](https://github.com/all-contributors/all-contributors-cli/commits?author=M-ZubairAhmed "Tests" ) | [<img src="https://avatars3.githubusercontent.com/u/6177621?v=4" width="100px;"/><br /><sub><b>Divjot Singh</b></sub> ](http://bogas04.github.io )< br /> [📖](https://github.com/all-contributors/all-contributors-cli/commits?author=bogas04 "Documentation") | [<img src="https://avatars0.githubusercontent.com/u/15315098?v=4" width="100px;"/><br /><sub><b>João Marques</b></sub> ](https://github.com/tigermarques )< br /> [💻](https://github.com/all-contributors/all-contributors-cli/commits?author=tigermarques "Code") [📖 ](https://github.com/all-contributors/all-contributors-cli/commits?author=tigermarques "Documentation" ) [🤔 ](#ideas-tigermarques "Ideas, Planning, & Feedback" ) | [<img src="https://avatars3.githubusercontent.com/u/1192452?v=4" width="100px;"/><br /><sub><b>Andrew Lisowski</b></sub> ](http://hipstersmoothie.com )< br /> [💻](https://github.com/all-contributors/all-contributors-cli/commits?author=hipstersmoothie "Code") [📖 ](https://github.com/all-contributors/all-contributors-cli/commits?author=hipstersmoothie "Documentation" ) [⚠️ ](https://github.com/all-contributors/all-contributors-cli/commits?author=hipstersmoothie "Tests" ) | [<img src="https://avatars3.githubusercontent.com/u/1736154?v=4" width="100px;"/><br /><sub><b>Xianming Zhong</b></sub> ](https://github.com/chinesedfan )< br /> [📖](https://github.com/all-contributors/all-contributors-cli/commits?author=chinesedfan "Documentation") | [<img src="https://avatars2.githubusercontent.com/u/8073251?v=4" width="100px;"/><br /><sub><b>C.Y.Xu</b></sub> ](https://github.com/xuchaoying )< br /> [💻](https://github.com/all-contributors/all-contributors-cli/commits?author=xuchaoying "Code") |
2019-01-14 16:37:17 +00:00
| [<img src="https://avatars3.githubusercontent.com/u/3680914?v=4" width="100px;"/><br /><sub><b>Dura</b></sub> ](https://github.com/chris-dura )< br /> [📖](https://github.com/all-contributors/all-contributors-cli/commits?author=chris-dura "Documentation") | [<img src="https://avatars2.githubusercontent.com/u/3534236?v=4" width="100px;"/><br /><sub><b>Jake Bolam</b></sub> ](https://jakebolam.com )< br /> [🚇](#infra-jakebolam "Infrastructure (Hosting, Build-Tools, etc)") [💻 ](https://github.com/all-contributors/all-contributors-cli/commits?author=jakebolam "Code" ) [📖 ](https://github.com/all-contributors/all-contributors-cli/commits?author=jakebolam "Documentation" ) [⚠️ ](https://github.com/all-contributors/all-contributors-cli/commits?author=jakebolam "Tests" ) | [<img src="https://avatars0.githubusercontent.com/u/8260834?v=4" width="100px;"/><br /><sub><b>Maximilian Berkmann</b></sub> ](http://maxcubing.wordpress.com )< br /> [💻](https://github.com/all-contributors/all-contributors-cli/commits?author=Berkmann18 "Code") [⚠️ ](https://github.com/all-contributors/all-contributors-cli/commits?author=Berkmann18 "Tests" ) [📖 ](https://github.com/all-contributors/all-contributors-cli/commits?author=Berkmann18 "Documentation" ) | [<img src="https://avatars2.githubusercontent.com/u/7265547?v=4" width="100px;"/><br /><sub><b>tbenning</b></sub> ](https://github.com/tbenning )< br /> [🎨](#design-tbenning "Design") |
2019-01-16 11:14:59 +00:00
2016-03-06 15:49:46 +00:00
<!-- ALL - CONTRIBUTORS - LIST:END -->
2016-02-29 22:50:30 +00:00
2017-11-22 18:09:06 +00:00
This project follows the
2019-01-07 06:38:29 +00:00
[all-contributors ](https://github.com/all-contributors/all-contributors )
2017-11-22 18:09:06 +00:00
specification. Contributions of any kind are welcome!
2016-02-29 22:50:30 +00:00
## LICENSE
MIT
2017-11-22 18:09:06 +00:00
[npm]: https://www.npmjs.com/
[node]: https://nodejs.org
2019-01-07 07:55:57 +00:00
[chat-badge]: https://img.shields.io/badge/slack-join-ff69b4.svg?style=flat-square
[chat]: https://join.slack.com/t/all-contributors/shared_invite/enQtNTE3ODMyMTA4NTk0LTUwZDMxZGZkMmViMzYzYzk2YTM2NjRkZGM5Yzc0ZTc5NmYzNWY3Y2Q0ZTY3ZmFhZDgyY2E3ZmIzNWQwMTUxZmE
[build-badge]: https://img.shields.io/circleci/project/all-contributors/all-contributors-cli/master.svg?style=flat-square
[build]: https://circleci.com/gh/all-contributors/all-contributors-cli
2019-01-07 06:38:29 +00:00
[coverage-badge]: https://img.shields.io/codecov/c/github/all-contributors/all-contributors-cli.svg?style=flat-square
[coverage]: https://codecov.io/github/all-contributors/all-contributors-cli
2017-11-22 18:09:06 +00:00
[version-badge]: https://img.shields.io/npm/v/all-contributors-cli.svg?style=flat-square
[package]: https://www.npmjs.com/package/all-contributors-cli
[downloads-badge]: https://img.shields.io/npm/dm/all-contributors-cli.svg?style=flat-square
[downloads]: http://www.npmtrends.com/all-contributors-cli
[license-badge]: https://img.shields.io/npm/l/all-contributors-cli.svg?style=flat-square
2019-01-07 06:38:29 +00:00
[license]: https://github.com/all-contributors/all-contributors-cli/blob/master/other/LICENSE
2017-11-22 18:09:06 +00:00
[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
[prs]: http://makeapullrequest.com
[coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square
2019-01-07 06:38:29 +00:00
[coc]: https://github.com/all-contributors/all-contributors-cli/blob/master/other/CODE_OF_CONDUCT.md
[github-watch-badge]: https://img.shields.io/github/watchers/all-contributors/all-contributors-cli.svg?style=social
[github-watch]: https://github.com/all-contributors/all-contributors-cli/watchers
[github-star-badge]: https://img.shields.io/github/stars/all-contributors/all-contributors-cli.svg?style=social
[github-star]: https://github.com/all-contributors/all-contributors-cli/stargazers
[twitter]: https://twitter.com/intent/tweet?text=Check%20out%20all-contributors-cli!%20https://github.com/all-contributors/all-contributors-cli%20%F0%9F%91%8D
[twitter-badge]: https://img.shields.io/twitter/url/https/github.com/all-contributors/all-contributors-cli.svg?style=social
[emojis]: https://github.com/all-contributors/all-contributors#emoji-key
[all-contributors]: https://github.com/all-contributors/all-contributors