diff --git a/README.md b/README.md index 644ccd9..dfcfb56 100644 --- a/README.md +++ b/README.md @@ -4,69 +4,75 @@ ![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/rly0nheart/octosuite?style=for-the-badge&logo=github) ![OS](https://img.shields.io/badge/OS-GNU%2FLinux-red?style=for-the-badge&logo=Linux) ![OS](https://img.shields.io/badge/OS-Windows-blue?style=for-the-badge&logo=Windows) +![OS](https://img.shields.io/badge/OS-Mac-blue?style=for-the-badge&logo=apple) ![GitHub](https://img.shields.io/github/license/rly0nheart/octosuite?style=for-the-badge&logo=github) -![Lines of code](https://img.shields.io/tokei/lines/github/rly0nheart/octosuite?style=for-the-badge&logo=github) ![GitHub repo size](https://img.shields.io/github/repo-size/rly0nheart/octosuite?style=for-the-badge&logo=github) > *Simply gather OSINT on Github users and organizations like a god🔥* + # INSTALLATION **clone project**: ``` -$ git clone https://github.com/rly0nheart/octosuite.git +git clone https://github.com/rly0nheart/octosuite.git ``` ``` -$ cd octosuite +cd octosuite ``` ``` -$ pip install -r requirements.txt +pip install -r requirements.txt ``` # USAGE **Linux**: ``` -$ sudo chmod +x octosuite +sudo chmod +x octosuite ``` ``` -$ sudo ./octosuite +sudo ./octosuite ``` **Windows**: ``` -$ python3 octosuite +python3 octosuite +``` + +**Mac**: +``` +python3 octosuite ``` # AVAILABLE COMMANDS | Command | Usage| | ------------- |:---------:| -| orginfo | *get organization info* | -| userinfo | *get user profile info* | -| repoinfo | *get repository info* | -| pathcontents | *get contents of a path from a specified repository* | -| orgrepos | *get a list of repositories owned by a specified organization* | -| userrepos | *get a list of repositories owned by a specified user* | -| usergists | *get a list of gists owned by a specified user* | -| userfollowers | *get a list of a user's followers* | -| userfollowing | *check whether user A follows user B* | -| usersearch | *search user(s)* | -| reposearch | *search repositor(y)(ies)* | -| topicsearch | *search topics(s)* | -| issuesearch | *search issue(s)* | -| commitsearch | *search commit(s)* | -| usersearch | *search user(s)* | -| update | *check for/download updates* | -| author | *show author info* | -| help | *show usage/help* | -| exit | *exit session* | +| ``orginfo`` | *get organization info* | +| ``userinfo`` | *get user profile info* | +| ``repoinfo`` | *get repository info* | +| ``pathcontents`` | *get contents of a path from a specified repository* | +| ``orgrepos`` | *get a list of repositories owned by a specified organization* | +| ``userrepos`` | *get a list of repositories owned by a specified user* | +| ``usergists`` | *get a list of gists owned by a specified user* | +| ``userfollowers`` | *get a list of a user's followers* | +| ``userfollowing`` | *check whether user A follows user B* | +| ``usersearch`` | *search user(s)* | +| ``reposearch`` | *search repositor(y)(ies)* | +| ``topicsearch`` | *search topics(s)* | +| ``issuesearch`` | *search issue(s)* | +| ``commitsearch`` | *search commit(s)* | +| ``usersearch`` | *search user(s)* | +| ``update`` | *check for/download updates* | +| ``author`` | *show author info* | +| ``help`` | *show usage/help* | +| ``exit`` | *exit session* | # NOTE * *octosuite automatically logs network and minor user activity. The logs are saved by date and time in .logs folder* -* *octosuite has only been tested on **Termux** *and* **Kali Linux** (for now), please be sure to let me know how it works on **Windows*** +* *Although octosuite was developed to work on **Mac**, **Windows**, or any **Linux** *Distribution*, it has only been tested on **Termux** *and* **Kali Linux*** # LICENSE ![license](https://user-images.githubusercontent.com/74001397/137917929-2f2cdb0c-4d1d-4e4b-9f0d-e01589e027b5.png)