Hex-Rays CLI Utility

0.17.2 · active · verified Sat Apr 11

ida-hcli (Hex-Rays CLI Utility) is a command-line interface tool designed to interact with Hex-Rays IDA Pro installations. It assists with managing IDA versions, plugins, and configurations programmatically or via the terminal. Currently at version 0.17.2, it sees frequent updates, typically with minor releases several times a month.

Warnings

gotcha Prior to v0.17.0, the help message for the `HCLI_CURRENT_IDA_INSTALL_DIR` environment variable on macOS was misleading, potentially causing confusion during setup.
Fix: Upgrade to v0.17.0 or newer for clarified help messages related to IDA installation directories.
gotcha Versions before v0.16.0 had a less robust algorithm for detecting the correct Python executable associated with IDA Pro, which could lead to runtime errors or incorrect interpreter usage.
Fix: Update to v0.16.0 or later to benefit from improved Python executable detection logic, ensuring better compatibility with various IDA Pro setups.
breaking Before v0.16.0, explicit UTF-8 encoding was not consistently used across the library and for subprocesses. This could cause encoding-related errors or unexpected behavior when dealing with non-ASCII characters in paths, filenames, or output.
Fix: Upgrade to v0.16.0 or higher. This version explicitly sets UTF-8 encoding for files and subprocesses, mitigating potential encoding issues.

Install

pip install ida-hcli Install stable version

Imports

HCLISettings
```
from hcli.settings import HCLISettings
```
While primarily a CLI tool, core components like HCLISettings can be imported for programmatic configuration.

Quickstart

This quickstart demonstrates how to invoke the `hcli` command-line utility programmatically using Python's `subprocess` module to check its installed version. `ida-hcli` is primarily a CLI tool, and this is the most common way to interact with it.

import subprocess

try:
    # Run a basic hcli command to check its version
    result = subprocess.run(['hcli', '--version'], capture_output=True, text=True, check=True)
    print(f"hcli version: {result.stdout.strip()}")

    # Example of checking IDA Pro installations
    # result = subprocess.run(['hcli', 'check'], capture_output=True, text=True, check=True)
    # print(f"hcli check output:\n{result.stdout}")

except FileNotFoundError:
    print("Error: 'hcli' command not found. Ensure ida-hcli is installed and in your PATH.")
except subprocess.CalledProcessError as e:
    print(f"Error running hcli command: {e.cmd}")
    print(f"Stdout: {e.stdout}")
    print(f"Stderr: {e.stderr}")

view raw JSON →