@conscience-technology/nora-relay

Wire the Nora Relay in-app bug reporter into your site — create a project and drop in the widget, from one command.

Nora Relay lets a site's own users report a problem by pointing at it — the broken button, not a paragraph describing it. Each report becomes a fix a maintenance agent drafts as a pull request, which a human approves before it ships. This CLI is how you set the reporter up.

Install

Nothing to install — run it with npx:

npx @conscience-technology/nora-relay <command>

Or add it globally: npm i -g @conscience-technology/nora-relay, then relay ….

Quickstart

# 1. Save your workspace + API key (once)
npx @conscience-technology/nora-relay login

# 2. In your site's repo: create a project and drop the widget in
npx @conscience-technology/nora-relay init

init creates the project, detects your framework (Next.js, Vite, plain HTML), and inserts the one-line widget in the right file. Reports start flowing to your Relay console immediately.

Commands

| Command | What it does | |---|---| | relay login | Save your workspace slug + org API key to ~/.nora/relay.json | | relay init | Create a project, detect the framework, and place the widget | | relay projects | List the projects in your workspace | | relay snippet <projectKey> | Print the embed snippet | | relay install <projectKey> | Place the widget in the current project |

Customising the widget

The reporter should fit the site it lives on. init, snippet, and install all take:

| Flag | Effect | |---|---| | --accent <css-color> | Recolour the button and panel, e.g. --accent "#0075de" | | --position <corner> | bottom-right (default) · bottom-left · top-right · top-left | | --offset-x <px> / --offset-y <px> | Nudge it away from its edges | | --lang <code> | Force the reporter language, e.g. ko, en |

# A blue reporter in the bottom-left, nudged up 24px, in Korean
npx @conscience-technology/nora-relay snippet pk_live_… \
  --accent "#0075de" --position bottom-left --offset-y 24 --lang ko

The widget

It's a single hosted script — nothing to bundle:

<script src="https://relay.nora.my/relay.js" data-project="pk_live_…" defer></script>

The same customisation is available as data- attributes if you place it by hand: data-accent, data-position, data-offset-x, data-offset-y, data-lang.

Authentication

Resolved in this order:

1. Flags: --org, --key, --api
2. Environment: NORA_RELAY_ORG, NORA_RELAY_KEY, NORA_RELAY_API
3. ~/.nora/relay.json (written by relay login)

Your org API key (nrk_…) comes from the Relay console → Settings → API keys. It scopes to one workspace and can create and list its projects.

Prefer an AI agent?

@conscience-technology/nora-relay-mcp is the same capability as an MCP server — "add Nora Relay to this project" from Claude Code or Cursor.

License

MIT