Speculos documentation

Source code

• Installation
• User
• Developer documentation

Users

Installation and basic usage

• Linux: Requirements and build

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

• Mac M1 users: How to build and use the 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