Skip to content

Commit 0f21d7b

Browse files
committed
add couple examples to help new users
1 parent cb33b9b commit 0f21d7b

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

README.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,3 +114,20 @@ Note: When you run github-backup, you will be asked whether you want to allow "
114114

115115
1. **Allow:** In this case you will need to click "Allow" each time you run `github-backup`
116116
2. **Always Allow:** In this case, you will not be asked for permission when you run `github-backup` in future. This is less secure, but is required if you want to schedule `github-backup` to run automatically
117+
118+
Examples
119+
========
120+
121+
Backup all repositories::
122+
123+
export ACCESS_TOKEN=SOME-GITHUB-TOKEN
124+
github-backup WhiteHouse --token $ACCESS_TOKEN --organization --output-directory /tmp/white-house --repositories
125+
126+
Backup a single organization repository with everything else (wiki, pull requests, comments, issues etc)::
127+
128+
export ACCESS_TOKEN=SOME-GITHUB-TOKEN
129+
ORGANIZATION=docker
130+
REPO=cli
131+
# e.g. [email protected]:docker/cli.git
132+
github-backup $ORGANIZATION -P -t $ACCESS_TOKEN -o . --all -O -R $REPO
133+

0 commit comments

Comments
 (0)