diff --git a/README.md b/README.md index d318e6e..c8fd404 100644 --- a/README.md +++ b/README.md @@ -77,34 +77,47 @@ GENERAL: --version display version ``` -### Examples - -#### Basic Usage +## Example Usage ```bash rescope https://hackerone.com/security https://bugcrowd.com/tesla ``` ```bash -rescope --output-file burp_scope.json --output-burp https://hackerone.com/security https://bugcrowd.com/tesla +rescope --output-burp --output-file burp_scope.json https://hackerone.com/security https://bugcrowd.com/tesla ``` -#### Custom includes / excludes +### Custom Include and Exclude Lists -Note that `--include-list` file may also contain bug bounty URLs. +The `--include-list` (`-iL`) and `--exclude-list` (`-eL`) options allow you to define custom scope rules that may include wildcard domains, IP ranges, and specific ports. -```bash -rescope -iL include.txt -eL exclude.txt +#### Example `include.txt`: +``` +*.example.com +api.example.com +192.168.1.0/24 +10.0.0.1 +10.0.0.1:8080 ``` -#### Piping to rescope +#### Example `exclude.txt`: +``` +test.example.com +192.168.1.100 +``` -You may also pipe a list of bug bounty URLs directly to rescope: +You can use these lists to specify which targets should be included or excluded in your scope definitions. +```bash +rescope -iL include.txt -eL exclude.txt +``` +You can also pipe a list of bug bounty URLs directly into `rescope` using standard input: ```bash cat urls.txt | rescope ``` +This will process the URLs in `urls.txt` using the default configuration or any additional flags provided. + ## As a library ```go