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:

   npm

   npm i -D all-contributors-cli

   pnpm

   pnpm add -D all-contributors-cli

   Yarn

   yarn add -D all-contributors-cli

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

   Tip

   The CLI is Node-based, if you don’t wish to add a Node dependency use the @all-contributors bot 🤖

2. Initialize the Project

   Init the project using init and answer a few questions

   npm

   npx all-contributors init

   pnpm

   pnpm all-contributors init

   Yarn

   yarn all-contributors init

   Execute bin

   ./node_modules/.bin/all-contributors init

3. Add some contributors

   npm

   npx all-contributors add jfmengels doc
   npx all-contributors generate

   pnpm

   pnpm all-contributors add jfmengels doc
   pnpm all-contributors generate

   Yarn

   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:

   package.json

   {
       "scripts": {
           "contributors:add": "all-contributors add",
           "contributors:generate": "all-contributors generate"
       }
   }

   To support shortcuts such as:

   npm

   npx contributors:add jfmengels doc

   pnpm

   pnpm contributors:add jfmengels doc

   Yarn

   yarn contributors:add jfmengels doc