Skip to content

Commit

Permalink
doc: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ndrewh committed May 7, 2024
1 parent 99c2303 commit 0f67843
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,13 @@ It is intended to fufill many of the same use-cases as debuggers (e.g. GDB/Pwndb
or complex dynamic instrumentation frameworks (Frida, Dynamorio, DynInst, PIN, etc.).
It was designed with CTF challenges (pwn/rev) in mind.

```sh
docker run -it ghcr.io/ndrewh/pyda

$ pyda <script_name> -- <target> <target_args>
```


> [!WARNING]
> This API is not stable and will likely change. Please provide
> feedback on the API by filing an issue.
Expand All @@ -34,7 +41,7 @@ def main_hook(p):
return_addr = p.read(p.regs.rsp, 8)
print(f"return address: {hex(u64(return_addr))}")

# Register the hook, and run the bianry
# Register the hook, and run the binary
p.hook(e.symbols["main"], main_hook)
p.run()
```
Expand Down

0 comments on commit 0f67843

Please sign in to comment.