Wavyzz/python-github-backup
2
0
Fork 0
mirror of https://github.com/josegonzalez/python-github-backup.git synced 2025-12-06 00:28:01 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update README.rst to match 'github-backup -h'

Browse Source
This commit is contained in:
Tom Hoover
2020-03-22 08:48:50 -05:00
parent 85e4399408
commit a351cdc103
1 changed files with 23 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
README.rst
View File

@@ -29,19 +29,19 @@ Usage
CLI Usage is as follows:: 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] [-o OUTPUT_DIRECTORY] [-i] [--starred] [--all-starred]
[--watched] [--followers] [--following] [--all] [--watched] [--followers] [--following] [--all]
[--issues] [--issue-comments] [--issue-events] [--pulls] [--issues] [--issue-comments] [--issue-events] [--pulls]
[--pull-comments] [--pull-commits] [--labels] [--hooks] [--pull-comments] [--pull-commits] [--pull-details]
[--milestones] [--repositories] [--releases] [--assets] [--labels] [--hooks] [--milestones] [--repositories]
[--bare] [--lfs] [--wikis] [--gists] [--starred-gists] [--bare] [--lfs] [--wikis] [--gists] [--starred-gists]
[--skip-existing] [--skip-existing] [-L [LANGUAGES [LANGUAGES ...]]]
[-L [LANGUAGES [LANGUAGES ...]]] [-N NAME_REGEX] [-N NAME_REGEX] [-H GITHUB_HOST] [-O] [-R REPOSITORY]
[-H GITHUB_HOST] [-O] [-R REPOSITORY] [-P] [-F] [-P] [-F] [--prefer-ssh] [-v]
[--prefer-ssh] [-v]
[--keychain-name OSX_KEYCHAIN_ITEM_NAME] [--keychain-name OSX_KEYCHAIN_ITEM_NAME]
[--keychain-account OSX_KEYCHAIN_ITEM_ACCOUNT] [--keychain-account OSX_KEYCHAIN_ITEM_ACCOUNT]
[--releases] [--assets]
USER USER
Backup a github account Backup a github account
@@ -57,36 +57,36 @@ CLI Usage is as follows::
password for basic auth. If a username is given but password for basic auth. If a username is given but
not a password, the password will be prompted for. not a password, the password will be prompted for.
-t TOKEN, --token TOKEN -t TOKEN, --token TOKEN
personal access or OAuth token, or path to token personal access, OAuth, or JSON Web token, or path to
(file://...) token (file://...)
--as-app authenticate as github app instead of as a user.
-o OUTPUT_DIRECTORY, --output-directory OUTPUT_DIRECTORY -o OUTPUT_DIRECTORY, --output-directory OUTPUT_DIRECTORY
directory at which to backup the repositories directory at which to backup the repositories
-i, --incremental incremental backup -i, --incremental incremental backup
--starred include JSON output of starred repositories in backup --starred include JSON output of starred repositories in backup
--all-starred include starred repositories in backup --all-starred include starred repositories in backup [*]
--watched include watched repositories in backup --watched include JSON output of watched repositories in backup
--followers include JSON output of followers in backup --followers include JSON output of followers in backup
--following include JSON output of following users 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 --issues include issues in backup
--issue-comments include issue comments in backup --issue-comments include issue comments in backup
--issue-events include issue events in backup --issue-events include issue events in backup
--pulls include pull requests in backup --pulls include pull requests in backup
--pull-comments include pull request review comments in backup --pull-comments include pull request review comments in backup
--pull-commits include pull request commits in backup --pull-commits include pull request commits in backup
--pull-details include more pull request details in backup [*]
--labels include labels in backup --labels include labels in backup
--hooks include hooks in backup (works only when --hooks include hooks in backup (works only when
authenticated) authenticated)
--milestones include milestones in backup --milestones include milestones in backup
--repositories include repository clone 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 --bare clone bare repositories
--lfs clone LFS repositories (requires Git LFS to be --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 --wikis include wiki clone in backup
--gists include gists in backup --gists include gists in backup [*]
--starred-gists include starred gists in backup --starred-gists include starred gists in backup [*]
--skip-existing skip project if a backup directory exists --skip-existing skip project if a backup directory exists
-L [LANGUAGES [LANGUAGES ...]], --languages [LANGUAGES [LANGUAGES ...]] -L [LANGUAGES [LANGUAGES ...]], --languages [LANGUAGES [LANGUAGES ...]]
only allow these languages only allow these languages
@@ -97,8 +97,8 @@ CLI Usage is as follows::
-O, --organization whether or not this is an organization user -O, --organization whether or not this is an organization user
-R REPOSITORY, --repository REPOSITORY -R REPOSITORY, --repository REPOSITORY
name of repository to limit backup to name of repository to limit backup to
-P, --private include private repositories -P, --private include private repositories [*]
-F, --fork include forked repositories -F, --fork include forked repositories [*]
--prefer-ssh Clone repositories using SSH instead of HTTPS --prefer-ssh Clone repositories using SSH instead of HTTPS
-v, --version show program's version number and exit -v, --version show program's version number and exit
--keychain-name OSX_KEYCHAIN_ITEM_NAME --keychain-name OSX_KEYCHAIN_ITEM_NAME
@@ -107,6 +107,10 @@ CLI Usage is as follows::
--keychain-account OSX_KEYCHAIN_ITEM_ACCOUNT --keychain-account OSX_KEYCHAIN_ITEM_ACCOUNT
OSX ONLY: account field of password item in OSX OSX ONLY: account field of password item in OSX
keychain that holds the personal access or OAuth token 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). 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).