Home

Ethernity Wiki

Welcome to the Ethernity operator and contributor guide.

Ethernity is a CLI for creating encrypted, printable recovery artifacts (QR documents, fallback text, and optional shard documents) for offline-capable recovery workflows.

This wiki is for practical usage guidance, runbooks, and troubleshooting. The format specification and normative rules remain in the repository docs.

Start Here (Recommended)

If you are new to Ethernity:

1. Read Getting Started
2. Create a test backup using Backup Workflow
3. Perform a full recovery drill using Recovery Workflow
4. If needed, use the browser Recovery Kit (lean vs scanner variants)

Choose Your Path

I want to use Ethernity (operators)

• Getting Started - first-run workflow and what artifacts to expect
• Backup Workflow - backup runbooks and operator checklists
• Recovery Workflow - recovery runbooks, input modes, and recovery order
• Recovery Kit - offline browser recovery helper (lean/scanner variants)
• Troubleshooting - common problems and quick fixes

I want command/reference help

• Command Cheatsheet - common commands, flags, and config examples
• Release Artifacts - release archive verification and provenance checks
• FAQ - common questions

I want to compare designs/templates

• Template Gallery - preview images and design notes

Safety and Operations Notes

• Treat recovery as an operational process, not just a command invocation.
• Run recovery drills before relying on any artifact set.
• Keep independent backups; do not rely on a single recovery path.
• Use the recovery kit offline whenever possible.

Source-of-Truth References (In Repo)

These remain canonical and versioned with the codebase:

• Format spec
• Format notes
• Release artifacts anchor
• Security policy

Contributing / Project Docs

• README
• CONTRIBUTING
• AGENTS.md