gh-find

gh-find

Walk file hierarchies across GitHub repositories.

Installation

cd
GO111MODULE=on go get github.com/pmatseykanets/gh-tools/cmd/gh-find@latest

Usage

Usage: gh-find [flags] [owner][/repo]
  owner         Repository owner (user or organization)
  repo          Repository name

Flags:
  -archived          Include archived repositories
  -help, h           Print this information and exit
  -branch=           The branch name if different from the default
  -grep=             The pattern to match the file contents. Implies
                      -type f
  -list-details      List details (file type, author, size, last commit date)
  -max-depth         Descend at most n directory levels
  -max-grep-results= Limit the number of grep results
  -max-repo-results= Limit the number of matched entries per repository
  -max-results=      Limit the number of matched entries
  -min-depth=        Descend at least n directory levels
  -name=             The pattern to match the last component of the pathname
  -no-fork           Don't include fork repositories
  -no-grep=          The pattern to reject the file contents. Implies
                       -type f
  -no-matches        List repositories with no matches. Implies
                       -max-results 0
                       -max-grep-results 1
                       -max-repo-results 1
  -no-name=          The pattern to reject the last component of the pathname
  -no-path=          The pattern to reject the pathname
  -no-private        Don't include private repositories
  -no-public         Don't include public repositories
  -path=             The pattern to match the pathname
  -no-repo=          The pattern to reject repository names
  -repo=             The pattern to match repository names
  -size=             Limit results based on the file size [+-]<d><u>
  -token             Prompt for an Access Token
  -type=             The entry type f - file, d - directory
  -version           Print the version and exit

Environment variables

GHTOOLS_TOKEN and GITHUB_TOKEN in the order of precedence can be used to set a GitHub access token.

Examples

List all files in the default branch of the golang/go repository:

gh-find golang/go

List all files in the release-branch.go1.15 branch of the golang/go repository:

gh-find -branch 'release-branch.go1.15' golang/go

List all files in all repositories in the golang GitHub organization:

gh-find golang

List all README and LICENSE files in all repositories in the golang GitHub organization but skip the ones in the vendor directories:

gh-find -name '^README$' -name '^LICENSE$' -no-path '^vendor/' -no-path '^src/vendor/' golang

List README files in the root directories of all repositories in the golang GitHub organization:

gh-find -name '^README$' -max-depth 1 golang

List all LICENSE files repositories which name starts with go in the golang GitHub organization:

gh-find -name '^LICENSE$' -repo '^go' golang

Find all go.mod files containing golang.org/x/sync in all repositories in the golang GitHub organization:

gh-find -name '^go.mod$' -grep 'golang.org/x/sync' golang