Outlit SDK Integration

Decision-tree-driven guide for integrating Outlit customer journey tracking. Detects what it can from the codebase, asks only what it must, and links to official docs for implementation details.

Branching Check

Before anything else, check if Outlit is already installed:

1. Look for @outlit/browser, @outlit/node, or outlit (Rust crate) in package.json or Cargo.toml
2. If not installed -> go to Phase 1: Quick Connect
3. If already installed -> go to Already Installed

Already Installed

Ask the user what they need help with:

• Add event tracking -> Run detection, then go to Decision 7: Event Tracking. Fetch the relevant framework doc from the Doc URL Map for implementation patterns.
• Add/change auth integration -> Run detection, then go to Decision 3: Auth & Identity. Fetch the framework doc and identity resolution doc.
• Add consent management -> Go to Decision 2: Consent Stance. Fetch the framework doc's consent section.
• Add server-side tracking -> Go to Decision 1: App Type & SDK for the server package, then fetch the Node.js or Rust doc.
• Add billing/Stripe integration -> Go to Decision 6: Billing Integration. Fetch the customer journey doc.
• Add activation tracking -> Go to Decision 5: Activation Event. Fetch the customer journey doc.
• Migrate from other analytics -> Run detection, then go to Decision 4: Existing Analytics.
• Debug/troubleshoot -> Go to Troubleshooting.

Phase 1: Quick Connect

Goal: get events flowing in ~2 minutes so the user sees "Connected" on their Outlit onboarding screen. Zero user decisions required.

Step 1: Detect Framework & Package Manager

Use glob/grep to check:

• Framework: Check package.json dependencies for next, vue, nuxt, react, svelte, @sveltejs/kit, @angular/core, astro, express, fastify. Check for Cargo.toml with tauri or outlit.
• Package manager: Check for bun.lockb (bun), pnpm-lock.yaml (pnpm), yarn.lock (yarn), package-lock.json (npm). Use the first match found.

Step 2: Install SDK

Based on detected framework:

• Browser app (React, Next.js, Vue, Nuxt, Svelte, Angular, Astro) -> @outlit/browser
• Server app (Express, Fastify, Node.js) -> @outlit/node
• Tauri -> outlit Rust crate via cargo add outlit
• Electron -> @outlit/browser

Install using the detected package manager.