@launchthatbot/convex-plugin
v0.1.1
Published
OpenClaw plugin package for deterministic Convex bootstrap and migration workflows.
Readme
@launchthatbot/convex-plugin
OpenClaw plugin for full Convex lifecycle, sync, and storage workflows.
This package is intentionally separate from @launchthatbot/convex-backend:
@launchthatbot/convex-backendremains the skill/instruction package.@launchthatbot/convex-pluginprovides lifecycle, provisioning, sync orchestration, storage profile controls, and migration diagnostics.
What this plugin includes
openclaw.plugin.jsonmanifest with plugin id and config schema.- TypeScript plugin entrypoint (
src/index.ts). - Typed plugin API via
openclaw/plugin-sdk. - Lifecycle + sync tool:
convex_connection_lifecycleconnect_beginconnect_statusconnect_disconnectprovision_runprovision_statushealth_checksync_backfill
- Tool:
convex_project_scan- structured scan withscan(env | logic | cron-memory | all) and optionalrootPath.
- Slash commands:
/convex-connect-begin [--scope project|team] [--server <id>]/convex-connect-status [--connection <id>]/convex-connect-disconnect [--connection <id>]/convex-provision-run [--connection <id>] [--server <id>]/convex-provision-status [--connection <id>]/convex-health-check [--connection <id>]/convex-sync-backfill [--connection <id>] [--domains memory,dailyLogs,agentState,events] [--window-days 30]/convex-migration-mode- report migration policy./convex-env-diff [rootPath]- compare local.env*keys vs Convex env keys (excludingCONVEX_DEPLOY_KEYandCONVEX_DEPLOYMENT)./convex-unmigrated-logic [rootPath]- find local logic candidates likely not yet migrated into Convex./convex-cron-memory-scan [rootPath]- scan cron-like code and memory/daily-log files that could move to Convex.
Install (OpenClaw)
openclaw plugins install @launchthatbot/convex-pluginThen enable/configure under plugins.entries.launchthatbot-convex in your OpenClaw config.
Config
openclaw.plugin.json supports:
launchthatbotApiBaseUrlworkspaceIdinstanceNamedeploymentMode:external | managedmanaged.serverIdconnection.connectionIdconnection.scope:project | teamsync.enabledDomains: subset ofmemory,dailyLogs,agentState,eventssync.batchSizesync.backfillWindowDayssync.maxRetryAttemptsstorage.profile:local-only | convex-managed | convex-r2-offloadstorage.r2.enabledstorage.r2.credentialReffeatures.enableLifecyclefeatures.enableBackfillfeatures.enableR2OffloaddefaultMigrationMode:"one-by-one"or"blanket"requireExplicitCleanupApproval:true|false
Development
pnpm --filter @launchthatbot/convex-plugin build
pnpm --filter @launchthatbot/convex-plugin testRollout plan
Use staged feature-flag rollout to reduce risk:
- Enable
features.enableLifecycleonly. - Enable
features.enableBackfilland validate sync state/receipts/backfill jobs. - Enable
features.enableR2Offloadwithstorage.profile=convex-r2-offloadon pilot tenants. - Monitor health via
convex-health-checkand keep migration scan commands active during rollout:/convex-env-diff/convex-unmigrated-logic/convex-cron-memory-scan
