ADscanADscan Docs

Command Reference

Quick reference for all ADscan commands

Quick reference for all ADscan commands. For detailed documentation, see individual command pages.

Workspace Commands

CommandDescriptionSyntax
workspace createCreate new workspaceworkspace create <name>
workspace listList all workspacesworkspace list
workspace switchSwitch to different workspaceworkspace switch <name>
workspace deleteDelete workspaceworkspace delete <name>
workspace infoShow workspace detailsworkspace info
clear_allClear all workspace dataclear_all

Configuration Commands

CommandDescriptionSyntaxExample
set ifaceSet network interfaceset iface <interface>set iface tun0
set hostsSet target IP rangeset hosts <cidr|ip>set hosts 10.10.10.0/24
set autoSet automation levelset auto <True|False>set auto False
set verboseSet verbose modeset verbose <True|False>set verbose True
set telemetryEnable/disable telemetryset telemetry <on|off>set telemetry on

Scanning Commands

CommandDescriptionSyntax
start_unauthStart unauthenticated scanstart_unauth
start_authStart authenticated scanstart_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:hash

Credential Commands

CommandDescriptionSyntax
creds showDisplay discovered credentialscreds show
creds selectSelect credential for enumerationcreds select <domain>

System Command

CommandDescriptionSyntax
systemExecute local system commandsystem <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 status

Help Commands

CommandDescriptionSyntax
helpList all commandshelp
help <command>Get help for specific commandhelp start_auth
exitExit ADscanexit

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 help

Workflow Quick Start

Unauthenticated Scan

adscan start -v
workspace create <name>
set iface tun0
set hosts 10.10.10.0/24
set auto False
start_unauth

Authenticated 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 credential

Using 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 user

Configuration Cheat Sheet

For Production/Client Engagements

set auto False               # Semi-automatic mode
set verbose True             # Detailed output
set telemetry off            # Disable if required

For Labs/CTFs

set auto True                # Automatic mode
set verbose True             # See what's happening

Network Configuration

# Find your interface
system ip addr show

# Common interfaces
set iface eth0               # Ethernet
set iface tun0               # VPN (HTB, VulnHub)
set iface wlan0              # WiFi

Automation Modes

ModeDescriptionUse CasePrompts
auto=FalseSemi-automaticProduction, client engagementsBefore each risky operation
auto=TrueAutomaticLabs, CTFs, testingMinimal, 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 logs

Logs

~/.adscan/logs/adscan.log     # Main log file

Configuration

~/.adscan/config.json         # User configuration
~/.adscan/tools/              # Installed tools

BloodHound 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 paths

Common 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 escalates

2. 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 password

3. 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 privileges

Tips and Tricks

Check VPN Before Scanning

system ping <target_ip>
system ip addr show | grep tun0

Monitor Scan Progress

# In another terminal
tail -f ~/.adscan/logs/adscan.log

View 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 bloodhound

Troubleshooting Quick Reference

IssueQuick Fix
Docker not runningsystem sudo systemctl start docker
Interface not foundsystem ip addr show to find correct interface
Authentication failedVerify credentials with system nxc smb <ip> -u <user> -p <pass>
BloodHound not accessiblesystem docker restart bloodhound
Out of disk spaceDelete old workspaces or use clear_all

For detailed troubleshooting, see the Troubleshooting Guide.