From a351cdc1034def0042810b8ef63f68861970fc16 Mon Sep 17 00:00:00 2001 From: Tom Hoover Date: Sun, 22 Mar 2020 08:48:50 -0500 Subject: [PATCH] Update README.rst to match 'github-backup -h' --- README.rst | 42 +++++++++++++++++++++++------------------- 1 file changed, 23 insertions(+), 19 deletions(-) diff --git a/README.rst b/README.rst index 12c50f9..701ab32 100644 --- a/README.rst +++ b/README.rst @@ -29,19 +29,19 @@ Usage CLI Usage is as follows:: - github-backup [-h] [-u USERNAME] [-p PASSWORD] [-t TOKEN] + github-backup [-h] [-u USERNAME] [-p PASSWORD] [-t TOKEN] [--as-app] [-o OUTPUT_DIRECTORY] [-i] [--starred] [--all-starred] [--watched] [--followers] [--following] [--all] [--issues] [--issue-comments] [--issue-events] [--pulls] - [--pull-comments] [--pull-commits] [--labels] [--hooks] - [--milestones] [--repositories] [--releases] [--assets] + [--pull-comments] [--pull-commits] [--pull-details] + [--labels] [--hooks] [--milestones] [--repositories] [--bare] [--lfs] [--wikis] [--gists] [--starred-gists] - [--skip-existing] - [-L [LANGUAGES [LANGUAGES ...]]] [-N NAME_REGEX] - [-H GITHUB_HOST] [-O] [-R REPOSITORY] [-P] [-F] - [--prefer-ssh] [-v] + [--skip-existing] [-L [LANGUAGES [LANGUAGES ...]]] + [-N NAME_REGEX] [-H GITHUB_HOST] [-O] [-R REPOSITORY] + [-P] [-F] [--prefer-ssh] [-v] [--keychain-name OSX_KEYCHAIN_ITEM_NAME] [--keychain-account OSX_KEYCHAIN_ITEM_ACCOUNT] + [--releases] [--assets] USER Backup a github account @@ -57,36 +57,36 @@ CLI Usage is as follows:: password for basic auth. If a username is given but not a password, the password will be prompted for. -t TOKEN, --token TOKEN - personal access or OAuth token, or path to token - (file://...) + personal access, OAuth, or JSON Web token, or path to + token (file://...) + --as-app authenticate as github app instead of as a user. -o OUTPUT_DIRECTORY, --output-directory OUTPUT_DIRECTORY directory at which to backup the repositories -i, --incremental incremental backup --starred include JSON output of starred repositories in backup - --all-starred include starred repositories in backup - --watched include watched repositories in backup + --all-starred include starred repositories in backup [*] + --watched include JSON output of watched repositories in backup --followers include JSON output of followers in backup --following include JSON output of following users in backup - --all include everything in backup + --all include everything in backup (not including [*]) --issues include issues in backup --issue-comments include issue comments in backup --issue-events include issue events in backup --pulls include pull requests in backup --pull-comments include pull request review comments in backup --pull-commits include pull request commits in backup + --pull-details include more pull request details in backup [*] --labels include labels in backup --hooks include hooks in backup (works only when authenticated) --milestones include milestones in backup --repositories include repository clone in backup - --releases include repository releases' information without assets or binaries - --assets include assets alongside release information; only applies if including releases --bare clone bare repositories --lfs clone LFS repositories (requires Git LFS to be - installed, https://git-lfs.github.com) + installed, https://git-lfs.github.com) [*] --wikis include wiki clone in backup - --gists include gists in backup - --starred-gists include starred gists in backup + --gists include gists in backup [*] + --starred-gists include starred gists in backup [*] --skip-existing skip project if a backup directory exists -L [LANGUAGES [LANGUAGES ...]], --languages [LANGUAGES [LANGUAGES ...]] only allow these languages @@ -97,8 +97,8 @@ CLI Usage is as follows:: -O, --organization whether or not this is an organization user -R REPOSITORY, --repository REPOSITORY name of repository to limit backup to - -P, --private include private repositories - -F, --fork include forked repositories + -P, --private include private repositories [*] + -F, --fork include forked repositories [*] --prefer-ssh Clone repositories using SSH instead of HTTPS -v, --version show program's version number and exit --keychain-name OSX_KEYCHAIN_ITEM_NAME @@ -107,6 +107,10 @@ CLI Usage is as follows:: --keychain-account OSX_KEYCHAIN_ITEM_ACCOUNT OSX ONLY: account field of password item in OSX keychain that holds the personal access or OAuth token + --releases include release information, not including assets or + binaries + --assets include assets alongside release information; only + applies if including releases The package can be used to backup an *entire* organization or repository, including issues and wikis in the most appropriate format (clones for wikis, json files for issues).