rz-pipe/python/README.md

rzpipe for Python

Interact with rizin using the #!pipe command or in standalone scripts that communicate with local or remote rizin via pipe, tcp or http.

Installation

$ pip install rzpipe

or

$ pip3 install rzpipe

Usage example:

import rzpipe

pipe = rzpipe.open("/bin/ls")
pipe.cmd('aa')
print(pipe.cmd("afl")) # Prints the command result. Errors are not detectable.
print(pipe.cmd("aaaaaaaaaaa"), ret_stderr=True) # This will return the error message.
print(pipe.cmd("px 3"), echo_cmd=True) # Python echos the command to the shell, before executing it.
print(pipe.cmdj("aflj"))            # parses the JSON and returns a dict (note the lowercase j)
print(pipe.cmdJ("ij").core.format)  # parses the JSON and returns a namedtuple (note the uppercase J)
pipe.quit()