https://github.com/spcomb/getkey

Command-line and Awesome client for gnome-keyring
https://github.com/spcomb/getkey

Last synced: about 2 months ago
JSON representation

Command-line and Awesome client for gnome-keyring

• Host: GitHub
• URL: https://github.com/spcomb/getkey
• Owner: SpComb
• Created: 2014-02-21T22:59:13.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2023-10-25T06:21:08.000Z (over 2 years ago)
• Last Synced: 2025-10-14T11:53:44.609Z (8 months ago)
• Language: Python
• Size: 22.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# getkey

Command-line [Freedesktop.org Secret Service](https://specifications.freedesktop.org/secret-service/) client.

Tested against gnome-keyring.

### APT Depends:

* `python3-secretstorage`

* `xclip`

* `wl-clipboard`

## `getkey`

Python command-line client using [secretstorage](https://github.com/mitya57/secretstorage)

List available keyrings:

    $ getkey --list-keyrings

    login

    foobar

Unlock a locked keyring if required, prompting for a password on stdin:

    $ getkey --keyring foobar --unlock

    ...

List keys from a given keyring:

    $ getkey --keyring foobar --list

    random1

    pw3

Retreive and print out the plaintext key:

    $ getkey --keyring foobar random1

    ...

Retreive a key into the X selection buffer, ready for pasting. Does not display the key:

    $ getkey --keyring foobar --selection pw3

Generate and store a new key, using `--generate-length` random alnum chars:

    $ getkey --keyring foobar --generate pw4

Generate and update a key, including special chars (when the normal generate password is rejected):

   

    $ getkey --generate --generate-special --update pwd -o

Output keynames for tab-completion:

    $ getkey --keyring foobar --list

    random1

    pw3

    $ getkey --keyring foobar --list ra*

    random1

## `--list-cache`

Use `getkey --list-cache=${XDG_CACHE_HOME:-$HOME/.cache}/getkey/list-cache` to order most recently used keys first in the `--list` output.

    $ getkey -k session --list-cache ~/.cache/getkey/list-cache -l

    test3

    test2

    test

    $ getkey -k session --list-cache ~/.cache/getkey/list-cache test2 -o

    DFlG5OMsOyiqH9Zi

    $ getkey -k session --list-cache ~/.cache/getkey/list-cache -l

    test2

    test3

    test

    $ cat ~/.cache/getkey/list-cache

    test2

## awesome `getkey.lua`

Support for Awesome using either `awful.prompt` with tab-completion or an interactive `awful.menu`.

Customize the keyring to use for the prompt:

    GETKEY_KEYRING = "foobar"

Bind to a key in your `~/.config/awesome/rc.lua` using:

    local getkey = require("awesome-getkey")

    globalkeys = awful.util.table.join(

        ...

        awful.key({ modkey },            "e",     function () getkey.prompt() end),

        awful.key({ modkey, "Shift" },   "e",     function () getkey.menu() end),

        ...

    )

## i3/sway `dmenu_getkey`

Trivial wrapper around `dmenu` and getkey, for use with i3/sway

    bindsym $mod+e exec --no-startup-id "dmenu_getkey"