keepassxc-cli 0.1.0__tar.gz

keepassxc_cli-0.1.0/.github/workflows/auto-merge-dependabot.yml

@@ -0,0 +1,32 @@
+name: Auto Merge Dependabot
+on:
+  pull_request:
+    types:
+      - opened
+    branches:
+      - main
+
+permissions:
+  pull-requests: write
+  contents: write
+
+jobs:
+  auto-merge:
+    name: Auto Merge Dependabot PR
+    runs-on: ubuntu-24.04
+    if: github.actor == 'dependabot[bot]'
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/create-github-app-token@v3
+        id: generate-token
+        with:
+          app-id: ${{ secrets.APP_ID_MERGE }}
+          private-key: ${{ secrets.APP_PRIVATE_KEY_MERGE }}
+      - name: Enable Pull Request Automerge
+        run: gh pr merge --squash --auto "${{ github.event.pull_request.number }}"
+        env:
+          GH_TOKEN: ${{ steps.generate-token.outputs.token }}
+      - name: Auto approve
+        run: gh pr review --approve "${{ github.event.pull_request.number }}"
+        env:
+          GH_TOKEN: ${{ steps.generate-token.outputs.token }}

keepassxc_cli-0.1.0/.github/workflows/auto-release.yml

@@ -0,0 +1,41 @@
+name: Auto Release
+on:
+  pull_request:
+    types:
+      - closed
+
+permissions:
+  contents: read
+
+jobs:
+  auto-release:
+    if: github.event.pull_request.merged == true && github.event.pull_request.user.login == 'dependabot[bot]' && contains(github.event.pull_request.labels.*.name, 'pip')
+
+    name: Auto Release
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+      - name: Get Version
+        id: get-version
+        run: |
+          LATEST_TAG=$(curl -s "https://api.github.com/repos/${GITHUB_REPOSITORY}/releases/latest" | jq -r '.name')
+          # Strip leading 'v' if present
+          VERSION="${LATEST_TAG#v}"
+          # Parse semver components
+          IFS='.' read -r MAJOR MINOR PATCH <<< "$VERSION"
+          # Bump minor, reset patch
+          MINOR=$((MINOR + 1))
+          PATCH=0
+          echo "version=v${MAJOR}.${MINOR}.${PATCH}" >> $GITHUB_OUTPUT
+      - uses: actions/create-github-app-token@v3
+        id: generate-token
+        with:
+          app-id: ${{ secrets.APP_ID_MERGE }}
+          private-key: ${{ secrets.APP_PRIVATE_KEY_MERGE }}
+      - name: Create Release
+        run: gh release create ${{ steps.get-version.outputs.version }} --generate-notes
+        env:
+          GH_TOKEN: ${{ steps.generate-token.outputs.token }}

keepassxc_cli-0.1.0/.github/workflows/lint_and_test.yml

@@ -0,0 +1,59 @@
+name: Python Lint and Test
+
+on:
+  pull_request:
+    branches:
+      - main
+    paths-ignore:
+      - "**.md"
+  push:
+    branches:
+      - main
+    paths-ignore:
+      - "**.md"
+
+permissions:
+  contents: read
+
+jobs:
+  Test:
+    runs-on: ubuntu-24.04
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+      fail-fast: false
+
+    steps:
+      - uses: actions/checkout@v6
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install ruff
+          pip install -e ".[dev]"
+      - name: Test with pytest
+        run: |
+          pytest --cov=keepassxc_cli --cov-report=term-missing
+      - name: Lint with ruff
+        env:
+          PY_VER: ${{ matrix.python-version }}
+        run: |
+          PY_VER=$(echo py${PY_VER} | tr -d '.')
+          ruff check --output-format=github --ignore=E501 --exclude=__init__.py --target-version=${PY_VER} ./keepassxc_cli
+
+  Check-Test:
+    if: ${{ always() }}
+    runs-on: ubuntu-24.04
+    needs:
+      - Test
+    steps:
+      - run: |
+          result="${{ needs.Test.result }}"
+          if [[ $result == "success" || $result == "skipped" ]]; then
+            exit 0
+          else
+            exit 1
+          fi

keepassxc_cli-0.1.0/.github/workflows/pypi.yml

@@ -0,0 +1,79 @@
+name: Build & Upload Python Package
+
+on:
+  release:
+    types:
+      - published
+
+permissions:
+  contents: read
+
+jobs:
+  Setup:
+    runs-on: ubuntu-24.04
+    outputs:
+      version: ${{ steps.set-version.outputs.version }}
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v6
+      with:
+        fetch-depth: 0
+    - name: Get Version
+      id: set-version
+      env:
+        VERSION: ${{ github.ref_name }}
+      run: |
+        if grep -c -E '^v[[:digit:]]{1,3}\.[[:digit:]]{1,3}\.[[:digit:]]{1,3}$' <<< ${VERSION}; then
+          VERSION=$(sed 's/^.\{1\}//g' <<< ${VERSION})
+        else
+          echo "This branch shouldn't be build: ${VERSION}"
+          exit 1
+        fi
+        echo "version=$(echo ${VERSION})" >> $GITHUB_OUTPUT
+
+  Deploy:
+    runs-on: ubuntu-24.04
+    needs: Setup
+    environment:
+      name: pypi
+      url: https://pypi.org/p/keepassxc-cli/
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+    - uses: actions/checkout@v6
+      with:
+        fetch-depth: 0
+    - name: Set up Python
+      uses: actions/setup-python@v6
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+    - name: Build package
+      env:
+        SETUPTOOLS_SCM_PRETEND_VERSION: ${{ needs.Setup.outputs.version }}
+      run: python -m build
+    - name: Publish package
+      uses: pypa/gh-action-pypi-publish@v1.14.0
+
+  Notify-Homebrew:
+    runs-on: ubuntu-24.04
+    needs: [Setup, Deploy]
+    steps:
+      - uses: actions/create-github-app-token@v3
+        id: generate-token
+        with:
+          app-id: ${{ secrets.APP_ID_MERGE }}
+          private-key: ${{ secrets.APP_PRIVATE_KEY_MERGE }}
+          owner: ${{ github.repository_owner }}
+          repositories: homebrew-tap
+      - name: Trigger Homebrew formula update
+        env:
+          GH_TOKEN: ${{ steps.generate-token.outputs.token }}
+        run: |
+          gh api repos/${{ github.repository_owner }}/homebrew-tap/dispatches \
+            -f event_type=update-keepassxc-cli \
+            -f "client_payload[version]=${{ needs.Setup.outputs.version }}"

keepassxc_cli-0.1.0/.gitignore

@@ -0,0 +1,207 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

keepassxc_cli-0.1.0/CLAUDE.md

@@ -0,0 +1,116 @@
+# CLAUDE.md — keepassxc-cli
+
+This document provides context for AI assistants working on this project.
+
+## Project Purpose
+
+`keepassxc-cli` is a Python command-line tool that communicates with a running KeePassXC instance using the KeePassXC Browser Extension protocol (native messaging over a Unix socket). It enables terminal users to interact with KeePassXC — listing, searching, adding, editing, and deleting entries — while leveraging KeePassXC's biometric (TouchID/fingerprint) unlock support.
+
+## Package Structure
+
+```
+keepassxc_cli/
+├── __init__.py          # empty (just from __future__ import annotations)
+├── __main__.py          # CLI entry point; argument parsing; dispatches to commands
+├── config.py            # CliConfig dataclass; save/load ~/.keepassxc/cli.json
+├── output.py            # Output formatting: table, json, tsv
+└── commands/
+    ├── __init__.py      # empty
+    ├── setup.py         # associate with KeePassXC
+    ├── status.py        # show connection/association status
+    ├── show.py          # show entries by URL
+    ├── search.py        # search all entries
+    ├── ls.py            # list entries or groups
+    ├── add.py           # add new entry
+    ├── edit.py          # edit existing entry by UUID
+    ├── rm.py            # delete entry by UUID
+    ├── totp.py          # get TOTP code
+    ├── clip.py          # copy field to clipboard
+    ├── generate.py      # generate password
+    ├── lock.py          # lock database
+    └── mkdir.py         # create group
+
+tests/
+├── conftest.py          # fixtures: mock_entry, mock_group, mock_browser_config, mock_client
+├── test_config.py       # CliConfig unit tests
+├── test_output.py       # output formatting tests
+└── test_commands.py     # command run() function tests with mocked BrowserClient
+```
+
+## Dependency: keepassxc-browser-api
+
+This package depends on `keepassxc-browser-api` (local package at `../mietzen-keepassxc-browser-api/`), which provides:
+
+- `BrowserClient` — the main client that communicates with KeePassXC
+- `BrowserConfig` — configuration dataclass (associations, keys)
+- `Entry`, `Group` — data models
+- Exceptions: `KeePassXCError`, `AssociationError`, `NotAssociatedError`, `DatabaseLockedError`, `ProtocolError`, `ConnectionError`
+
+Import path: `from keepassxc_browser_api import BrowserClient, BrowserConfig, Entry, Group`
+
+## Command Module Convention
+
+Every command module (`keepassxc_cli/commands/*.py`) must implement:
+
+```python
+def add_parser(subparsers) -> None:
+    p = subparsers.add_parser("name", help="...")
+    # add arguments
+    p.set_defaults(func=run)
+
+def run(client, args, cli_config, browser_config, browser_config_path, *, fmt="table") -> int:
+    # returns 0 on success, non-zero on failure
+    ...
+```
+
+The `run()` function signature is always:
+```python
+def run(
+    client: BrowserClient,
+    args: argparse.Namespace,
+    cli_config: CliConfig,
+    browser_config: BrowserConfig,
+    browser_config_path: Path,
+    *,
+    fmt: str = "table",
+) -> int:
+```
+
+## How to Build, Test, and Lint
+
+```bash
+# Create venv and install
+python3 -m venv .venv
+source .venv/bin/activate
+pip install ../mietzen-keepassxc-browser-api/   # local dependency
+pip install -e ".[dev]"
+
+# Run tests
+pytest --tb=short -q
+pytest --cov=keepassxc_cli --cov-report=term-missing
+
+# Lint
+ruff check --ignore=E501 --exclude=__init__.py ./keepassxc_cli
+```
+
+## Key Conventions
+
+- **`from __future__ import annotations`** must be the first line of every `.py` source file.
+- **Ruff**: `ruff check --ignore=E501 --exclude=__init__.py ./keepassxc_cli`
+- **No async code**: Everything is synchronous. No threads in the CLI.
+- **Output**: Use `print()` for normal output, `sys.stderr` for errors.
+- **Exit codes**: `run()` functions return `int` (0 = success, 1 = failure).
+- **Config permissions**: Config files are written with `0o600` (owner read/write only).
+- **Venv**: Always use `.venv` for development.
+- **Python ≥ 3.10** required.
+
+## Config Files
+
+| File | Purpose |
+|------|---------|
+| `~/.keepassxc/cli.json` | CLI preferences (default format, custom browser-api config path). Only non-default values stored. |
+| `~/.keepassxc/browser-api.json` | Shared with keepassxc-browser-api. Contains association keys. Written by `setup` command. |
+
+## Output Formats
+
+Three formats are supported everywhere: `table` (default), `json`, `tsv`. The `--format` global flag or `default_format` in `cli.json` controls the default.

keepassxc_cli-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Nils
+
+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.