Using the All Contributors CLI

Dica

These examples run the CLI without installing it by using npx, pnpm dlx, or yarn dlx. If you prefer to add it to your project, follow the CLI installation steps.

All Contributors command line interface commands

You will mostly use four commands:

Command	What it does
init	Prepare a project to use the CLI
add	Add a contributor or update their contribution types
check	Find contributors who are not yet acknowledged
generate	Regenerate the contributor tables and badge

all-contributors init

You can run all-contributors init when you first start using the All Contributors CLI. This command asks you a few questions and then sets up the project to support All Contributors.

npm

npx all-contributors init

pnpm

pnpm dlx all-contributors init

Yarn

yarn dlx all-contributors init

The setup includes creating:

• an .all-contributorsrc configuration file and
• a contributor table in the files you specify.

The default file for the contributor table is your README.md.

all-contributors add

Use the add command to add:

• new contributors to your project, or
• new ways in which they have contributed.

If you run add without a username, the CLI asks who to add and which contribution types to record.

npx all-contributors add
? What is the contributor's GitHub username? lwasser
? What are the contribution types? 💻  Code, 📖  Documentation

If you pass a username and one or more contribution types, the CLI adds that person without those prompts. For instance, someone may already be credited for code, and you later want to credit a documentation pull request too. The contributor is updated in your configuration file, and the contributors file is updated just as if you used the generate command.

npm

# Add new contributor <username>, who made a contribution of type <contribution>
npx all-contributors add <username> <contribution>
# Example:
npx all-contributors add jfmengels code,doc

pnpm

# Add new contributor <username>, who made a contribution of type <contribution>
pnpm dlx all-contributors add <username> <contribution>
# Example:
pnpm dlx all-contributors add jfmengels code,doc

Yarn

# Add new contributor <username>, who made a contribution of type <contribution>
yarn dlx all-contributors add <username> <contribution>
# Example:
yarn dlx all-contributors add jfmengels code,doc

Where 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 contribution types.

Dica

GitLab Users: See the additional requirements for GitLab users

all-contributors check

Use check to compare people who have commits on GitHub or GitLab with the ones credited in your .all-contributorsrc file.

The command prints two lists when it finds a mismatch: people who have commits but are missing from .all-contributorsrc, and people credited for code or tests who have no matching commits.

Missing contributors in .all-contributorsrc:
octocat

Unknown contributors found in .all-contributorsrc:
ghost

Nota

Due to GitHub API restrictions, this command only works for projects with less than 500 contributors (Unless you set a PRIVATE_TOKEN as mentioned below in GitHub users).

npm

npx all-contributors check

pnpm

pnpm dlx all-contributors check

Yarn

yarn dlx all-contributors check

all-contributors generate

Use generate to read the contributors list from your .all-contributorsrc file and update the contributor tables specified by the files key.

npm

npx all-contributors generate

pnpm

pnpm dlx all-contributors generate

Yarn

yarn dlx all-contributors generate

Note que o comando deve ser capaz de encontrar as seguintes tags nesses arquivos, para atualizar a tabela:

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- ALL-CONTRIBUTORS-LIST:END -->

Além disso, note que é necessário encontrar as seguintes tags para atualizar o emblema:

<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
<!-- ALL-CONTRIBUTORS-BADGE:END -->

Usuários do GitHub

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 to circumvent this GitHub rate limit.

O token privado é seu Token de Acesso Pessoal (PAT) para autenticar com a API do GitHub.

Usuários do GitLab

Please note that if you are using a self-hosted GitLab instance, If you are using a private repository, a self-hosted GitLab instance, or encounter rate limits on GitLab.com, set an environment variable named PRIVATE_TOKEN.

Dica

PRIVATE_TOKEN é o seu token de acesso para autenticação com a API do GitLab.

# definindo o token privado no Linux
export PRIVATE_TOKEN=seu_token_privado
# definindo o token privado no Windows
set PRIVATE_TOKEN=seu_token_privado