Interface R2Pipe

Generic interface to interact with radare2, abstracts the access to the associated instance of the tool, which could be native via rlang or remote via pipes or tcp/http.

Hierarchy

R2Pipe

Index

Methods

call callAt callj cmd cmdAt cmdj log plugin unload

Methods

call

call(cmd): string
Call a radare2 command. This is similar to R2Pipe.cmd, but skips all the command parsing rules, which is safer and faster but you cannot use any special modifier like @, ~, ...

See R2Pipe.callAt() to call a command on a different address
Parameters
- cmd: string
Returns string
the JSON decoded object from the output of the command
- Defined in r2pipe.ts:41

callAt

callAt(cmd, at): string
Call a radare2 command in a different address
Parameters
- cmd: string
- at: any
Returns string
the string containing the output of the command
- Defined in r2pipe.ts:50

callj

callj(cmd): any
Same as cmdj but using .call which avoids command injection problems
Parameters
- cmd: string
Returns any
the JSON decoded object from the command output
- Defined in r2pipe.ts:58

cmd

cmd(cmd): string
Run a command in the associated instance of radare2
Parameters
- cmd: string
Returns string
The output of the command execution
- Defined in r2pipe.ts:14

cmdAt

cmdAt(cmd): string
Run a radare2 command in a different address. Same as .cmd(x + '@ ' + a)
Parameters
- cmd: string
Returns string
The output of the command execution
- Defined in r2pipe.ts:22

cmdj

cmdj(cmd): any
Run a radare2 command expecting the output to be JSON
Parameters
- cmd: string
Returns any
the JSON decoded object from the output of the command
- Defined in r2pipe.ts:30

log

log(msg): string
Log a string to the associated console. This is used internally by console.log in some implementations.
Parameters
- msg: string
Returns string
true if successful
- Defined in r2pipe.ts:66

plugin

plugin(type, maker): boolean
Instantiate a new radare2 plugin with the given type and constructor method.
Parameters
- type: string
  
  of plugin ("core", "io", "arch", ...)
- maker: any
Returns boolean
true if successful
- Defined in r2pipe.ts:75

unload

unload(type, name): boolean
Unload the plugin associated with a type and a name.
Parameters
- type: string
  
  of plugin ("core", "io", "arch", ...)
- name: string
  
  of the plugin
Returns boolean
true if successful
- Defined in r2pipe.ts:84

Generated using TypeDoc