From ead080c508dd550b65c4724b7c179c5687aae68e Mon Sep 17 00:00:00 2001 From: Grey_D Date: Wed, 26 Apr 2023 23:32:18 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E2=9C=8F=EF=B8=8F=20update=20readme?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3151eeb..7709fdf 100644 --- a/README.md +++ b/README.md @@ -51,7 +51,7 @@ https://user-images.githubusercontent.com/78410652/232327920-7318a0c4-bee0-4cb4- 1. The commands are: - `help`: show the help message. - `next`: key in the test execution result and get the next step. - - `more`: let **PentestGPT** to explain more details of the current step. + - `more`: let **PentestGPT** to explain more details of the current step. Also, a new sub-task solver will be created to guide the tester. - `todo`: show the todo list. - `discuss`: discuss with the **PentestGPT**. - `google`: search on Google. This function is still under development. @@ -59,7 +59,13 @@ https://user-images.githubusercontent.com/78410652/232327920-7318a0c4-bee0-4cb4- 2. You can use to end your input (and is for next line). 3. You may always use `TAB` to autocomplete the commands. 4. When you're given a drop-down selection list, you can use cursor or arrow key to navigate the list. Press `ENTER` to select the item. Similarly, use to confirm selection. - +4. In the sub-task handler initiated by `more`, users can execute more commands to investigate into a specific problem: + 1. The commands are: + - `help`: show the help message. + - `brainstorm`: let PentestGPT brainstorm on the local task for all the possible solutions. + - `discuss`: discuss with PentestGPT about this local task. + - `google`: search on Google. This function is still under development. + - `continue`: exit the sub task and continue the main testing session. ## Report 1. After finishing the penetration testing, a report will be automatically generated in `logs` folder (if you quit with `quit` command). 2. The report can be printed in a human-readable format by running `python3 utils/report_generator.py `. A sample report `sample_pentestGPT_log.txt` is also uploaded.