Skip to content
This repository has been archived by the owner on Feb 23, 2024. It is now read-only.

Commit

Permalink
add note for module
Browse files Browse the repository at this point in the history
  • Loading branch information
Mustafa Hastürk committed Nov 18, 2019
1 parent c455a88 commit e3d87ec
Showing 1 changed file with 27 additions and 15 deletions.
42 changes: 27 additions & 15 deletions README.md
Expand Up @@ -4,6 +4,9 @@
[![Python Version][Python Image]][Python]
![Project Status: Active][Project Status Image]

Clone all your Github repositories.


.--. .--. __ __ ___
.--./) |__| |__|| |/ `.' `.
/.''\ .--. .| .--.| .-. .-. '
Expand All @@ -15,28 +18,37 @@
|| || | '.'
'. __// | /
`'---' `'-'

created by "Mustafa Hasturk"

Clone all your Github repositories.

## Installation
```
pip3 install .
```
or
```
python3 setup.py install
```


### Usage
`'python -m gitim'`

Username and password will be prompted.

#### Optional Arguments
-h, --help show this help message and exit
-u USER, --user USER Your github username
-p PASSWORD, --password PASSWORD
Github password
-t TOKEN, --token TOKEN
Github OAuth token
-o ORG, --org ORG Organisation/team. User used by default.
-d DEST, --dest DEST Destination directory. Created if doesn't exist.
[curr_dir]
--nopull Don't pull if repository exists. [false]
```
-h, --help show this help message and exit
-u USER, --user USER Your github username
-p PASSWORD, --password PASSWORD
Github password
-t TOKEN, --token TOKEN
Github OAuth token
-o ORG, --org ORG Organisation/team. User used by default.
-d DEST, --dest DEST Destination directory. Created if doesn't exist.
[curr_dir]
--nopull Don't pull if repository exists. [false]
--shallow Perform shallow clone. [false]
--ssh Use ssh+git urls for checkout. [false]
```

##### Licence
MIT
Expand Down

0 comments on commit e3d87ec

Please sign in to comment.