Skip to content
SHC Docs

shc vault escrow record

record that a key is escrowed, and where

Record that the key named by --what has been escrowed at --where, tied to the key’s current generation. A second record for the same key replaces the first.

--where is a label for the person who needs the copy at 3am: which password manager item, which safe, which CI variable. Never the key itself: a label or note that contains the key is refused, because receipts are copied into every database backup.

shc vault escrow record [flags]
shc vault escrow record --what unlock-key --where '1Password, vault Infra, item SHC master'
shc vault escrow record --what backup-key --where 'printed sheet, office safe' --note 'repository URL and bucket account on the same sheet'
-h, --help help for record
--note string optional context: who holds it, how to reach it
--what string the key that was escrowed: unlock-key, backup-key or secrets-key
--where string where the escrowed copy is kept, as a label (never the key)
--config stringArray extra YAML config file to layer on top of auto-discovered config; repeatable, later files win
-d, --debug enable debug mode (default: $SHC_DEBUG)
-e, --environment string environment name (default: "prod", or "default" on an estate with no licence and no trial; $SHC_ENVIRONMENT and shc ctx -e override it, and the "master" tenant is always "default")
--exclude string comma-separated dotted paths to drop
--fields string comma-separated columns/keys to show (and their order)
--filter string comma-separated dotted paths to keep (drops everything else)
-o, --output string output format: tty|text|json|yaml (default: $SHC_OUTPUT)
-p, --password string vault password (visible in the process list, prefer --password-file)
--password-file string read the vault password from a file (mode 0600 expected); use '-' to read stdin. Takes precedence over --password and never puts the secret in argv
-s, --stack string stack name (default: $SHC_STACK)
-t, --tenant string tenant name (default: $SHC_TENANT)
-v, --verbose verbose output (default: $SHC_VERBOSE)
  • shc vault escrow - record where the vault unlock key and the backup key are escrowed