Skip to content
Docs

AOZUMI documentation

Ideas, deployed. Aozumi turns a GitHub repository or a folder on your machine into a running web app with a link you control. Pick the way in that fits how you work.

Three ways to deploy

Quick start

The fastest path for a static site or single-page app that already builds on your machine:

Terminal
npm i -g @aozumi/aozumi
aozumi login
# in your project folder
aozumi deploy my-site

The CLI prints the site URL when the upload is verified. Read the CLI guide for flags, link access and CI use.

What happens on a deploy

  1. InspectionFor GitHub imports, Aozumi reads the repository and reports the framework, required environment variable names and a security review.
  2. PlanYou see what will run and anything still missing, such as secrets. Findings that need a decision wait for you.
  3. ReleaseAozumi builds or receives the artifact and starts a new release. The current release keeps serving until the new one is ready.
  4. LinkThe app is served behind Aozumi's gateway, which applies the link access you chose before a request reaches your app.

All guides

Building with agents? See how agents work with Aozumi, from the first check to the share link.

Questions

What is Aozumi?
Aozumi is a deploy and hosting service for small web apps. It inspects a GitHub repository, shows a launch plan with any safety findings and missing settings, deploys the app, and gives you a link whose audience you choose: anyone, your workspace, or people you invite. Aozumi is in beta.
How do I deploy a static site with Aozumi?
Install the CLI with npm i -g @aozumi/aozumi, run aozumi login and approve the request in your browser, then run aozumi deploy my-site in the project folder. The CLI publishes an existing dist, build, out or public folder, offers to run your build script if there is none, or, from version 0.1.5, publishes a plain HTML folder without --dir, web files only.
Can an AI agent deploy to Aozumi?
Yes. Aozumi has an MCP endpoint at https://aozumi.dev/mcp. Create an agent key under Profile → Agents, choose its access level, and send it as the X-API-Key header. The agent can check, import, set secrets, deploy, read status and logs, and create a share link. The same keys drive the REST API from CI (see /docs/rest-api). It cannot import a repository with a blocking finding, and findings that need review pause until someone accepts them.
Is my link public?
It depends on what you chose, and you can change it later. When you import from GitHub in the console, you pick a first audience; "Anyone with the link" is preselected, so change it before importing if the app is not for everyone. New CLI sites are private unless you pick team or public when asked, or pass --public or --team. Apps imported by an agent default to your workspace team. Only Production can be public.

Checked against the product on .