Skip to content

Commit bd13972

Browse files
committed
docs: added example usages
1 parent 1388c7d commit bd13972

File tree

6 files changed

+47
-6
lines changed

6 files changed

+47
-6
lines changed

examples/ai_news/README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
1-
Fetches the latest AI news and provides a few bullet-points summary.
1+
Fetches the latest AI news and provides a few bullet-points summary.
2+
3+
### Example Usage
4+
5+
```sh
6+
nerve -G "openai://gpt-4" -T ai_news
7+
```

examples/code_auditor/README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
1-
Looks for vulnerabilities in the specified code folder.
1+
Looks for vulnerabilities in the specified code folder.
2+
3+
### Example Usage
4+
5+
```sh
6+
nerve -G "openai://gpt-4" -T code_auditor -DTARGET_PATH=/path/to/code
7+
```

examples/fuzzer/README.md

+12-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,12 @@
1-
Fuzzes a test binary in order to find a crash.
1+
Fuzzes a test binary in order to find a crash.
2+
3+
**NOTEs**
4+
5+
* The fuzz.py script assumes the presence of LLDB.
6+
* The test_binary must be compiled with make.
7+
8+
### Example Usage
9+
10+
```sh
11+
nerve -G "openai://gpt-4" -T fuzzer
12+
```

examples/kali_pentester/README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
1-
Uses access to a Kali computer (default [email protected], can be set via KALI_VM_CONNECTION_STRING).
1+
Uses access to a Kali computer (default [email protected], can be set via KALI_VM_CONNECTION_STRING).
2+
3+
### Example Usage
4+
5+
```sh
6+
nerve -G "openai://gpt-4" -T kali_pentester -DTARGET_HOST=your-target.com
7+
```

examples/ssh_agent/README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
1-
Executes tasks on a remote computer by executing bash commands on it via ssh.
1+
Executes tasks on a remote computer by executing bash commands on it via ssh.
2+
3+
### Example Usage
4+
5+
```sh
6+
nerve -G "openai://gpt-4" -T ssh_agent -DSSH_USER_HOST_STRING=username@hostname -P "check which process is consuming more ram"
7+
```
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
1-
Performs simple HTTP requests to find vulnerabilities in a target website.
1+
Performs simple HTTP requests to find vulnerabilities in a target website.
2+
3+
### Example Usage
4+
5+
```sh
6+
nerve -G "openai://gpt-4" -T web_vulnerability_scanner -D "URL=http://testphp.vulnweb.com/"
7+
```

0 commit comments

Comments
 (0)