keyring1
Python-keyring command-line utility
Usage
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
getoperation.passwordrequires a username and will return only the password.credsdoes not require a username and will return both the username and password separated by a newline. Default ispassword.
-
--output {plain,json} -
Specify output format for
getoperation. Default isplain.
-
--print-completion {bash,zsh,tcsh} -
Print shell completion script.
Overview
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.
Releases
4 releases since Debian 10 (Buster); the text changed 1 time.
--mode since Debian 13 (Trixie);
--output since Debian 13 (Trixie);
--print-completion since Debian 13 (Trixie).