Command Reference
Quick reference for all ADscan commands
Quick reference for all ADscan commands. For detailed documentation, see individual command pages.
Workspace Commands
| Command | Description | Syntax |
|---|---|---|
workspace create | Create new workspace | workspace create <name> |
workspace list | List all workspaces | workspace list |
workspace switch | Switch to different workspace | workspace switch <name> |
workspace delete | Delete workspace | workspace delete <name> |
workspace info | Show workspace details | workspace info |
clear_all | Clear all workspace data | clear_all |
Configuration Commands
| Command | Description | Syntax | Example |
|---|---|---|---|
set iface | Set network interface | set iface <interface> | set iface tun0 |
set hosts | Set target IP range | set hosts <cidr|ip> | set hosts 10.10.10.0/24 |
set auto | Set automation level | set auto <True|False> | set auto False |
set verbose | Set verbose mode | set verbose <True|False> | set verbose True |
set telemetry | Enable/disable telemetry | set telemetry <on|off> | set telemetry on |
Scanning Commands
| Command | Description | Syntax |
|---|---|---|
start_unauth | Start unauthenticated scan | start_unauth |
start_auth | Start authenticated scan | start_auth <domain> <dc_ip> <user> <pass|hash> |
start_auth Syntax
# With password
start_auth <domain> <dc_ip> <username> <password>
# With NTLM hash
start_auth <domain> <dc_ip> <username> <ntlm_hash>
# Examples
start_auth corp.local 10.10.10.1 jdoe Password123
start_auth htb.local 10.10.10.161 svc-alfresco s3rvice
start_auth example.local 10.0.0.1 admin aad3b435b51404eeaad3b435b51404ee:hashCredential Commands
| Command | Description | Syntax |
|---|---|---|
creds show | Display discovered credentials | creds show |
creds select | Select credential for enumeration | creds select <domain> |
System Command
| Command | Description | Syntax |
|---|---|---|
system | Execute local system command | system <command> |
Local Execution
system runs commands on your local machine (where ADscan is running), NOT on the target domain.
Common system commands:
system whoami # Local user
system ip addr show # Network interfaces
system ping <ip> # Test connectivity
system ls ~/.adscan/workspaces/ # List workspaces
system df -h # Disk space
system docker ps # BloodHound statusHelp Commands
| Command | Description | Syntax |
|---|---|---|
help | List all commands | help |
help <command> | Get help for specific command | help start_auth |
exit | Exit ADscan | exit |
CLI Flags
Launch ADscan with these flags:
adscan start # Start interactive TUI
adscan start -v # Start with verbose mode
adscan start --verbose # Same as -v
adscan start --debug # Start with debug mode
adscan install # Install dependencies
adscan check # Check installation status
adscan --version # Show version
adscan --help # Show helpWorkflow Quick Start
Unauthenticated Scan
adscan start -v
workspace create <name>
set iface tun0
set hosts 10.10.10.0/24
set auto False
start_unauthAuthenticated Scan
adscan start -v
workspace create <name>
set iface tun0
set auto False
start_auth <domain> <dc_ip> <user> <pass>Credential Management
creds show # View all credentials
creds select <domain> # Select credential
# ADscan enumerates with selected credentialUsing Discovered Credentials
# After discovering credentials in unauthenticated scan
start_unauth # Discovers credentials
creds show # View what was found
creds select <domain> # Pick credential
start_auth ... # Enumerate as that userConfiguration Cheat Sheet
For Production/Client Engagements
set auto False # Semi-automatic mode
set verbose True # Detailed output
set telemetry off # Disable if requiredFor Labs/CTFs
set auto True # Automatic mode
set verbose True # See what's happeningNetwork Configuration
# Find your interface
system ip addr show
# Common interfaces
set iface eth0 # Ethernet
set iface tun0 # VPN (HTB, VulnHub)
set iface wlan0 # WiFiAutomation Modes
| Mode | Description | Use Case | Prompts |
|---|---|---|---|
auto=False | Semi-automatic | Production, client engagements | Before each risky operation |
auto=True | Automatic | Labs, CTFs, testing | Minimal, fast |
Production Safety
Always use auto=False in production environments. Automatic mode may execute disruptive operations without confirmation.
File Locations
Workspace Data
~/.adscan/workspaces/<workspace>/
├── credentials.json # Discovered credentials
├── users.txt # Domain users
├── computers.txt # Domain computers
├── bloodhound/ # BloodHound data
└── logs/ # Scan logsLogs
~/.adscan/logs/adscan.log # Main log fileConfiguration
~/.adscan/config.json # User configuration
~/.adscan/tools/ # Installed toolsBloodHound Integration
ADscan automatically collects and uploads BloodHound data during authenticated scans.
# BloodHound CE runs on
http://localhost:8080
# Default credentials (set during adscan install)
# Username: admin
# Password: <set during installation>
# Data is auto-uploaded during scans
# Access BloodHound to view attack pathsCommon Workflows
1. CTF Auto-Pwn
adscan start -v
workspace create htb_forest
set iface tun0
set auto True
set hosts 10.10.10.161
start_unauth
# ADscan automatically discovers, cracks, and escalates2. Client Pentest (Conservative)
adscan start -v
workspace create client_jan2024
set iface eth0
set auto False
set hosts 192.168.1.0/24
start_unauth
# Review findings, then:
creds show
creds select corp.local
start_auth corp.local 192.168.1.10 user password3. Credential Testing
workspace create cred_test
set iface eth0
set auto False
start_auth corp.local 10.0.0.1 testuser TestPass123
# Enumerate access and privilegesTips and Tricks
Check VPN Before Scanning
system ping <target_ip>
system ip addr show | grep tun0Monitor Scan Progress
# In another terminal
tail -f ~/.adscan/logs/adscan.logView Workspace Files
system ls -la ~/.adscan/workspaces/<workspace>/Backup Workspace
system tar -czf backup.tar.gz ~/.adscan/workspaces/<workspace>/Check BloodHound Status
system docker ps | grep bloodhound
system docker logs bloodhoundTroubleshooting Quick Reference
| Issue | Quick Fix |
|---|---|
| Docker not running | system sudo systemctl start docker |
| Interface not found | system ip addr show to find correct interface |
| Authentication failed | Verify credentials with system nxc smb <ip> -u <user> -p <pass> |
| BloodHound not accessible | system docker restart bloodhound |
| Out of disk space | Delete old workspaces or use clear_all |
For detailed troubleshooting, see the Troubleshooting Guide.
Related Pages
- Workspace Management - Detailed workspace documentation
- Scanning Commands - In-depth scanning guide
- Credential Management - Credential command details
- Best Practices - Professional usage guidelines
- Troubleshooting - Common issues and solutions