naglfar / krunner-keepassxc

A small krunner plugin to copy keepassxc entries to clipboard using its Freedesktop.org Secret Service dbus integration.
MIT License
27 stars 3 forks source link

Documentation update / addition suggestion #7

Closed N-Upchurch closed 2 years ago

N-Upchurch commented 2 years ago

Thanks for making this tool; I had a little trouble getting started, so I thought I'd contribute some suggestions for the README that might be helpful to others:

Not Working? Basic Troubleshooting Steps:

  1. Be sure you have the dependencies installed:
    • xsel
    • xclip
    • python 3.6+
    • You may also have to install python-setproctitle
  2. Ensure Secret Service is enabled in both places in the KeepassXC desktop client:
    • Database > Database Settings > Secret Service > Expose entries under this group > [Select group]
    • Tools > Settings > Secret Service > Enable KeepassXC Freedesktop.org Secret Service integration
  3. Ensure that the plugin is selected in krunner settings.

Usage via Krunner:

  1. Launch krunner.
  2. Enter a search term based on the title of the entry you would like credentials for; there is no need for a keyword to use this plugin.
  3. Using the mouse, click on the entry you are looking for to copy the password to the clipboard. To copy the username, click on the icon to the right of the entry.
  4. If you are a keyboard user, use the arrow keys to navigate to the correct entry. Press enter to copy the password to the clipboard, or press tab, then enter, to copy the username to the clipboard.
naglfar commented 2 years ago

Hey, thanks for the feedback! I actually knew about the setproctitle problem since the beginning of the year. It was supposed to be bundled into the release package but I ran into the sort of problems you tend to do when dealing with pypi: it threw some errors while building in my environment and I gave up. I now got around to building it on another machine and pushed version 1.5.2 to the kde store so this should no longer be an issue. I'll see about updating the documentation / store description with your suggestions.