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

Update README with new CLI usage

Browse Source
This commit is contained in:
Alex Hall
2016-01-12 14:40:29 +02:00
parent 325f77dcd9
commit 675484a215
1 changed files with 13 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
README.rst
View File

@@ -23,15 +23,14 @@ CLI Usage is as follows::
Github Backup [-h] [-u USERNAME] [-p PASSWORD] [-t TOKEN] Github Backup [-h] [-u USERNAME] [-p PASSWORD] [-t TOKEN]
[-o OUTPUT_DIRECTORY] [--starred] [--watched] [--all] [-o OUTPUT_DIRECTORY] [--starred] [--watched] [--all]
[--issues] [--issue-comments] [--issue-events] [--pulls] [--issues] [--issue-comments] [--issue-events] [--pulls]
[--pull-comments] [--pull-commits] [--repositories] [--pull-comments] [--pull-commits] [--labels] [--hooks]
[--wikis] [--labels] [--hooks] [--skip-existing] [--milestones] [--repositories] [--wikis]
[-L [LANGUAGES [LANGUAGES ...]]] [-N NAME_REGEX] [--skip-existing] [-L [LANGUAGES [LANGUAGES ...]]]
[-H GITHUB_HOST] [-O] [-R REPOSITORY] [-P] [-F] [-N NAME_REGEX] [-H GITHUB_HOST] [-O] [-R REPOSITORY]
[--prefer-ssh] [-v] [-P] [-F] [--prefer-ssh] [-v]
USER USER
Backup a github account
Backup a github users account
positional arguments: positional arguments:
USER github username USER github username
@@ -41,7 +40,8 @@ CLI Usage is as follows::
-u USERNAME, --username USERNAME -u USERNAME, --username USERNAME
username for basic auth username for basic auth
-p PASSWORD, --password PASSWORD -p PASSWORD, --password PASSWORD
password for basic auth password for basic auth. If a username is given but
not a password, the password will be prompted for.
-t TOKEN, --token TOKEN -t TOKEN, --token TOKEN
personal access or OAuth token personal access or OAuth token
-o OUTPUT_DIRECTORY, --output-directory OUTPUT_DIRECTORY -o OUTPUT_DIRECTORY, --output-directory OUTPUT_DIRECTORY
@@ -55,10 +55,12 @@ CLI Usage is as follows::
--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
--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 --repositories include repository clone in backup
--wikis include wiki clone in backup --wikis include wiki clone in backup
--labels include labels in backup
--hooks include web hooks in backup (works only when authenticated)
--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
@@ -66,7 +68,7 @@ CLI Usage is as follows::
python regex to match names against python regex to match names against
-H GITHUB_HOST, --github-host GITHUB_HOST -H GITHUB_HOST, --github-host GITHUB_HOST
GitHub Enterprise hostname GitHub Enterprise hostname
-O, --organization whether or not this is a query for an organization -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