https://github.com/soxoj/osint-cli-tool-skeleton
Template for new OSINT command-line tools
https://github.com/soxoj/osint-cli-tool-skeleton
osint osint-python osint-tool osint-tools
Last synced: about 1 month ago
JSON representation
Template for new OSINT command-line tools
- Host: GitHub
- URL: https://github.com/soxoj/osint-cli-tool-skeleton
- Owner: soxoj
- License: mit
- Created: 2021-12-04T12:30:53.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-25T20:02:02.000Z (6 months ago)
- Last Synced: 2025-03-30T06:04:02.867Z (about 1 month ago)
- Topics: osint, osint-python, osint-tool, osint-tools
- Language: Python
- Homepage:
- Size: 58.6 KB
- Stars: 69
- Watchers: 4
- Forks: 9
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OSINT cli tool skeleton
Template for new OSINT command-line tools.
**Press button "[Use this template](https://github.com/soxoj/osint-cli-tool-skeleton/generate)" to generate your own tool repository.** See [INSTALL.md](INSTALL.md) for further setup.
## Features
- Detailed readme
- Process N targets from args, text files, stdin
- Make TXT, CSV reports
- Proxy support
- Ready to publish Python package
## Usage
```sh
$ python3 -m osint-cli-tool-skeleton
# or simply
$ osint_cli_tool_skeleton
# or locally without installing
$ ./run.py
```
Targets
Specify targets one or more times:
```sh
$ osint_cli_tool_skeleton www.google.com reddit.com patreon.com
Target: www.google.com
Results found: 1
1) Value: Google
Code: 200
------------------------------
Target: patreon.com
Results found: 1
1) Value: Best way for artists and creators to get sustainable income and connect with fans | Patreon
Code: 200
------------------------------
Target: reddit.com
Results found: 1
1) Value: Reddit - Dive into anything
Code: 200
------------------------------
Total found: 3
```
Or use a file with targets list:
```sh
$ osint_cli_tool_skeleton --target-list targets.txt
```
Or combine tool with other through input/output pipelining:
```sh
$ cat list.txt | osint_cli_tool_skeleton --targets-from-stdin
```
Reports
The skeleton implements CSV reports:
```sh
$ osint_cli_tool_skeleton www.google.com reddit.com patreon.com -oC results.csv
...
Results were saved to file results.csv
$ more results.csv
"Target","Value","Code"
"www.google.com","Google","200"
"patreon.com","Best way for artists and creators to get sustainable income and connect with fans | Patreon","200"
"reddit.com","Reddit - Dive into anything","200"
```
Also tool supports JSON output format:
```
osint_cli_tool_skeleton www.google.com reddit.com patreon.com -oJ results.json
...
Results were saved to file results.json
$ cat results.json | jq | head -n 10
[
{
"input": {
"value": "www.google.com"
},
"output": [
{
"value": "Google",
"code": 200
}
]
},
```
And can save console output to text file separately:
```sh
osint_cli_tool_skeleton www.google.com reddit.com patreon.com -oT results.txt
...
Results were saved to file results.txt
$ head -n 4 results.txt
Target: www.google.com
Results found: 1
1) Value: Google
Code: 200
```
Proxy
The tool supports proxy:
```sh
$ osint_cli_tool_skeleton www.google.com --proxy http://localhost:8080
```
Server
The tool can be run as a server:
```sh
$ osint_cli_tool_skeleton --server 0.0.0.0:8080
Server started
$ curl localhost:8080/check -d '{"targets": ["google.com", "yahoo.com"]}' -s | jq
[
{
"input": {
"value": "google.com"
},
"output": [
{
"value": "Google",
"code": 200
}
]
},
{
"input": {
"value": "yahoo.com"
},
"output": [
{
"value": "Yahoo | Mail, Weather, Search, Politics, News, Finance, Sports & Videos",
"code": 200
}
]
}
]
```
## Installation
Make sure you have Python3 and pip installed.
Manually
1. Clone or [download](https://github.com/soxoj/osint-cli-tool-skeleton/archive/refs/heads/main.zip) respository
```sh
$ git clone https://github.com/soxoj/osint-cli-tool-skeleton
```
2. Install dependencies
```sh
$ pip3 install -r requirements.txt
```
As a the package
You can clone/download repo and install it from the directory to use as a Python package.
```sh
$ pip3 install .
```
Also you can install it from the PyPI registry:
```sh
$ pip3 install https://github.com/soxoj/osint-cli-tool-skeleton
```