From 8383a241fc3cf5b022c9c53f8f19690edf04177b Mon Sep 17 00:00:00 2001 From: s Date: Mon, 10 Nov 2025 15:22:32 -0500 Subject: refactor: restructure client modules and add config file support - 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 --- README.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) (limited to 'README.md') 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 -- cgit v1.2.3