Skip to content

Commit 401e1fd

Browse files
Updating README and changed the CLI, I have pushed my cli to pip
1 parent f282a41 commit 401e1fd

2 files changed

Lines changed: 61 additions & 10 deletions

File tree

README.md

Lines changed: 51 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -332,18 +332,28 @@ For direct CLI use, `InvestigationPipeline` runs the same logic synchronously wi
332332
333333
---
334334

335-
## Quick Start
335+
### Quick Start
336336

337-
The fastest path to a working investigation and no server or database required:
337+
The fastest path to a working investigation is installing directly from PyPI:
338+
339+
```bash
340+
pip install herald-investigator
341+
python -m playwright install chromium
342+
herald investigate paypal-login-alert.com
343+
```
344+
345+
#### Running from Source (GitHub)
346+
If you prefer to clone the repository and run without installing:
338347

339348
```bash
340349
git clone https://github.com/Black-Coffee-Ramen/HERALD
341350
cd HERALD
342-
python -m venv .venv && source .venv/bin/activate
343-
pip install -r requirements-dev.txt
344-
pip install -e .
351+
python3 -m venv .venv && source .venv/bin/activate
352+
pip install -r requirements-runtime.txt
345353
python -m playwright install chromium
346-
herald investigate paypal-login-alert.com
354+
355+
# Use the included run.py convenience script
356+
python run.py investigate paypal-login-alert.com
347357
```
348358

349359
Example output:
@@ -404,10 +414,10 @@ Install Python dependencies:
404414
pip install -r requirements-runtime.txt
405415
```
406416

407-
Install HERALD:
417+
Install HERALD directly from PyPI:
408418

409419
```bash
410-
pip install -e .
420+
pip install herald-investigator
411421
```
412422

413423
Install Playwright browsers:
@@ -546,7 +556,7 @@ docker compose up --build
546556

547557
## CLI Reference
548558

549-
The `herald` console script is installed by `setup.py` as `herald = herald.cli:main`.
559+
The `herald` console script is installed automatically when using `pip install herald-investigator`. If running from source, use `python run.py` instead of `herald`.
550560

551561
### `herald investigate`
552562

@@ -568,6 +578,10 @@ herald investigate suspicious.example --no-visual
568578

569579
# Permit private/internal IP resolution (metadata endpoints remain blocked)
570580
herald investigate internal.test --allow-private
581+
582+
# Batch Investigation
583+
# If the target is a text file, HERALD processes domains line-by-line and outputs an aggregated summary.
584+
herald investigate domains.txt
571585
```
572586

573587
Output includes trace ID, verdict, phishing score, evidence path, risk factor explanations, DNS/TLS intelligence, and pipeline stage lifecycle.
@@ -603,10 +617,36 @@ Screenshot saved to: `evidence/<trace_id>_<domain>/screenshots/homepage.png`
603617
Loads a previously persisted investigation by trace ID.
604618

605619
```bash
606-
herald report <trace_id> [--json]
620+
herald report <trace_id> [--json] [--open]
607621
```
608622

609623
Trace IDs follow the format `trc-<10 hex chars>`. Lookup scans `evidence/<trace_id>*/investigation.json`.
624+
Passing `--open` will automatically open the evidence directory in your operating system's file explorer.
625+
626+
### `herald update`
627+
628+
Checks PyPI for the latest version of `herald-investigator` and interactively prompts you to upgrade if a newer version is found.
629+
630+
### `herald config`
631+
632+
Manage user-level configuration stored in `~/.herald/config.json`.
633+
634+
```bash
635+
herald config show
636+
herald config set screenshot false
637+
```
638+
639+
### `herald cleanup`
640+
641+
Helps SOC teams manage disk space by deleting older investigation evidence directories.
642+
643+
```bash
644+
# Deletes investigations older than 30 days (default)
645+
herald cleanup
646+
647+
# Deletes investigations older than 7 days
648+
herald cleanup --older-than 7
649+
```
610650

611651
### Exit Codes
612652

@@ -624,6 +664,7 @@ evidence/
624664
trc-1a2b3c4d5e_paypal-login-alert.com/
625665
investigation.json ← complete structured result
626666
report.md ← human-readable Markdown report
667+
report.html ← styled, presentation-ready HTML report
627668
screenshots/
628669
homepage.png ← full-page screenshot
629670
```

run.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
#!/usr/bin/env python3
2+
"""
3+
Convenience runner for executing the HERALD CLI directly from the source code.
4+
Usage: python run.py investigate google.com
5+
"""
6+
import sys
7+
from herald.cli import main
8+
9+
if __name__ == "__main__":
10+
sys.exit(main())

0 commit comments

Comments
 (0)