Skip to content

docs: document OSINT/threat-intel commands merged into main#247

Merged
uforia merged 1 commit into
mainfrom
docs/readme-reconcile
May 31, 2026
Merged

docs: document OSINT/threat-intel commands merged into main#247
uforia merged 1 commit into
mainfrom
docs/readme-reconcile

Conversation

@spierenburg
Copy link
Copy Markdown
Collaborator

What

Brings the README ### `matterbot` Commands table back in sync with the code. Over the last weeks ~38 @command modules were merged (the OSINT / surface-search batch — APIVoid, Fofa, ZoomEye, Onyphe, Netlas, WiGLE, etc. — plus several others) but none of them got a corresponding entry in the command table. This adds the missing rows.

Details

  • 38 new rows added; 0 existing row contents changed. The diff shows one "removed" line — that is the previously mis-sorted OpenCVE row being moved into its correct alphabetical position by the re-sort, not a deletion.
  • Existing alphabetical ordering and the Name / Type / Functionality / API Key Required / Paid Subscription schema are preserved (57 existing + 38 new = 95 rows).
  • Values are derived from source, not guessed:
    • API Key Required from each module's defaults.py (a non-empty placeholder key like <your-…-here> ⇒ Yes; empty/absent ⇒ No).
    • Functionality from each module's HELP description and what it actually queries.
    • CLI-binary wrappers (GHunt, Holehe, httpx, Unfurl, DNSTwist) and self-hosted Caldera are noted in the Functionality column rather than the API column.
  • Coverage checked: every module directory under commands/ now resolves to a table row.

A few "paid tier" notes that couldn't be confirmed from source were deliberately not invented — those modules are listed as No for Paid Subscription. Source-grounded paid/credit notes (APIVoid pay-as-you-go credits, Open Measures free/paid tiers, VARIoT free-query cap, Caldera self-hosted) are kept.

Modules documented

Analyze, APIVoid, MITRE Caldera, ChainAbuse, CIRCL Passive DNS, CyberThreat.nl, MITRE D3FEND, DNSTwist, FileSec, Fofa, FullHunt, GeoLookup, GHunt, HackerTarget, HaveIBeenRansomed, Holehe, HoneyDB, httpx, Hunter.how, MalAPI, MalShare, Maltiverse, MetaDefender, Netlas, Onyphe, Open Measures, PeeringDB, PhishStats, Searchcode, ThreatBook, ThreatRip, Unfurl, VARIoT, VulnCheck, WaybackLister, WiGLE, YARAify, ZoomEye

Not included

The @reload / @restart / systemd-supervision docs are intentionally out of scope here — that code lives in the still-open PRs #233/#234 and isn't on main yet. This PR only documents what has actually merged.

The command table in the README had fallen behind the code: ~38 @command
modules merged over the last weeks (the OSINT/surface-search batch and
several others) shipped without a corresponding table entry.

Add a row for each undocumented module and re-sort the table alphabetically
(this also moves the previously mis-sorted OpenCVE row into place). The
Name/Type/Functionality/API-key/Paid-subscription schema is preserved and
no existing row content was changed. Values are derived from each module's
defaults.py (API-key requirement) and HELP description (functionality).

Modules added: Analyze, APIVoid, MITRE Caldera, ChainAbuse, CIRCL Passive
DNS, CyberThreat.nl, MITRE D3FEND, DNSTwist, FileSec, Fofa, FullHunt,
GeoLookup, GHunt, HackerTarget, HaveIBeenRansomed, Holehe, HoneyDB, httpx,
Hunter.how, MalAPI, MalShare, Maltiverse, MetaDefender, Netlas, Onyphe,
Open Measures, PeeringDB, PhishStats, Searchcode, ThreatBook, ThreatRip,
Unfurl, VARIoT, VulnCheck, WaybackLister, WiGLE, YARAify, ZoomEye.
@uforia uforia merged commit 6259ee1 into main May 31, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants