Skip to main content

KeePass shell interface and daemon

Project description

kpsh

kpsh, or KeePass Shell, is a password manager and an interactive shell for working directly with KeePass password database files.

Features

  • create, open, lock and unlock databases
  • add, edit and delete database entries
  • list contents of database
  • show contents of database entries and filter them by fields
  • autotype usernames and passwords or any sequences of entry fields (by xdotool on X11 and ydotool on Wayland)
  • access all commands non-interactively via -c switch or by piping commands directly to kpsh
  • tab-completion in interactive mode
  • daemon mode: open and unlock your database once and then quickly access its contents from kpsh-client.
  • several built-in ways to obtain a password, which can be passed by argument, typed directly to kpsh or through pinentry program program or fetched from a provided command output
  • ships with highly customizable kpsh-menu script which performs any kpsh command on entries selected by dmenu/rofi/fzf (e.g. autotype passwords selected in dmenu/rofi)

Usage examples

Typical session:

$ kpsh passwords.kdbx

passwords.kdbx> ls
Password: ********
personal/bank
personal/login
personal/website
work/login

passwords.kdbx> show work/login
path: work/login
username: John Doe
password: jsdf7y8h8349yhj3h42
notes[1]: this is my work password
notes[2]: it's the best

Get a password from gpg-encrypted file (trailing newline, which isn't a part of password is trimmed):

$ gpg --encrypt -o masterpass.gpg -r mymail@example.com
<type type type>
^D
$ kpsh passwords.kdbx --password-command "gpg --decrypt masterpass.gpg | tr -d '\n'"

... or from a keyring:

$ secret-tool store --label='keepass' database passwords.kdbx
$ kpsh passwords.kdbx --password-command "secret-tool lookup database passwords.kdbx"

Autotype a user/password sequence:

$ kpsh passwords.kdbx --password-command "secret-tool lookup database passwords.kdbx"
                      -c autotype entry1

... or just a password, but a little faster:

$ kpsh passwords.kdbx --password-command "secret-tool lookup database passwords.kdbx"
                      -c "autotype -s {PASSWORD} -D 12 entry1"

Run as daemon (-d):

$ kpsh passwords.kdbx -d --password-command "secret-tool lookup database passwords.kdbx" &
$ kpsh-client ls
entry1
entry2
$ kpsh-client autotype entry1

Use pinentry to get a password to unlock database:

$ kpsh passwords.kdbx --pinentry /usr/bin/pinentry

Installation

Use pipx:

$ pipx install kpsh

Or directly pip:

$ pip install --user kpsh

Install fetched git repository (for example to test yet unreleased code):

$ cd keepass-shell
$ rm -rf dist
$ pipx install poetry>=1.2.0a
$ poetry build
$ pipx install dist/kpsh-*.whl

Test kpsh without installation (e.g. for development purposes)

One time setup:

$ pipx install poetry>=1.2.0a
$ poetry lock
$ poetry install

The last command installs kpsh in editable mode, meaning that it will automatically reflect changes in source code. You can safely use it to change kpsh to your liking.

Once kpsh is installed in poetry-managed virtualenv, you can run it like this:

$ poetry run kpsh

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for kpsh, version 2.0.1
Filename, size File type Python version Upload date Hashes
Filename, size kpsh-2.0.1.tar.gz (58.9 kB) File type Source Python version None Upload date Hashes View
Filename, size kpsh-2.0.1-py3-none-any.whl (39.2 kB) File type Wheel Python version py3 Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page