githubsearch

README

githubsearch

Introduction

GitHub Search is a GitHub search tool written in Go.

Feature

GitHub Search supports:

• GitHub GraphQL API v4

• GitHub REST API v3

  • Search on GitHub
  • Search Query
  • License Type

Usage

usage: githubsearch --api=API --config=CONFIG --output=OUTPUT --qualifier=QUALIFIER --search=SEARCH [<flags>]

GitHub Search

Flags:
      --help                 Show context-sensitive help (also try --help-long
                             and --help-man).
      --version              Show application version.
  -a, --api=API              API type, format: graphql or rest
  -c, --config=CONFIG        Config file, format: .json
  -o, --output=OUTPUT        Output file, format: .json
  -q, --qualifier=QUALIFIER  Qualifier list, format:
                             {qualifier}:{query},{qualifier}:{query},...
  -s, --search=SEARCH        Search list, format: code:{text} or repo:{text}

-q/--qualifier: See "Searching on GitHub" for a complete list of available qualifiers, their format, and an example of how to use them.

Setting

GitHub Search parameters can be set in the directory config.

An example of configuration in search.json:

{
  "rest": {
    "order": "desc",
    "page": 2,
    "per_page": 10,
    "sort": "stars"
  }
}

Running

githubsearch \
  --api="rest" \
  --config="config/search.json" \
  --output="output.json" \
  --qualifier="in:file,language:go,repo:githubsearch,user:craftslab" \
  --search="code:runSearch"

githubsearch \
  --api="rest" \
  --config="config/search.json" \
  --output="output.json" \
  --qualifier="language:go,user:craftslab" \
  --search="repo:githubsearch"

License

Project License can be found here.