gh-montage

A gh extension to generate GitHub user avatar montage from an organization or organization team.

I must give thanks to @martinwoodward because his gist was the foundation for this extension! Thank you so much, Martin, for finding creative and clever ways to showcase GitHub users! 🙇

Quickstart

1. Download and install ImageMagick 7.1.0 or newer
   • Linux
   • Mac OS
   • Windows
2. gh extension install andyfeller/gh-montage
3. gh montage <organization>
4. Profit! 💰 💸 🤑 💸 💰

Usage

Note Processing username files assumes 1 username per line and will fail if any username is invalid. This is because gh-montage is not retrieving usernames from GitHub API before processing them.

$ gh montage --help

Generate montage from GitHub user avatars.

USAGE
  gh montage [options] <organization>
  gh montage [options] <organization>/<team>
  gh montage [options] <path/to/username file>

FLAGS
  -a, --avatar-pixels <integer>       Size of GitHub avatar icons in pixels; default '48'
  -d, --debug                         Enable debugging
  -f, --force                         Whether to overwrite output file if it exists
  -h, --help                          Displays help usage
  -m, --montage-width <integer>       Width of GitHub montage in number of avatar icons; default '58'
  -o, --output-file <output-file>     Name of GitHub montage file to generate, without '.jpg' extension
  -p, --preserve                      Preserve temporary directory containing data

Setup

Like any other gh CLI extension, gh-montage is trivial to install or upgrade and works on most operating systems:

• Installation

  gh extension install andyfeller/gh-montage

  For more information: gh extension install

• Upgrade

  gh extension upgrade gh-montage

  For more information: gh extension upgrade

ImageMagick 7.1.0-45 was used at the time of development and is likely the most involved depending on your operating system:

• Linux
• Mac OS
• Windows