Skip to content

Commit 23e85ee

Browse files
committed
.
2 parents b1cd29e + 97754ca commit 23e85ee

1 file changed

Lines changed: 11 additions & 3 deletions

File tree

README.md

Lines changed: 11 additions & 3 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,19 +165,27 @@ 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 (NEW FEATURE🚀)
169+
170+
<img width="864" height="1098" alt="image" src="https://github.com/user-attachments/assets/5094fef9-73d1-4d34-b530-9498d923a514" />
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
177185
pyspector scan /path/to/your/project --ai
178186
```
179187

180-
## Plugin System (NEW FEATURE🚀)
188+
## Plugin System
181189

182190
<img width="1298" height="538" alt="image" src="https://github.com/user-attachments/assets/f2ad2a5e-c8e3-4723-a729-f318fef07e24" />
183191
PySpector ships with an extensible plugin architecture that lets you post-process findings, generate custom artefacts, or orchestrate follow-up actions after every scan. Plugins run in-process once the Rust core returns the final issue list, so they see exactly the same normalized data that drives the built-in reports.

0 commit comments

Comments
 (0)