GitHub Community Wall

Connect to GitHub

Configure a GitHub token in your environment. TheGITHUB_TOKEN variable lets you query the API without including credentials directly in commands.

export GITHUB_TOKEN=github_pat_...

Replace the example value with your token. The required permissions depend on the source; sponsors require access to the authenticated maintainer's sponsorship data.

Your first wall

To show the people who contribute to a repository, usecontributors followed by owner/repository. Choose an output file and limit the number of avatars.

npx github-community-wall contributors owner/repository \
  --output community-wall.png \
  --limit 100

Replace owner/repository with your repository. You will getcommunity-wall.png in the directory where you ran the command: an image ready to publish.

Contributor walls exclude bots by default. You can adjust the filters to decide who appears.

Choose your community

Every community has different ways to participate. In addition to contributors, you can generate walls for followers, sponsors, stargazers, watchers, and organization members.

Use a user for followers and sponsors, a repository for contributors, stargazers, andwatchers, or an organization for members.

npx github-community-wall followers octocat
npx github-community-wall members organization

Make it yours

Customize the theme, background, avatar shape, and spacing. Add titles, subtitles, or a watermark to tailor the result to your project.

PNG is the default format. You can also export to JPEG, WebP, SVG, HTML, or JSON. HTML generates a standalone file; JSON includes avatar and design metadata.

npx github-community-wall contributors owner/repository \
  --theme github-light \
  --shape circle \
  --format svg \
  --output community-wall.svg

If you use the same options repeatedly, save them in.community-wall.json. Commands read this file from the current directory, and terminal options take precedence.

npx github-community-wall config init

Share and automate

Include the wall in your README, share it on your website, or use it in a post. The --twitter-banner option generates a1500 × 500 follower banner for X.

npx github-community-wall followers octocat \
  --twitter-banner \
  --output followers-banner.png

The readme command updates the wall block between its markers. If they do not exist, it adds the block to the document.

npx github-community-wall readme contributors owner/repository \
  --output assets/contributors.png \
  --theme github-light

To keep the image up to date, you can run the tool on a schedule with GitHub Actions. The repository includes an example workflow that generates and saves the walls.