Skip to content

Command Cheatsheet

Alex Stoyanov edited this page Apr 17, 2026 · 8 revisions

Command Cheatsheet

This page is for copy/paste work. Use it when you already know which workflow you want.

Quick Commands

Task Command
Show global help ethernity --help
Show backup help ethernity backup --help
Show recover help ethernity recover --help
Show extend help ethernity extend --help
Show compact help ethernity compact --help
Show mint help ethernity mint --help
Create backup ethernity backup --input ./file.txt --output-dir ./backup-out --passphrase "example"
Recover from scans ethernity recover --scan ./backup-out --passphrase "example" --output ./restored.bin
Recover from fallback text ethernity recover --fallback-file ./recovery.txt --passphrase "example" --output ./restored.bin
Extend an unsealed root ethernity extend --root-dir ./backup-root --input-dir ./docs --base-dir ./docs --passphrase "example"
Compact a root into a fresh standalone backup ethernity compact --root-dir ./backup-root --output-dir ./backup-compacted --passphrase "example"
Mint new shard PDFs ethernity mint --scan ./backup-root --shard-threshold 2 --shard-count 3 --output-dir ./minted
Generate recovery kit QR PDF ethernity kit --output ./recovery_kit_qr.pdf
Open config ethernity config

Useful Notes

  • recover --output defaults to stdout only for single-file recovery.
  • Multi-file recovery requires --output to be a directory.
  • extend works on a writable unsealed backup root.
  • compact writes a new standalone backup. It does not rewrite the old one in place.

Supported Design Names

  • archive
  • forge
  • ledger
  • maritime
  • sentinel

If you are unsure, start with sentinel.

Related

Clone this wiki locally