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

Update README usage docs

Browse Source
This commit is contained in:
thePR0M3TH3AN
2025-07-09 12:07:57 -04:00
parent 4963026573
commit aca1012aed
2 changed files with 8 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -175,7 +175,8 @@ seedpass import --file "~/seedpass_backup.json"
seedpass search "github" seedpass search "github"
seedpass search --tags "work,personal" seedpass search --tags "work,personal"
seedpass get "github" seedpass get "github"
seedpass totp "email" # Retrieve a TOTP entry
seedpass entry get "email"
# The code is printed and copied to your clipboard # The code is printed and copied to your clipboard
# Sort or filter the list view # Sort or filter the list view
@@ -186,6 +187,9 @@ seedpass list --filter totp
# on an external drive. # on an external drive.
``` ```
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).
### Vault JSON Layout ### 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. The encrypted index file `seedpass_entries_db.json.enc` begins with `schema_version` `2` and stores an `entries` map keyed by entry numbers.

6
docs/README.md
View File

@@ -4,12 +4,12 @@ This directory contains supplementary guides for using SeedPass.
## Quick Example: Get a TOTP Code ## Quick Example: Get a TOTP Code
Run `seedpass totp <query>` to retrieve a time-based one-time password (TOTP). The Run `seedpass entry get <query>` to retrieve a time-based one-time password (TOTP).
`<query>` can be a label, title, or index. A progress bar shows the remaining The `<query>` can be a label, title, or index. A progress bar shows the remaining
seconds in the current period. seconds in the current period.
```bash ```bash
$ seedpass totp "email" $ seedpass entry get "email"
[##########----------] 15s [##########----------] 15s
Code: 123456 Code: 123456
``` ```