Add get-code example and 2FA note

This commit is contained in:
thePR0M3TH3AN
2025-07-03 00:16:55 -04:00
parent 565958f271
commit 8249b0cf32
2 changed files with 16 additions and 0 deletions

View File

@@ -44,6 +44,7 @@ SeedPass now uses the `portalocker` library for cross-platform file locking. No
- **Checksum Verification:** Ensure the integrity of the script with checksum verification.
- **Multiple Seed Profiles:** Manage separate seed profiles and switch between them seamlessly.
- **Interactive TUI:** Navigate through menus to add, retrieve, and modify entries as well as configure Nostr settings.
- **SeedPass 2FA:** Generate TOTP codes with a real-time countdown progress bar.
## Prerequisites

15
docs/README.md Normal file
View File

@@ -0,0 +1,15 @@
# SeedPass Documentation
This directory contains supplementary guides for using SeedPass.
## Quick Example: Get a TOTP Code
Run `seedpass get-code` to retrieve a time-based one-time password (TOTP). A progress bar shows the remaining seconds in the current period.
```bash
$ seedpass get-code --index 0
[##########----------] 15s
Code: 123456
```
See [advanced_cli.md](advanced_cli.md) for a full command reference.