roomie-kit-host
v0.1.4
Published
Managed deployment assistant CLI for Roomie Kit.
Maintainers
Readme
Roomie Kit Ops
Private Roomie Kit Cloud deployment tooling for Roomie Kit.
This repo is intentionally separate from the public MIT-licensed Roomie Kit starter. It contains the paid managed launch layer: guided onboarding, deployment checks, hosted asset defaults, health checks, and future update tooling.
Current MVP
The first product is a Node/TypeScript CLI named roomie-kit-host.
npm install
npm run build
npm run dev -- login
npm run dev -- onboardCustomer Flow
Customers can first print a guided checklist for every outside account value:
npx roomie-kit-host keysA paid customer should not need to clone Roomie Kit manually. The default onboarding flow logs in, clones the starter, asks for provider keys, deploys Supabase/Vercel, saves the Vercel URL, and runs health checks.
npx roomie-kit-host onboardQuickStart is the default:
- Roomie-managed asset CDN
- Vercel generated
*.vercel.appURL - full Roomie Kit preset
- app name and theme template prompt
- no custom domain
- safe deploy resume from
.roomie-host/deploy-state.local.json
Advanced mode asks for existing checkout, deployment preset, optional modules, local assets, Vercel scope, and custom domain metadata:
npx roomie-kit-host onboard --advancedScripted/CI-like setup uses --non-interactive and must pass all required values through flags or environment variables:
npx roomie-kit-host onboard my-roomie-app \
--non-interactive \
--token rk_live_... \
--supabase-url https://example.supabase.co \
--supabase-anon-key sb_publishable_... \
--supabase-project-ref example \
--supabase-access-token sbp_... \
--supabase-db-password ... \
--agora-app-id ... \
--agora-app-certificate ... \
--vercel-project-name my-roomie-app \
--vercel-token ...Commands
roomie-kit-host keys
roomie-kit-host onboard
roomie-kit-host customize
roomie-kit-host login
roomie-kit-host login --token <license-key>
roomie-kit-host whoami
roomie-kit-host logout
roomie-kit-host init [app-folder]
roomie-kit-host doctor
roomie-kit-host deploy --execute --resume
roomie-kit-host health
roomie-kit-host update
roomie-kit-host mcponboard is the white-glove path. init, doctor, deploy, and health remain lower-level commands for debugging, reconfiguration, and support.
Branding And Local Assets
Onboarding configures web/roomie.config.json and creates empty local override folders under web/public/roomie-local. Customers can rerun the customization step without redeploying from scratch:
roomie-kit-host customize
roomie-kit-host customize --brand-template stream-dark --app-name "Acme Live"
roomie-kit-host customize --advanced --brand-primary '#2563EB' --brand-secondary '#06B6D4' --brand-accent '#F97316'Supported templates are roomie-neon, stream-dark, startup-blue, creator-pink, and minimal-dark.
The CLI prints exact folders for logos, lobby cards, avatars, room models, furniture, and sounds. Files placed there win over the Roomie Kit Cloud CDN while missing files still fall back to VITE_ASSET_BASE_URL.
Where Customers Get Values
Roomie Kit Cloud login:
- Open https://roomiekit.io/login.
- Log in with the Stripe Checkout email.
- Run
roomie-kit-host loginand approve the browser activation code. - Fallback: open Need a manual license key? in the account dashboard and run
roomie-kit-host login --token <license-key>.
Supabase:
- Create/open a project at https://supabase.com/dashboard/projects.
- Project URL and publishable key: Project Connect dialog or Settings -> API Keys.
- Project ref: Settings -> General -> Reference ID, or the subdomain in https://.supabase.co.
- Access token: https://supabase.com/dashboard/account/tokens.
- Database password: Project database settings; reset it if unknown.
Agora:
- Open https://console.agora.io/projects.
- Create/open a secured token project.
- Copy the App ID and Primary App Certificate from Project Management/Config.
Vercel:
- Open https://vercel.com/dashboard.
- Create a personal access token at https://vercel.com/account/tokens.
- Pick a project name; Vercel can create/link it during deploy.
- Use a Vercel scope/team only when the project belongs to a team.
Local Files
The CLI stores local customer config and auth in .roomie-host/, which is ignored by git:
.roomie-host/config.local.json.roomie-host/env.local.roomie-host/auth.local.json.roomie-host/deploy-state.local.json
Customer Supabase, Vercel, and Agora secrets stay local and are never sent to the Roomie backend. Deploy logs and deploy state redact known secrets.
Codex And Claude Code Plugins
The first plugin wrappers live in plugins/ and both launch the same MCP server:
npx roomie-kit-host mcpThe MCP server currently exposes login, account status, bootstrap, customization, doctor, health, Hosted app reservations, and docs lookup tools. The plugin wrappers are intentionally thin so Codex and Claude Code share the same paid Roomie Kit Cloud entitlement checks and setup logic.
Managed Defaults
- Roomie Kit Cloud plan:
$19/month, no setup fee. - Roomie Kit Hosted beta:
$99/month, Roomie-owned hosted app subdomains reserved ashttps://<app-slug>.roomiekit.io. - Starter repo:
https://github.com/davidkc0/roomie-kit.git. - Asset CDN default:
https://pub-1ed033e5fb5c4bebbf86a4d0438002e8.r2.dev/for the MVP. Swap to a custom R2 domain before meaningful production scale. - Customer-owned infrastructure: Vercel, Supabase, Agora.
- Roomie-owned backend: Supabase Edge Functions for license auth, entitlements, presets, and release metadata.
- Public starter repo stays open source and separate.
Deploy Behavior
deploy --execute --resume currently performs:
- Write
web/.env.local. - Apply Supabase migrations with
supabase db push. - Set Supabase Edge Function secrets.
- Deploy core Supabase functions with
--use-api. - Link the Vercel project.
- Set Vercel production env vars.
- Deploy Vercel production.
- Parse and save the production URL as
ROOMIE_DEPLOYED_URL. - Print exact Supabase Auth redirect URLs to confirm.
Supabase Auth URL configuration is still a manual post-deploy confirmation until a reliable public API route is wired in.
Publishing
The npm package is public so customers can run npx roomie-kit-host, but Roomie Kit Cloud commands still require browser login or a manual fallback license key.
npm run check
npm publish --access public