CLI command
skarbiec notes
Keep the free text that belongs with an account — security answers, a support PIN, which phone opened it — encrypted with the account rather than in a separate file.
Invocation#
skarbiec notes <id>
printf '%s' '<text>' | skarbiec notes <id> --setPurpose#
Keep the free text that belongs with an account — security answers, a support PIN, which phone opened it — encrypted with the account rather than in a separate file.
Required inputs and options#
- The item id. --set reads the whole new text on standard input; trailing newlines are dropped, and text that is only whitespace removes the notes.
Output and state effects#
- Without --set prints ok, item and notes (null when the item carries none). With --set stores the text as context.notes in a new revision with the same recipients and tags, or removes it, appends notes-set naming the item, whether they were removed and the revision, and prints ok, item, removed and revision; the text itself is not journalled. POST /v1/operator/items/notes takes id; POST /v1/operator/items/notes/set takes id and notes, empty to remove. Desktop's item inspector offers Show notes and Save notes.
Refusals#
- A missing id exits 2 with the usage. --set is refused for a lifecycle-controlled item and on a replica vault as any owner write is, and for a context that is not an object naming the item; an item that will not open fails with its decryption error. The operator route refuses a body without notes.