Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
root4loot authored Oct 4, 2024
1 parent 4b57e2a commit fe9f7d3
Showing 1 changed file with 23 additions and 10 deletions.
33 changes: 23 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit fe9f7d3

Please sign in to comment.