Metadata-Version: 2.4
Name: awrecover
Version: 0.1.0
Summary: Labelled snapshots of a directory, with a restore that either fully lands or does not land at all — and a verify that proves restorability by restoring.
License: Apache-2.0
Project-URL: Homepage, https://github.com/Aitherium/awrecover
Project-URL: Repository, https://github.com/Aitherium/awrecover.git
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: awshare>=0.1.0
Requires-Dist: cryptography>=41
Provides-Extra: seal
Requires-Dist: awseal>=0.1.0; extra == "seal"
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == "dev"
Dynamic: license-file

# awrecover

<!-- aither-header:start GENERATED from the ecosystem registry. Edits here are overwritten; change the registry instead. -->

**[Docs](https://aitherium.github.io/awrecover/)**  ·  [Source](https://github.com/Aitherium/awrecover)  ·  `pip install awrecover`  ·  [The Aither World](https://aitherium.github.io/)

> **The Aither World** is an operating system for agents — a Linux you can hand to one, the runtimes it works in, and the tools it works with. [awnix](https://github.com/Aitherium/awnix) is the Linux underneath it; **awrecover** is one of its 33 bricks — each installs on its own, runs offline, and needs no account.
>
> **Start here:** Snapshot one directory, break it, restore it, diff it.

<!-- aither-header:end -->

Snapshot a directory, and get it back — with proof that you can.

```bash
pip install awrecover

awrecover snapshot ./run --store .snaps --label pre-finetune
awrecover verify   --store .snaps --label pre-finetune      # RESTORES it, to a scratch dir
awrecover restore  --store .snaps --label pre-finetune --dest ./run
```

Python 3.10+. `awrecover` needs [`awshare`](https://github.com/Aitherium/awshare),
which it installs with; add `pip install "awshare[seal]"` if you want snapshots
signed as well as digested.

## Deliberately thin

A snapshot **is** an awshare bundle. Archiving, digesting, atomic writes, path
containment, refusing symlinks and bounding expansion are all awshare's job and
are not reimplemented here. awrecover adds exactly two things awshare has no
opinion about:

- **a label index**, so you say `pre-finetune` instead of remembering a digest
- **a restore that fully lands or does not land at all**

If you want a bundle, use awshare. You want awrecover when you will be coming
back for it under a name, possibly in a hurry.

## Two rules it exists to enforce

### A backup nobody has restored is a hypothesis

`verify` does not check that the archive exists, or that it is a plausible size.
Those pass for a snapshot **of the wrong directory**, a truncated one, and one
taken of nothing at all. It restores into a scratch directory, through the same
code path a real restore uses, and throws the result away.

```bash
awrecover verify --store .snaps --label pre-finetune
# 0  restorable — this really came back
# 1  checked, and it is NOT restorable
# 2  could not check at all
```

Exit 1 and exit 2 stay separate for the reason they always must: collapsing them
turns *"I could not check this"* into *"it checked out"*.

There is a narrower version of the same trap inside `verify` itself. A label can
be present in the index while its manifest is gone — so the index says the
backup exists and the backup does not. That is reported as its own error, in
those words: **the index is a claim; the archive is the backup.**

### A half-restore is worse than no restore

It destroys the working state *and* fails to deliver the snapshot. So `restore`
never writes into the target:

```
1. unpack into a staging dir BESIDE dest      (a failure here changes nothing)
2. verify the staged tree
3. move dest aside     -> .awrecover-replaced-<label>-<pid>
4. rename staging      -> dest
```

The window where neither tree is in place is **one rename wide**. And the tree
it replaced is *moved aside, not deleted* — if the swap fails, your old state is
still there under a name you can find. Pass `--discard-replaced` when you are
sure and want the space back.

If anything fails before step 3, the error says `Nothing was changed`, and it is
telling the truth.

## Everything it does

| | |
|---|---|
| `awrecover snapshot DIR --store S --label L [--seal] [--key-path P]` | take one |
| `awrecover list --store S` | label, when, digest, file count |
| `awrecover verify --store S --label L [--key K]` | prove it restores |
| `awrecover restore --store S --label L --dest D [--key K] [--discard-replaced]` | put it back |
| `awrecover drop --store S --label L` | remove one — explicit, never implicit |
| `awrecover doctor` | what is installed, and whether the store answers |

```python
import awrecover
from pathlib import Path

awrecover.snapshot(Path("run"), Path(".snaps"), "pre-finetune")
awrecover.verify(Path(".snaps"), "pre-finetune")          # raises if it will not restore
r = awrecover.restore(Path(".snaps"), "pre-finetune", Path("run"))
r["replaced"]   # where your previous tree went

awrecover.latest(Path(".snaps"))        # the most recent Snapshot, or None
awrecover.list_snapshots(Path(".snaps"))
```

`--key` on `verify` and `restore` is passed through to awshare, so a snapshot
can be required to come from a **known publisher** and not merely to be intact.
Integrity and provenance are two questions; awshare answers the first and
[`awseal`](https://github.com/Aitherium/awseal) the second.

## Licence

Apache-2.0.

<!-- aither-ecosystem:start GENERATED from the ecosystem registry. Edits here are overwritten; change the registry instead. -->

## The aw family

Standalone tools that share one idea: **replace something you would otherwise have to _trust_ with something you can _check_.**

Each installs on its own, works offline, and needs no account.

| | instead of trusting | you check |
|---|---|---|
| [awdk](https://github.com/Aitherium/awdk) | a framework's idea of how your agents should run | one loop you can read, pointed at a backend you already pay for |
| [awskills](https://github.com/Aitherium/awskills) | that an agent knows your procedure | the procedure written down, versioned, and loadable by any agent |
| [awm](https://github.com/Aitherium/awm) | that memory stayed in its lane | tenant:user:project scopes, so a write cannot cross a boundary |
| [awnode](https://github.com/Aitherium/awnode) | a vendor's cloud with every prompt | a local gateway routing to backends you chose |
| [awgraph](https://github.com/Aitherium/awgraph) | that grep found everything | an AST + tree-sitter call graph an agent can traverse |
| [awgit](https://github.com/Aitherium/awgit) | that no one else is editing this file | a lease, refused at commit time if you do not hold it |
| [awseal](https://github.com/Aitherium/awseal) | that the artifact came from who you think | an Ed25519 seal — the key that verifies is not the key that forges |
| [awshare](https://github.com/Aitherium/awshare) | that the download is intact | content-addressed bundles, verified on fetch |
| [awnest](https://github.com/Aitherium/awnest) | that there is a person on the other end | a verdict with evidence, where "we could not tell" is not "yes" |
| [awnboard](https://github.com/Aitherium/awnboard) | a share link anyone who sees it can use | an invitation addressed to one person, for one gate, revocable |
| [awnix](https://github.com/Aitherium/awnix) | that the box is what you left it as | an immutable image you built, with atomic rollback |
| **awrecover** _(you are here)_ | that the restore worked | a restore that fully lands or does not land at all |
| [awkno](https://github.com/Aitherium/awkno) | that the docs site is up, or that you remember the family | the whole ecosystem in your terminal, with no network at all |
| [awrelay](https://github.com/Aitherium/awrelay) | a SaaS in the middle of your agents | findings, alerts and coordination over your own transport |
| [awmail](https://github.com/Aitherium/awmail) | a mailbox somebody else can read | mail your agents send and receive over your own server |
| [awfind](https://github.com/Aitherium/awfind) | one vendor's idea of the web | results from whichever providers you configured |
| [awbrowse](https://github.com/Aitherium/awbrowse) | that the page said what you were told | the render, the DOM and the requests it made |
| [aitherkvcache](https://github.com/Aitherium/aitherkvcache) | a vendor's quantisation defaults | sub-byte KV cache kernels you can benchmark yourself |
| [AitherZero](https://github.com/Aitherium/AitherZero) | a pile of scripts nobody has numbered | numbered, discoverable automation with declarative playbooks |
| [AitherConnect](https://github.com/Aitherium/AitherConnect) | what a page tells your browser to do | a federated search and desktop bridge you host |
| [awreason](https://github.com/Aitherium/awreason) | a confident paragraph | the phases it went through, and every tool call it made to get there |
| [awrecurse](https://github.com/Aitherium/awrecurse) | that everything you pasted in was actually read | which slices it opened, and what it concluded from each |
| [awprism](https://github.com/Aitherium/awprism) | the first explanation that fits | the ranked alternatives, and the observation that separates them |
| [awrepl](https://github.com/Aitherium/awrepl) | what the agent believes the value is | the value, printed from the live session |
| [awresearch](https://github.com/Aitherium/awresearch) | a summary of pages nobody opened | every claim against the source it came from |
| [awpredict](https://github.com/Aitherium/awpredict) | a model because it trained without erroring | its prediction against a self-updating lookup, on the rows that are actually novel |
| [awkno](https://github.com/Aitherium/awkno) | that the docs site is up, or that you remember the family | the whole ecosystem in your terminal, with no network at all |

[**awnix**](https://github.com/Aitherium/awnix) is the ground floor — A Linux you can hand to an agent — immutable base, capabilities included.

## The Aitherium ecosystem

Every repository here is public. Each publishes an `aither-manifest.json` beside its page, so any surface can read every sibling's — the network is browsable from any node in it.

| repo | what it is | pages |
|---|---|---|
| [awdk](https://github.com/Aitherium/awdk) | Build AI agent fleets — 3 lines, any backend, local or cloud | [docs](https://aitherium.github.io/awdk/) |
| [awskills](https://github.com/Aitherium/awskills) | Portable agent skills — self-contained procedures an agent loads on demand | [docs](https://aitherium.github.io/awskills/) |
| [awm](https://github.com/Aitherium/awm) | A portable, scoped agent memory | [docs](https://aitherium.github.io/awm/) |
| [awnode](https://github.com/Aitherium/awnode) | A lightweight local gateway — bridges your apps to the AI backends you chose | [docs](https://aitherium.github.io/awnode/) |
| [awrun](https://github.com/Aitherium/awrun) | A priority-aware queue and dispatcher for agentic runs and ad-hoc CI builds | [docs](https://aitherium.github.io/awrun/) |
| [awgraph](https://github.com/Aitherium/awgraph) | A semantic code graph for agents — AST + tree-sitter, call graphs | [docs](https://aitherium.github.io/awgraph/) |
| [awgit](https://github.com/Aitherium/awgit) | Semantic version control on top of git — edit-ops and leases | [docs](https://aitherium.github.io/awgit/) |
| [awseal](https://github.com/Aitherium/awseal) | Sign an artifact so a stranger can verify it | [docs](https://aitherium.github.io/awseal/) |
| [awshare](https://github.com/Aitherium/awshare) | Publish an artifact and fetch it back verified | [docs](https://aitherium.github.io/awshare/) |
| [awdit](https://github.com/Aitherium/awdit) | An append-only audit trail whose gaps are DETECTABLE | [docs](https://aitherium.github.io/awdit/) |
| [awbac](https://github.com/Aitherium/awbac) | Role-based access control that fails closed and explains itself | [docs](https://aitherium.github.io/awbac/) |
| [awiam](https://github.com/Aitherium/awiam) | Who is this caller? A directory and session store that fails honestly | [docs](https://aitherium.github.io/awiam/) |
| [awtunnel](https://github.com/Aitherium/awtunnel) | Reach a service that has no public address | [docs](https://aitherium.github.io/awtunnel/) |
| [awnest](https://github.com/Aitherium/awnest) | Prove there is a human before you let them into the nest | [docs](https://aitherium.github.io/awnest/) |
| [awnboard](https://github.com/Aitherium/awnboard) | A front gate you can put in front of anything, and hand someone the key to | [docs](https://aitherium.github.io/awnboard/) |
| [awnix](https://github.com/Aitherium/awnix) | A Linux you can hand to an agent — immutable base, capabilities included | [docs](https://aitherium.github.io/awnix/) |
| **awrecover** _(you are here)_ | Labelled snapshots with an all-or-nothing restore | [docs](https://aitherium.github.io/awrecover/) |
| [awkno](https://github.com/Aitherium/awkno) | The man page for the Aither World — every brick, stack and law, offline | [docs](https://aitherium.github.io/awkno/) |
| [awrelay](https://github.com/Aitherium/awrelay) | Portable agent messaging — findings, alerts, coordination | [docs](https://aitherium.github.io/awrelay/) |
| [awmail](https://github.com/Aitherium/awmail) | Give an agent an email address — send, and actually receive | [docs](https://aitherium.github.io/awmail/) |
| [awnet](https://github.com/Aitherium/awnet) | The agentic web — agents host a mesh, and agents join one | [docs](https://aitherium.github.io/awnet/) |
| [awfind](https://github.com/Aitherium/awfind) | A portable search client — query, results, ranking | [docs](https://aitherium.github.io/awfind/) |
| [awbrowse](https://github.com/Aitherium/awbrowse) | A portable browser client — navigate, console, network, DOM, screenshot | [docs](https://aitherium.github.io/awbrowse/) |
| [awknowledge](https://github.com/Aitherium/awknowledge) | How to run a coding agent so the result survives — the laws, with evidence | [docs](https://aitherium.github.io/awknowledge/) |
| [aitherkvcache](https://github.com/Aitherium/aitherkvcache) | Near-optimal KV cache quantization for LLM inference — sub-byte compression | [docs](https://aitherium.github.io/aitherkvcache/) |
| [AitherZero](https://github.com/Aitherium/AitherZero) | PowerShell 7+ automation framework — numbered, self-describing scripts | [docs](https://aitherium.github.io/AitherZero/) |
| [AitherConnect](https://github.com/Aitherium/AitherConnect) | Browser extension — federated AI search, page context, and the Living OS overlay | [docs](https://aitherium.github.io/AitherConnect/) |
| [awreason](https://github.com/Aitherium/awreason) | A portable reasoning client — sessions, phases, thoughts, and the chain that produced the answer | [docs](https://aitherium.github.io/awreason/) |
| [awrecurse](https://github.com/Aitherium/awrecurse) | Answer a question over a context far larger than the window — recursively, with the trace kept | [docs](https://aitherium.github.io/awrecurse/) |
| [awprism](https://github.com/Aitherium/awprism) | Turn a failure into ranked hypotheses — and say what would confirm each one | [docs](https://aitherium.github.io/awprism/) |
| [awrepl](https://github.com/Aitherium/awrepl) | A REPL an agent can actually use — state that survives between turns | [docs](https://aitherium.github.io/awrepl/) |
| [awresearch](https://github.com/Aitherium/awresearch) | Ask a research question, get a cited report you can check | [docs](https://aitherium.github.io/awresearch/) |
| [awpredict](https://github.com/Aitherium/awpredict) | Predict what your environment does next, and how surprised you were | [docs](https://aitherium.github.io/awpredict/) |
| [awkno](https://github.com/Aitherium/awkno) | The man page for the Aither World — every brick, stack and law, offline | [docs](https://aitherium.github.io/awkno/) |

<div id="aither-constellation" data-self="awrecover"></div>
<script src="aither-constellation.js"></script>

<!-- aither-ecosystem:end -->
