Skip to content

Commit 3975a8a

Browse files
committed
docs: update README to reflect free AI integration via OpenRouter and new Discord commands
1 parent 82181f0 commit 3975a8a

1 file changed

Lines changed: 41 additions & 3 deletions

File tree

README.md

Lines changed: 41 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Results are automatically uploaded to **Cloudflare R2 storage** and linked direc
3434
| ⚙️ **Misconfigs** | 100+ service misconfiguration checks |
3535
| 🏴‍☠️ **BB Scope** | Fetch scope from HackerOne, Bugcrowd, Intigriti, YesWeHack, Immunefi |
3636
| 🔄 **Monitoring** | Subdomain + URL change monitoring daemon with Discord alerts & DB history |
37-
| 🤖 **AI Agent CLI** | Full AI hunt loop as a CLI command: `autoar agent "find XSS on example.com"` |
37+
| 🤖 **AI Agent** | Full AI hunt loop (CLI + Discord `/ai` & `/brain`) — powered by **Step-3.5 Flash via OpenRouter (free tier)** — zero cost required |
3838
| 📤 **R2 Storage** | Auto-upload every non-empty result file to Cloudflare R2 and print the public URL |
3939

4040
---
@@ -256,6 +256,40 @@ autoar status [--json]
256256
```
257257

258258

259+
---
260+
261+
## 🤖 AI-Driven Security Framework — Free for Everyone
262+
263+
As of the latest release, AutoAR's AI engine runs on **[`stepfun/step-3.5-flash:free`](https://openrouter.ai/stepfun/step-3.5-flash:free)** via [OpenRouter](https://openrouter.ai). This is a **completely free model** — no credits, no billing required.
264+
265+
> **Every AutoAR user can now access a full AI-driven bug bounty framework at zero cost** — just sign up for a free OpenRouter account and paste your key into `.env`.
266+
267+
### What the AI powers
268+
269+
| Discord Command | What it does |
270+
|---|---|
271+
| `/ai message:<request>` | Chat with AutoAR AI in natural language. Describe your target and it will queue the right scans automatically. |
272+
| `/ai message:<request> agent_mode:True` | Autonomous agent loop — the AI plans, runs tools, validates findings, and reports confirmed bugs. |
273+
| `/ai message:<request> dry_run:True` | Preview what scans would run without executing anything. |
274+
| `/brain` | AI analysis of your latest scan results — suggests next-step attacks and highlights interesting findings. |
275+
| `autoar agent "<request>"` | Same autonomous agent loop from the terminal (no Discord needed). |
276+
| `autoar explain <result-file>` | Feed any result file to the AI for triage and follow-up suggestions. |
277+
278+
### Getting your free OpenRouter key
279+
280+
1. Go to [openrouter.ai](https://openrouter.ai) and create a **free account** (no credit card required for free models)
281+
2. Navigate to **Keys****Create Key**
282+
3. Copy your key and add it to `.env`:
283+
284+
```env
285+
OPENROUTER_API_KEY=sk-or-v1-...
286+
```
287+
288+
That's it. AutoAR will automatically use `stepfun/step-3.5-flash:free` for all `/ai` and `/brain` commands.
289+
290+
> **Tip:** If `OPENROUTER_API_KEY` is set, it is used first. `GEMINI_API_KEY` is a fallback for direct Gemini access. You only need one of the two.
291+
292+
259293
### Database & Results
260294

261295
```
@@ -419,8 +453,12 @@ ZOOMEYE_PASSWORD=...
419453
H1_API_KEY=... # HackerOne
420454
INTEGRITI_API_KEY=... # Intigriti
421455
422-
# AI analysis
423-
OPENROUTER_API_KEY=... # For AI-driven scan analysis
456+
# AI analysis — only ONE key is needed
457+
# ✅ Recommended: OpenRouter free tier (no credit card required)
458+
# Sign up at https://openrouter.ai · Uses stepfun/step-3.5-flash:free automatically
459+
OPENROUTER_API_KEY=... # Powers /ai, /brain, and `autoar agent` — completely free
460+
461+
# Optional fallback: direct Gemini API (only if you don't use OpenRouter)
424462
GEMINI_API_KEY=...
425463
```
426464

0 commit comments

Comments
 (0)