SnapsOS

SnapsOS is the command-line interface of SnapsVault. It automates the snapshot workflow: discovery, verification, download, unpacking, and application using the standardized metadata defined by the Framework and the catalogs displayed in the Marketplace.

Why It Matters

Manual snapshot hunting and ad-hoc scripts are error-prone and time-consuming. SnapsOS eliminates guesswork by providing a fast, repeatable, and verifiable way to bootstrap or recover nodes across supported networks with integrity checks built in by default.

This enables operators and teams to standardize provisioning, reduce setup time, and safely automate node deployment across multiple networks and environments.

Key Features

• Snapshot Discovery: Find snapshots by chain_id, type (archival, pruned), and optional height or date.

• Integrity Verification: SHA-256 checks run by default and abort on mismatches to prevent corrupted or tampered data from being applied.

• Automated Extraction: Download and unpack archives directly into your target node --home directory with proper structure.

• Headless Automation: Run in CI/CD, systemd, or cron jobs with clear exit codes and structured logs for monitoring and alerting.

• Marketplace Alignment: Uses the same backend feeds shown in the UI, ensuring consistency between manual and automated workflows.

Safety & Reliability

• Integrity checks are enabled by default and abort on hash mismatches.
• Basic preflight validation checks permissions, available disk space, and pruning compatibility.
• Non-root usage is recommended; explicit flags are required for any destructive operations.

Compatibility

• Operating Systems: Linux and macOS (production deployments focus on Linux).
• Supported Chains: Works with all networks listed in Coverage, as long as snapshots follow the Framework schema.

Quickstart

For installation steps, command examples, available flags, and detailed workflows, see the Install & Use SnapsOS CLI guide. This page covers everything from basic usage to advanced automation patterns and best practices.

Best Practices

• Always verify snapshot hashes before applying to production nodes.
• Run SnapsOS as a non-root user in production environments.
• Use automation tools like systemd or cron for scheduled updates and fleet provisioning.
• Keep the CLI binary updated to benefit from the latest features and security fixes.

---

For any improvement, feature request, or contribution, see the Contributing page.