Quick start

Use this tutorial the first time you open GitVault. It keeps the critical order clear: create the vault, protect recovery, set unlock, then connect sync.

Before you start

• GitHub account Required only when you want encrypted sync or multi-device use.
• Private repository Recommended for every synced vault. Keep it dedicated to GitVault.
• Recovery storage Prepare a place outside GitVault for the recovery phrase or recovery kit.

Create your first vault

1. 1
   Open GitVault.

   Use the web app on desktop, or install the Android APK from GitHub Releases.

2. 2
   Choose the new-vault path.

   Use fresh setup when this is your first GitVault device.

3. 3
   Save the recovery phrase.

   Write it down or store the recovery kit outside GitVault. Do not keep the only copy inside the vault.

4. 4
   Create a PIN.

   Use a 4-6 digit PIN you can enter accurately. On web, type the PIN with the physical keyboard.

5. 5
   Add one item.

   Add a password, note, 2FA code, or SSH credential, then reopen it to confirm the saved data is correct.

Set up sync

1. 1
   Create a private GitHub repository.

   Use a dedicated empty repository for the encrypted vault files.

2. 2
   Create a fine-grained token.

   Give the token access only to the vault repository with Metadata read and Contents read/write permissions.

3. 3
   Open Settings, then GitHub Sync.

   Enter the GitHub owner, repository name, and token.

4. 4
   Run the first sync.

   Wait for a success state before opening the vault on another device.

Add another device

Use Link New Device when you still have an unlocked trusted device. Use Restore Device only when you are setting up from recovery.

• Link New Device Opens a short-lived invite from a trusted device and is the normal path for adding your phone, laptop, or browser.
• Restore Device Starts from the recovery phrase and GitHub access, then waits for a trusted-device approval or the lost-device new-token path.

Verify the setup

• Unlock Close and reopen GitVault, then confirm PIN or biometric unlock works.
• Sync Check Settings for a successful sync timestamp after adding an item.
• Recovery Confirm the recovery phrase or kit is stored somewhere you can access without GitVault.