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

docs: document tags

Browse Source
This commit is contained in:
thePR0M3TH3AN
2025-07-08 14:33:56 -04:00
parent 9db9a4d9fa
commit f1fff317fa
3 changed files with 17 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@@ -53,6 +53,7 @@ SeedPass now uses the `portalocker` library for cross-platform file locking. No
- **Optional External Backup Location:** Configure a second directory where backups are automatically copied. - **Optional External Backup Location:** Configure a second directory where backups are automatically copied.
- **Auto‑Lock on Inactivity:** Vault locks after a configurable timeout for additional security. - **Auto‑Lock on Inactivity:** Vault locks after a configurable timeout for additional security.
- **Secret Mode:** Copy retrieved passwords directly to your clipboard and automatically clear it after a delay. - **Secret Mode:** Copy retrieved passwords directly to your clipboard and automatically clear it after a delay.
- **Tagging Support:** Organize entries with optional tags and find them quickly via search.
## Prerequisites ## Prerequisites
@@ -172,6 +173,7 @@ seedpass import --file "~/seedpass_backup.json"
# Quickly find or retrieve entries # Quickly find or retrieve entries
seedpass search "github" seedpass search "github"
seedpass search --tags "work,personal"
seedpass get "github" seedpass get "github"
seedpass totp "email" seedpass totp "email"
# The code is printed and copied to your clipboard # The code is printed and copied to your clipboard
@@ -295,14 +297,14 @@ entry includes a `label`, while only password entries track a `url`.
| Entry Type | Extra Fields | | Entry Type | Extra Fields |
|---------------|---------------------------------------------------------------------------------------------------------------------------------------| |---------------|---------------------------------------------------------------------------------------------------------------------------------------|
| Password | `username`, `url`, `length`, `archived`, optional `notes`, optional `custom_fields` (may include hidden fields) | | Password | `username`, `url`, `length`, `archived`, optional `notes`, optional `custom_fields` (may include hidden fields), optional `tags` |
| 2FA (TOTP) | `index` or `secret`, `period`, `digits`, `archived`, optional `notes` | | 2FA (TOTP) | `index` or `secret`, `period`, `digits`, `archived`, optional `notes`, optional `tags` |
| SSH Key | `index`, `archived`, optional `notes` | | SSH Key | `index`, `archived`, optional `notes`, optional `tags` |
| Seed Phrase | `index`, `word_count` *(mnemonic regenerated; never stored)*, `archived`, optional `notes` | | Seed Phrase | `index`, `word_count` *(mnemonic regenerated; never stored)*, `archived`, optional `notes`, optional `tags` |
| PGP Key | `index`, `key_type`, `archived`, optional `user_id`, optional `notes` | | PGP Key | `index`, `key_type`, `archived`, optional `user_id`, optional `notes`, optional `tags` |
| Nostr Key Pair| `index`, `archived`, optional `notes` | | Nostr Key Pair| `index`, `archived`, optional `notes`, optional `tags` |
| Key/Value | `value`, `archived`, optional `notes`, optional `custom_fields` | | Key/Value | `value`, `archived`, optional `notes`, optional `custom_fields`, optional `tags` |
| Managed Account | `index`, `word_count`, `fingerprint`, `archived`, optional `notes` | | Managed Account | `index`, `word_count`, `fingerprint`, `archived`, optional `notes`, optional `tags` |
### Managing Multiple Seeds ### Managing Multiple Seeds

6
docs/advanced_cli.md
View File

@@ -107,11 +107,11 @@ Miscellaneous helper commands.
### `entry` Commands ### `entry` Commands
- **`seedpass entry add`** – Add a new entry. Use `--type` to specify `password`, `totp`, `ssh`, `pgp`, `nostr`, `key-value`, or `managed-account`. - **`seedpass entry add`** – Add a new entry. Use `--type` to specify `password`, `totp`, `ssh`, `pgp`, `nostr`, `key-value`, or `managed-account`. Include `--tags tag1,tag2` to categorize the entry.
- **`seedpass entry get <query>`** – Retrieve the primary secret for one matching entry. - **`seedpass entry get <query>`** – Retrieve the primary secret for one matching entry.
- **`seedpass entry list`** – List entries in the vault, optionally sorted or filtered. - **`seedpass entry list`** – List entries in the vault, optionally sorted or filtered.
- **`seedpass entry search <query>`** – Search across labels, usernames, URLs, and notes. - **`seedpass entry search <query>`** – Search across labels, usernames, URLs, notes, and tags.
- **`seedpass entry modify <query>`** – Update fields on an existing entry. Use `--archive` to hide or `--restore` to un‑archive. - **`seedpass entry modify <query>`** – Update fields on an existing entry. Use `--archive` to hide or `--restore` to un‑archive. Specify `--tags tag1,tag2` to replace the entry's tags.
- **`seedpass entry delete <query>`** – Permanently delete an entry after confirmation. - **`seedpass entry delete <query>`** – Permanently delete an entry after confirmation.
### `vault` Commands ### `vault` Commands

4
docs/json_entries.md
View File

@@ -77,6 +77,7 @@ Each entry is stored within `seedpass_entries_db.json.enc` under the `entries` d
"notes": "", "notes": "",
"custom_fields": [], "custom_fields": [],
"origin": "", "origin": "",
"tags": [],
"index": 0 "index": 0
} }
``` ```
@@ -97,6 +98,7 @@ Each entry is stored within `seedpass_entries_db.json.enc` under the `entries` d
- **index** (`integer`, optional): BIP-85 derivation index for entries that derive material from a seed. - **index** (`integer`, optional): BIP-85 derivation index for entries that derive material from a seed.
- **word_count** (`integer`, managed_account only): Number of words in the child seed. Managed accounts always use `12`. - **word_count** (`integer`, managed_account only): Number of words in the child seed. Managed accounts always use `12`.
- **fingerprint** (`string`, managed_account only): Identifier of the child profile, used for its directory name. - **fingerprint** (`string`, managed_account only): Identifier of the child profile, used for its directory name.
- **tags** (`array`, optional): Category labels to aid in organization and search.
Example: Example:
```json ```json
@@ -126,6 +128,7 @@ Each entry is stored within `seedpass_entries_db.json.enc` under the `entries` d
"custom_fields": [ "custom_fields": [
{"name": "department", "value": "finance"} {"name": "department", "value": "finance"}
], ],
"tags": ["work"],
"timestamp": "2024-04-27T12:34:56Z", "timestamp": "2024-04-27T12:34:56Z",
"metadata": { "metadata": {
"created_at": "2024-04-27T12:34:56Z", "created_at": "2024-04-27T12:34:56Z",
@@ -250,6 +253,7 @@ Each entry is stored within `seedpass_entries_db.json.enc` under the `entries` d
"key": "api_key", "key": "api_key",
"value": "<encrypted_value>" "value": "<encrypted_value>"
}, },
"tags": ["api"],
"timestamp": "2024-04-27T12:40:56Z" "timestamp": "2024-04-27T12:40:56Z"
} }
``` ```