# deedar
<p align="center">
<img src="docs/logo/icon.svg" width="120" height="120" alt="deedar: a receipt pinned through a gold seal">
</p>
deedar stores the product of one unit of work as a deed: the bytes by
hash, who produced them, and the deeds they were made from. Each deed
is appended to a Merkle log. A reader who kept a head can show the deed
was in that log. A tracker or a pack cites the accession. The bytes
stay in the store.
Docs: https://leidarljos.github.io/deedar/
## Why
The next unit of work opens the product by accession. A better take is
a new deed that `--supersedes` the old one. `current` prints the tip;
over several ids it says which citations moved. The log is RFC 9162
hashing (doi:10.17487/RFC9162): inclusion receipts travel with an
export, `log bridge` proves a log grew from a head you kept, and
`log audit` finds a deed that was logged and is gone.
## Guides
| [Installation](https://leidarljos.github.io/deedar/install.html) | Linux, macOS, and Windows |
| [Getting started](https://leidarljos.github.io/deedar/getting-started.html) | Freeze a file, prove it, supersede it |
| [How-to](https://leidarljos.github.io/deedar/howto.html) | Export, check, hand a receipt |
| [Concepts](https://leidarljos.github.io/deedar/concepts.html) | Bytes, deed, log, bag, citation |
| [Explanation](https://leidarljos.github.io/deedar/explanation.html) | What a signature covers, and what the log adds |
| [Reference](https://leidarljos.github.io/deedar/reference.html) | Kinds, accessions, the log |
| [API reference](https://leidarljos.github.io/deedar/api.html) | `deed` and `deedar`, generated from rustdoc |
| [Changelog](https://leidarljos.github.io/deedar/changelog.html) | What each version changed |
The seat that cites a deed is documented at https://leidarljos.github.io.
## Install
```console
$ cargo binstall deedar-cli
$ export DEEDAR_URL=file://$HOME/.local/share/deedar/store
```
`deedar-mcp` is the read-only MCP surface. There is no daemon: each command
opens the store. The first `create` makes it. A read does not: until then,
`deedar list` prints one line saying there is no store yet and how to make one.
Release archives, crates.io, and a checkout install are
on the installation page, including `DEEDAR_HOST_SIGNING_KEY`.
## First minute
The block is a fresh store with signing off, recorded with the clock
stopped. Run it yourself and the time and the root will differ; the other
lines will not.
```console
$ export DEEDAR_URL=file:///tmp/deeds
$ export DEEDAR_HOST_SIGNING_KEY=off
$ echo 'fn main() {}' > note.rs
$ deedar create file --name "the parser patch" --path note.rs --agent you
id=deed-file-the-parser-patch kind=file name=the parser patch
paths=sha256:536e506bb90914c243a12b397b9a998f85ae2cbd9ba02dfd03a9e155ca5ca0f4
sources=
producedBy=you -
grants=
face=document
file=sha256:536e506bb90914c243a12b397b9a998f85ae2cbd9ba02dfd03a9e155ca5ca0f4
accession=deed-file-the-parser-patch
$ deedar evidence deed-file-the-parser-patch
id=deed-file-the-parser-patch ok
producedBy=you -
time=1700000000
$ deedar export --into bag/data/deeds deed-file-the-parser-patch
exported 1 deeds, 4 files
$ deedar check bag
1 deeds proven against a log of 1 entries, root b1799b9f22404b3626b3c43e80f26232922113b997a1e3377bc803ff799f4ee8
the head is unsigned, so every proof above is against a head this bag asserted about itself
```
## What holds
- A deed stays as written. A better take is a new deed that `--supersedes`
the old one. `current` prints the tip; over several ids it says which
citations moved.
- `evidence`, `current` and `export` take one id, several, or `-` from a
pipe, and exit non-zero on any failure.
- A configured host key signs heads, sidecars and satchel manifests. With signing off, nothing is signed. A receiver lists accepted keys in its store's `layout`.
`deedar host accept` adds this host's own key there, except in a store
whose layout says `attestation = required`.
- The default host key is one file per user account, so a signature names an
account on one machine. Seats and agents under that account share it, and
`--agent` is what the caller says. See the explanation page for keeping
the key out of an agent's reach.
- Bytes and deeds are content addressed. Log appends take a file lock, so
two processes minting at once write whole lines.
## Kinds
`file`, `set`, `quote`, `patch`, `mailDraft`, `clip`, `page`, `form`,
`table`, `procedure`, `event`. The reference page lists each kind's flags.
## License
MIT.