Skip to content

Commit 98e7eac

Browse files
authored
Enhanced README with Wizard Mode instructions
Added Wizard Mode section for beginners in README.
1 parent 9985bae commit 98e7eac

1 file changed

Lines changed: 10 additions & 2 deletions

File tree

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ pyspector scan [PATH or --url REPO_URL] [OPTIONS]
153153

154154
* **Scan a single file**
155155
```bash
156-
pyspector scan project/main.py
156+
pyspector scan /path/to/your/project
157157
```
158158

159159
* **Scan a local directory and save the report as HTML:**
@@ -165,12 +165,20 @@ pyspector scan /path/to/your/project -o report.html -f html
165165
```bash
166166
pyspector scan --url https://github.com/username/repo.git
167167
```
168+
### Wizard Mode for Beginners
169+
170+
<img width="462" height="920" alt="pyspector wizard screenshot" src="https://github.com/user-attachments/assets/c43cd5ba-9d5b-4420-a33a-7aa999a399cc" />
171+
172+
* **Use the `--wizard` flag to enter the guided scan mode, perfect for 1st time users and beginners or students:**
173+
174+
```bash
175+
pyspector scan --wizard
176+
```
168177

169178
### Scan for AI and LLM Vulnerabilities
170179

171180
<img width="970" height="1096" alt="image" src="https://github.com/user-attachments/assets/14bac1c0-eae2-4dab-ab40-8047b46bbac8" />
172181

173-
174182
* **Use the `--ai` flag to enable a specialized ruleset, for projects using Large Language Models:**
175183

176184
```bash

0 commit comments

Comments
 (0)