Zelos (Zeropoint Emulated Lightweight Operating System) is a python-based binary emulation platform. One use of zelos is to quickly assess the dynamic behavior of binaries via command-line or python scripts. All syscalls are emulated to isolate the target binary. Linux x86_64 (32- and 64-bit), ARM and MIPS binaries are supported. Unicorn provides CPU emulation.

Full documentation is available here.

Installation
Use the package manager pip to install zelos.

Basic Usage

Command-line
To emulate a binary with default options:
To view the instructions that are being executed, add the -v flag:
You can print only the first time each instruction is executed, rather than every execution, using --fasttrace:
By default, syscalls are emitted on stdout. To write syscalls to a file instead, use the --strace flag:
Specify any command line arguments after the binary name:

Programmatic

Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.

Local Development Environment
First, create a new python virtual environment. This will ensure no package version conflicts arise:
Now clone the repository and change into the zelos directory:
Install an editable version of zelos into the virtual environment. This makes import zelos available, and any local changes to zelos will be effective immediately:
At this point, tests should pass and documentation should build:
Built documentation is found in docs/_build/html/.
Install zelos pre-commit hooks to ensure code style compliance:
In addition to automatically running every commit, you can run them anytime with:

Windows Development:
Commands vary slightly on Windows: