---
name: "keyring"
section: "1"
platform: "linux"
package: "python3-keyring"
version: "25.6.0-2"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/keyring"
---

# keyring(1)

Python-Keyring command-line utility

## 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.

## SEE ALSO

[**secret-tool**(1)](/secret-tool/1.md)