> For the complete documentation index, see [llms.txt](https://developers.incidents.cloud.solarwinds.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.incidents.cloud.solarwinds.com/typescript/examples.md).

# @solarwinds/squadcast-sdk-typescript Examples

This directory contains example scripts demonstrating how to use the @solarwinds/squadcast-sdk-typescript SDK.

## Prerequisites

* Node.js (v18 or higher)
* npm

## Setup

1. Copy `.env.template` to `.env`:

   ```bash
   cp .env.template .env
   ```
2. Edit `.env` and add your actual credentials

## Running the Examples

To run an example file from the examples directory:

```bash
npm run build && npx tsx example.ts
```

## Creating new examples

Duplicate an existing example file, they won't be overwritten by the generation process.
