Skip to content

install.md

Latest commit

 

History

History
57 lines (39 loc) · 927 Bytes

install.md

File metadata and controls

57 lines (39 loc) · 927 Bytes

Installation and Docker usage

Speakeasy requires Python 3.10+.

Install from PyPI

python3 -m pip install speakeasy-emulator

Optional GDB support:

python3 -m pip install "speakeasy-emulator[gdb]"

Verify installation:

speakeasy -h

Install from source

git clone https://github.com/mandiant/speakeasy.git
cd speakeasy
python3 -m pip install -e ".[dev]"

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