diff options
| author | blasty <blasty@local> | 2026-08-07 15:33:17 +0200 |
|---|---|---|
| committer | blasty <blasty@local> | 2026-08-07 15:33:17 +0200 |
| commit | c6ea3e3fbee8dcdcf0a70939d7e57001af57e5bc (patch) | |
| tree | 85b9a76d904feef11ea82daf6062ac995e859a7a /README.md | |
| parent | docs: drop two stale files, correct the two the README links, cut sharp edges (diff) | |
| download | ida-tui-c6ea3e3fbee8dcdcf0a70939d7e57001af57e5bc.tar.gz ida-tui-c6ea3e3fbee8dcdcf0a70939d7e57001af57e5bc.tar.xz ida-tui-c6ea3e3fbee8dcdcf0a70939d7e57001af57e5bc.zip | |
Install ida-codemode from PyPI, not a sibling clone
The README told people to "git clone ... ../ida-codemode" and pyproject carried
a matching [tool.uv.sources] path override. That is not a convention, it is
Duncan's development layout, inherited from the port patch and never
questioned: it writes into the parent of the user's checkout, breaks if the
directory is named anything else, and pins everyone to whatever happens to be
in that working tree.
ida-codemode is published on PyPI (0.3.1, the same version the clone was
sitting at), so the dependency is now an ordinary versioned requirement and
"uv sync" is the whole install. Verified end to end: uv lock resolves, uv sync
--frozen installs from the registry, and ida_codemode.client.DatabaseHandle
imports from the resulting venv.
The path override is still the right answer when hacking on both at once, so
that stays in the README as one "uv add --editable" line rather than as the
default everyone pays for.
Also fixed the plugin command it now documents: upstream's own README passes
--prerelease=allow, and without it uvx refuses to resolve, because ida-codemode
depends on ida-domain>=0.5.1.dev2. Checked that --install-plugin is a real flag
and that the command runs, instead of copying it over on faith.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 20 |
1 files changed, 14 insertions, 6 deletions
@@ -32,17 +32,25 @@ this draws it. ## Install -Needs **Python ≥ 3.11**, **IDA Pro 9.4+ with idalib**, and -[ida-codemode](https://github.com/HexRaysSA/ida-codemode) checked out next to -this repo (`../ida-codemode`): +Needs **Python ≥ 3.11** and **IDA Pro 9.4+ with idalib**. ```sh -git clone https://github.com/HexRaysSA/ida-codemode ../ida-codemode uv sync ``` -Install the ida-codemode plugin in IDA too, if you want the TUI to attach to -databases you already have open in the GUI. +That pulls [ida-codemode](https://github.com/HexRaysSA/ida-codemode) from PyPI, +which is how ida-tui talks to IDA. To also attach to databases you have open in +the IDA GUI, install its plugin: + +```sh +uvx --prerelease=allow --from ida-codemode ida-codemode-mcp --install-plugin +``` + +Hacking on ida-codemode itself? Point at a checkout instead: + +```sh +uv add --editable ../ida-codemode +``` ## Run |
