Skip to content
SHC Docs

shc vault unlock

unlock the vault (alias for bare shc vault)

Unlock the vault so the daemon can read secrets again.

Non-interactive (what unattended recovery needs):

shc vault unlock --password-file /etc/shc/vault.pw # mode 0600 printf %s “$PW” | shc vault unlock --password-file -

--password-file takes precedence over --password, and never puts the secret on the command line. -p/--password does: argv is readable in ps, in /proc//cmdline and in docker inspect, so a password passed that way is disclosed to every local user for the life of the call. There is deliberately no environment-variable form: the environment is inherited by every child process, is readable at /proc//environ, and lands verbatim in a systemd unit and in docker inspect. A file has an owner and a mode the kernel enforces; - puts the secret nowhere at all but the pipe.

With neither flag the command prompts.

shc vault unlock [flags]
-h, --help help for unlock
--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)