summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authors <[email protected]>2025-11-06 22:24:43 -0500
committers <[email protected]>2025-11-06 22:24:43 -0500
commitd9990f48d76bf13f59b582e13eb66b1756457bfb (patch)
tree08fbd124e765e14a7e9a3196dfe266bd67236aca /README.md
parent5f0e15788032951f215bda1df3b5ce1e55125f59 (diff)
downloaddborg-d9990f48d76bf13f59b582e13eb66b1756457bfb.tar.gz
dborg-d9990f48d76bf13f59b582e13eb66b1756457bfb.zip
feat: add osint, reddit, and skiptrace commands and update installation to use @latestv0.3.0
Diffstat (limited to 'README.md')
-rw-r--r--README.md115
1 files changed, 107 insertions, 8 deletions
diff --git a/README.md b/README.md
index 4f27264..c83c2d5 100644
--- a/README.md
+++ b/README.md
@@ -9,9 +9,13 @@ dborg/
├── cmd/ # CLI commands
│ ├── admin.go # Admin commands (build tag: admin)
│ ├── npd.go # NPD breach data search
+│ ├── osint.go # OSINT tools (username, BSSID, BreachForum)
+│ ├── reddit.go # Reddit data retrieval
│ ├── root.go # Root command configuration
+│ ├── skiptrace.go # Premium skiptrace operations
│ ├── sl.go # Stealer logs search
-│ ├── usrsx.go # Username availability check
+│ ├── update.go # Auto-update functionality
+│ ├── version.go # Version command
│ └── x.go # Twitter/X username history
├── internal/ # Private application code
│ ├── client/ # API client implementation
@@ -19,6 +23,9 @@ dborg/
│ │ ├── client.go # Base HTTP client
│ │ ├── client_test.go # Client tests
│ │ ├── npd.go # NPD API methods
+│ │ ├── osint.go # OSINT API methods
+│ │ ├── reddit.go # Reddit API methods
+│ │ ├── skiptrace.go # Skiptrace API methods
│ │ ├── sl.go # Stealer logs API methods
│ │ ├── usrsx.go # Username check API methods
│ │ └── x.go # Twitter/X API methods
@@ -28,6 +35,9 @@ dborg/
│ ├── models/ # Data models
│ │ ├── admin.go # Admin response types
│ │ ├── npd.go # NPD response types
+│ │ ├── osint.go # OSINT response types
+│ │ ├── reddit.go # Reddit response types
+│ │ ├── skiptrace.go # Skiptrace response types
│ │ ├── sl.go # Stealer logs types
│ │ ├── usrsx.go # Username check types
│ │ └── x.go # Twitter/X types
@@ -45,7 +55,7 @@ dborg/
## Installation
```bash
-go install git.db.org.ai/dborg
+go install git.db.org.ai/dborg@latest
```
To build with admin commands:
@@ -64,7 +74,7 @@ go build -tags admin -o dborg .
The CLI automatically checks for updates on startup. When a newer version is available:
- You'll be prompted to update
-- Accepts with `Y` or `Enter` to install the latest version via `go install git.db.org.ai/dborg`
+- Accepts with `Y` or `Enter` to install the latest version via `go install git.db.org.ai/dborg@latest`
- The binary automatically restarts with the new version
- Skip with `n` to continue with your current version
@@ -117,16 +127,105 @@ Available flags:
- `--posted_start_date`, `--posted_end_date`
- `--format` (json, ulp, up, pul, etc.)
-### USRSX - Check username availability
+### OSINT - Open Source Intelligence tools
+
+#### Username Check
+Check username availability across hundreds of websites using WhatsMyName dataset:
+
+```bash
+dborg osint username john_doe --sites GitHub,Twitter --max_tasks 100
+```
+
+Available flags:
+- `--sites`, `-s` (comma-separated list of specific sites to check)
+- `--fuzzy`, `-f` (enable fuzzy validation mode)
+- `--max_tasks`, `-m` (maximum concurrent tasks, default: 50)
+
+#### BSSID Lookup
+Lookup WiFi access point location by BSSID (MAC address):
+
+```bash
+dborg osint bssid 00:11:22:33:44:55 --google --osm
+```
+
+Available flags:
+- `--all`, `-a` (show all related results instead of exact match only)
+- `--google`, `-g` (include Google Maps URL for the location)
+- `--osm`, `-o` (include OpenStreetMap URL for the location)
+
+#### BreachForum Search
+Search BreachForum data from breachdetect index:
```bash
-dborg usrsx username123 --sites GitHub,Twitter --max_tasks 100
+dborg osint breachforum "search term" --max_hits 20
```
Available flags:
-- `--sites` (comma-separated list)
-- `--fuzzy` (enable fuzzy validation)
-- `--max_tasks` (default: 50)
+- `--max_hits`, `-m` (maximum number of results, default: 10)
+
+### Reddit - Reddit data retrieval
+
+#### Subreddit Posts
+```bash
+dborg reddit subreddit posts programming
+```
+
+#### Subreddit Comments
+```bash
+dborg reddit subreddit comments programming
+```
+
+#### User Posts
+```bash
+dborg reddit user posts spez
+```
+
+#### User Comments
+```bash
+dborg reddit user comments spez
+```
+
+#### User Profile
+```bash
+dborg reddit user about spez
+```
+
+### Skiptrace - Premium people search (requires premium access)
+
+**Note:** All skiptrace commands require a premium API key. Contact support to upgrade for premium access.
+
+#### Search People
+```bash
+dborg skiptrace people --first-name John --last-name Doe --city Austin --state TX
+```
+
+Required flags:
+- `--first-name`, `-f` (first name)
+- `--last-name`, `-l` (last name)
+
+Optional flags:
+- `--city`, `-c` (city)
+- `--state`, `-s` (state, 2-letter code)
+- `--age`, `-a` (age)
+
+#### Get Person Report
+```bash
+dborg skiptrace report SX_KEY 1
+```
+
+Args: `[sx_key]` `[selection]` from previous search results
+
+#### Phone Lookup
+```bash
+dborg skiptrace phone 5551234567
+```
+
+Args: 10-digit phone number (no +1 prefix)
+
+#### Email Lookup
+```bash
+dborg skiptrace email [email protected]
+```
### X - Twitter/X username history