Skip to content

Latest commit

 

History

History
85 lines (63 loc) · 2.29 KB

File metadata and controls

85 lines (63 loc) · 2.29 KB

Usage and Commands

This document covers all runtime commands exposed by OnionSpy.

Startup

Run OnionSpy:

python main.py

After startup, the app:

  • shows tool information
  • handles login password creation/validation
  • checks Tor connectivity
  • enters the command loop

On Startup Workflow

Basic Commands

Command Description
help / h Show all available commands
about Show project overview
version Show current version
command <command_name> Show purpose for a specific command
changepass Change OnionSpy login password
cachecl Clear cache from ./data
exit / quit / q Exit the tool

Connection Commands

Command Description
torverify Verify Tor connection status
torconn Start/attach local Tor daemon flow
torclose Shutdown local Tor daemon via control port
checkproxy Validate current request proxy flow
changeproxy <url> Update proxy_url in config.yaml
ip Print current Tor exit IP

Examples:

torverify
changeproxy http://127.0.0.1:8118
ip

Research Commands

Command Description
search <query> Search across configured dark web search engines, filter results, and save JSON
crawl <url> Crawl onion page metadata via model-assisted extraction
scan <url> Check onion site availability and server header
relay <ip_or_fingerprint_or_name> Query Tor relay information
istor <ip> Check if IP is related to Tor relay infrastructure
breaches Fetch top data breach set and store full output file
breachinfo <company> Fetch breach details for one company

Search workflow:

Search Workflow

Crawl workflow:

Crawl Workflow

Output Files

Typical generated files:

  • ./data/search_results/<query>_search_results.json
  • ./data/relays_info/<identity>_relays_info.json
  • ./data/breaches_info/<company>_data_breach_info.json
  • ./data/all_breaches.json
  • ./logs/onionspy.log

Notes

  • search and crawl rely on Ollama availability.
  • MongoDB insertion is optional and prompted interactively where supported.
  • Tor must be reachable through your configured proxy_url.