Installation
This section covers the installation and setup requirements for TrigDroid.
Note
TrigDroid is designed for defensive security research and malware analysis only. Only test applications you own or have permission to analyze.
Requirements
System Requirements
Python 3.9+ - Required for running TrigDroid
Node.js 16+ - Required for building TypeScript Frida hooks
Android SDK with ADB - For Android device communication
Android Device or Emulator - With USB debugging enabled
Optional Dependencies
Frida 16.0+ - For runtime instrumentation (recommended)
Android Studio - For managing emulators and SDK components
Quick Installation
Basic Installation
Install TrigDroid with basic functionality:
pip install -e .
Development Installation
Install with all development tools and features:
pip install -e ".[full,dev]"
Feature-Specific Installation
Install with specific features only:
# Frida support only
pip install -e ".[frida]"
# Development tools only
pip install -e ".[dev]"
Android SDK Setup
Android Studio Installation
Download and install Android Studio
Launch Android Studio and complete the initial setup
Install the Android SDK and build tools through the SDK Manager
Setting up an Emulator
Open Android Studio
Go to Tools > AVD Manager
Click Create Virtual Device
Select a device definition and system image
Configure the AVD settings and click Finish
Start the emulator from the AVD Manager
Adding ADB to PATH
Add the Android SDK platform-tools to your system PATH:
Linux/macOS:
export PATH="$HOME/Android/Sdk/platform-tools:$PATH"
# Add to your ~/.bashrc or ~/.zshrc for persistence
Windows:
set PATH=%LOCALAPPDATA%\Android\Sdk\platform-tools;%PATH%
Device Configuration
Physical Device Setup
Enable Developer Options on your Android device:
Go to Settings > About Phone
Tap Build Number 7 times
Enable USB Debugging:
Go to Settings > Developer Options
Enable USB Debugging
Connect your device via USB and accept the debugging authorization
Emulator Setup
Start your Android emulator
Verify ADB connection:
adb devices
You should see your device/emulator listed.
Verification
Test Your Installation
Verify that TrigDroid is installed correctly:
# Check TrigDroid installation
python -c "import trigdroid; print('TrigDroid installed successfully')"
# Test CLI access
trigdroid --help
# List connected devices
trigdroid devices
Build TypeScript Hooks (Optional)
If you plan to use Frida instrumentation:
cd frida-hooks
npm install
npm run build
Quick Start Test
Run a basic test to verify everything works:
# Test with a system app (replace with actual package)
trigdroid -p com.android.settings
# If you have a test app installed
trigdroid -p com.example.testapp --timeout 30
Troubleshooting
Common Issues
- ADB not found:
Ensure Android SDK platform-tools are in your PATH
- No devices found:
Check USB debugging is enabled
Run
adb devices
to verify connectionTry
adb kill-server && adb start-server
- Permission denied:
Check USB debugging authorization on device
Try different USB cable or port
- Frida installation issues:
Install Frida server on your device/emulator
Ensure Frida version compatibility
- Import errors:
Verify Python version (3.9+)
Try
pip install -e ".[full]"
for all dependencies
For more detailed troubleshooting, see the Troubleshooting section.
Next Steps
Now that TrigDroid is installed, you can:
Read the Background & Usage to understand TrigDroid’s capabilities
Check out the API Reference for programmatic usage
Explore the Development guide if you want to contribute