Speculos documentation

Source code

• Installation
• User
• Developer documentation

Users

Getting started

• New here? Start with the Quickstart (install + run on any OS)

• Get an app to run (find or build an .elf)

• Driving Speculos from code or an agent

• Troubleshooting

Installation per platform

• Linux: Requirements and build

• macOS (and Linux) users: How to use the Docker image with VNC

• macOS Apple Silicon users: Run the prebuilt Docker image

• Windows users: Using speculos from WSL 2

• Usage

Interaction with an app

• How to send APDUs to an app (and more)

• How to use gdb to debug an app

• How to automate actions thanks to the REST API

For advanced users

• Automation: press buttons automatically

• Semihosting as an additional debug mechanism

Speculos developers

• CI (Continuous Integration)

• Internals

• How to run tests