Angular — Installation

Requirements

Angular 19+

This is a dedicated Angular library — an injectable LerixService, a provideLerix() function for your app.config.ts, and an Angular ErrorHandler integration — built on top of @lerix-dev/lerix-core, the framework-agnostic engine shared by every Lerix web SDK. Building a React app instead? See the React SDK. If you’re using neither Angular nor React, @lerix-dev/lerix-core also works directly.

1. Add the dependency

npm install @lerix-dev/lerix-angular

2. Register the SDK

Add provideLerix() to your app.config.ts:

app.config.ts

import { ApplicationConfig } from '@angular/core';
import { provideLerix } from '@lerix-dev/lerix-angular';

export const appConfig: ApplicationConfig = {
  providers: [
    provideLerix({
      apiKey: 'your-api-key',
      projectId: 'your-project-id',
      debugMode: true,
    }),
  ],
};

Find your API key and project ID in the Lerix Dashboard under Project Settings.

Registration with the backend, and the automatic crash handler, run at bootstrap — before your app becomes interactive. There’s no separate init() call to make.

Parameters

Parameter	Type	Required	Description
`apiKey`	`string`	Yes	Your project API key from the dashboard
`projectId`	`string`	Yes	Your project ID (slug) from the dashboard
`url`	`string`	No	Backend base URL. Defaults to `https://api.lerix.dev/v1` — only change this if you’re pointing at a self-hosted backend
`release`	`string`	No	The version this build ships as (e.g. `1.4.0` or a commit SHA). Pass the same value when uploading source maps so production stack traces show your original files: see Source maps
`debugMode`	`boolean`	No	Print SDK request/response logs to the console (default: `false`)
`enableCrashReporting`	`boolean`	No	Install the automatic error handler (default: `true`) — see Error Tracking
`onError`	`(error: unknown) => void`	No	Called if initialization itself fails (e.g. network unreachable)

3. Verify the integration

Inject LerixService and throw a test error to confirm everything is working:

import { Component, inject } from '@angular/core';
import { LerixService } from '@lerix-dev/lerix-angular';

@Component({ ... })
export class MyComponent {
  private readonly lerix = inject(LerixService);

  test() {
    this.lerix.throwError('Test error');
  }
}

Then open your dashboard — the error should appear within seconds.

You’re all set! Continue to Error Tracking to report custom errors and enable automatic capture, or Push Notifications to enable push delivery.

Getting started

Frameworks

Modules

Developers

Angular — Installation

Requirements

1. Add the dependency

2. Register the SDK

Parameters

3. Verify the integration

​Requirements

​1. Add the dependency

​2. Register the SDK

​Parameters

​3. Verify the integration

Requirements

1. Add the dependency

2. Register the SDK

Parameters

3. Verify the integration