Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mojoaxel/keepass-print

📄 Print password list from a keepass database for long-term backup
https://github.com/mojoaxel/keepass-print

backup cli keepass

Last synced: 12 days ago
JSON representation

📄 Print password list from a keepass database for long-term backup

Host: GitHub
URL: https://github.com/mojoaxel/keepass-print
Owner: mojoaxel
License: agpl-3.0
Created: 2024-01-13T16:59:38.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2024-01-21T22:12:06.000Z (about 1 year ago)
Last Synced: 2024-12-18T17:47:24.158Z (about 1 month ago)
Topics: backup, cli, keepass
Language: JavaScript
Homepage:
Size: 352 KB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 2
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

awesome-keepass - keepass-print - Command-line tool written in JavaScript to print password list for long-term backup. (Clients / Other clients)

README

# keepass-print

Print password list from a keepass database for long-term backup.

![banner image](./.github/keepass-print.png)

> ⚠️ **WARNING**: Please exercise caution when using this tool! It takes you beyond encrypted realms, making your passwords readable by multiple npm libraries and tools like browsers. Additionally, the resulting output documents may leave traces on your computer, such as in your trash bin or even in your printer's cache. Be aware of these potential risks!

## Setup

To use `keepass-print` as a cli tool install it globally:

```
npm install -g keepass-print
```

## Usage

### command-line-interface (CLI)

If no password and no key-file is provided the tools ask to enter a password.

```
$> keepass-print --help
Usage: keepass-print [options]

Print password list from a keepass database for long-term backup.

Arguments:
database path to the kdbx database file
output path to the output file

Options:
-V, --version output the version number
--outFormat [outFormat] supported output formats (["json", "markdown", "html"]) (default: "json")
--password [password] password to access the database
--key [keyFile] path to the key-file to access the database
--verbose verbose output (default: false)
-h, --help display help for command
```

#### Examples

Basic usage (export json):
```
$> keepass-print ./database.kdbx ./database.json
```

Provide the password as parameter:
```
$> keepass-print --password "pass123" ./database.kdbx ./database.json
```

Provide a key-file instead of a password:
```
$> keepass-print --key ./secret/key ./database.kdbx ./database.json
```

Export as Markdown:
```
$> keepass-print --outFormat markdown ./database.kdbx ./database.md
```

Export as Html:
```
$> keepass-print --outFormat html ./database.kdbx ./database.html
```

## Dependencies

This tool makes heavy usage of the following libraries:
- [kdbxweb](https://www.npmjs.com/package/kdbxweb)
- [ejs](https://www.npmjs.com/package/ejs)

## Legal