convex-backup

Configures Convex snapshot backups and verifies recovery through restore drills into preview deployments.

9.4k|1.5k|Updated Jan 3, 2026
One-click install
npx skills add https://github.com/openclaw/clawhub --skill convex-backup
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: convex-backup
Source: https://github.com/openclaw/clawhub/tree/main/.agents/skills/convex-backup
Command: npx skills add https://github.com/openclaw/clawhub --skill convex-backup

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Teams often take database backups but never test whether those backups can actually be restored, discovering failures only during a real disaster. This Skill sets up scheduled Convex snapshot exports and runs a restore drill that recovers data into a throwaway preview deployment and asserts the data came back intact.

Core Features & Use Cases

  • Snapshot Export: Takes portable backup artifacts with npx convex export, including file storage when needed, and recommends a schedule matched to your RPO with a retention window.
  • Restore Drill: Restores the snapshot into a throwaway preview deployment created with npx convex deploy --preview-create, then asserts recovery by checking row counts and sampling real records via MCP queries.
  • Recovery Runbook: Produces a gated restore-to-production runbook (npx convex import backup.zip --replace --prod) with the post-snapshot write-loss caveat stated.
  • Use Case: Before a major launch, run a restore drill on last night's export to confirm your critical tables recover with expected row counts, then schedule daily exports to durable storage you control.

Quick Start

Set up scheduled Convex backups for my app and run a restore drill to prove the latest snapshot actually recovers into a preview deployment.

Frequently Asked Questions about convex-backup

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I back up a Convex database?

Run npx convex export --path backup-<date>.zip to create a portable snapshot artifact, adding --include-file-storage if your app stores files. Schedule it via CI or cron at a cadence matched to your RPO, and store copies in durable storage you control.

How do I test that a Convex backup can be restored?

Create a throwaway preview deployment with npx convex deploy --preview-create, then restore with npx convex import backup.zip --deployment <preview-name> --replace. Verify recovery by checking critical-table row counts and sampling real records against the source.

Does the restore drill require a paid Convex plan?

Preview deployments require a Preview Deploy Key set as CONVEX_DEPLOY_KEY, which is a paid-tier feature. If unavailable, the drill can run against a fresh personal dev deployment instead.

Why does a restore succeed but show zero rows?

An import can complete without errors yet land zero rows, which counts as a failed drill. Always assert recovery by comparing critical-table row counts and a sample of real records against the source deployment.

Is it safe to restore a backup into production?

Restores into production use npx convex import backup.zip --replace --prod and are gated by deploy-guard. Writes made after the snapshot was taken are lost, so the drill targets a throwaway preview, never production.