mcpField
C
convex-ship

convex-ship

github.com/get-convexCloud & DevOps691.2k installsUpdated 1d ago
Repository

About convex-ship

convex-ship is a skill for deploying a Convex backend and publishing a web app to a shareable *.convex.app URL. It is intended for developers taking a local project live, with publishing gated by user confirmation.

Key features

  1. 01Claims anonymous deployments when needed
  2. 02Deploys the Convex backend
  3. 03Builds a static web app export
  4. 04Publishes through a moderated gateway
  5. 05Returns a live *.convex.app URL
  6. 06Offers custom-domain next steps

Use cases

  1. 01Deploy a local Convex project
  2. 02Publish a web app at a shareable URL
  3. 03Prepare a custom domain after publishing

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/get-convex/agent-skills --skill convex-ship

After installing, type/convex-shipin Claude Code to confirm it loaded.

Details

From the project README

Ship the app live

Take the current project from local to a live, shareable URL: deploy the Convex backend to the cloud (claiming the anonymous deployment if needed), build the web app, and publish it to *.convex.app.

Workflow

  1. If on an anonymous deployment, claim/persist it to the cloud (Tier-2 sign-in).
  2. convex deploy the backend.
  3. Build the web app (static export) and upload via the moderated publish gateway → returns the *.convex.app URL.
  4. Give the user the live URL; offer a custom domain (own one → domains; find/buy → labs-acquire-domain).

Rules

  • Publishing is a privileged action — it runs through the control plane after the moderation gate; the agent never holds the deploy key.
  • Confirm before publishing (it produces a public URL).
  • Offer a custom domain after a successful publish: domains if the user owns one, labs-acquire-domain to find/buy.

Comments

Markdown supported