From aca1012aedf52daf417ccb3f37d2ebc2ad7f0848 Mon Sep 17 00:00:00 2001 From: thePR0M3TH3AN <53631862+PR0M3TH3AN@users.noreply.github.com> Date: Wed, 9 Jul 2025 12:07:57 -0400 Subject: [PATCH] Update README usage docs --- README.md | 6 +++++- docs/README.md | 6 +++--- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9719589..60e8580 100644 --- a/README.md +++ b/README.md @@ -175,7 +175,8 @@ seedpass import --file "~/seedpass_backup.json" seedpass search "github" seedpass search --tags "work,personal" seedpass get "github" -seedpass totp "email" +# Retrieve a TOTP entry +seedpass entry get "email" # The code is printed and copied to your clipboard # Sort or filter the list view @@ -186,6 +187,9 @@ seedpass list --filter totp # 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 The encrypted index file `seedpass_entries_db.json.enc` begins with `schema_version` `2` and stores an `entries` map keyed by entry numbers. diff --git a/docs/README.md b/docs/README.md index eb149ff..bf93cc0 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,12 +4,12 @@ This directory contains supplementary guides for using SeedPass. ## Quick Example: Get a TOTP Code -Run `seedpass totp ` to retrieve a time-based one-time password (TOTP). The -`` can be a label, title, or index. A progress bar shows the remaining +Run `seedpass entry get ` to retrieve a time-based one-time password (TOTP). +The `` can be a label, title, or index. A progress bar shows the remaining seconds in the current period. ```bash -$ seedpass totp "email" +$ seedpass entry get "email" [##########----------] 15s Code: 123456 ```