/github-aus-check0r

Image for bulk checkout of github repositories

Primary LanguageShellCreative Commons Zero v1.0 UniversalCC0-1.0

Github - Auscheck0r

Build Codacy Badge Known Vulnerabilities

A simple tool for checking out all Github repositories of an organisation or an user.

Usage

$ docker run -ti \
             --rm=true  \
             -e GITHUB_USERNAME=koenighotze \
             -e GITHUB_TOKEN=<GITHUB API TOKEN> \
             -e ENTRYPOINT=<ENTRYPOINT> \
             -v <TARGET DIRECTORY>:/home/auscheckor/target \
             koenighotze/github-auscheck0r
  • GITHUB_USERNAME: The username for accessing the Github API, e.g. koenighotze
  • GITHUB_TOKEN: The authentication token for using the Github API, e.g. c497615529f89...
  • ENTRYPOINT: The entrypoint for checking out repositories. Either user-based, e.g. users/koenighotze or an organisation e.g. orgs/google.
  • TARGET DIRECTORY: /home/auscheckor/target should be mounted to a local directory for storing the checked-out files, e.g. /home/koenighotze/dev/

For example:

$ docker run \
      -ti
      --rm=true  \
      -e GITHUB_USERNAME=koenighotze \
      -e GITHUB_TOKEN=c497615529f89... \
      -e TARGET_DIR=./checkout \
      -e ENTRYPOINT=users/koenighotze \
      -v `pwd`/target:/home/auscheckor/checkout \
      koenighotze/github-auscheck0r

This checks-out all repository from user koenighotze to the local directory target.