# AOZUMI

> Ideas, deployed. Aozumi is a deploy and hosting service for small web apps, in beta. It turns a GitHub repository or a folder on your machine into a running app behind a gateway that applies the link access you choose: anyone with the link, your workspace team, or only people you invite. You can deploy from the web console, the `aozumi` CLI, or an AI agent over MCP.

Key facts:

- GitHub deploys: sign in with GitHub, approve repositories in the Aozumi GitHub App, and Aozumi inspects the repository. The launch plan shows the framework, required environment variable names and a security review (clear, review or blocked). Findings that need review must be accepted by a person; blocked repositories cannot be imported. Importing and deploying are separate steps.
- CLI: `npm i -g @aozumi/aozumi`, then `aozumi login` (browser approval) and `aozumi deploy <site>`. It publishes an existing dist, build, out or public folder, offers to run the build script, or (from 0.1.5) publishes a plain HTML folder without --dir, web files only. It uploads build output only, never the repository. `--public`, `--team` or `--private` sets link access; a new site asks once in a terminal and defaults to private. `AOZUMI_TOKEN` supplies a key in CI.
- Agents: MCP endpoint `https://aozumi.dev/mcp` (HTTP JSON-RPC). Authenticate with an agent key from Profile → Agents, sent as `X-API-Key` (or `Authorization: Bearer`). Tools: check, import, secrets, deploy, status, logs, share. Keys created by `aozumi login` are refused at `/mcp`.
- Stacks: every stack has a live test app deployed through the real pipeline. Rated Good: static HTML, React/Vite, Next.js static export (served as files, edge-cached when public) and Next.js server. Rated OK, proven: Node.js/Express, Remix, FastAPI, Flask and Go (containers that sleep when idle; Python installs and Go compiles on first boot). Django: OK with gunicorn, weak without.
- Also available: custom domains with automatic HTTPS, encrypted write-only environment variables per environment, opt-in pull request previews (same-repository only, no Production secrets), rollback to an earlier healthy release, sleep modes (Eco, Balanced, Responsive, Stay warm), build and runtime logs, health history, and managed Postgres with backups and point-in-time restore.
- Beta limits apply per workspace, including the number of apps and deployments per 24 hours.

## Docs

- [Overview](https://aozumi.dev/docs): what Aozumi does and the three ways to deploy
- [Deploy from GitHub](https://aozumi.dev/docs/getting-started): sign in, pick a repo, review the plan, deploy, share
- [Deploy with the CLI](https://aozumi.dev/docs/cli): install, login, deploy, flags, CI
- [Supported stacks](https://aozumi.dev/docs/stacks): what runs today and how well proven it is
- [Link access and sharing](https://aozumi.dev/docs/access): public, team or private; share links; invitations
- [Custom domains](https://aozumi.dev/docs/domains): DNS records and automatic HTTPS
- [Environment variables](https://aozumi.dev/docs/environment-variables): encrypted, write-only values per environment
- [Managed Postgres](https://aozumi.dev/docs/postgres): DATABASE_URL, backups, point-in-time restore
- [Pull request previews](https://aozumi.dev/docs/previews): opt-in private previews
- [Releases and rollback](https://aozumi.dev/docs/rollback): roll back to an earlier healthy release
- [Sleep when idle](https://aozumi.dev/docs/sleep): Eco, Balanced, Responsive, Stay warm
- [Logs and health](https://aozumi.dev/docs/logs-and-health): status, logs, diagnoses, health history
- [Limits and quotas](https://aozumi.dev/docs/limits): beta limits
- [Connect an AI agent (MCP)](https://aozumi.dev/docs/mcp): endpoint, agent keys, tools, safety model

## Agents

- [Aozumi for AI agents](https://aozumi.dev/agentic): how an agent goes from check to share, and where it must stop for a person

## Optional

- [Changelog](https://aozumi.dev/changelogs)
- [Privacy](https://aozumi.dev/privacy)
- [Terms](https://aozumi.dev/terms)