mirror of
https://github.com/PR0M3TH3AN/SeedPass.git
synced 2025-09-08 07:18:47 +00:00
docs: expand GUI start options
This commit is contained in:
14
README.md
14
README.md
@@ -232,15 +232,11 @@ For additional command examples, see [docs/advanced_cli.md](docs/advanced_cli.md
|
|||||||
### Getting Started with the GUI
|
### Getting Started with the GUI
|
||||||
|
|
||||||
SeedPass also ships with a simple BeeWare desktop interface. Launch it from
|
SeedPass also ships with a simple BeeWare desktop interface. Launch it from
|
||||||
your virtual environment using:
|
your virtual environment using any of the following commands:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
seedpass gui
|
||||||
python -m seedpass_gui
|
python -m seedpass_gui
|
||||||
```
|
|
||||||
|
|
||||||
If installed globally, you can run the `seedpass-gui` entry point instead:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
seedpass-gui
|
seedpass-gui
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -601,6 +597,12 @@ scripts/vendor_dependencies.sh
|
|||||||
pyinstaller SeedPass.spec
|
pyinstaller SeedPass.spec
|
||||||
```
|
```
|
||||||
|
|
||||||
|
You can also produce packaged installers for the GUI with BeeWare's Briefcase:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
briefcase build
|
||||||
|
```
|
||||||
|
|
||||||
The standalone executable will appear in the `dist/` directory. This process works on Windows, macOS and Linux but you must build on each platform for a native binary.
|
The standalone executable will appear in the `dist/` directory. This process works on Windows, macOS and Linux but you must build on each platform for a native binary.
|
||||||
|
|
||||||
## Security Considerations
|
## Security Considerations
|
||||||
|
@@ -4,20 +4,19 @@ SeedPass ships with a proof-of-concept graphical interface built using [BeeWare]
|
|||||||
|
|
||||||
## Getting Started with the GUI
|
## Getting Started with the GUI
|
||||||
|
|
||||||
After installing the project dependencies, launch the desktop interface with:
|
After installing the project dependencies, launch the desktop interface with one
|
||||||
|
of the following commands:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
seedpass gui
|
||||||
python -m seedpass_gui
|
python -m seedpass_gui
|
||||||
```
|
|
||||||
|
|
||||||
If you installed the package globally, you can use the provided entry point:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
seedpass-gui
|
seedpass-gui
|
||||||
```
|
```
|
||||||
|
|
||||||
The GUI shares the same encrypted vault and configuration as the command line tool.
|
The GUI shares the same encrypted vault and configuration as the command line tool.
|
||||||
|
|
||||||
|
To generate a packaged binary, run `briefcase build` (after the initial `briefcase create`).
|
||||||
|
|
||||||
```mermaid
|
```mermaid
|
||||||
graph TD
|
graph TD
|
||||||
core["seedpass.core"]
|
core["seedpass.core"]
|
||||||
|
Reference in New Issue
Block a user