Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Add instructions for usage with Docker image
  • Loading branch information
EONRaider authored Sep 3, 2021
1 parent ba3449d commit 3bae4e5
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,22 @@ $ pip3 install -r requirements.txt
```

## Usage

### From Python interpreter
```
$ python3 -m clairvoyance --help
```

```
$ python3 -m clairvoyance -vv -o /path/to/schema.json -w /path/to/wordlist.txt https://swapi-graphql.netlify.app/.netlify/functions/index
```
### From Docker Image
```
$ docker run --rm nikitastupin/clairvoyance --help
```
```
# Assuming the wordlist.txt file is found in $PWD
$ docker run --rm -v $(pwd):/tmp/ nikitastupin/clairvoyance -vv -o /tmp/schema.json -w /tmp/wordlist.txt https://swapi-graphql.netlify.app/.netlify/functions/index
```

You can refer to 2nd half of [GraphQL APIs from bug hunter's perspective by Nikita Stupin](https://youtu.be/nPB8o0cSnvM) talk for detailed description.

Expand Down

0 comments on commit 3bae4e5

Please sign in to comment.