OSINT-Framework README

The project's README from github.com/lockfale/OSINT-Framework. As one markdown file: README.md.

OSINT Framework

http://osintframework.com

Notes

OSINT framework focused on gathering information from free tools or resources. The intention is to help people find free OSINT resources. Some of the sites included might require registration or offer more data for $$$, but you should be able to get at least a portion of the available information for no cost.

I originally created this framework with an information security point of view. Since then, the response from other fields and disciplines has been incredible. I would love to be able to include any other OSINT resources, especially from fields outside of infosec. Please let me know about anything that might be missing!

Please visit the framework at the link below and good hunting!

https://osintframework.com

Legend

Name Markers

(T) - Indicates a link to a tool that must be installed and run locally (D) - Google Dork, for more information: Google Hacking (R) - Requires registration (M) - Indicates a URL that contains the search term and the URL itself must be edited manually

Tool Metadata Fields

Each tool entry in arf.json can include structured metadata beyond the name and URL:

Field Type Description
description string What the tool does
status string live, degraded, down, or deprecated
pricing string free, freemium, or paid
bestFor string Primary use case in one line
input string What the tool takes as input
output string What the tool returns
opsec string passive or active
opsecNote string Operational security considerations
localInstall boolean Corresponds to (T) marker
googleDork boolean Corresponds to (D) marker
registration boolean Corresponds to (R) marker
editUrl boolean Corresponds to (M) marker
api boolean Whether the tool offers an API
invitationOnly boolean Whether access requires an invitation
deprecated boolean Whether the tool is deprecated

For Update Notifications

Follow me on Twitter: @jnordine - https://twitter.com/jnordine
Watch or star the project on Github: https://github.com/lockfale/osint-framework

Suggestions, Comments, Feedback

Feedback or new tool suggestions are extremely welcome! Please feel free to submit a pull request or open an issue on github or reach out on Twitter.

Contribute with a GitHub Pull Request

For new resources, please ensure that the site is available for public and free use.

  1. Update arf.json with your new tool entry in the appropriate category folder. Use the enriched format below:
{
  "name": "Example Name (T)",
  "type": "url",
  "url": "https://example.com",
  "description": "Brief description of what the tool does and its key capabilities.",
  "status": "live",
  "pricing": "free",
  "bestFor": "Primary use case in one sentence",
  "input": "What the tool accepts (e.g., Username, Domain, IP address)",
  "output": "What the tool returns (e.g., Profile matches, DNS records)",
  "opsec": "passive",
  "opsecNote": "Any operational security considerations for using this tool.",
  "localInstall": true,
  "googleDork": false,
  "registration": false,
  "editUrl": false,
  "api": false,
  "invitationOnly": false,
  "deprecated": false
}

At a minimum, include name, type, and url. The metadata fields are strongly encouraged as they help users understand each tool at a glance.

Append (T), (D), (R), or (M) to the name when applicable, and set the corresponding boolean field to true.

  1. Submit your pull request!

OSINT Framework Website

https://osintframework.com

Happy Hunting!

OSINT-Framework (lockfale/OSINT-Framework)

Searching Database…

What is this?OSINT Framework is a curated, browsable index of free OSINT (open-source intelligence) tools and resources, organized into a clickable category tree so you can find the right tool for a given task.
Is this a tool or just a list of links?It's a website: a visual tree menu where each node links out to an external OSINT tool or site, not software that runs the lookups itself.
How do I use it?Open the hosted OSINT Framework website and click through the category tree to the resource you need; to run it locally the repo serves the static site from ./public with python3 -m http.server 8000.
Do I need to install anything to browse it?No, it has no runtime dependencies listed; it's a static site, though a Cloudflare Workers deploy/preview script (wrangler) is included for maintainers.
Are all the linked tools free to use?Most entries are free but some require registration, some are Google dorks, some need manual URL editing, and some are local tools you must install yourself, each marked with (R), (D), (M), or (T).
Who is this aimed at?Originally built from an infosec/reconnaissance perspective, but the author notes it now serves people in other fields beyond security who need public-record research tools.
How is each tool entry described?Entries in the underlying arf.json file can carry metadata like description, status (live/degraded/down/deprecated), pricing, bestFor, input/output types, opsec notes, and whether the tool has an API or requires an invitation.
How do I suggest or add a new tool?Submit a pull request updating arf.json in the appropriate category with at least a name, type, and url, following the enriched metadata format and marker conventions.
Is it still being maintained?Yes, the project actively accepts new resource suggestions via GitHub issues or pull requests and tracks tool status (live, degraded, down, deprecated) in its data file.
Creator
lockfale
Size
2.6 MB
Stars
12.3K
Updated
CommitOct 10
Age
10y
Commits · 90 Days