thePR0M3TH3AN/seedPass
1
0
Fork 0
mirror of https://github.com/PR0M3TH3AN/SeedPass.git synced 2025-09-08 07:18:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: describe launching TUI

Browse Source
This commit is contained in:
thePR0M3TH3AN
2025-07-11 12:41:31 -04:00
parent 077893a389
commit fc56ec169f
4 changed files with 26 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@@ -160,11 +160,12 @@ After installing dependencies and activating your virtual environment, install t
python -m pip install -e . python -m pip install -e .
``` ```
You can then launch SeedPass and create a backup: You can then launch SeedPass and create a backup:
```bash ```bash
# Start the application # Start the application (interactive TUI)
python src/main.py seedpass
# Export your index # Export your index
seedpass export --file "~/seedpass_backup.json" seedpass export --file "~/seedpass_backup.json"
@@ -216,13 +217,19 @@ After successfully installing the dependencies, install the package with:
python -m pip install -e . python -m pip install -e .
``` ```
Once installed, you can run SeedPass using the following command: Once installed, launch the interactive TUI with:
```bash
seedpass
```
You can also run directly from the repository with:
```bash ```bash
python src/main.py python src/main.py
``` ```
You can also use the new Typer-based CLI: You can explore other CLI commands using:
```bash ```bash
seedpass --help seedpass --help
@@ -247,8 +254,9 @@ For a full list of commands see [docs/advanced_cli.md](docs/advanced_cli.md). Th
1. **Start the Application:** 1. **Start the Application:**
```bash ```bash
python src/main.py seedpass
``` ```
*(or `python src/main.py` when running directly from the repository)*
2. **Follow the Prompts:** 2. **Follow the Prompts:**

16
docs/docs/content/index.md
View File

@@ -186,7 +186,7 @@ create a backup:
```bash ```bash
# Start the application # Start the application
python src/main.py seedpass
# Export your index # Export your index
seedpass export --file "~/seedpass_backup.json" seedpass export --file "~/seedpass_backup.json"
@@ -234,14 +234,19 @@ The encrypted index file `seedpass_entries_db.json.enc` begins with `schema_vers
## Usage ## Usage
After successfully installing the dependencies, you can run SeedPass using the following command: After successfully installing the dependencies, launch the interactive TUI with:
```bash
seedpass
```
You can also run directly from the repository using:
```bash ```bash
python src/main.py python src/main.py
``` ```
You can also use the Typer-based command line interface once the You can explore other CLI commands using:
package is installed:
```bash ```bash
seedpass --help seedpass --help
``` ```
@@ -252,8 +257,9 @@ For a full list of commands see [docs/advanced_cli.md](docs/advanced_cli.md). Th
1. **Start the Application:** 1. **Start the Application:**
```bash ```bash
python src/main.py seedpass
``` ```
*(or `python src/main.py` if running directly from the repository)*
2. **Follow the Prompts:** 2. **Follow the Prompts:**

2
scripts/install.ps1
View File

@@ -292,5 +292,5 @@ if (($UserPath -split ';') -notcontains $LauncherDir) {
} }
Write-Success "Installation/update complete!" Write-Success "Installation/update complete!"
Write-Info "To run the application, please open a NEW terminal window and type: seedpass" Write-Info "To launch the interactive TUI, open a NEW terminal window and run: seedpass"
Write-Info "'seedpass' resolves to: $(Get-Command seedpass | Select-Object -ExpandProperty Source)" Write-Info "'seedpass' resolves to: $(Get-Command seedpass | Select-Object -ExpandProperty Source)"

2
scripts/install.sh
View File

@@ -140,7 +140,7 @@ EOF2
# 8. Final instructions # 8. Final instructions
print_success "Installation/update complete!" print_success "Installation/update complete!"
print_info "You can now run the application by typing: seedpass" print_info "You can now launch the interactive TUI by typing: seedpass"
print_info "'seedpass' resolves to: $(command -v seedpass)" print_info "'seedpass' resolves to: $(command -v seedpass)"
if [[ ":$PATH:" != *":$LAUNCHER_DIR:"* ]]; then if [[ ":$PATH:" != *":$LAUNCHER_DIR:"* ]]; then
print_warning "Directory '$LAUNCHER_DIR' is not in your PATH." print_warning "Directory '$LAUNCHER_DIR' is not in your PATH."