Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pbkhrv/ulauncher-keepassxc
Ulauncher extension to quickly search a KeePassXC password manager database
https://github.com/pbkhrv/ulauncher-keepassxc
keepassxc ulauncher ulauncher-extension ulauncher-extensions
Last synced: about 1 month ago
JSON representation
Ulauncher extension to quickly search a KeePassXC password manager database
- Host: GitHub
- URL: https://github.com/pbkhrv/ulauncher-keepassxc
- Owner: pbkhrv
- License: mit
- Created: 2019-10-02T01:54:09.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-07-21T04:21:39.000Z (over 1 year ago)
- Last Synced: 2024-08-04T01:15:39.228Z (5 months ago)
- Topics: keepassxc, ulauncher, ulauncher-extension, ulauncher-extensions
- Language: Python
- Homepage:
- Size: 120 KB
- Stars: 19
- Watchers: 3
- Forks: 13
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-keepass - ulauncher-keepassxc - Ulauncher extension to quickly search a KeePassXC password manager database (Clients / Other clients)
README
# ulauncher-keepassxc
A [Ulauncher](https://ulauncher.io/) extension to search your [KeePassXC](https://keepassxc.org/) password manager database and copy passwords to the clipboard.
## Features
- Quickly search through the database entries by name, and copy passwords/usernames/URLs to the clipboard
- Work with any file (.kdbx etc) that can be accessed by the KeePassXC itself via the `keepassxc-cli` command line tool
- Support files locked with a passphrase. The extension asks for the passphrase and stores it in memory for a configurable amount of time
- Doesn't require the KeePassXC app to be running
## Requirements
- Install a recent version of [KeePassXC](https://keepassxc.org/download/) (tested with 2.4.3, 2.5.0 and 2.6.6)
- Make sure you can execute `keepassxc-cli` in a terminal without errors
## Installation
Open Ulauncher preferences window -> Extensions -> "Add extension" and paste the following url:
```
https://github.com/pbkhrv/ulauncher-keepassxc
```
## Configuration
- `Password database location`: path to the password database file that you want to access through Ulauncher. *This is the only preference that you need to set before you can use the extension.*
- `Inactivity lock timeout`: forces you to re-enter the passphrase after you haven't used the extension for a while. By default it's set to 600 seconds (10 minutes). If you'd rather not re-enter it, you can set the value to 0, but that's probably not a great idea. NOTE: The cached passphrase is only stored in memory, so you'll need to re-enter it if you reboot your computer or restart Ulauncher.
## Usage
Open Ulauncher and type in "kp " to start the extension. If your password database is locked with a passphrase, it'll ask you to enter it:
Once unlocked, search the database for Github logins:
Look at the `Github work` entry:
## Troubleshooting
### Why doesn't the passphrase window come to the foreground when it's asking me to unlock the database?
Please install [wmctrl](http://tripie.sweb.cz/utils/wmctrl/) - it's a utility that ulauncher-keepassxc calls to "activate" the passphrase window and bring it to the top:
**Ubuntu and Debian**
```shell
sudo apt-get install wmctrl
```
## Development
I use the following tools while working on this extension:
- [`Black`](https://github.com/psf/black) code formatter
- `pytest`
- `pylint` with the `flake8` plugin
- `mypy` static type checker
You can install them in one shot (except for `Black` - that's up to you) by running:
```shell
pip install -r scripts/requirements.txt
```
Check PEP8 compliance, perform static type analysis and run unit tests:
```shell
make test
```
Backup the "production" version of the extension and symlink the development version into Ulauncher's extension directory:
```shell
make symlink
```
Quit Ulauncher. Then run it in debug mode:
```shell
make run_ul
```
Run extension in the terminal, connect it to Ulauncher in debug mode:
```shell
make run
```
(if that doesn't work, check the connection string URL printed out by Ulauncher and modify the Makefile accordingly.)
Unlink the development version of the extension from Ulauncher and replace it with whatever was there before:
```shell
make unlink
```
## Contributions
Issues and pull requests are welcome!
## Inspiration and thanks
I loved Alfred on MacOS, and now I love Ulauncher on Linux. The Python API is a joy to work with.
Thanks to [pass-ulauncher](https://github.com/yannishuber/pass-ulauncher) for the overall structure and for teaching me a few things about the API. I aaaalmost switched away from KeePassXC to [pass: the standard unix password manager](https://www.passwordstore.org/) because of it.
[The Noun Project](https://thenounproject.com/) for the icons - there's nothing else quite like it.
Finally, thanks to [KeePassXC](https://keepassxc.org/) on Linux and [KyPass](https://www.kyuran.be/software/kypass/) on iOS.
## License
MIT license. See [LICENSE](LICENSE) file for details.