# OpenQuick

> Deploy a folder of static HTML, CSS, and JavaScript to a durable URL.

Status: private preview. Public discovery is open; deploy credentials are minted through browser-mediated agent connection.

## Start here
- [Agent entry point](https://open-quick-production.up.railway.app/agent.md): Read this first for the supported workflow and safety boundaries.
- [Join guide](https://open-quick-production.up.railway.app/join): Human-readable onboarding for agents and operators.
- [Agent skill](https://open-quick-production.up.railway.app/skill.md): Exact deploy workflow, constraints, and receipt contract.
- [Authentication](https://open-quick-production.up.railway.app/auth.md): Current credential model and safe handling rules.
- [OpenAPI](https://open-quick-production.up.railway.app/openapi.json): Machine-readable HTTP API.
- [Agent card](https://open-quick-production.up.railway.app/.well-known/agent.json): Machine-readable capability discovery.
- [MCP](https://open-quick-production.up.railway.app/mcp): Hosted Streamable HTTP MCP (`claude mcp add --transport http openquick https://open-quick-production.up.railway.app/mcp`).
- AI chat proxy: authenticated `POST https://open-quick-production.up.railway.app/api/v1/ai/chat` (see docs/AI.md). No provider keys in the browser.
- Site documents: authenticated `/api/v1/sites/{slug}/db/{collection}` + browser SDK `quick.db.collection` (see docs/DOCUMENTS.md). Namespace is path slug only.
- Private files: authenticated `/api/v1/sites/{slug}/files` + SDK `quick.files` (see docs/FILES.md). Path slug only; HMAC signed retrieve optional.
- Realtime: SSE `/api/v1/sites/{slug}/realtime` + channels; SDK `subscribe` / `quick.channel` (see docs/REALTIME.md). Single-process only.

## Public endpoints
- [Health](https://open-quick-production.up.railway.app/healthz)
- [Production revision](https://open-quick-production.up.railway.app/.well-known/openquick-release.json)
- [Sites API](https://open-quick-production.up.railway.app/api/v1/sites)
- [Live sites](https://open-quick-production.up.railway.app/#sites)

## Examples
- [Signal Room](https://open-quick-production.up.railway.app/sites/signal-room/): Interactive, zero-backend example.
- [Hello](https://open-quick-production.up.railway.app/sites/hello/): Minimal static example.

## Source
- [Repository](https://github.com/nicolaerusan/open-quick)
- [Example folders](https://github.com/nicolaerusan/open-quick/tree/main/examples)
- [Cold onboarding harness](https://github.com/nicolaerusan/open-quick/blob/main/docs/COLD_ONBOARDING.md): Space-repo scorecard + CI dry-run (`npm run harness:cold-onboarding -- --dry-run`)