mirror of
https://github.com/bellingcat/octosuite.git
synced 2026-06-12 21:38:34 +03:00
141 lines
4.6 KiB
Markdown
141 lines
4.6 KiB
Markdown
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
> *Simply gather OSINT on Github users & organizations like a God🔥*
|
|
|
|
# FEATURES
|
|
- [x] Fetches organization info
|
|
- [x] Fetches user info
|
|
- [x] Fetches repository info
|
|
- [x] Returns contents of a path from a repository
|
|
- [x] Returns a list of repos owned by an organization
|
|
- [x] Returns a list of repos owned by a user
|
|
- [x] Returns a list of gists owned by a user
|
|
- [x] Returns a list of a user's followers
|
|
- [x] Checks whether user A follows user B
|
|
- [x] Searches users
|
|
- [x] Searches repositories
|
|
- [x] Searches topics
|
|
- [x] Searches issues
|
|
- [x] Searches commits
|
|
- [x] Easily updates with the 'update' command
|
|
- [x] Automatically logs network activity (.logs folder)
|
|
|
|
# INSTALLATION
|
|
## Clone from Github
|
|
|
|
```
|
|
git clone https://github.com/rly0nheart/octosuite.git
|
|
```
|
|
|
|
|
|
|
|
```
|
|
cd octosuite
|
|
```
|
|
|
|
|
|
|
|
```
|
|
pip install -r requirements.txt
|
|
```
|
|
|
|
|
|
|
|
|
|
## Install from PyPI
|
|
```
|
|
pip install octosuite
|
|
```
|
|
|
|
|
|
|
|
# GITHUB FORK USAGE
|
|
## Linux
|
|
```
|
|
sudo chmod +x octosuite
|
|
```
|
|
|
|
|
|
|
|
```
|
|
sudo ./octosuite
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
## Windows
|
|
```
|
|
python3 octosuite
|
|
```
|
|
|
|
## Mac
|
|
```
|
|
python3 octosuite
|
|
```
|
|
|
|
# PYPI PACKAGE USAGE
|
|
## Linux
|
|
```
|
|
octosuite
|
|
```
|
|
|
|
## Windows
|
|
```
|
|
octosuite
|
|
```
|
|
|
|
## Mac
|
|
```
|
|
octosuite
|
|
```
|
|
|
|
# AVAILABLE COMMANDS
|
|
| COMMAND | DESCRIPTION|
|
|
| ------------- |:---------:|
|
|
| ``info:org`` | *get organization info* |
|
|
| ``info:user`` | *get user profile info* |
|
|
| ``info:repo`` | *get repository info* |
|
|
| ``info:dev`` | *show developer's info* |
|
|
| ``path:contents`` | *get contents of a path from a specified repository* |
|
|
| ``repos:org`` | *get a list of repositories owned by a specified organization* |
|
|
| ``repos:user`` | *get a list of repositories owned by a specified user* |
|
|
| ``user:gists`` | *get a list of gists owned by a specified user* |
|
|
| ``user:followers`` | *get a list of a user's followers* |
|
|
| ``user:following`` | *check whether user A follows user B* |
|
|
| ``search:users`` | *search user(s)* |
|
|
| ``search:repos`` | *search repositor(y)(ies)* |
|
|
| ``search:topics`` | *search topics(s)* |
|
|
| ``search:issues`` | *search issue(s)* |
|
|
| ``search:commits`` | *search commit(s)* |
|
|
| ``update`` | *update octosuite* |
|
|
| ``changelog`` | *show changelog* |
|
|
| ``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*
|
|
* *Although octosuite was developed to work on **Mac**, **Windows**, or any **Linux** *Distribution*, it has only been tested on **Termux** *and* **Kali Linux***
|
|
* If you believe octosuite can be better, feel free to open a pull request with your improvements ✌🏾🙂
|
|
|
|
# PYPI
|
|
[PyPI](https://pypi.org/project/octosuite)
|
|
|
|
# LICENSE
|
|
|
|
|
|
# ABOUT DEVELOPER
|
|
[About.me](https://about.me/rly0nheart)
|