kherge/github-archive

Archives repositories owned by a GitHub user.

1.0.1 2017-06-05 01:35 UTC

README

Archives owned repositories.

Usage

$ gh-archive -h
Usage:
  archive [options] [--] [<dir>]

Arguments:
  dir                      Th path to the archive directory [default: "archive"]

Options:
      --https              Use HTTPS to archive new repositories?
  -p, --password=PASSWORD  The GitHub password or personal access token
      --ssh                Use SSH to archive new repositories?
  -u, --username=USERNAME  The GitHub username
  -h, --help               Display this help message
  -q, --quiet              Do not output any message
  -V, --version            Display this application version
      --ansi               Force ANSI output
      --no-ansi            Disable ANSI output
  -n, --no-interaction     Do not ask any interactive question
  -v|vv|vvv, --verbose     Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Help:
  The archive command will query GitHub's (v3) API for a list of repositories
  owned by the user. Once the list has been acquired, all of the repositories
  will be cloned or updated in a specific directory.

  ENVIRONMENT

  Instead of passing the GitHub username and password as command line options,
  you may instead define a couple of environment variables to pass long that
  information.

      GITHUB_USERNAME  The GitHub username.
      GITHUB_PASSWORD  The GitHub password or personal access token.

Requirements

  • PHP 7.1+
  • Git

License

This project is dual licensed under the MIT and Apache 2.0 licenses.