summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authors <[email protected]>2025-11-10 15:22:32 -0500
committers <[email protected]>2025-11-10 15:22:32 -0500
commit8383a241fc3cf5b022c9c53f8f19690edf04177b (patch)
tree887a489f7931d07373530c7e053f0343dca65e1d /README.md
parent9a9e79f232b83d3bd2a816287272515863df1299 (diff)
downloaddborg-0.8.1.tar.gz
dborg-0.8.1.zip
refactor: restructure client modules and add config file supportv0.8.1
- Split large osint.go client into focused modules (bssid.go, breachforum.go, buckets.go, etc.) - Add config file support with init command for API key management - Remove api-key flag in favor of config file + env var fallback - Update API paths to remove /osint prefix - Add crawl endpoint streaming support - Improve error handling with 402 payment required status
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 12 insertions, 4 deletions
diff --git a/README.md b/README.md
index c83c2d5..b322f35 100644
--- a/README.md
+++ b/README.md
@@ -85,18 +85,26 @@ dborg version
## Configuration
-Set your API key:
+### Initial Setup
+
+Run the initialization command to set up your API key:
```bash
-export DBORG_API_KEY=your_api_key_here
+dborg init
```
-Or pass it with each command:
+This will prompt you to enter your API key and save it to `~/.config/dborg/config.json`.
+
+### Alternative Configuration Methods
+
+You can also set your API key via environment variable:
```bash
-dborg --api-key YOUR_KEY [command]
+export DBORG_API_KEY=your_api_key_here
```
+**Note:** Environment variables take precedence over the config file.
+
## Commands
### NPD - Search NPD breach data