From 132ef4f2ac2751cda019cf4c92359c3eaa03f1c7 Mon Sep 17 00:00:00 2001 From: Richard Mwewa <74001397+rly0nheart@users.noreply.github.com> Date: Wed, 16 Mar 2022 22:33:34 +0200 Subject: [PATCH] Update README.md --- README.md | 38 +++++++++++++++++++++++++++----------- 1 file changed, 27 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 670a005..fb2cdc1 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,13 @@ ![octosuite](https://user-images.githubusercontent.com/74001397/155901728-82917d24-5b5a-4016-b5f7-df479699ba87.png) -> *Gather advanced OSINT on Github users and organizations* - -![Python Version](https://img.shields.io/badge/python-3.x-blue?style=for-the-badge&logo=python) ![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) ![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🔥* + ![octosuite](https://user-images.githubusercontent.com/74001397/155878843-0e6e3337-98bf-4b4f-97f3-c31d8350468c.gif) @@ -38,16 +37,33 @@ $ ./octosuite $ 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* | + # NOTE -* Requirement(s) [requests] will be installed on first run -* Enter *help* command to show usage -* 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 *Linux* for now, please be sure to let me know how it works on *Windows* - -* Feel free to open pull requests if there are any notable bugs found - +* *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 **Linux** (for now), please be sure to let me know how it works on **Windows*** # LICENSE ![license](https://user-images.githubusercontent.com/74001397/137917929-2f2cdb0c-4d1d-4e4b-9f0d-e01589e027b5.png)