# keepassxc-cli-integration
*CLI and Python integration for KeepassXC GUI.*
---
# CLI
---
- kpx
- get
- login
- {{url}} (Get login for the specified URL from open databases.)
- password
- {{url}} (Get password for the specified URL from open databases.)
- \--name (Specify the name of the entry in the database. Required if the URL has multiple entries.)
- \--bat (Escape output to use BAT.)
- associate
- add (Default. Create an association with the CURRENT ACTIVE database.)
- delete
- {{select}} (Default: "current". Delete the selected association. You can specify the association name as either "all" or "current".)
- show (Show all saved associations.)
---
# Python
---
The keepassxc_cli_integration.kpx module provides similar functions for use directly in Python.
---
*Notes:*
- **KeepassXC-GUI !!!MUST!!! have browser integration enabled.**
- *The association is carried out only with the active (and not with all open) databases. In order to receive information from all open databases, you must first carry out an association with each of them.*
- *Intended for Windows. May or may not work on Linux.*
- *Due to limitations of KeepassXC-GUI, it is possible to retrieve records from databases only by URL. The URL field **can be** written in the database without http(s):\\ and **can** also be specified without http(s):\\ in CLI\Python to retrieve data.*
---
# Example
---
```powershell
# example.ps1
$VeraCrypt = "C:\Program Files\VeraCrypt\VeraCrypt.exe"
$password = kpx get passoword example-vault
& $VeraCrypt /volume "C:\example\vault.hc" /letter Y /password $password /b /q
```
# Installation
1. pip / pipx
```
pip (or pipx) install keepassxc-cli-integration
```
2. git
```
git clone https://github.com/overgodofchaos/keepassxc_cli_integration.git
cd keepassxc-cli-integration
pip (or pipx) install .
```
Raw data
{
"_id": null,
"home_page": null,
"name": "keepassxc-cli-integration",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "keepassxc, keepassxc-cli, keepass, password manager",
"author": "oevergodofchaos",
"author_email": "vezonzzzzzz@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/8c/cc/3af33c5f06acf2bb049afce772915adc63ce9eb758f23291341775252323/keepassxc_cli_integration-1.1.2.tar.gz",
"platform": null,
"description": "# keepassxc-cli-integration\n\n\n\n*CLI and Python integration for KeepassXC GUI.*\n\n---\n\n\n# CLI\n\n---\n- kpx\n - get\n - login\n - {{url}} (Get login for the specified URL from open databases.)\n - password\n - {{url}} (Get password for the specified URL from open databases.)\n - \\--name (Specify the name of the entry in the database. Required if the URL has multiple entries.)\n - \\--bat (Escape output to use BAT.)\n - associate\n - add (Default. Create an association with the CURRENT ACTIVE database.)\n - delete\n - {{select}} (Default: \"current\". Delete the selected association. You can specify the association name as either \"all\" or \"current\".)\n - show (Show all saved associations.)\n\n---\n\n# Python\n\n--- \n\nThe keepassxc_cli_integration.kpx module provides similar functions for use directly in Python.\n\n---\n\n*Notes:*\n- **KeepassXC-GUI !!!MUST!!! have browser integration enabled.**\n- *The association is carried out only with the active (and not with all open) databases. In order to receive information from all open databases, you must first carry out an association with each of them.*\n- *Intended for Windows. May or may not work on Linux.*\n- *Due to limitations of KeepassXC-GUI, it is possible to retrieve records from databases only by URL. The URL field **can be** written in the database without http(s):\\\\ and **can** also be specified without http(s):\\\\ in CLI\\Python to retrieve data.*\n\n---\n\n# Example\n\n---\n\n```powershell\n# example.ps1\n$VeraCrypt = \"C:\\Program Files\\VeraCrypt\\VeraCrypt.exe\"\n$password = kpx get passoword example-vault\n\n& $VeraCrypt /volume \"C:\\example\\vault.hc\" /letter Y /password $password /b /q\n```\n\n# Installation\n\n1. pip / pipx\n```\npip (or pipx) install keepassxc-cli-integration\n```\n2. git\n```\ngit clone https://github.com/overgodofchaos/keepassxc_cli_integration.git\ncd keepassxc-cli-integration\npip (or pipx) install .\n```",
"bugtrack_url": null,
"license": null,
"summary": "CLI integration for KeepassXC GUI.",
"version": "1.1.2",
"project_urls": null,
"split_keywords": [
"keepassxc",
" keepassxc-cli",
" keepass",
" password manager"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6574a67c3145ea3f5e46c94d05d8c31618e0a4c87a0710d9ae7f1baa267c0f0b",
"md5": "e48df20d7f68eca2a73b27d7edc436cd",
"sha256": "e5a8598d75b00616952a4d05c5c5723a809cd1375cd4fd86aca56a7de22dfb05"
},
"downloads": -1,
"filename": "keepassxc_cli_integration-1.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e48df20d7f68eca2a73b27d7edc436cd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 9702,
"upload_time": "2025-07-27T14:03:08",
"upload_time_iso_8601": "2025-07-27T14:03:08.649688Z",
"url": "https://files.pythonhosted.org/packages/65/74/a67c3145ea3f5e46c94d05d8c31618e0a4c87a0710d9ae7f1baa267c0f0b/keepassxc_cli_integration-1.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8ccc3af33c5f06acf2bb049afce772915adc63ce9eb758f23291341775252323",
"md5": "bedf14b6a9d5107d8de50107b5326045",
"sha256": "b6d2e50759cca6d153e540b0944805e97f4147f6302f5020c90635ad72453c58"
},
"downloads": -1,
"filename": "keepassxc_cli_integration-1.1.2.tar.gz",
"has_sig": false,
"md5_digest": "bedf14b6a9d5107d8de50107b5326045",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 6541,
"upload_time": "2025-07-27T14:03:09",
"upload_time_iso_8601": "2025-07-27T14:03:09.795388Z",
"url": "https://files.pythonhosted.org/packages/8c/cc/3af33c5f06acf2bb049afce772915adc63ce9eb758f23291341775252323/keepassxc_cli_integration-1.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-27 14:03:09",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "keepassxc-cli-integration"
}
JSON