Skip to content

Commit ef5697e

Browse files
committed
docs: Enhance command discoverability with a new /help command and updated README, refine Discord file handling, and remove dsieve.go.
1 parent cba44b9 commit ef5697e

11 files changed

Lines changed: 507 additions & 372 deletions

File tree

README.md

Lines changed: 45 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,58 @@
1-
# AutoAR - Automated Reconnaissance Platform
1+
# AutoAR - Automated Attack & Reconnaissance Platform
2+
3+
AutoAR is a powerful, highly scalable automated security reconnaissance tool and Discord bot specifically designed for bug bounty hunters and penetration testers. It automates gathering subdomains, scanning ports, detecting technologies, mapping GitHub repositories, fuzzing, testing vulnerabilities, and executing AI analysis.
4+
5+
## 🚀 Key Features
6+
7+
- **Centralized Discord Command Hub**: Run, monitor, and manage full reconnaissance workflows directly from a Discord interface using slash commands.
8+
- **Granular & Automated Workflows**:
9+
- `/domain_run`: A comprehensive, fully-automated recon and vulnerability assessment pipeline for an entire root domain.
10+
- `/subdomain_run`: A focused, deep-dive workflow targeting a single specific subdomain (including port scanning, exposure checks, and nuclei profiling).
11+
- `/lite_scan` & `/fast_look`: Scalable scanning options designed to quickly summarize targets while skipping heavy fuzzing execution.
12+
- **Comprehensive Infrastructure Mapping**: Integrates seamlessly with Subfinder, Amass, crt.sh, Wayback Machine, and Chaos to enumerate subdomains and live hosts.
13+
- **AI Brain & Natural Language Processing**:
14+
- Send direct natural language instructions via `/ai` (e.g., *"Do a quick scan on example.com for zero-days"*).
15+
- Use `/brain` to feed scan records to an AI model (Gemini/OpenRouter), allowing it to intelligently analyze the output and suggest follow-up attacks or generate exploit `curl` commands.
16+
- **Continuous Vulnerability Assessment**:
17+
- `/nuclei`: Continuous targeted exposure monitoring using customized templates.
18+
- `/zerodays`: Specialized rapid verification scanners for the newest active Zero-Day vulnerabilities.
19+
- **Advanced Target Deep Dives**:
20+
- Intelligent JavaScript endpoint and secrets extraction.
21+
- Mobile application security scanning (`/apkx_scan`, `/apkx_ios`).
22+
- Active Misconfiguration testing, S3 Bucket detection, and GitHub source code exposure scanning.
223

3-
AutoAR is an automated security reconnaissance tool and Discord bot for bug bounty hunters and penetration testers. It automates gathering subdomains, scanning ports, detecting technologies, mapping GitHub repositories, fuzzing, testing vulnerabilities, and AI analysis.
24+
---
25+
26+
## 📋 Available Commands
427

5-
## Features
28+
AutoAR provides an extensive toolkit of over 30 Discord commands to orchestrate your workflow:
629

7-
- **Discord Bot Interface**: Run and manage full reconnaissance workflows from Discord commands (`/domain_run`, `/subdomain_run`, `/brain`, etc.).
8-
- **Subdomain Enumeration**: Subfinder, amass, crt.sh, wayback machine and chaos integration.
9-
- **Port Scanning**: Naabu integration for continuous port scanning.
10-
- **Vulnerability Scanning**: Nuclei templates for continuous exposure monitoring.
11-
- **AI Brain**: AI-driven analysis of discovery logs, automated follow-up commands (`curl`, `nmap` scanning) via Gemini and OpenRouter using the `/brain` command.
12-
- **Web App Analysis**: JavaScript file analysis, secret scanning (jwt-hack, dalfox), misconfiguration and S3 bucket testing.
13-
- **Mobile Scanning**: APK and iOS package fetching and testing.
14-
- **Zero Days & Exposures**: Specialized scanning components for recent CVEs and quick verifications.
30+
- **Automated Orchestration**: `/domain_run`, `/subdomain_run`, `/lite_scan`, `/fast_look`
31+
- **Reconnaissance & Asset Discovery**: `/subdomains`, `/livehosts`, `/urls`, `/ports`
32+
- **Vulnerability Checks**: `/zerodays`, `/nuclei`, `/sqlmap`, `/dalfox`, `/dns`
33+
- **Specific Scanners**: `/apkx_scan`, `/apkx_ios`, `/s3_scan`, `/github`, `/jwt_scan`
34+
- **AI Intelligence**: `/ai`, `/brain`
35+
- **Utilities & State**: `/help`, `/cancel_scan`, `/scans`, `/db`
36+
37+
*(Type `/help` in your Discord server for a completely categorized view of all features.)*
1538

1639
---
1740

18-
## Prerequisites
41+
## ⚙️ Prerequisites
1942

2043
Ensure you have the following installed on your host or Docker environment:
2144
- **Go** (1.21+ recommended)
2245

23-
*(AutoAR handles security tools and utilities internally via Go modules and libraries.)*
46+
*(AutoAR gracefully handles security tools and utilities internally via Go modules and system libraries.)*
2447

25-
## Installation & Setup
48+
---
49+
50+
## 🛠️ Installation & Setup
2651

2752
There are two primary ways to install and run AutoAR:
2853

2954
### Option 1: Quick Install using `go install`
30-
Because the main executable is located in the `cmd/autoar` directory, you cannot simply run `go install github.com/h0tak88r/AutoAR@latest`. Instead, you must point directly to the binary package:
55+
Because the main executable is located in the `cmd/autoar` directory, you cannot simply run `go install github.com/h0tak88r/AutoAR@latest`. Instead, point directly to the binary package:
3156

3257
```bash
3358
go install github.com/h0tak88r/AutoAR/cmd/autoar@latest
@@ -58,12 +83,12 @@ go install github.com/h0tak88r/AutoAR/cmd/autoar@latest
5883
Copy the provided `.env.example` or tailor your `.env` in the root directory. AutoAR relies strictly on these environment variables:
5984

6085
- **DISCORD_BOT_TOKEN**: Your Discord Bot Token (Bot must have `applications.commands` and standard message intents).
61-
- **DISCORD_ALLOWED_GUILD**: Restricts the bot exclusively to your own Guild (Server) Name.
86+
- **DISCORD_ALLOWED_GUILD_ID**: Restricts the bot exclusively to your own Guild (Server) ID.
6287
- **DB_TYPE**: `postgresql` or `sqlite3`
6388
- **DB_HOST**: Your connection URI or sqlite path.
6489
- **OPENROUTER_API_KEY** / **GEMINI_API_KEY**: API key for your AI Analysis features.
6590
- **AUTOAR_RESULTS_DIR**: Set to `./new-results` or `/app/new-results` if running via Docker.
66-
- **Additional Integrations**: Shodan, Censys, VirusTotal, R2 Storage IDs as needed in `.env`.
91+
- **Optional Integrations**: Shodan, Censys, VirusTotal, R2 Storage IDs as needed.
6792

6893
5. **Run the Bot or API:**
6994
Run the bot natively, ensuring `.env` is loaded automatically:
@@ -78,7 +103,9 @@ go install github.com/h0tak88r/AutoAR/cmd/autoar@latest
78103
./autoar both
79104
```
80105

81-
## Troubleshooting
106+
---
107+
108+
## 🐛 Troubleshooting
82109

83110
**No Logs Displaying in the Terminal?**
84111

cmd/autoar/main.go

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -199,9 +199,10 @@ Commands:
199199
Options for start/stop: --id <id> | -d <domain> | --all
200200
201201
Workflows:
202-
lite run -d <domain>
203-
fastlook run -d <domain>
204-
domain run -d <domain>
202+
lite run -d <domain> Full scan: livehosts → reflection → JS → CNAME → backup → DNS → misconfig
203+
fastlook run -d <domain> Quick recon: subdomains → live hosts → URLs/JS collection
204+
domain run -d <domain> [--skip-ffuf] Full domain workflow: enumerate everything, ports, vuln scan, github, etc.
205+
subdomain run -s <subdomain> Full workflow on a single subdomain: live check → ports → JS → vuln scan → nuclei
205206
206207
Database:
207208
db domains list

0 commit comments

Comments
 (0)