Compare commits
4 Commits
27e85f01f2
...
e534746cf3
| Author | SHA1 | Date | |
|---|---|---|---|
| e534746cf3 | |||
| 5397b37c13 | |||
| 2df2792a75 | |||
| 4fe568f803 |
28
README.md
28
README.md
@@ -15,10 +15,10 @@ go install sneak.berlin/go/vaultik/cmd/vaultik@latest
|
||||
# create a default config file (prints the path it wrote to)
|
||||
vaultik config init
|
||||
|
||||
# generate an age keypair; keep key.txt somewhere safe and offline —
|
||||
# you need it to restore, and the backed-up machine does not need it
|
||||
age-keygen -o key.txt
|
||||
grep 'public key' key.txt
|
||||
# generate an age keypair; keep the private key file somewhere safe and
|
||||
# offline — you need it to restore, and the backed-up machine does not need it
|
||||
age-keygen -o vaultik_backup_private_key.txt
|
||||
grep 'public key' vaultik_backup_private_key.txt
|
||||
|
||||
# configure the encryption key and backup destination
|
||||
vaultik config set age_recipients.0 age1YOUR_PUBLIC_KEY_HERE
|
||||
@@ -104,6 +104,7 @@ vaultik [--config <path>] info
|
||||
vaultik [--config <path>] remote info [--json]
|
||||
vaultik [--config <path>] store info
|
||||
vaultik [--config <path>] database purge [--force]
|
||||
vaultik completion <bash|zsh|fish|powershell>
|
||||
vaultik version
|
||||
```
|
||||
|
||||
@@ -120,6 +121,25 @@ vaultik version
|
||||
* `VAULTIK_CONFIG`: Path to config file (overridden by `--config`)
|
||||
* `VAULTIK_INDEX_PATH`: Override local SQLite index path
|
||||
|
||||
### shell completion
|
||||
|
||||
```sh
|
||||
# zsh: load for the current session
|
||||
source <(vaultik completion zsh)
|
||||
|
||||
# zsh: install permanently
|
||||
vaultik completion zsh > "${fpath[1]}/_vaultik"
|
||||
|
||||
# bash: load for the current session
|
||||
source <(vaultik completion bash)
|
||||
|
||||
# bash: install permanently (Linux)
|
||||
vaultik completion bash > /etc/bash_completion.d/vaultik
|
||||
|
||||
# fish
|
||||
vaultik completion fish > ~/.config/fish/completions/vaultik.fish
|
||||
```
|
||||
|
||||
### command details
|
||||
|
||||
**`config init`**: Write a default config file with commented explanations for
|
||||
|
||||
@@ -20,7 +20,8 @@ const defaultConfigTemplate = `# vaultik configuration
|
||||
# Age recipient public keys for encryption.
|
||||
# Backups are encrypted to ALL listed recipients. Any one of the corresponding
|
||||
# private keys can decrypt. Generate a keypair with:
|
||||
# age-keygen -o key.txt && grep 'public key' key.txt
|
||||
# age-keygen -o vaultik_backup_private_key.txt
|
||||
# grep 'public key' vaultik_backup_private_key.txt
|
||||
age_recipients:
|
||||
- age1REPLACE_WITH_YOUR_PUBLIC_KEY
|
||||
|
||||
|
||||
Reference in New Issue
Block a user