HexRaysSA /ida-domain

IDA Domain API - Python interface for IDA Pro reverse engineering platform

★ 301⑂ 32👁 5⑃ 120● 36▤ 20
PythonMITCreated 2025-08-12ida-domain.docs.hex-rays.com/
下载:v0.6.0v0.6.0 ↓0.6.02026-11-10
+0
日增长
301
stars
32
forks
5
watchers
120
prs
36
issues
20
releases

README

IDA Domain





The IDA Domain API is a new open-source Python API designed to make scripting in IDA simpler, more consistent, and more natural.

This is a first step in a much longer journey. It’s not the finish line, but a foundation for ongoing collaboration between Hex-Rays and the reverse engineering community. Over time, the Domain API will expand to cover more areas of IDA, gradually becoming the main entry point for scripting and plugin development.

The Domain in Domain API refers to the domain of reverse engineering. Concepts like functions, types, cross-references, and more are first-class citizens in this API, giving you cleaner, domain-focused abstractions for common tasks.

The Domain API sits on top of the IDA Python SDK, complementing it rather than replacing it. You can use both side by side—combining the clarity and simplicity of Domain API calls with the full flexibility of the SDK when needed.

 Compatibility: Requires IDA Pro 9.1.0 or later

 🚀 Key Features

- Domain-focused design – Work directly with core reverse engineering concepts like functions, types, and xrefs as first-class citizens.
- Open source from day one – Read the code, suggest improvements, or contribute new ideas.
- Pure Python implementation – No compilation required, works with modern Python versions.
- Compatible by design – Use alongside the IDA Python SDK without conflicts.
- Developer-centric – Reduce boilerplate and streamline frequent tasks.
- Independently versioned – Upgrade at your own pace and pin versions for stability.
- Simple installation – Get started with a single pip install.

 📦 Installation

 Prerequisites

IDA Pro Version: The IDA Domain library requires IDA Pro 9.1.0 or later.

The idapro Python module needs to know where IDA Pro is installed. The location is stored in a per-user config file (%APPDATA%\Hex-Rays\IDA Pro\ida-config.json on Windows, ~/.idapro/ida-config.json on Linux/macOS).

- If IDA was installed via HCLI: the install path is configured automatically — no further setup is required.
- Otherwise: run the py-activate-idalib.py activation script that ships with IDA once. It auto-detects the install directory from its own location and writes it to the per-user config. The script normally lives in /idalib/python/:

  Linux/macOS:
  bash
  python3 "/path/to/ida/idalib/python/py-activate-idalib.py"
  

  Windows:
  cmd
  python "C:\Program Files\IDA Professional 9.1\idalib\python\py-activate-idalib.py"
  

  You can also pass -d  to point at a specific IDA installation explicitly.

 Install from PyPI

bash
pip install ida-domain


 Overriding the IDA install directory with IDADIR

To override the configured install directory for a single session or script — for example to test a specific IDA build, switch between multiple installed versions, or in CI — set the IDADIR environment variable before importing idapro:

Linux/macOS:
bash
export IDADIR="/path/to/your/ida/installation"


Windows:
cmd
set "IDADIR=C:\Program Files\IDA Pro

Top issues

Discussions

Latest release

v0.6.0 v0.6.0 2026-11-10
v0.6.0 (2026-11-10)

_Changes since v0.5.0, including those shipped in v0.5.1._

 Added
- Analysis API – db.analysis: enable or disable the auto-analyzer, wait for it, and schedule or cancel work on addresses and ranges (114).
- License API – db.license / License: query the active license, add-ons and features, check out, borrow and return seats. (122, 128).
- Synthetic strings – db.strings now lists strings that do not exist in the bytes, such as those reconstructed by the decompiler (121, 150).
- Functions – set_start / set_end, update, reanalyze, is_outlined / set_outlined, apply_de

Snapshot: 2026-11-16T09:23:14Z · Data license Apache-2.0 · JSON