Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nicokosi/gh-collab-scanner

🔎 A GitHub CLI extension that displays collaboration-related information about a GitHub repository.
https://github.com/nicokosi/gh-collab-scanner

cli collaboration gh-extension github github-extension

Last synced: 3 months ago
JSON representation

🔎 A GitHub CLI extension that displays collaboration-related information about a GitHub repository.

Host: GitHub
URL: https://github.com/nicokosi/gh-collab-scanner
Owner: nicokosi
Created: 2022-02-21T06:28:58.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2024-07-28T13:33:28.000Z (3 months ago)
Last Synced: 2024-07-28T14:55:36.833Z (3 months ago)
Topics: cli, collaboration, gh-extension, github, github-extension
Language: Go
Homepage:
Size: 57.6 KB
Stars: 6
Watchers: 4
Forks: 0
Open Issues: 2
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

awesome-gh-cli-extensions - **collab-scanner** - Extension that displays collaboration-related information about a repository. (Tool)

README

# `collab-scanner` GitHub CLI extension

A [GitHub CLI extension](https://docs.github.com/en/github-cli/github-cli/using-github-cli-extensions) that displays collaboration-related information on repositories.

![collab-scanner](https://user-images.githubusercontent.com/3862051/157172870-0d50c1b8-d238-4227-ad86-d12855303e13.gif)

## Install ⬇️

```sh
gh extension install nicokosi/gh-collab-scanner
```

## Use ▶️

From a folder where a GitHub repository has been cloned:

```sh
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:

```sh
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:

```sh
gh collab-scanner --org python
```

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

```sh
gh collab-scanner --user torvalds
```

Need help? Run:

```sh
gh-collab-scanner --help
```

## Develop 🧑‍💻

Requires Go 1.18 or later.

### Build from source code 🧑‍💻▶️

Build then run:

```sh
go build && ./gh-collab-scanner
```

### Install from source code 🧑‍💻⏺

Install and run:

```sh
gh extension install .; gh collab-scanner
```

### Examine code 🧑‍💻🔍

```sh
go vet
```

### Run tests 🧑‍💻☑️

```sh
go test -v -cover
```

### Release 🧑‍💻📦

Check the current version:

```sh
gh release view | head -n 2
```

Then create a tag for the next version with respect with [semver](https://semver.org):

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