Getting Started

Step 1: The Ingestion Key

Every project in DeployOwl is assigned a unique API key. You can find this in Project tab inside a project or create a new project to get started.

Step 2: Global Initialization

Install the official protocol client:

npm install @deployowl

Initialize it at the very top of your entry point (e.g., layout.tsx, index.js, or server.ts).

By calling init(), DeployOwl automatically begins listening to uncaughtException, unhandledRejection, and browser window.onerror events. It also securely records console logs as "breadcrumbs" leading up to any crash.

import { init } from "@deployowl";

init({
  apiKey: process.env.DEPLOYOWL_KEY,
  environment: "production",
});

Step 3: Manual Capture (Optional)

If you need to catch an error gracefully without crashing your application, use the captureError method to send it to the autonomous engineer manually:

import { captureError } from "@deployowl";

try {
  // Your complex or risky logic
  await processPayment();
} catch (error) {
  // Catch the error and send it with optional context
  captureError(error, { 
    userId: "user_123", 
    action: "stripe_checkout" 
  });
  
  // Show a graceful fallback UI to the user
}

Step 4: Verify the Bridge

Once deployed, perform a "Test Breach" by triggering an error. If the bridge is active, you will see an error alert "Detected" indicator in your project dashboard within 500ms.