Welcome to the Trezor Suite repository! This repository contains the source code for 3 projects:

• Connect - tool that offers developers an easy way to integrate Trezor's functionality into their own applications
• Trezor Suite - desktop and web application for managing Trezor hardware wallet
• Trezor Suite Mobile - Mobile/Tablet application designed for managing Trezor hardware wallet

• Install NVM
  • Hint: you can have your shell automatically switch versions in each repo
• Enable Yarn through npm
• Install Git LFS (For Linux/Ubuntu, after adding the repository do sudo apt-get install git-lfs, more info here)
• Optional recommended: setup PMG

• git clone [email protected]:trezor/trezor-suite.git
• cd trezor-suite
• git submodule update --init --recursive
• git lfs install // Set up Git LFS for your user account. You only need to run this once per user account.
• git lfs pull
• nvm install
• yarn
• yarn build:essential

It's recommended to enable git config --global submodule.recurse true so you don't need to run git submodule update --init --recursive every time when submodules are updated.

You don't need a Trezor device to get into the app, you can use emulator. There is a Trezor User Env to help you set it up and run emulator for any Trezor model 🎉

You can use Nix to set up the repository — see Nix Documentation.

This repository is used for development of version 10 of @trezor/connect. For detailed documentation, please refer to this page.

Historically, Trezor Connect had its own repository. This repository is now archived.

Dev environment is primarily supported on macOS or Linux, though development on Windows is possible by following this guide.

Run a dev build:

• yarn suite:dev (web app)
• yarn suite:dev:vite (⚠️ EXPERIMENTAL: web app with Vite bundler used for development only, use yarn suite:dev if you want fidelity to production app)
• yarn suite:dev:desktop (electron app)