CLI Installation
1. Install the CLI tool
This module is distributed via npm which is bundled with node and
should be installed as one of your project's devDependencies:
yarn add --dev all-contributors-cli # or npm i -D all-contributors-cli
Alternatively, Arch Linux users can install the all-contributors-cli package from the AUR.
The CLI is node-based, if you don't wish to add a node dependency use the @all-contributors bot 🤖
2. Init the Project
Init the project using init and answer a few questions
yarn all-contributors init # or npx all-contributors init
# Or directly execute the bin
./node_modules/.bin/all-contributors init
3. Add some contributors
yarn all-contributors add jfmengels doc
yarn all-contributors generate
For more on the commands see CLI usage
4. Update your Contributing documentation
Consider updating your CONTRIBUTING.md or similar with steps on how your contributors can add themselves. You can even link to the cli usage documentation.
5. Optionally add shortcut scripts to your package.json
You can optionally add shortcuts to your commands in your package.json scripts field.
For example:
{
"scripts": {
"contributors:add": "all-contributors add",
"contributors:generate": "all-contributors generate"
}
}
To allow shortcuts such as
yarn contributors:add jfmengels doc