Skip to content
AOZUMIDocs

Deploy button

Add a Deploy to AOZUMI button to a README. A click opens AOZUMI with that repository filled in, ready to review and deploy.

Add the button

Paste this into your README and replace owner/name with your GitHub repository.

README.md
[![Deploy to AOZUMI](https://aozumi.dev/button.svg)](https://aozumi.dev/deploy?repo=owner/name)

It renders like this:

Deploy to AOZUMI

What a click does

  1. Someone who is signed out signs in with GitHub and comes back to the same link.
  2. AOZUMI opens its import with your repository filled in.
  3. They review what AOZUMI detected and the plan, then deploy. The app is created in their workspace.

Questions

Does clicking the button deploy anything?
No. The button opens AOZUMI with the repository filled in. The person who clicked signs in, reviews what AOZUMI detected and chooses to deploy.
Whose workspace does the app go to?
The workspace of the person who clicked. The repository's owner sees nothing and pays nothing.
Does the button work for private repositories?
Only for people who can already reach the repository through an approved GitHub connection. For everyone else, use a public repository.

Checked against the product on .