Skip to content
DevLab

Install

Install @neurologyca/capture 0.45.0 and @neurologyca/capture-server 0.20.1 from Neurologyca's private registry.

On this page
  1. Packages
  2. The registry token
  3. Install
  4. Requirements
  5. Without a bundler

Preview 0.45 Available · Preview 0.45. The API can change before 1.0: see Release phases.

Package Version Runs in Entries Use it for
@neurologyca/capture 0.45.0 The browser ., /record, /replay, /helpers The live client (createProtocolClient), the recording client (/record), the helpers (/helpers)
@neurologyca/capture-server 0.20.1 Your backend (Node.js 20.3 or later) ., /node The proxy, the token, createEngineAdmin, the upload receiver and the processing client; /node adapts them to node:http

The browser package installs @neurologyca/kodec 5.0.0-rc.14, the on-device codec, as a dependency. /replay is what Neurologyca’s processing service runs; running it yourself comes later.

Both packages together are what the docs call the SDK: one runs in the browser, the other in your backend.

The packages live in Neurologyca’s private GitHub Packages registry. Installing them needs a read token in NODE_AUTH_TOKEN: Neurologyca gives it to you with your invitation, through the same channel as the key; it is not in DevLab. It is not your API key: never mix them up, and keep both out of git.

.env
# .npmrc
@neurologyca:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=${NODE_AUTH_TOKEN}
Shell
export NODE_AUTH_TOKEN="<registry token>"
npm install @neurologyca/capture@0.45.0
npm install @neurologyca/capture-server@0.20.1

In CI, set NODE_AUTH_TOKEN as a secret: actions/setup-node and npm read it as is.

  • Browsers: Chrome or Edge 94+, Safari 16.4+ (iOS 16.4+). Firefox is not a target: kodec has not been tested there (on-device), and it does not record MP4/H.264 (deferred).
  • Serve the page over HTTPS, or localhost while you develop: browsers only open the camera in a secure context. Never from file://.
  • What depends on the device (GPU, WebGPU for speech) and how to check it at run time: Devices, quality and mode.
  • Node.js 20.3 or later for @neurologyca/capture-server (the starters of your kit need 20.6, for node --env-file). It only runs on the server: imported into a browser bundle, it throws when the page loads.

dist/capture.global.js puts the package’s API on window.NeuroCapture and registers nothing else. Copy it to your own origin and serve it: there is no public CDN.

HTML
<script src="/capture.global.js"></script>