This usage documentation assumes you have already followed the cli installation steps.
A quick note: Below we'll just show
all-contributors to keep things simple, but if you're having any difficulties, then give the
yarn all-contributors route a try 😺
Run this when you first start using the all-contributors-cli. This command asks a few questions and sets up the project for all-contributors.
This setup includes creating a
.all-contributorsrc configuration file and creating a contributor table in the
files you specify (usually your
add to add new contributors to your project, or add new ways in which they
have contributed. They will be added to your configuration file, and the
contributors file will be updated just as if you used the generate command.
Add new contributor <username>, who made a contribution of type <contribution> all-contributors add <username> <contribution> Example: all-contributors add jfmengels code,doc
username is the user's GitHub or Gitlab username, and
contribution is a
,-separated list of contributions. See the Emoji Key (Contribution Types Reference)
for a list of valid
GitLab Users: See the additional requirements for GitLab users
check to compare contributors from GitHub with the ones credited in your
.all-contributorsrc file, in order to make sure that credit is given where
Due to GitHub API restrictions, this command only works for projects with less than 500 contributors (Unless you set a
PRIVATE_TOKENas mentioned below in GitHub users).
generate to read the
contributors list from your
and update the contributor tables specified by the
Please note the command must be able to find the following tags in those files, in order to update the table:
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> <!-- ALL-CONTRIBUTORS-LIST:END -->
Also note that it needs to find the following tags in order to update the badge:
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --> <!-- ALL-CONTRIBUTORS-BADGE:END -->
In some cases you may see the error message
GitHub API rate limit exceeded for xxx. You may need to set an environment variable named
PRIVATE_TOKEN in order to circumvent this GitHub rate limit.
Private token is your personal access token to authenticate with the GitHub API.
Please note that if you are using a self-hosted gitlab instance,
some commands will need you to set an environment variable named
Private token is the personal access token to authenticate with the GitLab API.
set private token on Linux export PRIVATE_TOKEN=your_private_token set private token on Windows set PRIVATE_TOKEN=your_private_token