Add GUI getting started docs

This commit is contained in:
thePR0M3TH3AN
2025-07-18 09:48:13 -04:00
parent eb1ab7662d
commit dcda452da8
2 changed files with 61 additions and 0 deletions

View File

@@ -229,6 +229,37 @@ seedpass list --filter totp
For additional command examples, see [docs/advanced_cli.md](docs/advanced_cli.md). Details on the REST API can be found in [docs/api_reference.md](docs/api_reference.md).
### Getting Started with the GUI
SeedPass also ships with a simple BeeWare desktop interface. Launch it from
your virtual environment using:
```bash
python -m seedpass_gui
```
If installed globally, you can run the `seedpass-gui` entry point instead:
```bash
seedpass-gui
```
The GUI works with the same vault and configuration files as the CLI.
```mermaid
graph TD
core["seedpass.core"]
cli["CLI"]
api["FastAPI server"]
gui["BeeWare GUI"]
ext["Browser Extension"]
cli --> core
gui --> core
api --> core
ext --> api
```
### Vault JSON Layout
The encrypted index file `seedpass_entries_db.json.enc` begins with `schema_version` `2` and stores an `entries` map keyed by entry numbers.