Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ndrewh authored Jul 8, 2024
1 parent 3989500 commit c773f25
Showing 1 changed file with 16 additions and 8 deletions.
24 changes: 16 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,7 @@ It was designed with CTF challenges (pwn/rev) in mind.
#### Quickstart

```sh
docker run -it ghcr.io/ndrewh/pyda
pyda <script_name> -- <target> <target_args>
docker run -it ghcr.io/ndrewh/pyda pyda examples/ltrace.py -- ls -al
```


Expand Down Expand Up @@ -62,6 +61,7 @@ See [examples/](examples/) for additional examples.
Current features:
-----
- Hooks (aka "breakpoints" if you prefer) at arbitrary instructions
- Syscall pre/post hooks
- Read and write memory
- Read and modify registers
- Supports multithreaded programs
Expand All @@ -74,25 +74,33 @@ Current features:
attempts to isolate our libc from the target, OS structures (e.g. fds)
are shared.

## Usage
## Getting started

### Install

Suggested use is via Docker:
Suggested use is via Docker.

Pull the latest release:
```sh
docker pull ghcr.io/ndrewh/pyda pyda
```

Or build it yourself:
```sh
docker build -t pyda .
docker run -it pyda
```
(default entrypoint is `/bin/bash` in a ubuntu:22.04 image)

Usage:
(The Pyda image is currently based on `ubuntu:22.04` and we leave the default entrypoint as `/bin/bash`)

### Usage
```sh
pyda <script_path> [script_args] -- <bin_path> [bin_args]
```

"Hello World" example: `ltrace`
"Hello World" example: `ltrace` over `/bin/ls`
```sh
pyda examples/ltrace.py -- /usr/bin/ls
pyda examples/ltrace.py -- ls
```

### Examples
Expand Down

0 comments on commit c773f25

Please sign in to comment.