# R2PM

This repository is fetched by `r2pm -U` and provides the package database.

These packages are installed in user's home and can be plugins/scripts
for radare2 or even utilities/programs related to r2.

See https://github.com/radareorg/radare2 for r2pm

## How to use

```sh
$ r2pm -U
$ r2pm -ci r2frida
```

## Testing new packages

```sh
export R2PM_DBDIR="$PWD/db"
# export R2PM_GITDIR="/path/to/the/root/folder/of/the/local/repository"
# export R2PM_USRDIR="/path/to/usr/dir"
```

## Windows hooks

Windows install and uninstall hooks use native batch syntax. Stop explicitly
on failure with `command || exit /b 1`; this catches negative exit codes too.
Use `call helper.cmd || exit /b 1` when invoking another batch file so execution
returns to the hook. Environment changes persist across lines; multiline
`if/else` blocks and `^` continuations follow normal CMD rules.

## Binary packages

Use `r2pm -bi r2frida` to install a released binary without cloning or compiling
sources. `R2V` selects the release and defaults to the installed radare2 version:

```sh
R2V=6.2.2 r2pm -bi r2frida
```

Optionally declare supported operating systems, runtimes or exact targets with
`R2PM_PLATFORMS`:

```sh
R2PM_PLATFORMS "linux darwin windows"
# For a portable r2js script instead:
R2PM_PLATFORMS "r2js"
# For a package restricted to 32-bit x86 Linux instead:
R2PM_PLATFORMS "linux-x86-32"
```

The space-separated tags control package search filtering and populate the
`platforms` array in `r2pm -sj`. Other tags, such as `termux`, may be declared
when supported. The declaration is optional: packages without it, or with an
empty value, retain platform inference from their install hooks and keep their
existing install behavior. Exact `os-arch-bits` triplets are matched against
`r2pm -H R2PM_TRIPLET`, including the architecture and bitness. Multiple entries
are alternatives, so adding `linux` alongside a triplet allows all Linux
architectures. JSON also exposes `binary: true` when a `R2PM_BINSTALL*`
hook exists; ready-to-use scripts count as binary installs too. Platform tags
do not guarantee a binary for every release.

Packages provide `R2PM_BINSTALL()` for Unix shell commands and
`R2PM_BINSTALL_WINDOWS()` for Windows commands. These hooks run without a
source checkout, receive `R2V`, `R2PM_OS` (`linux`, `darwin`, `windows`, ...),
`R2PM_ARCH` (`x86`, `arm`, ...), `R2PM_BITS` (`32` or `64`) and `R2PM_TRIPLET`
(`<os>-<arch>-<bits>`, for example `linux-x86-64`), and install into
the usual `R2PM_PLUGDIR`, `R2PM_BINDIR` and other r2pm directories. `-g` selects
the system plugin directory and provides `R2PM_SUDO` on Unix.

Binary hooks must select the exact version and target, handle their own tools
and runtime dependencies, respect `R2PM_OFFLINE`, and return nonzero if the
binary is unavailable or installation fails. `R2PM_NEEDS` and `R2PM_DEPS` are
source-build prerequisites and are skipped. There is no source fallback: r2pm
reports the error and asks the user to re-run without `-b`.

The r2frida hooks extract Linux `.deb`, macOS `.pkg`, and Windows `.zip` release
assets into the r2pm directories. Availability depends on the selected release;
missing architectures or versions fail rather than using a different release.