README.md

collab-scanner GitHub CLI extension

A GitHub CLI extension that displays collaboration-related information on repositories.

Install ⬇️

gh extension install nicokosi/gh-collab-scanner

Use ▶️

From a folder where a GitHub repository has been cloned:

gh collab-scanner

will display something like:

(current repo) Repo nicokosi/gh-collab-scanner has: description ☑️, README ☑️, topics ☑️, 1 collaborator 👤, community profile score: 33 💯

For any GitHub repository, via its full name ${org}/${repo} (i.e. python/peps), use the --repo flag:

gh collab-scanner --repo python/peps

It will display something like:

Repo python/peps has: description ☑️, README ☑️, no topics 😇, community profile score: 71 💯

In order to scan all repositories for a given organization, use the --org flag:

gh collab-scanner --org python

In order to scan all repositories for a given user, use the --user flag:

gh collab-scanner --user torvalds

Need help? Run:

gh-collab-scanner --help

Develop 🧑‍💻

Requires Go 1.18 or later.

Build from source code 🧑‍💻▶️

Build then run:

go build && ./gh-collab-scanner

Install from source code 🧑‍💻⏺

Install and run:

gh extension install .; gh collab-scanner

Examine code 🧑‍💻🔍

go vet

Run tests 🧑‍💻☑️

go test -v -cover

Release 🧑‍💻📦

Check the current version:

gh release view | head -n 2

Then create a tag for the next version with respect with semver:

git tag ${version}
git push origin ${version}