---
title: "Nyxel Connect"
description: "The Shopify-facing provisioning and release control plane."
canonical_url: "https://nyxel.dev/docs/connect"
markdown_url: "https://nyxel.dev/docs/connect.md"
---

# Nyxel Connect
URL: /docs/connect
LLM index: /llms.txt
Description: The Shopify-facing provisioning and release control plane.

# Nyxel Connect

**Partial:** Nyxel Connect is the Shopify-facing host for projects, provider connections, revisions, and releases. It establishes the production ownership boundary without placing provider credentials or durable deployment work in the storefront or editor.

The repository contains a framework-neutral `@nyxel/connect` package and a standalone `apps/connect` SvelteKit host. The state machine, Shopify installation flow, Redis storage, scoped editor handoff, GitHub/Vercel clients, review deployment, and scheduled promotion routes are implemented and checked in the monorepo.

It is not a finished hosted service. Customer-owned GitHub App and Vercel authorization, webhook reconciliation, rollback, and a live merchant release still need end-to-end proof.

![Nyxel Connect showing provider readiness, merchant onboarding, and the release model.](/site-media/connect-control-plane.png)

## Four authorities

Connect coordinates four systems without pretending to replace them:

| Authority | Owns                                                                                 |
| --------- | ------------------------------------------------------------------------------------ |
| Shopify   | Installation identity, catalog, commerce data, and checkout                          |
| GitHub    | The customer-owned storefront repository and generated commits                       |
| Vercel    | Project configuration, Preview deployments, and production deployment artifacts      |
| Nyxel     | Project identity, document revisions, release state, and bounded editor capabilities |

A Nyxel Project stores stable provider resource IDs rather than relying on repository, team, or domain names that can change. Provider access tokens remain server-only.

## Editor handoff

Connect creates a single-use authorization code for one Project. The standalone editor exchanges it for an encrypted, short-lived capability, removes the code from the URL, and scopes subsequent document, Canvas, Preview, and Release requests to that Project.

The editor does not receive Shopify, GitHub, Vercel, or Redis credentials. Connect proxies the narrow operations it is allowed to perform and rejects requests for another Project.

## Release states

Saving documents is not publishing. Creating a Release captures an immutable Revision, writes that saved document set to a release branch, creates a Vercel Preview, and becomes ready only after the deployment is ready. A ready Release can be promoted immediately or scheduled.

The scheduled worker acts from the durable Release record rather than browser state. Closing the editor therefore cannot cancel a confirmed schedule. Failed provider operations stay attached to the Release instead of being represented as a vague Save error.

## Current limit

The implementation currently uses server-side bootstrap credentials for GitHub and Vercel. The intended customer-owned authorization model is still **Planned**, and the full flow has not been live-proven. The public Nyxel demo does not expose Review or Publish controls.

Bridge is optional. It will only be provisioned when a merchant needs an approved Shopify Liquid app-block surface; it is never the primary storefront.

## Sitemap

See the full [sitemap](/sitemap.md) for all pages.
Docs-scoped sitemap: [/docs/sitemap.md](/docs/sitemap.md).
Well-known sitemap: [/.well-known/sitemap.md](/.well-known/sitemap.md).