v1.1.0

README.md

@@ -1,18 +1,17 @@
 ![octosuite](https://user-images.githubusercontent.com/74001397/155901728-82917d24-5b5a-4016-b5f7-df479699ba87.png)
 
-Advanced Github OSINT Framework
-
-![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)
 
 
-# Installation
+# INSTALLATION
 **clone project**:
 
 ```
@@ -23,7 +22,7 @@ $ git clone https://github.com/rly0nheart/octosuite.git
 $ cd octosuite
 ```
 
-# Usage
+# USAGE
 **Linux**:
 ```
 $ sudo chmod +x octosuite
@@ -38,19 +37,36 @@ $ ./octosuite
 $ python3 octosuite
 ```
 
+# AVAILABLE COMMANDS
+| Command         | Usage|
+| ------------- |:---------:|
+| <code>orginfo</code> | *get organization info*  |
+| <code>userinfo</code> | *get user profile info*  |
+| <code>repoinfo</code> | *get repository info*  |
+| <code>pathcontents</code>  | *get contents of a path from a specified repository* |
+| <code>orgrepos</code>      | *get a list of repositories owned by a specified organization* |
+| <code>userrepos</code>  | *get a list of repositories owned by a specified user* |
+| <code>usergists</code>  |  *get a list of gists owned by a specified user* |
+| <code>userfollowers</code>  |  *get a list of a user's followers* |
+| <code>userfollowing</code> | *check whether user A follows user B* |
+| <code>usersearch</code> | *search user(s)* |
+| <code>reposearch</code> | *search repositor(y)(ies)* |
+| <code>topicsearch</code> | *search topics(s)* |
+| <code>issuesearch</code> | *search issue(s)* |
+| <code>commitsearch</code> | *search commit(s)* |
+| <code>usersearch</code> | *search user(s)* |
+| <code>update</code> | *check for/download updates* |
+| <code>author</code> | *show author info* |
+| <code>help</code> | *show usage/help* |
+| <code>exit</code> | *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 
 
+# 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 **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)
 
-# About me
+# ABOUT AUTHOR
-* [About.me](https://about.me/rly0nheart)
+[About.me](https://about.me/rly0nheart)

lib/banner.py

@@ -7,7 +7,7 @@ banner = f'''{red}
 ░ ████▓▒░▒ ▓███▀ ░  ▒██▒ ░ ░ ████▓▒░▒██████▒▒▒█████▓ ░██░  ▒██▒ ░ ░▒████▒
 ░ ▒░▒░▒░ ░ ░▒ ▒  ░  ▒ ░░   ░ ▒░▒░▒░ ▒ ▒▓▒ ▒ ░░▒▓▒ ▒ ▒ ░▓    ▒ ░░   ░░ ▒░ ░
   ░ ▒ ▒░   ░  ▒       ░      ░ ▒ ▒░ ░ ░▒  ░ ░░░▒░ ░ ░  ▒ ░    ░     ░ ░  ░
-░ ░ ░ ▒  ░          ░      ░ ░ ░ ▒  ░  ░  ░   ░░░ ░ ░  ▒ v1.0
+░ ░ ░ ▒  ░          ░      ░ ░ ░ ▒  ░  ░  ░   ░░░ ░ ░  ▒ v1.1.0
     ░ ░  ░ ░                   ░ ░        ░     ░      ░              ░  ░
          ░                              {white}— Advanced Github {red}OSINT{white} Framework{reset}
 

src/main.py

@@ -412,7 +412,7 @@ class octosuite:
     def update(self):
     	logging.info('Checking for update(s)...')
     	files_to_update = ['src/main.py','lib/banner.py','lib/colors.py','octosuite','LICENSE','README.md']
-    	print(f'\n{colors.white}[{colors.green}*{colors.white}] Fetching update(s). Please wait...{colors.reset}')
+    	print(f'\n{colors.white}[{colors.green}*{colors.white}] Fetching update(s). Please wait...{colors.reset}',end='')
     	for file in files_to_update:
     		data = urllib.request.urlopen(f'https://raw.githubusercontent.com/rly0nheart/octosuite/master/{file}').read()
     		with open(file, 'wb') as code:
@@ -420,7 +420,7 @@ class octosuite:
     			code.close()
     	
     	logging.info('Update complete.')		
-    	exit(f'{colors.white}[{colors.green}+{colors.white}] Update complete. Re-run octosuite.{colors.reset}')
+    	exit(f'\n{colors.white}[{colors.green}+{colors.white}] Update complete. Re-run octosuite.{colors.reset}')
     	
     	
     # Author info   
@@ -434,14 +434,14 @@ class octosuite:
     	help = '''
     	
 usage:
-   orginfo           -->    Get organization info
+   orginfo           -->    Get target organization info
-   userinfo          -->    Get user profile info
+   userinfo          -->    Get target user profile info
-   repoinfo          -->    Get user repository info
+   repoinfo          -->    Get target repository info
-   pathcontents      -->    Get contents of a specified path from a repository
+   pathcontents      -->    Get contents of a specified path from a target repository
-   orgrepos          -->    Get organization repositories
+   orgrepos          -->    Get a list of repositories owned by a target organization
-   userrepos         -->    Get user repositories
+   userrepos         -->    Get a list of repositories owned by a target user
-   usergists         -->    Get user gists
+   usergists         -->    Get a list of gists owned by a target user
-   userfollowers     -->    Get user followers
+   userfollowers     -->    Get a list of the target's followers
    userfollowing     -->    Check whether or not User[A] follows User[B]
    usersearch        -->    Search user(s)
    reposearch        -->    Search repositor[y][ies]
@@ -449,7 +449,7 @@ usage:
    issuesearch       -->    Search issue(s)
    commitsearch      -->    Search commit(s)
    update            -->    Check for/download update(s)
-   author            -->    Show author information
+   author            -->    Show author info
    help              -->    Show usage/help
    exit              -->    Exit session
    '''