Skip to content

install.md

Latest commit

 

History

History
55 lines (38 loc) · 1.21 KB

install.md

File metadata and controls

55 lines (38 loc) · 1.21 KB
Raw

Installation and Docker usage

Speakeasy requires Python 3.10+.

Install from PyPI

python3 -m pip install speakeasy-emulator

Verify installation:

speakeasy -h

Install from source

git clone --recurse-submodules https://github.com/mandiant/speakeasy.git
cd speakeasy
python3 -m pip install -e ".[dev]"
python3 scripts/gen_win32_signatures.py
python3 scripts/gen_phnt_signatures.py

The last two steps build the API signature databases from the deps/win32json and deps/phnt submodules (see Adding API handlers). Wheels built with python -m build include them automatically; an editable install needs them generated once, and again after updating the submodules.

Optional GDB support from source:

python3 -m pip install -e ".[dev,gdb]"

Run in Docker

Build image:

cd <repo_base_dir>
docker build -t speakeasy:local .

Run container with a host sample directory mounted at /sandbox:

docker run -v <path_containing_samples>:/sandbox -it speakeasy:local

Related docs