mirror of
https://github.com/bellingcat/octosuite.git
synced 2026-06-11 21:08:35 +03:00
Update README.md
This commit is contained in:
87
README.md
87
README.md
@@ -1,3 +1,5 @@
|
||||

|
||||
|
||||

|
||||

|
||||

|
||||
@@ -9,6 +11,12 @@
|
||||
|
||||
> *Simply gather OSINT on Github users & organizations like a God🔥*
|
||||
|
||||
# INSTALLATION
|
||||
Installation instructions are on the wiki, in addition to all other documentation.
|
||||
|
||||
[Refer to the Wiki](https://github.com/rly0nheart/octosuite/wiki)
|
||||
|
||||
***
|
||||
# FEATURES
|
||||
- [x] Fetches organization info
|
||||
- [x] Fetches user info
|
||||
@@ -28,77 +36,7 @@
|
||||
- [x] Automatically logs network activity (.logs folder)
|
||||
- [x] User can view, read and delete log files
|
||||
|
||||
# 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|
|
||||
| ------------- |:---------:|
|
||||
@@ -125,19 +63,22 @@ octosuite
|
||||
| ``help`` | *show usage/help* |
|
||||
| ``exit`` | *exit session* |
|
||||
|
||||
|
||||
# NOTE
|
||||
***
|
||||
# NOTES
|
||||
* *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 Package](https://pypi.org/project/octosuite)
|
||||
|
||||

|
||||
|
||||
***
|
||||
# LICENSE
|
||||

|
||||
|
||||
***
|
||||
# ABOUT DEVELOPER
|
||||
[About.me](https://about.me/rly0nheart)
|
||||
|
||||
Reference in New Issue
Block a user