Skip to content

Reuse local Rizin installations before downloading #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JerryLinLinLin merged 1 commit into from
Oct 2, 2026
Merged

Reuse local Rizin installations before downloading #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion plugins/rizin-re-toolkit/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Understand native executables and memory dumps with a portable Windows analysis

Install **Rizin RE Toolkit** from **Jerry's Plugin Marketplace** in Codex. The included skill guides runtime setup and analysis; invoke it as `$rizin-re-toolkit` or describe a relevant task.

The [PowerShell installer](skills/rizin-re-toolkit/scripts/install.ps1) downloads and verifies the runtime into a user-writable directory. It supports a custom destination and optional user PATH registration.
The skill first checks a known installation path, then `%LOCALAPPDATA%\Programs\Rizin\<release-tag>\rizin\bin\rizin.exe`, then PATH, and reuses a working runtime before downloading. The [PowerShell installer](skills/rizin-re-toolkit/scripts/install.ps1) downloads and verifies the runtime when needed. By default it adds `bin` only to the current PowerShell process's PATH; use `-AddToUserPath` for persistent user PATH registration or `-Destination <directory>` for a custom installation root. Across separate shell sessions, use the resolved absolute executable path.

For manual installation, use the [download catalog](https://github.com/JerryLinLinLin/jerry-plugin-marketplace/blob/main/docs/guides/releases.md#release-index), verify the archive checksum, and extract the complete `rizin` folder. Run `rizin\bin\rizin.exe` by absolute path. Keep the folder together when moving it; required runtime libraries and support data are included.

Expand Down
60 changes: 53 additions & 7 deletions plugins/rizin-re-toolkit/skills/rizin-re-toolkit/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ phrased in terms of other RE tools. Treat those tool names as descriptions of
the desired capability and perform equivalent work through Rizin. For supported
tasks, do not install, launch, or delegate to standalone Ghidra, IDA/Hex-Rays,
Binary Ninja, Cutter, radare2, or another RE tool as the default workflow.
Download the verified CLI below when it is missing, then continue the analysis.
Locate an existing CLI using the local checks below; download the verified bundle
only when no usable local installation is available, then continue the analysis.

| Request | Route inside this toolkit |
| --- | --- |
Expand All @@ -48,23 +49,68 @@ here. If not, explain the specific missing capability and request the necessary
input or follow a later explicit instruction requiring the native tool.
Do not silently discard project-specific state or fabricate compatibility.

## Install the dependency
## Locate or install the dependency

Use an existing verified bundle when available. Otherwise run the bundled
[installer](scripts/install.ps1) with PowerShell on Windows:
On Windows, the default installation root is `%LOCALAPPDATA%\Programs\Rizin`.
Each release lives in its own directory; the executable is
`%LOCALAPPDATA%\Programs\Rizin\<release-tag>\rizin\bin\rizin.exe`.
Installing the skill does not itself install the runtime or register it in PATH.

Before contacting GitHub or running the installer, look locally in this order:

1. A user-specified or previously verified executable path, including a known custom
`-Destination` installation.
2. The default installation root above. Check release directories for
`rizin\bin\rizin.exe`; prefer the newest compatible installed version, comparing
version numbers rather than directory names alphabetically.
3. `rizin.exe` already on PATH, using `Get-Command -CommandType Application`.

For the default-directory and PATH checks:

```powershell
$rizinInstallRoot = Join-Path $env:LOCALAPPDATA 'Programs\Rizin'
$rizinCandidates = @(
Get-ChildItem -LiteralPath $rizinInstallRoot -Directory -ErrorAction SilentlyContinue |
Where-Object { $_.Name -match '^rizin-(?:runtime-)?v\d+\.\d+\.\d+$' } |
Sort-Object { [version] ($_.Name -replace '^rizin-(?:runtime-)?v', '') } -Descending |
ForEach-Object { Join-Path $_.FullName 'rizin\bin\rizin.exe' } |
Where-Object { Test-Path -LiteralPath $_ -PathType Leaf }
Get-Command rizin.exe -CommandType Application -All -ErrorAction SilentlyContinue |
Select-Object -ExpandProperty Source
)
$rizinCandidates | Select-Object -Unique
```

Validate candidates with `-v`, the bundle manifest one directory above `bin`
(`rizin\bundle-manifest.json`), and the plugin help needed for the task
(`pdg?`, `pdd?`, `pdz?`, `yara?`). Reuse a
compatible working bundle and retain its absolute executable path as `$rizinExe`.
An empty PATH lookup does not mean Rizin is uninstalled. Do not download or query
the latest release merely because an existing bundle is absent from PATH or older
than the latest release; update only when requested or required for the task.

Only if no usable local installation is found, run the bundled
[installer](scripts/install.ps1) with PowerShell:

```powershell
& '<this-skill-directory>\scripts\install.ps1'
$rizinInstall = & '<this-skill-directory>\scripts\install.ps1'
$rizinExe = $rizinInstall.Executable
& $rizinExe -v
```

The installer finds the newest stable Rizin bundle among the repository's
[GitHub releases](https://github.com/JerryLinLinLin/jerry-plugin-marketplace/releases), verifies
`SHA256SUMS` and the GitHub asset digest when available, then extracts into
`%LOCALAPPDATA%\Programs\Rizin\<release-tag>\rizin`. It returns the executable path and
adds `bin` to the current PowerShell process's `PATH`. Shell tool processes may not share
environment changes: retain the returned absolute executable path for subsequent calls.
adds `bin` to the current PowerShell process's `PATH` by default; it does not persist
that change to the user or system PATH. Shell tool processes may not share environment
changes or variables: use the resolved absolute executable path in subsequent calls
(`& 'C:\...\rizin\bin\rizin.exe' ...`), even when later examples say `rizin`.
Use `-Destination <directory>` for a workspace-local install, `-Tag rizin-v0.3.1` for the
tested release, or `-AddToUserPath` when the user wants a persistent user PATH entry.
The installer queries releases before checking the destination and refuses to overwrite
an existing release directory, so use the local checks above instead of rerunning it
to locate an installation.
No administrator privileges or separate VC++ runtime installation are required.
Use Windows 10 version 1903 or later (including Windows 11), x64. The CLI's
UTF-8 application manifest enables Unicode installation and input paths.
Expand Down
Loading