Skip to content
All Contributors

CLI Installation

This guide explains how you can add the Command Line Interface to your project.

  1. How to Install the All Contributors CLI tool

    The all-contributors CLI module is distributed via npm which is bundled with node and should be installed as one of your project’s devDependencies.

    To install it run:

    Terminal window
    npm i -D all-contributors-cli

    Alternatively, Arch Linux users can install the all-contributors-cli package from the AUR.

  2. Initialize the Project

    Run init and answer a few questions. The command creates an .all-contributorsrc file in the root of your project.

    Terminal window
    npx all-contributors init

    A typical session looks like this:

    ? What's the name of the repository? all-contributors
    ? Who is the owner of the repository? all-contributors
    ? What is the repository type? GitHub
    ? Where is the repository hosted? Hit Enter if it's on GitHub or GitLab https://github.com
    ? In which file should contributors be listed? README.md
    ? Do you want a badge tallying the number of contributors? Yes
    ? In which file should the badge be shown? README.md
    ? How big should the avatars be? (in px) 100
    ? Do you want this badge to auto-commit when contributors are added? Yes
    ? What commit convention would you want it to use? Angular
    ? Do you want to add a footer with link to usage? Yes

  3. Add some contributors

    Terminal window
    npx all-contributors add jfmengels doc
    npx 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:

    package.json
    {
        "scripts": {
            "contributors:add": "all-contributors add",
            "contributors:generate": "all-contributors generate"
        }
    }

    To support shortcuts such as:

    Terminal window
    npx contributors:add jfmengels doc