keepassxc-go

README

keepassxc-go

This repository contains a library as well as a basic CLI tool to interact with KeepassXC using the provided unix socket.

Installation

To install it, you can either use the following one-liner or download the binary or one of the packages from the releases.

curl -Ls https://git.io/keepassxc-go.sh | sh

Usage

CLI tool

The CLI tool currently is quite limited as it only provides a way to search for an url.

$ ./ci-build/keepassxc-go --help
interact with keepassxc via unix-socket

Usage:
  keepassxc-go [command]

Available Commands:
  get-logins  query info for the specified url
  help        Help about any command

Flags:
  -h, --help             help for keepassxc-go
  -p, --profile string   Only necessary if keystore contains multiple profiles

Use "keepassxc-go [command] --help" for more information about a command.

$ ./ci-build/keepassxc-go get-logins --help
query info for the specified url

Usage:
  keepassxc-go get-logins URL [flags]

Flags:
      --all         show all matches otherwise only the first will be printed
  -h, --help        help for get-logins
      --plaintext   print out the password - BE CAREFUL

Global Flags:
  -p, --profile string   Only necessary if keystore contains multiple profiles

Documentation

Overview

Copyright © 2021 Markus Freitag <fmarkus@mailbox.org>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.