Quickstart

Create an account, open the workspace, and publish a static Cloud site or a Data project. Cloud cannot run a Node server.

1. Sign in and create a platform API key

Open https://xyvenra.com/login and continue with GitHub or Google. This step needs a browser and a human; an agent cannot complete signup on its own. Then open https://xyvenra.com/app/keys and create a platform API key. The plaintext secret is shown once. Prefix xyv_plat_.

2. Create a project

In the app, open Data, Cloud, Studio, or Mobile. You can also create them with the platform API after you have a key. Code stays in the browser.

curl -X POST https://xyvenra.com/api/platform/v1/projects \
  -H "Authorization: Bearer xyv_plat_..." \
  -H "Content-Type: application/json" \
  -d '{"product":"data","name":"Launch checklist"}'

3. Deploy static HTML to Cloud

Use a Cloud deploy key against /api/cloud/v1/{siteId}, or a platform key against /api/platform/v1/deploy. The CLI command is xyvenra deploy --site-id SITE_ID --file index.html.

curl -X POST https://xyvenra.com/api/platform/v1/deploy \
  -H "Authorization: Bearer xyv_plat_..." \
  -H "Content-Type: application/json" \
  -d '{"siteId":"SITE_ID","html":"<!doctype html><html><head><meta charset=\"utf-8\"><title>Hello</title></head><body><h1>Hello from Xyvenra Cloud</h1></body></html>"}'

The published URL is https://xyvenra.com/sites/YOUR_SLUG. Public env vars for that site are inserted into the HTML. Private values are not. There is no server runtime.

4. Optional: CLI and templates

Install the CLI with npm install -g xyvenra, or run npx xyvenra. After a human creates a key:

npx xyvenra login --api-key xyv_plat_...
npx xyvenra init static-site --dir mysite
npx xyvenra deploy --site-id SITE_ID --file mysite/index.html
npx xyvenra status
npx xyvenra guidance --product cloud --project-id SITE_ID

Use static-site for Cloud. The Next.js and API templates are for local development and Data; a Node server will not run on Cloud. XYVENRA_API_KEY, XYVENRA_API_URL, and XYVENRA_CONFIG_DIR configure the CLI. xyvenra env stores project env vars. Add --exposure public when a Cloud publish should copy that value into the page. xyvenra files uses the private Data file bucket. xyvenra eas dispatch forwards your Expo token once and does not store it. xyvenra guidance asks once about a next step and does not deploy, dispatch, or charge. Paid plans for Cloud, Data, Mobile, and Studio are still coming soon. The commands in this repository are ahead of the published xyvenra@0.1.1 npm package until that package is published again.