Skip to main content
This page is for project maintainers who want to make their template or example one-click deployable. If you’re trying to deploy your own code to Reminix, see Deploy from GitHub instead.
A Deploy to Reminix button is a clickable link in your README that takes visitors to the Reminix deploy page with your repository pre-filled. Same pattern as Vercel’s “Deploy with Vercel” or Netlify’s “Deploy to Netlify” buttons — a markdown link wrapping a badge image.

​
What it looks like

Deploy to Reminix Click it to see the Reminix deploy page with the repo pre-filled. That’s all the button does — it’s a deep link, not magic.

​
Add it to your README

Copy this snippet into your README.md. Replace OWNER/REPO with your GitHub repository: 
[![Deploy to Reminix](https://reminix.com/badge/deploy.svg)](https://reminix.com/new/deploy?repo=OWNER/REPO)
The pattern is a standard markdown link [label](url) wrapped around a markdown image ![alt](src):
  • https://reminix.com/badge/deploy.svg — the badge image, served by Reminix
  • https://reminix.com/new/deploy?repo=... — the deploy URL, with your repo as a query parameter
When a visitor clicks the button, they land on the Reminix new-project flow with your repo pre-selected. They sign in (if needed), name their project, set any required secrets, and deploy.

​
URL parameters

The https://reminix.com/new/deploy URL accepts three query parameters:
ParamDefaultDescription
repo(required)GitHub repository in owner/repo format
branchmainBranch to clone from
folder(repo root)Subfolder within the repo to use as the project source

​
A complete example

Here’s the button for an example that lives in a monorepo subfolder on a non-default branch: 
[![Deploy to Reminix](https://reminix.com/badge/deploy.svg)](https://reminix.com/new/deploy?repo=acme/my-agents&branch=main&folder=examples/customer-support)
Drop that snippet into your README and any visitor can deploy your examples/customer-support agent in about thirty seconds.

​
Tips for template authors

  • Pin a stable branch (main is fine for most). Don’t point at a feature branch the button might outlive.
  • Use the folder parameter if your repo contains multiple deployable projects. Otherwise the deploy will use the repo root.
  • Document required secrets in your README alongside the button. The deploy flow asks for them, but it’s friendlier to tell visitors what they’ll need before they click.
  • Test the button yourself. Click it from a logged-out browser to see exactly what your visitors see.

​
Next steps

Deploy from GitHub

The end-user perspective: connect a repo, push to deploy, manage secrets.

Configuration & Secrets

Document the env vars your template needs alongside the button in your README.