ida-settings

What it is and what it does

ida-settings is a configuration-retrieval library designed specifically for IDA Pro plugins. It reads settings that were initially configured during plugin installation via hcli and stored in ida-config.json, providing a simple API to fetch those values within plugin code. The library exposes methods to get, set, delete, check existence of, and list configuration values, though the primary use case is reading values that were declared in the plugin's ida-plugin.json file.

The library is tightly coupled to IDA Pro's plugin environment and does not function outside of it. It depends on ida-hcli as its only runtime dependency. Configuration changes are intended to be made through hcli or the IDA Pro GUI rather than programmatically, though programmatic access is available. The package also includes a graphical settings manager plugin that can be installed separately to browse and edit all plugin settings with validation and UI controls.

Use it for:

• Retrieve API keys or credentials stored in plugin configuration within an IDA Pro plugin
• Access user-configured options that were set during plugin installation
• Build IDA Pro plugins that respect user settings without hardcoding configuration
• Programmatically check or modify plugin settings when the GUI is not available

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Provides a Python API for IDA Pro plugins to retrieve configuration values stored in a shared settings infrastructure, with values initially set during plugin installation via hcli.

Yes, if you are developing IDA Pro plugins and need to access configuration values set during installation. The package is actively maintained, has low install friction, and is purpose-built for this use case. Not applicable outside of IDA Pro plugin development.

Install

ida-settings on PyPI

pip install ida-settings

uv add ida-settings

poetry add ida-settings

Installing ida-settings

Before you install

Low install friction with a single pure-Python dependency (ida-hcli). Actively maintained, with latest release 49 days ago. Requires Python 3.10 or later.

Quickstart

pip install ida-settings

import ida_settings
api_key = ida_settings.get_current_plugin_setting("openai_key")

This library only works within IDA Pro's plugin environment and cannot function outside of it.

Verify before relying

• Whether ida-hcli is available and installable in standard Python environments outside IDA Pro
• Stability and API compatibility guarantees across IDA Pro versions
• Whether the library works with IDA Pro versions prior to the latest release

Package facts

Evidence: ida_settings-3.5.1-py3-none-any.whl

Tags

More Software Development packages