> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sticklight.io/llms.txt
> Use this file to discover all available pages before exploring further.

# TypeScript SDK

> Capture runtime data from your TypeScript applications with the Sticklight TypeScript SDK.

## Installation

```bash
npm install @sticklight/sdk
# or
yarn add @sticklight/sdk
```

## Quick Start

```typescript
import * as sl from 'sticklight';

// Authenticate with your API key
sl.init("your-api-key");

// Publish an event
sl.capture("user_started_chat", {
    user_id: "user_123",
    message: "I need help with your new feature",
    // ... Any other data you want to track
});
```

To create an API key, go to the [Sticklight Platform].

## Requirements

* Node.js 18 or higher

# Identifying Users

It's important to identify users in order to track their behavior across different sessions.
It's encouraged to identify users early on in your application, ideally right after authentication.

```typescript
import * as sl from 'sticklight';

sl.identify("user_123", {
    name: "John Doe",
    email: "john.doe@example.com",
});
```

`sl.identify` stores the information it receives in the current session, and automatically adds it to the payload of all events captured during that session.

## About Sticklight

Sticklight provides precise and actionable analytics for AI-powered products, giving product managers and developers deep insights into how users interact with their AI features. Our platform helps you:

* Understand user patterns and behaviors in LLM interactions
* Identify where users struggle and detect critical issues in real-time
* Make data-driven decisions for your AI product roadmap

Think of it as product analytics, but specifically designed for the unique challenges of AI applications. Whether you're running a support chatbot, internal agentic architecture, or any other LLM-oriented product, Sticklight instills deep confidence and clarity in your product decisions.

## Development

```bash
# Clone the repository
git clone https://github.com/sticklight-io/sticklight-ts.git
cd sticklight-ts

# Install dependencies
pnpm install

# Run tests
pnpm test

# Build the package
pnpm build
```

## License

Apache 2.0

## Support

* Documentation: [docs.sticklight.io](https://docs.sticklight.io)
* Issues: [GitHub Issues](https://github.com/sticklight-io/sticklight-ts/issues)
* Email: [support@sticklight.io](mailto:support@sticklight.io)
* [Book a demo](https://calendly.com/matan-sticklight/30min)

[Sticklight Platform]: https://platform.sticklight.io