From 3bae4e5caa396ebcfee25f947e831aa140ceb538 Mon Sep 17 00:00:00 2001 From: EONRaider <15611424+EONRaider@users.noreply.github.com> Date: Fri, 3 Sep 2021 11:54:40 -0300 Subject: [PATCH] Update README.md Add instructions for usage with Docker image --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6e95c4a..eca8263 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ $ pip3 install -r requirements.txt ``` ## Usage - +### From Python interpreter ``` $ python3 -m clairvoyance --help ``` @@ -21,6 +21,14 @@ $ 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.