Skip to content

Commit

Permalink
docs: Tidy up KeepassXC reference documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
twpayne committed Apr 10, 2022
1 parent cd74d0c commit 462e547
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 14 deletions.
Expand Up @@ -3,3 +3,12 @@
The `keepassxc*` template functions return structured data retrieved from a
[KeePassXC](https://keepassxc.org/) database using the KeePassXC CLI
(`keepassxc-cli`)

The database is configured by setting `keepassxc.database` in the configuration
file. You will be prompted for the database password the first time
`keepassxc-cli` is run, and the password is cached, in plain text, in memory
until chezmoi terminates.

The command used can by changed by setting the `keepassxc.command`
configuration variable, and extra arguments can be added by setting
`keepassxc.args`.
@@ -1,14 +1,10 @@
# `keepassxc` *entry*

`keepassxc` returns structured data retrieved from a
[KeePassXC](https://keepassxc.org/) database using the KeePassXC CLI
(`keepassxc-cli`). The database is configured by setting `keepassxc.database`
in the configuration file. *database* and *entry* are passed to `keepassxc-cli
show`. You will be prompted for the database password the first time
`keepassxc-cli` is run, and the password is cached, in plain text, in memory
until chezmoi terminates. The output from `keepassxc-cli` is parsed into
key-value pairs and cached so calling `keepassxc` multiple times with the same
*entry* will only invoke `keepassxc-cli` once.
`keepassxc` returns structured data for *entry* using `keepassxc-cli`.

The output from `keepassxc-cli` is parsed into key-value pairs and cached so
calling `keepassxc` multiple times with the same *entry* will only invoke
`keepassxc-cli` once.

!!! example

Expand Down
@@ -1,8 +1,7 @@
# `keepassxcAttachment` *entry* *name*

`keepassxcAttachment` returns the attachment with *name* of *entry* using
`keepassxc-cli`. It behaves identically to the `keepassxc` function in terms of
configuration, password prompting, password storage, and result caching.
`keepassxc-cli`.

!!! example

Expand Down
@@ -1,9 +1,7 @@
# `keepassxcAttribute` *entry* *attribute*

`keepassxcAttribute` returns the attribute *attribute* of *entry* using
`keepassxc-cli`, with any leading or trailing whitespace removed. It behaves
identically to the `keepassxc` function in terms of configuration, password
prompting, password storage, and result caching.
`keepassxc-cli`, with any leading or trailing whitespace removed.

!!! example

Expand Down

0 comments on commit 462e547

Please sign in to comment.