Build

New Project

Run the following to checkout the project:

git clone --recurse-submodules https://github.com/trezor/trezor-firmware.git
cd trezor-firmware/core

After this you will need to install some software dependencies based on what flavor of Core you want to build. You can either build the Emulator or the actual firmware running on ARM devices. Emulator (also called unix port) is a unix version that can run on your computer. See Emulator for more information.

Existing Project

If you are building from an existing checkout, do not forget to refresh the submodules and the pipenv environment:

git submodule update --init --recursive --force
pipenv sync

Pipenv

We use Pipenv to install and track Python dependencies. You need to install it, sync the packages and then use pipenv run for every command or enter pipenv shell before typing any commands. The commands in this section suppose you are in a pipenv shell environment!

sudo pip3 install pipenv
pipenv sync
pipenv shell