On this page

Operations reference

Snapshot and ledger inspection

aii snapshot open -in <snapshot.tar.age> -out <new-directory> -key <snapshot.key>
aii verify -ledger <copy>/ledger.jsonl
aii verify -ledger <copy>/ledger.jsonl -cross <other-copy>/ledger.jsonl

snapshot open decrypts and writes a directory that must not exist, then checks snapshot SHA256SUMS. It does not activate a restored identity. Without -key, its key defaults to <dir>/data/snapshot.key; -dir defaults to the current directory. A checksum failure removes the unpacked output. Treat plaintext output as sensitive.

Sources: Snapshot CLI

verify checks the ledger's self-contained chain/signatures; it needs no configuration, network or running identity. This does not prove database recovery or factual truth. Repeatable -cross uses only ledgers you supply: exit 0 means verified and all citations matched; 1 means failure/mismatch; 3 means verified with citations uncheckable; flag-parse errors or a missing -ledger return 2.

Sources: Verify CLI

Escrow is a separate key operation

aii escrow create -out <new-escrow.age> -dir <identity-directory>
aii escrow check -in <escrow.age> -fingerprint <retained-fingerprint> -dir <identity-directory>
aii escrow restore -in <escrow.age> -ledger <verified-copy>/ledger.jsonl -dir <identity-directory>

An older escrow may contain only the signing key; the CLI includes a snapshot key only when present. Passphrases are typed at a terminal, not supplied as arguments or piped input. Creation refuses an existing output. Check/restore require exactly one identity reference: -ledger or -fingerprint. Check can write a coverage receipt on the matching host; it is not entirely write-free. Restore reinstates missing key files, not ledger/database data; conflicting existing keys are refused. It can report RESTORED IN PART, so preserve the exact output. Keep escrow and passphrase independently recoverable.

Sources: Escrow syntax and custody; Escrow receipt and partial restore

Logging inspection versus changes

aii log -dir <identity-directory> describes logging. Append details or groups to inspect available names/groups. Flags precede the subcommand. level, tap and clear change the runtime overlay, not the operator configuration; clearing restores configuration control, not necessarily logging-off. Raw taps require a separately considered capture decision.

Sources: Logging CLI; Tap and overlay commands

See backup/restore consequences and diagnostic handling before taking action.


Back to section overview · Documentation home