Quick Start

This document takes you through a minimal real GUI loop: Repository Settings → Login/Register → Add Items → Save/Export → Handle Conflicts (if any).

1. Prepare a Private Git Repository

We recommend preparing a separate private repository for GitPassword (GitHub, GitLab, or self-hosted services are all fine).

You only need to prepare:

• Remote URL (e.g., https://.../.git or SSH URL)
• A local directory to host this repository (the "Local Path" used below)

2. Repository Settings

Launch GitPassword, and fill in the "Repository Settings" page:

• Remote URL
• Local Path
• SSH Username (optional)
• SSH Private Key (optional)

Then click "Continue".

The app will begin cloning the repository (you might see "Cloning repository...").

3. Login or Register (Local Vault Identity)

Once cloning is complete, you will enter GitPassword's local vault identity process:

• Inputs: Username, Password
• Option: Remember credentials
• Buttons: Login, Register

The login/register here is only for local vault users and encryption keys; it does not mean your plaintext vault will be uploaded to GitBraints cloud services.

Tips:

• The login button is disabled until both username and password are filled.
• If you check "Remember credentials", the username may be auto-filled in the future, and it will try to log in automatically when conditions are met.

4. Add Your First Content (Add Menu)

Once inside the main interface, you can click the "Add" button to open the menu:

• Add Password
• Add Note
• Add File

If there is an unresolved conflict, the app will prompt "There are unresolved conflicts, cannot perform this action. Please resolve all conflicts first." In this case, you need to handle the conflict first (see the last section).

4.1 Add Password

Selecting "Add Password" creates an item with the default title "New Password" and takes you to the details page.

Common fields:

• Title
• Username
• Password (supports show/hide, copy, and "Generate Secure Password")
• Website
• Notes
• Folder
• Favorite

Once edited, click "Save" at the top of the details page.

4.2 Add Note

Selecting "Add Note" takes you to the details page:

• Title
• Content

Then click "Save" at the top.

4.3 Add File

Selecting "Add File" pops up a file selector window. Choose the file you want to import.