osint-cli-tool-skeleton

KO | EN

gitlite — search

#hacktoberfest #react #ai #typescript #android #machine-learning #rust #deep-learning #docker #macos #nodejs #java #mcp #ios

osint-cli-tool-skeleton

(★ 81)

Template for new OSINT command-line tools

osint-cli-tool-skeleton Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# OSINT cli tool skeleton

A universal, **AI-native** template for building OSINT tools.

Write **one plugin file**, and the same logic instantly works as a **CLI**, a
**Python library**, an **HTTP microservice** (FastAPI) and an **MCP server** for
AI agents — with concurrency, proxying, reports and config handled for you.

> **Press "[Use this template](https://github.com/soxoj/osint-cli-tool-skeleton/generate)"** to start your own tool, then see [INSTALL.md](INSTALL.md).

## Why this skeleton

- **Universal** — plugins return arbitrary fields; nothing is hardcoded to one
  data shape. Build a username checker, a domain enricher, a leak lookup, anything.
- **Easy to customize** — add a capability by dropping one file in `plugins/`.
  You never touch the engine, CLI, server or reports.
- **Embeddable** — clean sync (`run_tool`) and async (`arun_tool`) library API,
  plus a FastAPI app factory for microservices and pipelines.
- **AI-native** — every plugin is auto-exposed as an MCP tool, and
  [AGENTS.md](AGENTS.md) is a ready brief: point an agent at the repo and say
  "build a tool based on this".

## Architecture

```
                       your plugins/  (subclass Plugin, implement run())
                              │  auto-discovered & registered
                              ▼
   CLI ─┐                  ┌─────────┐
   lib ─┼──> Settings ──>  │ Engine  │ ──> Reporters (plain/csv/txt/json)
  HTTP ─┤   (file/env/CLI) │ +Context│      Result / ResultSet (any fields)
   MCP ─┘                  └─────────┘
```

## Quickstart

```sh
pip install -e .
python -m osint_cli_tool_skeleton --list-plugins
python -m osint_cli_tool_skeleton --plugin http_title example.com reddit.com
```

```
Target: example.com
Results found: 1
1) Value: Example Domain
   Code: 200
------------------------------
Total found: 1
```

## Write a tool (the only thing you edit)

```sh
python -m osint_cli_tool_skeleton --new-plugin my_tool
```

```python
# osint_cli_tool_skeleton/plugins/my_tool.py
from osint_cli_tool_skeleton import InputData, Plugin, Result

class MyTool(Plugin):
    name = "my_tool"
    description = "Look up something for a target."

async def run(self, target: InputData) -> Result:
        status, data = await self.ctx.fetch_json(f"https://api.example/{target.value}")
        return Result(found=data.get("found"), code=status)
```

That's it — `my_tool` now works on the CLI, as a library call, over HTTP and as
an MCP tool. Full contract in [AGENTS.md](AGENTS.md).

<details>
<summary>Inputs — args, file, or stdin</summary>

```sh
osint_cli_tool_skeleton a.com b.com c.com # positional
osint_cli_tool_skeleton --target-list targets.txt # from a file
cat list.txt | osint_cli_tool_skeleton --targets-from-stdin
```
</details>

<details>
<summary>Reports — console, CSV, TXT, JSON</summary>

```sh
osint_cli_tool_skeleton a.com b.com -oC out.csv -oJ out.json -oT out.txt
osint_cli_tool_skeleton a.com --format json        # JSON to stdout
```

Reports are schema-driven: columns/fields adapt to whatever your plugin emits.
```sh
$ cat out.json | jq '.[0]'
{ "input": { "value": "a.com" }, "results": [ { "value": "Site A", "code": 200 } ] }
```
</details>

<details>
<summary>Library — embed in your own code / pipeline</summary>

```python
from osint_cli_tool_skeleton import run_tool          # sync
results = run_tool("http_title", ["example.com"], proxy="socks5://127.0.0.1:1080")
for rs in results:
    print(rs.input_data, [r.fields for r in rs.results])

# inside an existing event loop:
from osint_cli_tool_skeleton import arun_tool
results = await arun_tool("http_title", ["example.com"])
```
</details>

<details>
<summary>HTTP microservice — FastAPI + OpenAPI</summary>

```sh
pip install -e '.[server]'
osint_cli_tool_skeleton --server 0.0.0.0:8080      # docs at /docs
```

```sh
curl localhost:8080/plugins/http_title/run \
  -d '{"targets": ["google.com", "yahoo.com"]}' -s | jq
```

Endpoints: `GET /plugins`, `GET /plugins/{name}/schema`,
`POST /plugins/{name}/run`, `POST /run`. For your own ASGI deployment:
`from osint_cli_tool_skeleton.server import create_app; app = create_app()`.

Or run it in Docker:
```sh
docker build -t osint-tool . && docker run -p 8080:8080 osint-tool
```
</details>

<details>
<summary>MCP server — for AI agents</summary>

```sh
pip install -e '.[mcp]'
osint_cli_tool_skeleton --mcp        # stdio MCP server
```

Every plugin becomes an MCP tool named after it, taking `targets` and optional
`options`. Register it with your agent/host as the command
`osint_cli_tool_skeleton --mcp`.
</details>

<details>
<summary>Configuration — file / env / CLI</summary>

Precedence: **defaults < config file < `OSINT_*` env < CLI flags**.

```toml
# osint.toml (auto-detected in cwd, or pass --config)
[osint]
plugin = "http_title"
proxy = "socks5://127.0.0.1:1080"
concurrency = 20
[osint.options]
api_key = "..."
```

```sh
OSINT_PROXY=socks5://127.0.0.1:1080 osint_cli_tool_skeleton example.com
osint_cli_tool_skeleton --plugin my_tool --option api_key=XXX --concurrency 20 t
```

See [`examples/osint.example.toml`](examples/osint.example.toml).
</details>

## Installation

Requires Python ≥ 3.10.

```sh
pip install osint_cli_tool_skeleton            # from PyPI (core)
pip install 'osint_cli_tool_skeleton[all]'     # + server, mcp, yaml
```

…or clone and `pip install -e '.[all,dev]'`. Details in [INSTALL.md](INSTALL.md).

## Development

```sh
make install-dev   # editable install with dev tools
make test          # pytest + coverage
make lint          # flake8 + mypy
make format        # black
```

## License

MIT

osint-cli-tool-skeleton

osint-cli-tool-skeleton Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

osint-cli-tool-skeleton

osint-cli-tool-skeleton Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README