lew/pda
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

docs: add edit and meta commands to README

Browse source
This commit is contained in:
Lewis Wynne 2026-02-13 15:29:52 +00:00
parent 637c7e0b56
commit eaaafbc040
1 changed files with 50 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

50
README.md
View file

@ -73,9 +73,11 @@ Usage:
Key commands: Key commands:
copy Make a copy of a key copy Make a copy of a key
edit Edit a key's value in $EDITOR
get Get the value of a key get Get the value of a key
identity Show or create the age encryption identity identity Show or create the age encryption identity
list List the contents of all stores list List the contents of all stores
meta View or modify metadata for a key
move Move a key move Move a key
remove Delete one or more keys remove Delete one or more keys
run Get the value of a key and execute it run Get the value of a key and execute it
@ -169,6 +171,24 @@ pda get name --exists
<p align="center"></p><!-- spacer --> <p align="center"></p><!-- spacer -->
`pda edit` to open a key in your `$EDITOR`.
```bash
# Edit an existing key.
pda edit name
# Edit a key that doesn't exist yet — saving non-empty content creates it.
pda edit newkey
# Edit and modify metadata in the same operation.
pda edit name --ttl 1h --encrypt
# Trailing newlines added by the editor are stripped by default.
# Pass --preserve-newline to keep them.
pda edit name --preserve-newline
```
<p align="center"></p><!-- spacer -->
`pda mv` to move it. `pda mv` to move it.
```bash ```bash
pda mv name name2 pda mv name name2
@ -671,6 +691,29 @@ pda ls
<p align="center"></p><!-- spacer --> <p align="center"></p><!-- spacer -->
`pda meta` views or modifies metadata (TTL, encryption) without changing a key's value.
```bash
# View metadata for a key.
pda meta session
# key: session@default
# secret: false
# expires: in 59m30s
# Set or change TTL.
pda meta session --ttl 2h
# Clear TTL.
pda meta session --ttl never
# Encrypt an existing plaintext key.
pda meta api-key --encrypt
# Decrypt an encrypted key.
pda meta api-key --decrypt
```
<p align="center"></p><!-- spacer -->
### Binary ### Binary
Save binary data. Save binary data.
@ -941,6 +984,13 @@ PDA_DATA=/tmp/stores pda set key value
<p align="center"></p><!-- spacer --> <p align="center"></p><!-- spacer -->
`EDITOR` is used by `pda edit` and `pda config edit` to open values in a text editor. Must be set for these commands to work.
```bash
EDITOR=nvim pda edit mykey
```
<p align="center"></p><!-- spacer -->
`SHELL` is used by `pda run` (or `pda get --run`) for command execution. Falls back to `/bin/sh` if unset. `SHELL` is used by `pda run` (or `pda get --run`) for command execution. Falls back to `/bin/sh` if unset.
```bash ```bash
pda run script pda run script