Getting Started

This page walks you through the five minutes it takes to go from zero to your first captured error.

1. Create an account

Sign up at larabug.com. The free plan covers your first project, so you can evaluate LaraBug without putting in a card.

2. Create a project

From your dashboard, click "Create project" and give it a name (usually the name of your app). Each project gets:

A project key — identifies the project when events arrive at the ingest endpoint.
A login key — authenticates your account to our API.

You'll need both. They're visible on the project page and in your profile.

3. Pick your SDK

LaraBug has two SDK families. Most teams install both:

Laravel (PHP) — for capturing server-side exceptions and queue jobs. → Laravel Installation
JavaScript — for capturing frontend errors from Vue, React, or Inertia. → Frontend Overview

You can start with one and add the other later. They're designed to be used together but work fine on their own.

4. Send a test event

Once the SDK is installed and configured with your keys, trigger a test event:

Laravel:

php artisan larabug:test

JavaScript:

import * as LaraBug from '@larabug/browser';
LaraBug.captureMessage('Hello from the frontend!', 'info');

Refresh your LaraBug dashboard. The event should appear within a few seconds.

5. Verify and explore

That's it. You're capturing errors. From here:

Configure environments so only production (or whatever you choose) reports to LaraBug.
Attach user context so you know which user hit each error.
Set up queue monitoring if your Laravel app uses background jobs.
Extend the data filter if you log fields beyond the built-in blacklist.

Every section in these docs assumes you already have a project and your keys. If you hit a wall, drop into Troubleshooting or reach out to support.

← Previous Welcome Next → Installation