Quick Start

Get auralog running in your app in under 2 minutes. You’ll install the SDK, initialize it with your API key, and send your first log.

Tip

You’ll need an auralog account and a project API key. Sign up at auralog.ai and create your first project to get one.

1. Install the SDK

npm install auralog-sdk

Or with yarn/pnpm:

yarn add auralog-sdk
# or
pnpm add auralog-sdk

2. Initialize auralog

Add these lines at the entry point of your application:

import { init, auralog } from "auralog-sdk";

init({
  apiKey: "aura_your_api_key",
  environment: "production",
});

That’s it. auralog is now capturing uncaught errors and unhandled promise rejections automatically.

3. Send a log

auralog.info("App started");

auralog.error("Payment failed", {
  userId: "usr_123",
  error: "card_declined",
});

Error-level logs are sent to auralog immediately. Other levels are batched and sent every 5 seconds.

What happens next

1. Logs are ingested — the SDK sends logs to ingest.auralog.ai.
2. Claude analyzes errors — when errors arrive, Claude reviews the context and generates an analysis.
3. You get notified — view analyses in your dashboard, receive email alerts, trigger custom webhooks, or get an auto-generated PR with the fix.

Next: Your First Log — verify everything is connected.