{"id":13746252,"url":"https://github.com/nologic/idaref","last_synced_at":"2025-12-16T15:04:11.953Z","repository":{"id":19726199,"uuid":"22982180","full_name":"nologic/idaref","owner":"nologic","description":"IDA Pro Instruction Reference Plugin","archived":false,"fork":false,"pushed_at":"2021-10-20T02:15:22.000Z","size":14659,"stargazers_count":636,"open_issues_count":1,"forks_count":108,"subscribers_count":35,"default_branch":"master","last_synced_at":"2024-11-15T19:37:21.974Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nologic.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-08-15T07:36:52.000Z","updated_at":"2024-10-10T11:58:56.000Z","dependencies_parsed_at":"2022-08-24T14:09:11.878Z","dependency_job_id":null,"html_url":"https://github.com/nologic/idaref","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nologic%2Fidaref","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nologic%2Fidaref/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nologic%2Fidaref/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nologic%2Fidaref/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nologic","download_url":"https://codeload.github.com/nologic/idaref/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253209229,"owners_count":21871612,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-03T06:00:50.609Z","updated_at":"2025-12-16T15:04:06.879Z","avatar_url":"https://github.com/nologic.png","language":"Python","funding_links":[],"categories":["PLSQL","\u003ca id=\"846eebe73bef533041d74fc711cafb43\"\u003e\u003c/a\u003e指令参考\u0026文档","PLSQL (1)","Python","使用"],"sub_categories":["\u003ca id=\"c42137cf98d6042372b1fd43c3635135\"\u003e\u003c/a\u003echeatsheets","\u003ca id=\"846eebe73bef533041d74fc711cafb43\"\u003e\u003c/a\u003e指令参考\u0026文档"],"readme":"IdaRef\n======\nIDA Pro Full Instruction Reference Plugin - It's like auto-comments but useful.\n\nI'm generally pretty good at figuring out what various Intel instructions do.\nBut, once in a while I need to either know some precise detail (i.e. exact \nside effects of SUB) or come across a rare instruction. Then I break my train\nof thought and have to dig out the reference manual. Which got me thinking: \n\u003ci\u003eWhy can't IDA just give me the full documentation?\u003c/i\u003e\n\nEnter IdaRef:\n![](./screenshot/idaref.png)\nThe plugin will monitor the location for your cursor (ScreenEA) and display the full\ndocumentation of the instruction. At the moment it only supports x86-64, ARM and MIPS 32bit, \nhowever adding support for other architectures is relatively easy.\n\nUsage\n-----\nSimply checkout or download the repository and install it to your IDA plugins directory:\n\n    idaref.py -\u003e \u003cida_path\u003e/plugins/idaref.py\n    arm.sql -\u003e \u003cida_path\u003e/plugins/archs/arm.sql\n    x86-64.sql -\u003e \u003cida_path\u003e/plugins/archs/x86-64.sql\n    mips32.sql -\u003e \u003cida_path\u003e/plugins/archs/mips32.sql\n    xtensa.sql -\u003e \u003cida_path\u003e/plugins/archs/xtensa.sql\n\nYou can also use the installer.sh file but you'll need to open it and edit the IDA path \nif you're not using Mac OS and IDA 6.8.\n\n![](./screenshot/idaref_start.png)\n\nOnce loaded, the plugin can be turned ON by going to Edit/Start IdaRef menu option. To \ncontrol the output right-click on the tab window to get a menu:\n\n* Update View - Load documentation for currectly selected instruction.\n* Lookup Instruction - Manual load documentation, you'll be prompted for the instruction.\n* Toggle Auto-refresh - Turn on/off auto loading of documentation and rely on the first two options.\n\n![](./screenshot/idaref_menu.png)\n    \nInternals\n---------\nUpon loading the script will look for SQlite databases in the same directory as the \nitself. The naming convention for the database files is [arch name].sql. The \n[arch name] will be presented to the user as choice.\n\nThe database has a table called 'instructions' and two columns called 'mnem' and\n'description'. The instructions are looked up case insensitive (upper case) by the\nmnem value. The text from description is displayed verbatim in the view.\n\nTo add support for more architectures simply create a new database with those\ncolumns and place it in the the script directory.\n\n    import sqlite3 as sq\n    con = sq.connect(\"asm.sqlite\")\n    con.text_factory = str\n    cur = con.cursor()\n    cur.execute(\"CREATE TABLE IF NOT EXISTS instructions (platform TEXT, mnem TEXT, description TEXT)\")\n    con.commit()\n    \nWhen working with x86, I noticed that many instructions point to the same documentation.\nSo, the plugin supports single level referencing. Just place '-R:[new instruction]' into\ndescription to redirect the loading. 'new instruction' is the target. So, when loading \nthe script will detect the link and load the new target automatically.\n\n    cur.execute(\"INSERT INTO instructions VALUES (?, ?, ?)\", (\"x86\", inst, \"-R:%s\" % first_inst))\n    \nSkeletons in the closet\n-----------------------\nThe documentation database was created using a rather hackish screen scraping\ntechnique by the x86doc project which I forked. So, there are probably some \nstrange characters or tags in the text. At least, it is a mechanical process\nso I expect that the information is correct relative to the original Intel PDF.\n\nPorts\n-----\nIf you're a hopper user, there is a port called hopperref: https://github.com/zbuc/hopperref\n\nIf you're an x64dbg user, IdaRef is integrated with the `mnemonichelp xxx` command or through the context menu. Fork: https://github.com/x64dbg/idaref\n\nEnjoy!\n------\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnologic%2Fidaref","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnologic%2Fidaref","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnologic%2Fidaref/lists"}