Breadcrumb
Guide

Quick Start

Visit the hosting section to set up your breadcrumb instance to get ready to track your calls.

Setup with your Coding Agent

If you're using an AI coding agent like Claude Code or Codex, you can install the Breadcrumb skill to let your agent automatically instrument your project:

npx skills add https://github.com/joshuaKnauber/breadcrumb --skill breadcrumb-tracing

Then ask your agent to add tracing to your project - it knows the full SDK API and will handle the setup for you.

Manual Install

npm install @breadcrumb-sdk/core @breadcrumb-sdk/ai-sdk

Setup

Initialize the Breadcrumb client with your API key. You can get one from your project settings after setting up your instance.

import { init } from "@breadcrumb-sdk/core";
import { initAiSdk } from "@breadcrumb-sdk/ai-sdk";

const bc = init({
  apiKey: process.env.BREADCRUMB_API_KEY!,
  baseUrl: process.env.BREADCRUMB_BASE_URL!,
});

const { telemetry } = initAiSdk(bc);

Start Tracing

const { text } = await generateText({
  model: anthropic("claude-sonnet-4-5"),
  prompt: "Explain what Breadcrumb does in one sentence.",

  // enable traces for this call
  experimental_telemetry: telemetry("quickstart"),
});

Open your Breadcrumb dashboard to see the trace. See the SDK details for more complex traces.

Already using Sentry or another OTel tool? Breadcrumb works alongside them automatically. See the compatibility guide for details.

On this page