Framework compatibility

New integrations should use Keys REST for resolve/catalog and @restormel/keys-elements for UI. Legacy npm adapters are deprecated — see npm → REST migration.

Compatibility at a glance

FrameworkRecommended pathStatus
Any (server)Keys REST + Gateway keySupported
Next.js / React / SvelteKit / Astro@restormel/keys-elementsSupported
Agents / IDE@restormel/mcp, @restormel/aaifSupported
Local tooling@restormel/keys-cli, @restormel/doctorSupported
Vue / NuxtKeys REST + Web ComponentsSupported via elements

Install paths

Resolve (no npm core):

ts
// Resolve via Keys REST (any language / framework)
const res = await fetch(
  `${process.env.RESTORMEL_KEYS_BASE}/keys/v1/projects/${projectId}/resolve`,
  {
    method: "POST",
    headers: {
      Authorization: `Bearer ${process.env.RESTORMEL_GATEWAY_KEY}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({ workload: "chat" }),
  },
);
const { data } = await res.json();

UI (Web Components — all frameworks):

bash
pnpm add @restormel/keys-elements
html
import "@restormel/keys-elements";

// In HTML or any framework template:
// <rk-key-manager user-id="u_123"></rk-key-manager>
// <rk-model-selector project-id="…"></rk-model-selector>

CLI + doctor:

bash
pnpm add -D @restormel/keys-cli

See also