Quick Start

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

Tip

You’ll need an auralogs account and an ingest key. Sign up at auralogs.ai, create your first project, and copy the one-time startup ingest key. The startup modal also gives you an MCP/API read key. An Anthropic or OpenAI key is only needed if you want auralogs-generated analyses.

1. Install the SDK

npm install auralogs-sdk

Or with yarn/pnpm:

yarn add auralogs-sdk
# or
pnpm add auralogs-sdk

2. Initialize auralogs

Add these lines at the entry point of your application:

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

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

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

3. Send a log

auralogs.info("App started");

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

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

What happens next

1. Logs are ingested — the SDK sends logs to ingest.auralogs.ai.
2. You can inspect them immediately — use the log viewer in the dashboard, or use the startup read key for API and MCP access.
3. Your agent can query production context — connect Codex, Claude, Cursor, or another MCP client and ask it to search logs, inspect metadata, and summarize what changed.
4. Automation is optional — add an AI provider key for generated analyses, notifications, scheduled reviews, or GitHub autofix.

Next: Your First Log — verify everything is connected.