Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shikaan/keydex
🔒 Terminal based password manager for KeePass databases.
https://github.com/shikaan/keydex
bash cli fzf keepass password password-manager terminal
Last synced: 9 days ago
JSON representation
🔒 Terminal based password manager for KeePass databases.
- Host: GitHub
- URL: https://github.com/shikaan/keydex
- Owner: shikaan
- License: mit
- Created: 2022-09-23T07:40:33.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-27T00:33:53.000Z (about 1 month ago)
- Last Synced: 2025-01-17T03:06:40.828Z (16 days ago)
- Topics: bash, cli, fzf, keepass, password, password-manager, terminal
- Language: Go
- Homepage:
- Size: 209 KB
- Stars: 71
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
keydex
Terminal based password manager for KeePass databases.
## ⚡️ Quick start
### Installation
_MacOS and Linux_
```sh
sudo sh -c "curl -s https://shikaan.github.io/sup/install | REPO=shikaan/keydex sh -"
```
or
```sh
sudo sh -c "wget -q https://shikaan.github.io/sup/install -O- | REPO=shikaan/keydex sh -"
```
_Windows and manual instructions_
Head to the [releases](https://github.com/shikaan/keydex/releases) page and download the executable for your system and architecture.
### Usage
You can get started simply [opening](./docs/keydex_open.md) your database.
```sh
# opens the interactive editor
keydex open ~/example.kdbx
```
However, the most common use case for `keydex` is [copying](./docs/keydex_copy.md) a password to your clipboard.
```sh
# copies password from the referenced entry (or stdinput)
keydex copy ~/example.kdbx /example/group/entry
```
Using environment variables and aliases you can save a couple of keystrokes
```sh
# ~/.bashrc or ~/.zshrc
export KEYDEX_PASSPHRASE=${MY_SECRET_PHRASE}
export KEYDEX_DATABASE=~/example.kdbx
alias entry-pwd="keydex copy /example/group/entry"
# and then you can use it like
$ entry-pwd
```
Opening a given entry and [listing](./docs/keydex_list.md) accept environment variables too.
```sh
# opens the editor at the given location
keydex open /example/group/entry
# lists all the entries in the database
keydex list
```
### Interoperability
keydex was designed to integrate in your existing workflow: it accepts inputs from stdin and can be piped to your existing toolchain.
For example, here's an of how you can use it to browse entries with [fzf](https://github.com/junegunn/fzf)
```sh
# copy entry's password selected with fzf to the clipboard
keydex list | fzf | keydex copy
# open entry at ref selected with fzf
keydex list | fzf | keydex open
```
## 📄 Documentation
More detailed documentation can be found [here](./docs/keydex.md).
## 🤓 Contributing
Have a look through existing [Issues](https://github.com/shikaan/keydex/issues) and [Pull Requests](https://github.com/shikaan/keydex/pulls) that you could help with. If you'd like to request a feature or report a bug, please create a [GitHub Issue](https://github.com/shikaan/keydex/issues).
## License
[MIT](./LICENSE)