Development Setup

​

Prerequisites

• Python: 3.10 or higher
• Platform: Windows, macOS, or Linux
• Qt: PySide6 (installed automatically)

​

Installation Methods

# Clone the repository
git clone https://github.com/angr/angr-management.git
cd angr-management

# Install with all development dependencies
uv sync --all-groups

# Activate the virtual environment
source .venv/bin/activate  # On Unix/macOS
# or
.venv\Scripts\activate  # On Windows

# Run angr Management
python -m angrmanagement

# Clone the repository
git clone https://github.com/angr/angr-management.git
cd angr-management

# Create a virtual environment
python -m venv venv
source venv/bin/activate  # On Unix/macOS

# Install in editable mode with dev dependencies
pip install -e ".[dev]"

# Run angr Management
angr-management

# Clone all required repositories
git clone https://github.com/angr/angr-management.git
git clone https://github.com/angr/angr.git
git clone https://github.com/angr/archinfo.git
git clone https://github.com/angr/pyvex.git
git clone https://github.com/angr/cle.git
git clone https://github.com/angr/claripy.git

# Install each in editable mode
cd archinfo && pip install -e . && cd ..
cd pyvex && pip install -e . && cd ..
cd cle && pip install -e . && cd ..
cd claripy && pip install -e . && cd ..
cd angr && pip install -e . && cd ..
cd angr-management && pip install -e ".[dev]" && cd ..

​

Dependency Groups

​

Core Dependencies

• PySide6-Essentials (>=6.4.2, !=6.7.0) - Qt bindings
• PySide6-QtAds (>=4.2.1) - Advanced docking system
• QtAwesome (1.4.0) - Icon fonts
• angr (with angrDB) - Binary analysis framework
• cle - Binary loader
• pyqodeng (>=0.0.10) - Code editor
• binsync (5.7.11) - Collaboration framework
• ipython - Interactive console

​

Development Group

uv sync --group dev

• docs - Documentation tools (Sphinx, furo, myst-parser)
• pyinstaller - Bundling tools
• testing - Test framework and coverage tools

​

Testing Group

uv sync --group testing

• pytest - Testing framework
• pytest-cov - Coverage plugin
• pytest-xdist - Parallel testing
• pytest-timeout - Test timeouts
• coverage - Code coverage

​

Documentation Group

uv sync --group docs

• sphinx - Documentation generator
• furo - Sphinx theme
• myst-parser - Markdown support
• sphinx-autodoc-typehints - Type hint documentation

​

PyInstaller Group

uv sync --group pyinstaller

• pyinstaller (6.16.0)
• pillow (macOS only)
• keystone-engine (non-Linux ARM)
• angr[unicorn]

​

Platform-Specific Setup

sudo apt-get update
sudo apt-get install -y \
  libfuse2 \
  libegl1 \
  libxkbcommon-x11-0 \
  libxcb-cursor0 \
  libxcb-icccm4 \
  libxcb-image0 \
  libxcb-keysyms1 \
  libxcb-randr0 \
  libxcb-render-util0 \
  libxcb-shape0

# Install Rust (required for some dependencies)
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

# Install angr Management
uv sync --all-groups

# Install Rust
# Download and run: https://rustup.rs/

# Clone and install
git clone https://github.com/angr/angr-management.git
cd angr-management
uv sync --all-groups

# Run
python -m angrmanagement

​

Running angr Management

# Using the installed script
angr-management

# Or the alias
am

# Using Python module
python -m angrmanagement

​

Development Tools

​

Code Quality

# Run linter
ruff check .

# Auto-fix issues
ruff check --fix .

# Format code
ruff format .

• Line length: 120
• Target version: Python 3.10
• Required imports: from __future__ import annotations

​

Type Checking

mypy angrmanagement tests

​

Testing

​

Environment Variables

# Force Qt API (set automatically by angr Management)
export QT_API=pyside6

# Set Qt platform for headless testing
export QT_QPA_PLATFORM=minimal:enable_fonts

# Enable debug logging
export ANGRMANAGEMENT_LOG_LEVEL=DEBUG

​

Project Structure

angr-management/
├── angrmanagement/          # Main package
│   ├── __init__.py         # Boot function
│   ├── __main__.py         # Entry point
│   ├── config/             # Configuration management
│   ├── data/               # Data models (Instance, ObjectContainer)
│   ├── logic/              # Business logic (GlobalInfo, managers)
│   ├── plugins/            # Plugin system
│   ├── ui/                 # UI components
│   │   ├── main_window.py  # MainWindow
│   │   ├── workspace.py    # Workspace
│   │   ├── views/          # All views
│   │   ├── dialogs/        # Dialog windows
│   │   └── widgets/        # Custom widgets
│   └── resources/          # Fonts, images, themes
├── tests/                  # Test suite
├── docs/                   # Documentation
├── pyproject.toml          # Project configuration
└── README.md

​

Optional Features

​

Bintrace Support

pip install angr-management[bintrace]

​

Troubleshooting

sudo apt-get install libegl1 libxkbcommon-x11-0 libxcb-cursor0

export QT_QPA_PLATFORM=offscreen

PySide6-Essentials>=6.4.2,!=6.7.0

pip install "PySide6-Essentials>=6.4.2,!=6.7.0"

# Check versions
python -c "import angrmanagement; print(angrmanagement.__version__)"
python -c "import angr; print(angr.__version__)"

​

Next Steps