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

# Installation

> Install the Cuey TypeScript client

## Requirements

* A Cuey account and API key ([Get one here](https://cuey.dev/dashboard))

## Install the Package

Install the `cuey` package using your preferred package manager:

<CodeGroup>
  ```bash npm theme={null}
  npm install cuey
  ```

  ```bash yarn theme={null}
  yarn add cuey
  ```

  ```bash pnpm theme={null}
  pnpm add cuey
  ```

  ```bash bun theme={null}
  bun add cuey
  ```
</CodeGroup>

## Configuration

After obtaining your API key from the [dashboard](https://cuey.dev/dashboard), set it as an environment variable named `CUEY_API_KEY`:

## Usage

Use the default `cuey` instance, which automatically reads the `CUEY_API_KEY` environment variable:

```typescript theme={null}
import { cuey } from "cuey";

await cuey.schedule({ ... });
```

<Info>
  The `cuey` instance is a pre-configured client that uses the `CUEY_API_KEY`
  environment variable for authentication. For advanced configuration options,
  see the [Advanced Configuration
  guide](/typescript-client/advanced-configuration).
</Info>

## Next Steps

<CardGroup cols={2}>
  <Card title="Quick Start" icon="rocket" href="/typescript-client/quickstart">
    Follow the quick start guide to schedule your first webhook.
  </Card>

  <Card title="TypeScript SDK Overview" icon="code" href="/typescript-client/overview">
    Learn about the client API and available methods.
  </Card>

  <Card title="Advanced Configuration" icon="gear" href="/typescript-client/advanced-configuration">
    Deep dive into configuration options.
  </Card>

  <Card title="REST API" icon="plug" href="/api-reference/introduction">
    Explore the REST API documentation.
  </Card>
</CardGroup>