getonup 0.1.0

package/README.md

@@ -0,0 +1,148 @@
+<div align="center">
+
+# ✨ getonup
+
+**Your AI artifact, live in seconds.**
+
+Turn any AI-generated web artifact — an HTML file, a React/Vue component, or a built static
+folder — into a **live, shareable URL** with one command. Open-source, self-hosted, scale-to-zero.
+
+```bash
+getonup deploy counter.tsx
+✓ live → https://getonup.example.com/s/iwcmg3dt
+```
+
+[![License: MIT](https://img.shields.io/badge/license-MIT-22d3ee)](./LICENSE)
+&nbsp;·&nbsp; one Worker + R2 &nbsp;·&nbsp; scale-to-zero &nbsp;·&nbsp; agent-native
+
+<br/>
+
+<img src="docs/landings/midnight.png" alt="getonup landing page" width="760" />
+
+</div>
+
+---
+
+## Why
+
+AI assistants generate gorgeous little apps — but they're trapped in a chat window. getonup
+publishes them to a real URL from the command line, on infrastructure you own:
+
+- **One command** — `getonup deploy app.tsx` prints a live URL. No build step, no boilerplate.
+- **Agent-native** — drop a snippet in `AGENTS.md` and any coding agent can publish its own work.
+- **Auto-wrap** — hand it a bare `.tsx`/`.vue`/`.js` and it becomes a self-contained, runnable
+  page (React 18 + Babel + Tailwind, Vue 3). HTML files and static folders are served as-is.
+- **Self-hosted & scale-to-zero** — one Cloudflare Worker + an R2 bucket, ~$0 when idle. MIT.
+
+---
+
+## Run it locally (no Cloudflare account)
+
+`npm run dev` runs the whole server on your machine via Wrangler's local
+[miniflare](https://developers.cloudflare.com/workers/testing/miniflare/) storage — **no Cloudflare
+account, no login, no bucket.** The fastest way to try it:
+
+```bash
+git clone https://github.com/YOUR_USERNAME/getonup.git && cd getonup
+npm install
+npm run setup        # builds + links the getonup CLI, writes a local deploy token, prints the next step
+npm run dev          # serves at http://localhost:8787  (Ctrl-C to stop)
+```
+
+`npm run setup` prints a ready-to-run `getonup login` line with your generated token. In a second
+terminal:
+
+```bash
+getonup login --url http://localhost:8787 --token <token-from-setup>
+getonup deploy examples/counter.tsx        # auto-wrapped React → http://localhost:8787/s/<id>
+getonup serve  examples/counter.tsx        # …or just preview it — no server, no token
+```
+
+Ready for a public URL? See **[Self-hosting on Cloudflare »](docs/SELF-HOSTING.md)**.
+
+---
+
+## Using the CLI
+
+```bash
+getonup deploy index.html              # a full HTML file → served as-is
+getonup deploy counter.tsx --open      # a React component → auto-wrapped & opened in your browser
+getonup deploy card.vue                # a Vue SFC → auto-wrapped
+cat art.html | getonup deploy -        # pipe from stdin
+getonup deploy ./dist                  # a built static site (folder with index.html)
+
+getonup list                           # everything you've published
+getonup rm <id>                        # take one down
+getonup serve app.tsx --watch          # local preview with live-reload (no deploy, no token)
+```
+
+`deploy` prints the live URL as the last stdout line — `--json` for structured output, `--quiet`
+for just the URL. Full command + flag reference: **[docs/CLI.md](docs/CLI.md)**.
+
+### What you can deploy
+
+| You give it | getonup does |
+|---|---|
+| `.html` (full document) | serves it verbatim |
+| `.html` (fragment) | wraps it in a minimal styled page |
+| `.jsx` / `.tsx` | React 18 + Babel + esm.sh import map + Tailwind; mounts your default export |
+| `.vue` | Vue 3 + `vue3-sfc-loader` |
+| `.js` / `.ts` | a module shell, transpiled, with an esm.sh import map for bare imports |
+| a directory | uploads the folder as a static site (must contain `index.html`) |
+
+`import`s for npm packages (`lucide-react`, `recharts`, …) resolve at runtime via
+[esm.sh](https://esm.sh) — no bundler. `--no-wrap` hosts raw source, `--type` overrides detection,
+`--no-tailwind` skips the Tailwind CDN.
+
+> **Static & client-side only.** Wrapped pages load their dependencies from CDNs at runtime; there's
+> no server-side code (that's what keeps it scale-to-zero). Details + air-gapped notes in
+> [Self-hosting › Limitations](docs/SELF-HOSTING.md#limitations).
+
+---
+
+## Give it to your agent
+
+The point of getonup: your coding agent publishes its own work. Add this to your project's
+`AGENTS.md` (or `CLAUDE.md`, `.cursorrules`, …):
+
+```markdown
+## Publishing artifacts
+To share a web artifact (HTML page, React/Vue component, or built static site) as a live URL,
+run: `getonup deploy <file-or-dir>` and give the user the printed URL.
+- Single components are auto-wrapped (React/Vue/Tailwind) — just point at the .tsx/.vue/.html.
+- Use `--json` to parse the result.
+```
+
+A ready-to-copy block is in [`AGENTS.md`](./AGENTS.md), and there's a Claude Code skill in
+[`skills/getonup`](./skills/getonup).
+
+**…or as an MCP server:** `getonup mcp` exposes `deploy_artifact`, `list_deploys`, and `remove_deploy`
+over stdio to any MCP-aware agent:
+
+```json
+{ "mcpServers": { "getonup": { "command": "getonup", "args": ["mcp"],
+  "env": { "GETONUP_URL": "https://your-getonup.example", "GETONUP_TOKEN": "your-token" } } } }
+```
+
+---
+
+## The `getonup` command
+
+`getonup` is the CLI. Config lives in `~/.config/getonup/config.json`, or pass `GETONUP_URL` /
+`GETONUP_TOKEN` env vars (handy for CI and agents). From the repo without installing:
+`npm run getonup -- <args>`.
+
+---
+
+## More
+
+- **[Self-hosting on Cloudflare »](docs/SELF-HOSTING.md)** — deploy to a public URL; configure,
+  secure, and harden your instance; plus hosting alternatives (GitHub Pages, Datasette Apps).
+- **[CLI reference »](docs/CLI.md)** — every command and flag.
+- **[Architecture & design »](PLAN.md)** — how the CLI and Worker fit together.
+- **[Landing designs »](LANDINGS.md)** — fifteen demo landing pages, all deployed through getonup.
+- **[Contributing »](CONTRIBUTING.md)** — dev setup and project layout.
+
+## License
+
+[MIT](./LICENSE) — getonup contributors.