# AGENTS.md — Build guide for 1Password

## Project scope
Wrap the installed keepassxc-cli to select an existing vault, search entries, request password generation and create encrypted backup copies. Use interactive password input, never command-line password arguments; restore only to a new path.

Catalogue verdict: kinda. A basic encrypted vault is buildable, but browser autofill, mobile apps, passkeys, sharing, recovery, audits, and trust make this a dangerous thing to replace casually.
Use the implementation prompt below to define the deliverable. Complete each phase's acceptance checks before extending the scope.

## Working agreement
- Inspect the repository and its existing instructions before choosing paths, dependencies or commands. Keep one coherent stack and explain changes to the proposed architecture.
- Plan a vertical slice that accepts a real input and produces the useful output described below. Persist only the state the prompt calls for; respect memory-only and upstream-managed workflows. Use fixtures only when they are clearly labelled.
- After scaffolding, document the actual install, development, check and build commands in README and keep them synchronized with the package or project manifest. Do not report commands as successful unless they ran.
- Work in small steps. At handoff, list implemented flows, checks actually performed, remaining blockers, and any credentials or provider setup the owner must supply.
- Do not publish, spend money, contact customers, delete source data or run irreversible migrations without the project owner's authorization.

## Prerequisites
- Python, an installed KeePassXC/keepassxc-cli, an existing test KDBX vault, its owner-controlled unlock method and a separate encrypted backup destination. No web server, browser extension, KDF implementation or model API is required.
- Implementation components: Python standard library CLI with subprocess argument arrays and interactive terminal input. Installed KeePassXC and its documented keepassxc-cli; the existing encrypted KDBX file is the source of truth.
- Scope boundary: Passkeys, browser autofill, account recovery and shared vault administration are not implemented.

## Stack and architecture
- Python standard library CLI with subprocess argument arrays and interactive terminal input.
- Installed KeePassXC and its documented keepassxc-cli; the existing encrypted KDBX file is the source of truth.
- Domain model: vault configuration, encrypted KDBX paths, operation receipts and backup manifests; KeePassXC owns encryption and unlock

## Security and data integrity
- Prompt for unlock interactively without shell interpolation, argv secrets or plaintext exports. Redact output by default, protect config/backup permissions and leave encryption to KeePassXC.
- Correctness boundary: No custom cryptography, plaintext vault cache or automated cloud merge; never overwrite the sole vault copy.
- Preflight the installed CLI version and show its documented command help. Check exit status, never persist the unlock password and make backups using a consistent closed/safely copied vault file.
- Store only the selected vault path in configuration. Keep dated encrypted KDBX copies and restore to a new path; prove it opens in KeePassXC before replacing anything.

## Agent implementation rules
- Project rule — data model: vault configuration, encrypted KDBX paths, operation receipts and backup manifests; KeePassXC owns encryption and unlock
- Project rule — preserve this invariant: No custom cryptography, plaintext vault cache or automated cloud merge; never overwrite the sole vault copy.
- Project rule — acceptance evidence: An incorrect password leaves the vault hash unchanged; a backup opens through KeePassXC at a new path, and cancelling unlock produces no plaintext output.

## Optional agent skills and references
- Optional external skill: [modern-python](https://github.com/trailofbits/skills/blob/main/plugins/modern-python/skills/modern-python/SKILL.md) — Set up Python projects with pyproject.toml, dependency management, linting, typing and automated checks. Review its instructions and compatibility before use; it does not grant deployment, data-access or publication permission.
- Optional external skill: [sharp-edges](https://github.com/trailofbits/skills/blob/main/plugins/sharp-edges/skills/sharp-edges/SKILL.md) — Review security-sensitive APIs and configuration for dangerous defaults and easy-to-misuse interfaces. Review its instructions and compatibility before use; it does not grant deployment, data-access or publication permission.

Read the linked SKILL.md and its dependencies before adding a skill. Select only the skills matching this project's runtime and task; their documentation does not supply API access, credentials or approval to perform external actions. Pin the reviewed revision where the tool supports it. Follow the chosen agent's documented project-level installation mechanism.

## Distribution ideas
These are optional planning notes. Obtain the owner's approval before publishing or contacting anyone.
- Demonstrate the actual 1Password-inspired workflow with owned or clearly labeled sample data: Wrap the installed keepassxc-cli to select an existing vault, search entries, request password generation and create encrypted backup copies. Use interactive password input, never command-line password arguments; restore only to a new path.
- Publish a reproducible walkthrough with this observable result: An incorrect password leaves the vault hash unchanged; a backup opens through KeePassXC at a new path, and cancelling unlock produces no plaintext output.
- Explain who can operate this scoped tool, its setup and ongoing costs, and these remaining product gaps: Passkeys, browser autofill, account recovery and shared vault administration are not implemented. Avoid guaranteed savings, performance scores or implied endorsement.

## Engineering roadmap
1. Phase 1 — Scope and fixtures. Implement this bounded workflow: Wrap the installed keepassxc-cli to select an existing vault, search entries, request password generation and create encrypted backup copies. Use interactive password input, never command-line password arguments; restore only to a new path. Record prerequisites, select representative user-owned fixtures and document the unsupported features: Passkeys, browser autofill, account recovery and shared vault administration are not implemented.
2. Phase 2 — Persist companion configuration only. Save the selected vault path and backup receipts in a small versioned config/manifest. KeePassXC exclusively owns the KDBX schema, migrations, encryption and unlock; do not inspect or migrate the vault internals. Preflight supported keepassxc-cli commands and permissions with synthetic credentials.
3. Phase 3 — Complete the first useful path. Implement the workflow's input, review and output interface, with clear controls and explicit empty/error states. Preflight the installed CLI version and show its documented command help. Check exit status, never persist the unlock password and make backups using a consistent closed/safely copied vault file.
4. Phase 4 — Permissions and integration failure. Prompt for unlock interactively without shell interpolation, argv secrets or plaintext exports. Redact output by default, protect config/backup permissions and leave encryption to KeePassXC. Request integration credentials and permissions only for the enabled feature; show a disconnected state instead of mock results.
5. Phase 5 — Portable handoff. Store only the selected vault path in configuration. Keep dated encrypted KDBX copies and restore to a new path; prove it opens in KeePassXC before replacing anything. Include setup, operating limits, fixture walkthrough and shutdown/restart instructions in the README.
6. Phase 6 — Acceptance scenarios. An incorrect password leaves the vault hash unchanged; a backup opens through KeePassXC at a new path, and cancelling unlock produces no plaintext output. Repeat the workflow after restart and with a denied permission or unavailable dependency; show recoverable failure rather than a success placeholder.

## Paid-product capabilities outside this build
- browser/mobile autofill
- passkey support
- secure sharing
- recovery
- audits
- watchtower alerts
- family/team management

## Implementation prompt
WORKING SLICE
Wrap the installed keepassxc-cli to select an existing vault, search entries, request password generation and create encrypted backup copies. Use interactive password input, never command-line password arguments; restore only to a new path.

Build this scoped 1Password-inspired workflow with a documented data model and visible failure states.

Architecture
- Python standard library CLI with subprocess argument arrays and interactive terminal input.
- Installed KeePassXC and its documented keepassxc-cli; the existing encrypted KDBX file is the source of truth.

Prerequisites and limits
Python, an installed KeePassXC/keepassxc-cli, an existing test KDBX vault, its owner-controlled unlock method and a separate encrypted backup destination. No web server, browser extension, KDF implementation or model API is required.
Outside this release: Passkeys, browser autofill, account recovery and shared vault administration are not implemented.

Data model and correctness
vault configuration, encrypted KDBX paths, operation receipts and backup manifests; KeePassXC owns encryption and unlock
Invariant: No custom cryptography, plaintext vault cache or automated cloud merge; never overwrite the sole vault copy.
Preflight the installed CLI version and show its documented command help. Check exit status, never persist the unlock password and make backups using a consistent closed/safely copied vault file.

Security and privacy
Prompt for unlock interactively without shell interpolation, argv secrets or plaintext exports. Redact output by default, protect config/backup permissions and leave encryption to KeePassXC.

Recovery and export
Store only the selected vault path in configuration. Keep dated encrypted KDBX copies and restore to a new path; prove it opens in KeePassXC before replacing anything.

Implementation order
1. Phase 1 — Scope and fixtures. Implement this bounded workflow: Wrap the installed keepassxc-cli to select an existing vault, search entries, request password generation and create encrypted backup copies. Use interactive password input, never command-line password arguments; restore only to a new path. Record prerequisites, select representative user-owned fixtures and document the unsupported features: Passkeys, browser autofill, account recovery and shared vault administration are not implemented.
2. Phase 2 — Persist companion configuration only. Save the selected vault path and backup receipts in a small versioned config/manifest. KeePassXC exclusively owns the KDBX schema, migrations, encryption and unlock; do not inspect or migrate the vault internals. Preflight supported keepassxc-cli commands and permissions with synthetic credentials.
3. Phase 3 — Complete the first useful path. Implement the workflow's input, review and output interface, with clear controls and explicit empty/error states. Preflight the installed CLI version and show its documented command help. Check exit status, never persist the unlock password and make backups using a consistent closed/safely copied vault file.
4. Phase 4 — Permissions and integration failure. Prompt for unlock interactively without shell interpolation, argv secrets or plaintext exports. Redact output by default, protect config/backup permissions and leave encryption to KeePassXC. Request integration credentials and permissions only for the enabled feature; show a disconnected state instead of mock results.
5. Phase 5 — Portable handoff. Store only the selected vault path in configuration. Keep dated encrypted KDBX copies and restore to a new path; prove it opens in KeePassXC before replacing anything. Include setup, operating limits, fixture walkthrough and shutdown/restart instructions in the README.
6. Phase 6 — Acceptance scenarios. An incorrect password leaves the vault hash unchanged; a backup opens through KeePassXC at a new path, and cancelling unlock produces no plaintext output. Repeat the workflow after restart and with a denied permission or unavailable dependency; show recoverable failure rather than a success placeholder.

Acceptance
An incorrect password leaves the vault hash unchanged; a backup opens through KeePassXC at a new path, and cancelling unlock produces no plaintext output.
Use real source data or clearly labeled fixtures. Explain unsupported input and provider failures; do not fabricate analytics, delivery receipts, accuracy claims or security guarantees.

Optional agent guidance
Optional external skill: [modern-python](https://github.com/trailofbits/skills/blob/main/plugins/modern-python/skills/modern-python/SKILL.md) — Set up Python projects with pyproject.toml, dependency management, linting, typing and automated checks. Review its instructions and compatibility before use; it does not grant deployment, data-access or publication permission.
Optional external skill: [sharp-edges](https://github.com/trailofbits/skills/blob/main/plugins/sharp-edges/skills/sharp-edges/SKILL.md) — Review security-sensitive APIs and configuration for dangerous defaults and easy-to-misuse interfaces. Review its instructions and compatibility before use; it does not grant deployment, data-access or publication permission.
Project rule — data model: vault configuration, encrypted KDBX paths, operation receipts and backup manifests; KeePassXC owns encryption and unlock
Project rule — preserve this invariant: No custom cryptography, plaintext vault cache or automated cloud merge; never overwrite the sole vault copy.
Project rule — acceptance evidence: An incorrect password leaves the vault hash unchanged; a backup opens through KeePassXC at a new path, and cancelling unlock produces no plaintext output.

## Completion evidence
Demonstrate the prompt's acceptance scenarios against the scoped workflow. Include setup from a clean checkout and failure recovery. Check persistence across restart and export/restore only for the state the prompt says to store; for memory-only tools, confirm that temporary content is discarded as specified. Record actual results and remaining limitations. A detailed plan alone does not establish a working replacement.