// doc

Documentation

Guides for using SeedLock, ways to check it for yourself, and notes for developers. Every page opens on GitHub.

// for users

For users

The essentials: everything you need to set up and use SeedLock safely.

01

Full user guide

The complete manual. It covers everything from creating a seed and using menus 1 to 10, to setting up Sparrow Wallet and scanning QR codes.

02

Android app guide

Instructions for the mobile preview app: how to install the apk, verify the certificate and use airplane mode.

03

Security advice and best practices

Passwords, keeping the backup file and the password separate, paper backups, and why the offline computer must stay offline.

// advanced and recovery

Advanced and recovery

Don’t trust, verify: see that SeedLock is transparent and that you truly own your data.

04

Command line reference

For power users who want to script SeedLock, or use terminal commands instead of the interactive menu, such as seedlock sign and seedlock new --dice.

05

Backup file format and recovery

Built to outlive the app. It explains the .seedlock format and gives you the recover.py Python script that opens any backup without SeedLock.

06

Verifying downloads (GPG and SHA-256)

Step by step: how to check the SHA256SUMS.txt file and verify the maintainer’s GPG signature.

// for developers and auditors

For developers and auditors

Under the hood, for programmers, security researchers and anyone who wants to build it from source.

07

For developers (building and testing)

How to build SeedLock from source, how the automated tests work, and how the code is laid out.

08

Supply chain and offline audit

How audit-offline.sh shows that there is no network code, no telemetry and no unsafe code in the core library.

09

Source code (GitHub)

The main repository, with all of the code.