Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/andyfeller/gh-montage
GitHub CLI extension to generate montage from GitHub user avatars
https://github.com/andyfeller/gh-montage
gh-extension
Last synced: about 2 months ago
JSON representation
GitHub CLI extension to generate montage from GitHub user avatars
- Host: GitHub
- URL: https://github.com/andyfeller/gh-montage
- Owner: andyfeller
- License: unlicense
- Created: 2022-08-20T20:36:27.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-01T17:58:30.000Z (about 1 year ago)
- Last Synced: 2024-07-30T18:44:14.058Z (6 months ago)
- Topics: gh-extension
- Language: Shell
- Homepage:
- Size: 22.5 KB
- Stars: 47
- Watchers: 2
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# gh-montage
A `gh` extension to generate GitHub user avatar montage from an organization or organization team.
I must give thanks to [@martinwoodward](https://github.com/martinwoodward) because [his gist](https://gist.github.com/martinwoodward/288812fa142e0b1153f60b9555b3d978) was the foundation for this extension! Thank you so much, Martin, for finding creative and clever ways to showcase GitHub users! :bow:
## Quickstart
1. Download and install [ImageMagick][imagemagick] 7.1.0 or newer
- [Linux][imagemagick-download-linux]
- [Mac OS][imagemagick-download-macos]
- [Windows][imagemagick-download-windows]
1. `gh extension install andyfeller/gh-montage`
1. `gh montage `
1. Profit! :moneybag: :money_with_wings: :money_mouth_face: :money_with_wings: :moneybag:
## 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.
```shell
$ gh montage --help
Generate montage from GitHub user avatars.
USAGE
gh montage [options]
gh montage [options] /
gh montage [options]
FLAGS
-a, --avatar-pixels 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 Width of GitHub montage in number of avatar icons; default '58'
-o, --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**
```shell
gh extension install andyfeller/gh-montage
```
_For more information: [`gh extension install`](https://cli.github.com/manual/gh_extension_install)_
- **Upgrade**
```shell
gh extension upgrade gh-montage
```
_For more information: [`gh extension upgrade`](https://cli.github.com/manual/gh_extension_upgrade)_
[ImageMagick][imagemagick] 7.1.0-45 was used at the time of development and is likely the most involved depending on your operating system:
- [Linux][imagemagick-download-linux]
- [Mac OS][imagemagick-download-macos]
- [Windows][imagemagick-download-windows]
[imagemagick]: https://imagemagick.org
[imagemagick-download-linux]: https://imagemagick.org/script/download.php#linux
[imagemagick-download-macos]: https://imagemagick.org/script/download.php#macosx
[imagemagick-download-windows]: https://imagemagick.org/script/download.php#windows