Deploy Button

The Deploy Button lets anyone deploy your open-source web app to their own Clawnify workspace in a single click. Drop a badge into your README, and visitors who click it land on a pre-filled Clawnify deploy form with your repo’s details loaded from a clawnify.json manifest.

Add the badge

Paste this into your README.md:

[![Deploy with Clawnify](https://clawnify.com/button.svg)](https://app.clawnify.com/deploy?repo=OWNER/NAME)

Replace OWNER/NAME with your GitHub repo path.

The clawnify.json manifest

At the root of your repository, add a clawnify.json:

{
  "name": "Example Todo",
  "description": "A simple todo app to demonstrate Clawnify deploys",
  "framework": "vite-preact",
  "env": [
    {
      "key": "EXAMPLE_API_KEY",
      "description": "API key for the example service",
      "required": true
    }
  ]
}

The deploy form reads this manifest to show the user what your app is, what environment variables they’ll need to provide, and which build framework to use.

What happens on click

  1. Visitor clicks your badge → lands on app.clawnify.com/deploy?repo=OWNER/NAME
  2. Clawnify fetches clawnify.json from your repo’s default branch
  3. If they’re already logged in: the agent receives “deploy this repo” as its first message and starts the build
  4. If they’re not logged in: onboarding → provision → the deploy kicks off as the first task

Supported frameworks

  • vite-preact — SPA scaffold with a typed backend + managed database (recommended)
  • vanilla — Static HTML/CSS/JS, no build step

If you’d like another framework supported, get in touch from clawnify.com.