From 0c39df4af2cf9a909943a5c753ed0ddc0b4d63b3 Mon Sep 17 00:00:00 2001 From: Gianni Furger Date: Tue, 29 Aug 2017 13:22:47 +0200 Subject: [PATCH] updated docs --- README.markdown | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/README.markdown b/README.markdown index daff30a..44af626 100644 --- a/README.markdown +++ b/README.markdown @@ -22,7 +22,7 @@ Installation is simple with Usage ----- ```` -usage: github-backup.py [-h] [-c] [-m] [-g ARGS] [-s SUFFIX] +usage: github-backup.py [-h] [-c] [-m] [-f] [-g ARGS] [-o ORGANIZATION] [-p PASSWORD] [-P PREFIX] [-s SUFFIX] [-S] [-t TOKEN] username backupdir makes a backup of all of a github user's repositories @@ -32,13 +32,23 @@ positional arguments: backupdir The folder where you want your backups to go optional arguments: - -h, --help show this help message and exit + -h, --help Show this help message and exit -c, --cron Use this when running from a cron job -m, --mirror Create a bare mirror -f, --skip-forks Skip forks -g ARGS, --git ARGS Pass extra arguments to git + -o ORGANIZATION, --organization ORGANIZATION + Backup Organizational repositories + -p PASSWORD, --password PASSWORD + Authenticate with Github API + -P PREFIX, --prefix PREFIX + Add prefix to repository directory names -s SUFFIX, --suffix SUFFIX Add suffix to repository directory names + -S, --ssh Use SSH protocol + -t TOKEN, --token TOKEN + Authenticate with Github API using OAuth token + ```` Then, put it in a cron job somewhere and forget about it for eternity.