Hex-rays

https://docs.hex-rays.com/
Admin
Hex-rays is a documentation repository created by Site2MD, likely for a project related to reverse...
Tokens:700,000
Snippets:7,956
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install IDA HCLI and idalib dependencies

Source: https://docs.hex-rays.com/core/idalib/how-tos/malware-analysis-with-idalib.md

Use this setup script in the cloud environment to install the necessary tools for idalib automation.

```bash
#!/bin/bash
uv tool install ida-hcli
pip install --user ida-domain
```

--------------------------------

### Start 64-bit application debugging

Source: https://docs.hex-rays.com/core/debugger/tutorials/debugger_pin.md

Example command to start a 64-bit application for remote debugging.

```shell
$ /usr/local/pin/pin \
  -t /usr/local/pin/source/tools/idapin/obj-intel64/idadbg64.so \
  -p 23947 -- \
  /bin/ls
```

--------------------------------

### Launch IDA Pro

Source: https://docs.hex-rays.com/getting-started/install-ida.md

Start the IDA Pro application from the installation directory.

```bash
./ida90
```

--------------------------------

### Start 32-bit application debugging

Source: https://docs.hex-rays.com/core/debugger/tutorials/debugger_pin.md

Example command to start a 32-bit application for remote debugging.

```shell
/usr/local/pin/pin \
  -t /usr/local/pin/source/tools/idapin/obj-ia32/idadbg.so \
  -p 23947 -- \
  ./hello32
```

--------------------------------

### Stack Frame Initialization Example

Source: https://docs.hex-rays.com/ida-actions/editfunction.md

Example assembly code showing the setup of a stack frame with EBP and ESP adjustments.

```assembly
           push    ebp
           lea     ebp, [esp-78h]
           sub     esp, 588h
           push    ebx
           push    esi
           lea     eax, [ebp+74h]
```

--------------------------------

### Golang Plugin Usage Examples

Source: https://docs.hex-rays.com/add-ons/plugins/concepts/plugins-shipped-with-ida/golang-plugin.md

Common command-line usage examples for the Golang plugin.

```text
  -Ogolang:force:force_regabi
```

```text
  -Ogolang:off
```

--------------------------------

### Display IDA Installer Help Options

Source: https://docs.hex-rays.com/getting-started/install-ida/ida-installer-commandline-options.md

View the available command-line arguments for the Linux installer.

```bash
root@jfndilt2# ./ida-pro_93_x64linux.run --help
IDA Professional 9.3
Usage:

 --help                                      Display the list of valid options

 --version                                   Display product information

 --unattendedmodeui <unattendedmodeui>       Unattended Mode UI
                                             Default: none
                                             Allowed: none minimal minimalWithDialogs

 --optionfile <optionfile>                   Installation option file
                                             Default:

 --debuglevel <debuglevel>                   Debug information level of verbosity
                                             Default: 2
                                             Allowed: 0 1 2 3 4

 --mode <mode>                               Installation mode
                                             Default: gtk
                                             Allowed: gtk xwindow text unattended

 --debugtrace <debugtrace>                   Debug filename
                                             Default:

 --installer-language <installer-language>   Language selection
                                             Default: en
                                             Allowed: sq ar es_AR az eu pt_BR bg ca hr cs da nl en et fi fr de el he hu id it ja kk ko lv lt no fa pl pt ro ru sr zh_CN sk sl es sv th zh_TW tr tk uk va vi cy

 --prefix <prefix>                           Installation Directory
                                             Default: /opt/ida-pro-9.3

 --errortrace <errortrace>                   Error trace filename
                                             Default:
```

--------------------------------

### Example plugin configuration entry

Source: https://docs.hex-rays.com/add-ons/plugins/overview.md

A practical example of a plugin entry in the plugins.cfg file.

```text
         Undefine undef    Alt-U  0
```

--------------------------------

### Install Qt via Homebrew

Source: https://docs.hex-rays.com/core/types/how-tos/creating-type-libraries/clang.md

Command to install the Qt framework on macOS.

```bash
brew install qt
```

--------------------------------

### Start application with bitness-agnostic configuration

Source: https://docs.hex-rays.com/core/debugger/tutorials/debugger_pin.md

Command to start an application using both 64-bit and 32-bit pintools.

```shell
/usr/local/pin/pin \
  -t64 /usr/local/pin/source/tools/idapin/obj-intel64/idadbg64.so \
  -t /usr/local/pin/source/tools/idapin/obj-ia32/idadbg.so \
  -p 23947 -- \
  /usr/bin/ls
```

--------------------------------

### GET /getting-started/install-ida/ida-installer-commandline-options.md

Source: https://docs.hex-rays.com/getting-started/install-ida/ida-installer-commandline-options.md

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /getting-started/install-ida/ida-installer-commandline-options.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a specific question.

### Method
GET

### Endpoint
https://docs.hex-rays.com/getting-started/install-ida/ida-installer-commandline-options.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /getting-started/install-ida.md

Source: https://docs.hex-rays.com/getting-started/install-ida.md

Performs a query against the documentation to retrieve answers, excerpts, and sources based on a specific question and optional goal.

```APIDOC
## GET /getting-started/install-ida.md

### Description
Queries the documentation dynamically to retrieve information not explicitly present on the page.

### Method
GET

### Endpoint
https://docs.hex-rays.com/getting-started/install-ida.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /add-ons/floating-license/getting-started.md

Source: https://docs.hex-rays.com/add-ons/floating-license/getting-started.md

Queries the documentation page for specific information using natural language.

```APIDOC
## GET /add-ons/floating-license/getting-started.md

### Description
Performs a query against the documentation to retrieve answers, excerpts, and sources based on a natural language question.

### Method
GET

### Endpoint
https://docs.hex-rays.com/add-ons/floating-license/getting-started.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /ida-actions/setupcompiler.md

Source: https://docs.hex-rays.com/ida-actions/setupcompiler.md

Perform a query against the documentation page to retrieve specific information or clarification.

```APIDOC
## GET /ida-actions/setupcompiler.md

### Description
Queries the documentation page dynamically to retrieve answers, excerpts, or context related to the SetupCompiler configuration.

### Method
GET

### Endpoint
https://docs.hex-rays.com/ida-actions/setupcompiler.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### Override IDAUSR and Install Plugin

Source: https://docs.hex-rays.com/developer/publishing-plugins/concepts/plugin-repository-architecture.md

Example of setting the IDA user directory environment variable before using HCLI to install a plugin.

```bash
$ export IDAUSR=~/.idapro91/
$ hcli plugin install ipyida
$ ~/software/ida-9.1/ida
```

--------------------------------

### GET /getting-started/licensing.md

Source: https://docs.hex-rays.com/getting-started/licensing.md

Perform a query against the documentation page to receive an answer based on the content.

```APIDOC
## GET /getting-started/licensing.md

### Description
Queries the documentation page dynamically to retrieve an answer to a specific question, optionally tailored to a broader goal.

### Method
GET

### Endpoint
https://docs.hex-rays.com/getting-started/licensing.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.

### Response
- The response contains a direct answer to the question along with relevant excerpts and sources from the documentation.
```

--------------------------------

### Configure file and directory mappings in startup.idc

Source: https://docs.hex-rays.com/core/debugger/tutorials/bochs_linux_primer.md

Demonstrates mapping individual files using the map keyword and directory paths for executables.

```text
/// map /Users/elias/idasrc/current/bin/idaq.app/Contents/MacOS/plugins/bochs/bochsys.dll=c:\windows\system32\bochsys.dll
```

```text
/// map /Users/elias/idasrc/current/bin/idaq.app/Contents/MacOS/plugins/bochs/bochsys.dll=c:\windows\system32\kvm.dll
```

```text
/// path /Users/elias/idasrc/current/bin/=c:\malware
```

--------------------------------

### Retrieve Function Name

Source: https://docs.hex-rays.com/developer/cpp-sdk/cpp-sdk-getting-started.md

Get the name of a function by its starting address.

```cpp
const char* func_name = get_func_name(0x401000);
printf("Function name: %s\n", func_name);
```

--------------------------------

### GET /ida-actions/quickstart.md

Source: https://docs.hex-rays.com/ida-actions/quickstart.md

Performs a query against the documentation to retrieve answers, excerpts, and sources based on a specific question and optional goal.

```APIDOC
## GET /ida-actions/quickstart.md

### Description
Perform an HTTP GET request on the documentation page URL to query information dynamically.

### Method
GET

### Endpoint
https://docs.hex-rays.com/ida-actions/quickstart.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.

### Response
- The response contains a direct answer to the question along with relevant excerpts and sources from the documentation.
```

--------------------------------

### Documentation Query API Request

Source: https://docs.hex-rays.com/core/disassembler/disassembly-gallery/c166-processor.md

Example of an HTTP GET request to query the documentation dynamically.

```http
GET https://docs.hex-rays.com/core/disassembler/disassembly-gallery/c166-processor.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### GET /add-ons/teams/getting-started/getting-started-git.md

Source: https://docs.hex-rays.com/add-ons/teams/getting-started/getting-started-git.md

Queries the documentation page for specific information using natural language.

```APIDOC
## GET /add-ons/teams/getting-started/getting-started-git.md

### Description
Queries the documentation dynamically by asking a question. This is useful for retrieving information not explicitly present in the current page or for clarifying context.

### Method
GET

### Endpoint
https://docs.hex-rays.com/add-ons/teams/getting-started/getting-started-git.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.
```

--------------------------------

### GET /add-ons/teams/getting-started.md

Source: https://docs.hex-rays.com/add-ons/teams/getting-started.md

Queries the documentation dynamically by providing a question and an optional goal to receive a contextual answer.

```APIDOC
## GET /add-ons/teams/getting-started.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically. This allows for retrieving specific information or clarification when not explicitly present in the page content.

### Method
GET

### Endpoint
https://docs.hex-rays.com/add-ons/teams/getting-started.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the answer.
```

--------------------------------

### Process Memory Loading Output

Source: https://docs.hex-rays.com/release-notes/7_2/the_mac_rundown.md

Example output showing the initial state of the process and loaded modules upon starting the debugger.

```text
1004E8000: loaded /usr/lib/dyld
100120000: process /var/containers/Bundle/Application/<UUID>/helloworld.app/helloworld has started
```

--------------------------------

### GET /ida-actions/processstart.md

Source: https://docs.hex-rays.com/ida-actions/processstart.md

Query the documentation dynamically by asking a question related to the content.

```APIDOC
## GET /ida-actions/processstart.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically.

### Method
GET

### Endpoint
https://docs.hex-rays.com/ida-actions/processstart.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to tailor the answer.
```

--------------------------------

### MIPS Assembly Disassembly Example

Source: https://docs.hex-rays.com/core/disassembler/disassembly-gallery/mips-processor-sony-elf.md

A sample subroutine disassembly showing stack frame setup and register operations in MIPS architecture.

```assembly
.text:0000073C
.text:0000073C  # =============== S U B R O U T I N E =======================================
.text:0000073C
.text:0000073C
.text:0000073C sub_73C:                                 # CODE XREF: sub_0+154↑p
.text:0000073C                                          # DATA XREF: .rodata.sceResident:00003910↓o
.text:0000073C
.text:0000073C var_s0          =  0
.text:0000073C var_s4          =  4
.text:0000073C var_s8          =  8
.text:0000073C var_sC          =  0xC
.text:0000073C
.text:0000073C                 addiu   $sp, -0x10
.text:00000740                 sw      $s0, var_s0($sp)
.text:00000744                 lui     $v0, 0x8002
.text:00000748                 move    $s0, $a0
.text:0000074C                 sltiu   $a0, 0x43  # 'C'
.text:00000750                 sw      $s1, var_s4($sp)
.text:00000754                 ori     $v1, $v0, 0x65  # 'e'
.text:00000758                 move    $s1, $zero
.text:0000075C                 sw      $ra, var_sC($sp)
.text:00000760                 beqz    $a0, loc_7A8
.text:00000764                 sw      $s2, var_s8($sp)
.text:00000768                 jal     sub_3180
.text:0000076C                 nop
.text:00000770                 sll     $a5, $s0, 3
.text:00000774                 subu    $a4, $a5, $s0
.text:00000778                 lui     $a3, %hi(unk_3C14)
.text:0000077C                 sll     $a1, $a4, 3
.text:00000780                 addiu   $a2, $a3, %lo(unk_3C14)
.text:00000784                 addu    $a0, $a1, $a2
.text:00000788                 lw      $v1, 0($a0)
.text:0000078C                 bnez    $v1, loc_7C4
.text:00000790                 move    $s2, $v0
.text:00000794                 lui     $a6, 0x8002
```

--------------------------------

### GET /core/idalib/getting-started.md

Source: https://docs.hex-rays.com/core/idalib/getting-started.md

Queries the documentation page for specific information using a natural language question and an optional goal context.

```APIDOC
## GET /core/idalib/getting-started.md

### Description
Performs a dynamic query against the documentation page to retrieve answers, excerpts, and sources based on a user question.

### Method
GET

### Endpoint
https://docs.hex-rays.com/core/idalib/getting-started.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained natural language question.
- **goal** (string) - Optional - The broader end goal to help tailor the response context.
```

--------------------------------

### Mac OS PEF Assembly Code Example

Source: https://docs.hex-rays.com/core/disassembler/disassembly-gallery/mac-os-pef-file.md

A snippet of PowerPC assembly code showing subroutine initialization and environment setup.

```assembly
seg000:00002BDC
seg000:00002BDC # =============== S U B R O U T I N E =======================================
seg000:00002BDC
seg000:00002BDC # Attributes: noreturn
seg000:00002BDC
seg000:00002BDC                 .globl .start
seg000:00002BDC .start:                                 # DATA XREF: seg000:00003A60↓o
seg000:00002BDC                                         # seg001:start↓o
seg000:00002BDC
seg000:00002BDC .set sender_sp, -0x450
seg000:00002BDC .set saved_toc, -0x43C
seg000:00002BDC .set var_20, -0x20
seg000:00002BDC .set var_C, -0xC
seg000:00002BDC .set var_8, -8
seg000:00002BDC .set var_4, -4
seg000:00002BDC .set sender_lr,  8
seg000:00002BDC
seg000:00002BDC                 mflr      r0
seg000:00002BE0                 stw       r31, var_4(r1)
seg000:00002BE4                 stw       r30, var_8(r1)
seg000:00002BE8                 stw       r29, var_C(r1)
seg000:00002BEC                 stw       r0, sender_lr(r1)
seg000:00002BF0                 stwu      r1, sender_sp(r1)
seg000:00002BF4                 mr        r29, r3
seg000:00002BF8                 mr        r30, r4
seg000:00002BFC                 mr        r31, r5
seg000:00002C00                 lwz       r3, TC_argv_save # argv_save
seg000:00002C04                 cmplwi    r31, 0
seg000:00002C08                 lwz       r4, TC_environ # environ
seg000:00002C0C                 stw       r30, 0(r3)
seg000:00002C10                 stw       r31, 0(r4)
seg000:00002C14                 bne       loc_2C20
seg000:00002C18                 addi      r0, r2, (off_3E44 - 0x3A70) # "NO_ENVIRON=true"
seg000:00002C1C                 stw       r0, 0(r4)
seg000:00002C20
seg000:00002C20 loc_2C20:                               # CODE XREF: .start+38↑j
seg000:00002C20                 li        r3, 0
```

--------------------------------

### MIPS Assembly Subroutine Example

Source: https://docs.hex-rays.com/core/disassembler/disassembly-gallery/mips-processor-sony-psx-1.md

A sample disassembly of a MIPS subroutine showing stack frame setup, register saving, and function calls.

```assembly
.text:00003E68
.text:00003E68  # =============== S U B R O U T I N E =======================================
.text:00003E68
.text:00003E68
.text:00003E68 sub_3E68:                                # CODE XREF: McGuiSave+64↓p
.text:00003E68                                          # McGuiLoad+64↓p
.text:00003E68
.text:00003E68 var_s0          =  0
.text:00003E68 var_s4          =  4
.text:00003E68 var_s8          =  8
.text:00003E68 var_sC          =  0xC
.text:00003E68 var_s10         =  0x10
.text:00003E68
.text:00003E68                 addiu   $sp, -0x28
.text:00003E6C                 lw      $a0, side
.text:00003E74                 li      $a1, 0x10
.text:00003E78                 sw      $s1, 0x10+var_s4($sp)
.text:00003E7C                 li      $s1, ot
.text:00003E84                 sw      $ra, 0x10+var_s10($sp)
.text:00003E88                 sw      $s3, 0x10+var_sC($sp)
.text:00003E8C                 sw      $s2, 0x10+var_s8($sp)
.text:00003E90                 sw      $s0, 0x10+var_s0($sp)
.text:00003E94                 sll     $a0, 6
.text:00003E98                 jal     ClearOTag
.text:00003E9C                 addu    $a0, $s1
.text:00003EA0                 li      $v1, (sDraw+0x17A)
.text:00003EA8                 lh      $v0, (aSsvabtransferF+6 - 0x282)($v1)  # "ransfer failed (%d)\n"
.text:00003EAC                 nop
.text:00003EB0                 blez    $v0, loc_3F7C
.text:00003EB4                 nop
.text:00003EB8                 move    $s0, $v1
.text:00003EBC                 li      $s3, disp
.text:00003EC4                 li      $s2, draw
.text:00003ECC
.text:00003ECC loc_3ECC:                                # CODE XREF: sub_3E68+10C↓j
.text:00003ECC                 lhu     $v0, 0($s0)
```

--------------------------------

### GET /getting-started.md

Source: https://docs.hex-rays.com/getting-started

Performs a natural language query against the documentation to retrieve answers and relevant excerpts.

```APIDOC
## GET /getting-started.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically using natural language.

### Method
GET

### Endpoint
https://docs.hex-rays.com/getting-started.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask the documentation.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the response.

### Response
#### Success Response (200)
- **answer** (string) - A direct answer to the question.
- **excerpts** (array) - Relevant excerpts and sources from the documentation.
```

--------------------------------

### Create an option file for unattended installation

Source: https://docs.hex-rays.com/getting-started/install-ida/ida-installer-commandline-options.md

Define installation parameters in a text file to avoid passing multiple arguments via the command line.

```text
prefix=/home/jfndi/ida-93
mode=unattended
```

--------------------------------

### Add a custom microcode block optimization rule

Source: https://docs.hex-rays.com/developer/idapython/idapython-examples.md

This example demonstrates how to install a custom microcode block optimization rule to simplify goto chains.

```python
  goto L1
  ...
L1:
  goto L2
```

```python
  goto L2
```

--------------------------------

### GET /add-ons/teams/getting-started/getting-started-vault/getting-started-with-hv.md

Source: https://docs.hex-rays.com/add-ons/teams/getting-started/getting-started-vault/getting-started-with-hv.md

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /add-ons/teams/getting-started/getting-started-vault/getting-started-with-hv.md

### Description
Queries the documentation dynamically by asking a question. This is useful when information is not explicitly present in the current page or when clarification is needed.

### Method
GET

### Endpoint
https://docs.hex-rays.com/add-ons/teams/getting-started/getting-started-vault/getting-started-with-hv.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the answer.
```

--------------------------------

### ARC Processor Assembly Code Example

Source: https://docs.hex-rays.com/core/disassembler/disassembly-gallery/arc-processor.md

A sample disassembly listing for an ARC processor subroutine, showing stack frame setup, register manipulation, and loop instructions.

```armasm
.text:0000109C
.text:0000109C # =============== S U B R O U T I N E =======================================
.text:0000109C
.text:0000109C # Attributes: bp-based frame
.text:0000109C
.text:0000109C                 .global ArcMain
.text:0000109C ArcMain:                                # CODE XREF: main+C↑p
.text:0000109C
.text:0000109C arg_0           =  0
.text:0000109C arg_4           =  4
.text:0000109C
.text:0000109C                 st      blink, [sp,arg_4]
.text:000010A0                 st      fp, [sp,arg_0]
.text:000010A4                 mov     fp, sp
.text:000010A8                 sub     sp, sp, 0x10
.text:000010AC                 mov     r0, state_ls
.text:000010B4                 bl.d    Core_LocalClear
.text:000010B8                 mov     r1, 0x18
.text:000010BC                 mov     r2, _stack_start
.text:000010C4                 mov     r0, 0x12345678
.text:000010CC                 sub     r1, r1, r1
.text:000010D0                 mov     lp_count, 0x20 # ' '
.text:000010D4                 lp      loc_10E4
.text:000010D8                 add     r12, r2, r1
.text:000010DC                 st      r0, [r12]
.text:000010E0                 add     r1, r1, 4
.text:000010E4
.text:000010E4 loc_10E4:                               # CODE XREF: ArcMain+38↑j
.text:000010E4                 mov     r0, 0xFFFFFFFF
.text:000010E8                 sr      r0, [0x23] # '#'
.text:000010EC                 sr      0, COUNT # '!' # Enhanced Timer 0  Timer 0 Count value
.text:000010F4                 sr      2, CONTROL # '"' # Enhanced Timer 0  Timer 0 Control value
.text:000010FC                 bl      Platform_Initialize
.text:00001100                 bl      Core_Loop
.text:00001104                 ld      blink, [fp,arg_4]
```

--------------------------------

### GET /getting-started/whats-next.md

Source: https://docs.hex-rays.com/getting-started/whats-next

Performs a dynamic query against the documentation to retrieve answers and relevant excerpts.

```APIDOC
## GET /getting-started/whats-next.md

### Description
Performs an HTTP GET request on the documentation page to retrieve a direct answer to a specific question, along with relevant excerpts and sources.

### Method
GET

### Endpoint
https://docs.hex-rays.com/getting-started/whats-next.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask in natural language.
- **goal** (string) - Optional - The broader end goal to help tailor the answer context.

### Response
#### Success Response (200)
- **answer** (string) - The direct answer to the provided question.
- **excerpts** (array) - Relevant documentation excerpts used to generate the answer.
- **sources** (array) - Links to the source documentation pages.
```

--------------------------------

### Plugin Initialization and Lifecycle

Source: https://docs.hex-rays.com/developer/cpp-sdk/cpp-sdk-examples.md

Handles plugin setup, including conditional hook installation, custom IDC function registration, and option retrieval. The destructor ensures cleanup of registered IDC functions.

```cpp
static plugmod_t *idaapi init()
{
  if ( inf_get_filetype() == f_ELF )
    return nullptr; // we do not want to work with this idb

  plugin_data_t *pd = new plugin_data_t;

  // notifications
#ifdef INSTALL_SAMPLE_CALLBACK
  hook_event_listener(HT_UI, pd, pd);
#endif // INSTALL_SAMPLE_CALLBACK

  // user-defined prefix. will be automatically uninstalled by the kernel
  // when our plugin gets unloaded.
#ifdef HAS_USER_DEFINED_PREFIX
  new sample_prefix_t(pd);
#endif // HAS_USER_DEFINED_PREFIX

  // custom IDC function
#ifdef DEFINE_IDC_FUNC
  add_idc_func(myfunc5_desc);
#endif // DEFINE_IDC_FUNC

  // an example how to retrieve plugin options
  const char *options = get_plugin_options("vcsample");
  if ( options != nullptr )
    warning("command line options: %s", options);

  return pd;
}

//--------------------------------------------------------------------------
plugin_data_t::~plugin_data_t()
{
#ifdef DEFINE_IDC_FUNC
  del_idc_func(myfunc5_desc.name);
#endif
}
```

--------------------------------

### Test local plugin installation

Source: https://docs.hex-rays.com/developer/publishing-plugins/how-tos/test-plugin-before-publishing.md

Install the plugin locally to verify the installation process and dependency resolution.

```bash
# Install from directory
hcli plugin install /path/to/your-plugin

# Or from ZIP
hcli plugin install ./your-plugin-v1.0.0.zip
```

```text
Installing plugin: my-awesome-plugin==1.0.0
Installing Python dependencies: requests>=2.28.0, pydantic>=2.0
✓ Installed plugin: my-awesome-plugin==1.0.0
```

--------------------------------

### Swift Plugin Command Line Examples

Source: https://docs.hex-rays.com/add-ons/plugins/concepts/plugins-shipped-with-ida/swift-plugin.md

Examples of using -Oswift command line switches to configure plugin behavior.

```text
  -Oswift:-g
```

```text
  -Oswift:/tmp/libSwiftDemangle_custom.dylib
```

--------------------------------

### Minimal Configuration Example

Source: https://docs.hex-rays.com/add-ons/floating-license/admin/license-server.md

Provides a basic configuration template containing essential settings for server operation.

```json
{
    "connection_string": "sqlite3;Data Source=./hexlicsrv.sqlite3;",
    "license_file": "/path/to/license_server.hexlic",
    "cert_file": "hexlicsrv.crt",
    "key_file": "hexlicsrv.key"
}
```

--------------------------------

### Verify Bochs installation

Source: https://docs.hex-rays.com/core/debugger/tutorials/bochs_linux_primer.md

Check the installation location of the Bochs binary after running make and make install.

```bash
lallous@ubuntu:~/dev/bochs-2.5.1$ whereis bochsbochs: /usr/local/bin/bochs /usr/local/lib/bochs
```

--------------------------------

### Install IDA via HCLI

Source: https://docs.hex-rays.com/getting-started/install-ida.md

Use the HCLI command-line tool to install IDA from a local installer file.

```bash
hcli ida install <path-to-installer>
```

--------------------------------

### GET /ida-actions/setupstrings.md

Source: https://docs.hex-rays.com/ida-actions/setupstrings.md

Performs a dynamic query against the documentation page to retrieve answers, excerpts, and sources based on a specific question and optional goal.

```APIDOC
## GET /ida-actions/setupstrings.md

### Description
Queries the documentation dynamically to retrieve information not explicitly present in the current page.

### Method
GET

### Endpoint
https://docs.hex-rays.com/ida-actions/setupstrings.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate, specific question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### Locate WinDbg installation path

Source: https://docs.hex-rays.com/core/debugger/concepts/local-debugging/windbg-ttd.md

Use this PowerShell command to find the installation directory of the installed WinDbg AppX package.

```powershell
Get-AppxPackage Microsoft.WinDbg | select InstallLocation
```

--------------------------------

### Execute IDA Installer

Source: https://docs.hex-rays.com/getting-started/install-ida.md

Run the installer script directly from the terminal.

```bash
./<your_IDA_version_>linux.run
```

--------------------------------

### GET /ida-actions/setupsrcpaths.md

Source: https://docs.hex-rays.com/ida-actions/setupsrcpaths.md

Queries the documentation page for information regarding source path configuration.

```APIDOC
## GET /ida-actions/setupsrcpaths.md

### Description
Perform a query against the documentation page to retrieve information or clarification about setting up source paths in IDA.

### Method
GET

### Endpoint
https://docs.hex-rays.com/ida-actions/setupsrcpaths.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.

### Response
- The response contains a direct answer to the question along with relevant excerpts and sources from the documentation.
```

--------------------------------

### GET /ida-actions/navjumplistingstart.md

Source: https://docs.hex-rays.com/ida-actions/navjumplistingstart.md

Query the documentation dynamically by asking a question related to the current page content.

```APIDOC
## GET /ida-actions/navjumplistingstart.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically using natural language.

### Method
GET

### Endpoint
https://docs.hex-rays.com/ida-actions/navjumplistingstart.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.
```

--------------------------------

### Test License Server Configuration

Source: https://docs.hex-rays.com/add-ons/floating-license/admin/license-server/license-server-checklist.md

Verify the license server setup by running it manually with the required certificate, key, and license files.

```bash
>sudo -u hexlicsrv ./license_server --config-file hexlicsrv.conf \
                                        --certchain-file hexlicsrv.crt \
                                        --privkey-file hexlicsrv.key \
                                        --license-file license_server_<LID>.hexlic
>2024-04-14 14:35:47 License Server v1.0 Hex-Rays (c) 2024
>2024-04-14 14:35:47 Using a license with 1 seats
>2024-04-14 14:35:47 Listening on 0.0.0.0:65434...
```

--------------------------------

### Install custom microcode optimization rule

Source: https://docs.hex-rays.com/developer/cpp-sdk/cpp-sdk-examples.md

Installs a rule to transform !DbgRaiseAssertionFailure calls.

```text
call !DbgRaiseAssertionFailure [fast:].0 => call !DbgRaiseAssertionFailure <fast:"char *" "assertion text">.0
```

--------------------------------

### Install Plugins via HCLI

Source: https://docs.hex-rays.com/getting-started/basic-usage.md

Use this command to install a specific plugin by its name.

```bash
hcli plugin install <plugin-name>
```

--------------------------------

### Windows Installer Command-Line Options

Source: https://docs.hex-rays.com/getting-started/install-ida/ida-installer-commandline-options.md

View the available command-line arguments for the Windows installer.

```text
IDA Professional 9.3
Usage:

 --help                                      Display the list of valid options

 --version                                   Display product information

 --unattendedmodeui <unattendedmodeui>       Unattended Mode UI
                                             Default: none
                                             Allowed: none minimal minimalWithDialogs

 --optionfile <optionfile>                   Installation option file
                                             Default: 

 --debuglevel <debuglevel>                   Debug information level of verbosity
                                             Default: 2
                                             Allowed: 0 1 2 3 4

 --mode <mode>                               Installation mode
                                             Default: win32
                                             Allowed: win32 unattended

 --debugtrace <debugtrace>                   Debug filename
                                             Default: 

 --installer-language <installer-language>   Language selection
                                             Default: en
                                             Allowed: sq ar es_AR az eu pt_BR bg ca hr cs da nl en et fi fr de el he hu id it ja kk ko lv lt no fa pl pt ro ru sr zh_CN sk sl es sv th zh_TW tr tk uk va vi cy

 --prefix <prefix>                           Installation Directory
                                             Default: C:\Program Files/ida-pro-9.3

 --install_python <install_python>           Install Python 3
                                             Default: 

 --errortrace <errortrace>                   Error trace filename
                                             Default: 
```

--------------------------------

### Install Permission Table

Source: https://docs.hex-rays.com/add-ons/teams/admin/teams-server.md

Applies a prepared permission file to the server.

```bash
>hv perm set @path/to/permission-file
```

--------------------------------

### Include Directive Example

Source: https://docs.hex-rays.com/core/types/how-tos/creating-type-libraries/idaclang_tutorial.md

Example of an include directive that requires proper framework resolution.

```cpp
#include <QtCore/QtCoreDepends>
```
Tokens:
Raw