table of contents
KEYRING(1) | General Commands Manual | KEYRING(1) |
NAME¶
keyring - Python-Keyring command-line utility
SYNOPSIS¶
keyring [OPTIONS] [get|set|del|diagnose] SERVICE USERNAME
OPTIONS¶
- -h, --help
- Show the help message and exit.
- -p KEYRING_PATH, --keyring-path=KEYRING_PATH
- Specify path to the keyring backend to use.
- -b KEYRING_BACKEND, --keyring-backend=KEYRING_BACKEND
- Specify name of the keyring backend to use.
- --list-backends
- List the available keyring backends and exit.
- --disable
- Create a configuration file disabling keyring and exit.
- --mode {password,creds}
- Specify mode for get operation. password requires a username and will return only the password. creds does not require a username and will return both the username and password separated by a newline. Default is password.
- --output {plain,json}
- Specify output format for get operation. Default is plain.
- --print-completion {bash,zsh,tcsh}
- Print shell completion script.
DESCRIPTION¶
keyring provides a way to store, lookup and delete passwords in various backends supported by Python-Keyring.
Usage example:
$ keyring set service username Password for 'username' in 'service': $ keyring get service username password
How the SERVICE and USERNAME parameters are handled depends on the backend, with the default Secret Service backend they are stored as item lookup attributes.