Update README.md

This commit is contained in:
Richard Mwewa
2022-03-16 22:33:34 +02:00
committed by GitHub
parent e450c43f19
commit 132ef4f2ac

View File

@@ -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|
| ------------- |:---------:|
| <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
* *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)