Observer/Help/Getting started
Kquick switch[email protected]
HELP · GETTING STARTED

Zero to live help in five steps

~30 minutes once you have an Anthropic API key and a willing staging host app.

  1. 01Confirm the runtime is healthy

    Open the dashboard. All four service-status dots should be green. If one is red, that service is down — check pm2 logs observer-<svc>.

    pm2 list | grep observer-
  2. 02Verify your host apps are registered

    The portfolio screen lists every app the Observer can be deployed to. The seed script registered six (Elyxen, LBR Compliance, Luxadvisory, ConsultaWatch, CogniVAT, AI Governance) at observerEnabled: false. Adjust their domain, jurisdictions, and language from the profile editor.

    pnpm --filter @help-layer/registry-api seed
  3. 03Load your knowledge base

    The sample KB ships three AML/KYC concepts (UBO threshold, PEP screening, source of funds) at status: draft. They are loadable but invisible to live resolution until a domain expert promotes them.

    Author your own under knowledge-base/concepts/<domain>/<concept>.yaml, validate, then load.

    pnpm --filter @help-layer/knowledge-api kb:validate knowledge-base
    pnpm --filter @help-layer/knowledge-api kb:load knowledge-base v0.1.0
  4. 04Exercise the pipeline from the Inspector

    The Inspector builds a synthetic HelpContext and runs it through the Knowledge Engine and Content Generator live. The output JSON shows what an actual user would see.

    Try toggling Rage click or Validation errors and re-running — you'll see the correctionGuidance component activate.

  5. 05Deploy Observer + Injector to a real host app

    Two script tags in the host app's <head>:

    <script src="https://observer.hexalab.dev/observer.iife.js"
            data-app-id="elyxen"
            data-registry-url="https://observer.hexalab.dev"
            async></script>
    <script src="https://observer.hexalab.dev/injector.iife.js"
            data-injector-auto
            async></script>

    Then flip observerEnabled to true on the app's profile. Telemetry will start showing up on the Health screen within minutes.

    Full walkthrough including CSP, identity probes, and rollback in the integration guide.