Skip to content

agile-4/opem

v0.2.0MIT

Install, configure and embed the Opem Help widget from your editor: the script tag and npm packages, Content-Security-Policy, allowed origins, identity signing, documentation sync, webhooks and every error code.

customise

Use when the developer wants to change the Help widget from code: the Opem.init options (theme, position, launcher, trigger, strings, context), opening the panel from their own button with Opem.open, request kinds, a title or an error pinned to a request, reportError, page context with Opem.context, the unread badge, or the open, close, navigate, request:sent, request:replied and ask:answered events.

identify

Use when the developer wants Opem to know who the signed-in user is: Opem.identify, HMAC signing, the verification secret (vs_), roles and signedAt, the errors identity_required, identity_signature_required or identity_signature_invalid, or a signing sample in Node.js, Python, Ruby, PHP or Go.

install

Use when adding the Opem Help widget to a website or web app: the script tag, the @opem/browser or @opem/react packages, Next.js, Remix, SvelteKit, Vite, Rails, Django or plain HTML, the Content-Security-Policy sources the widget needs, allowed origins, a widget that does not appear, or the error origin_not_allowed. Can check an install against the live /config endpoint.

knowledge-sync

Use when the developer wants Opem's assistant to answer from documentation kept in their repository: Markdoc or Markdown documents, front matter, access tags for roles, syncDocuments from @opem/node, PUT /api/v1/manage/knowledge/documents, a GitHub Actions workflow that syncs on every merge, or plan_limit_reached on a sync.

onboard

Use when the developer has no Opem account or project yet, asks how to start with Opem, or holds a key (pk_, sk_, vs_) with no idea where it goes. Walks through signing up at support.opem.app, creating a project, and finding the publishable key, the allowed origins and the verification secret on the Configuration page.

reference

Background knowledge about Opem for the other skills: every management API operation, the widget's public surface, the plans and their limits, rate limits and a glossary of Opem's terms. Read it when another skill does not cover a call or a limit.

troubleshoot

Use when something is wrong with an Opem install: the widget does not load or appear, a console line starting [Opem], a 401, 403 or 429 from the API, origin_not_allowed, identity_signature_invalid, plan_limit_reached, rate_limited, a Content-Security-Policy error, or a documentation sync that was refused.

webhooks

Use when the developer wants their server told when a request is raised, replied to or closed, or when the assistant answers: Opem webhooks, verifyWebhook from @opem/node, the Opem-Signature header, the whsec_ secret, redelivery, or testing a webhook handler locally.