Metadata-Version: 2.4
Name: kpass-cli
Version: 0.1.1
Summary: A pass-like CLI for KeePass KDBX databases
License: MIT
Keywords: keepass,kdbx,cli,password-store,pass
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Security
Classifier: Topic :: Utilities
Requires-Python: >=3.11
Description-Content-Type: text/markdown
Requires-Dist: pykeepass>=4.1.1.post1

# kpass

`kpass` is a CLI for KeePass KDBX databases, similar to [pass](https://www.passwordstore.org/).

It uses [pykeepass](https://pypi.org/project/pykeepass/) under the hood.

## Usage

```text
kpass [options] [path | command]
```

## Commands

- `kpass` — list the database tree
- `kpass <group/subgroup>` — list a subtree
- `kpass <record>` — show the main fields for a record
- `kpass show <record>` — show a record; use `-u`, `-p`, `-e`, `-l`, `-n`, or `-o` for one field
- `kpass find <terms...>` — search by name or path
- `kpass insert <path> ...` — add or update a record
- `kpass generate <path> ...` — add or update a record with a generated password
- `kpass edit <record> ...` — edit one field in `$EDITOR`
- `kpass ls <group>` — list a group subtree
- `kpass cp <source> <destination>` — copy a record or group
- `kpass mv <source> <destination>` — move a record or group
- `kpass rm <target>` — move to the Recycle Bin; use `-f` to delete permanently
- `kpass init [path]` — create a new vault
- `kpass vault ...` — change vault password or keyfile
- `kpass completion <bash|zsh|fish>` — print shell completions

## Common flags

- `--db` — database path
- `--db-password` — database password
- `--db-password-file` — read password from file
- `--db-keyfile` — keyfile for unlocking the database
- `--all` — show all content
- `--clip` — copy the selected field to the clipboard
- `--xml` — output raw KeePass XML
- `--version` — show the version number

Insert and generate also accept:

- `-u, --username`
- `-p, --password`
- `-e, --email`
- `-l, --url`
- `-n, --notes`
- `--otp`

Environment variables:

- `KPASS_DB`
- `KPASS_PASSWORD`
- `KPASS_PASSWORD_FILE`
- `KPASS_KEYFILE`

## Links

- [pass](https://www.passwordstore.org/)
- [KeePass](https://keepass.info/)
- [pykeepass](https://pypi.org/project/pykeepass/)
