# Installation

## Install the package

```bash
bun add @promptlycms/prompts
```
```bash
npm install @promptlycms/prompts
```
```bash
yarn add @promptlycms/prompts
```
```bash
pnpm add @promptlycms/prompts
```
## Peer dependencies

The SDK requires [Zod](https://zod.dev) v4, the [Vercel AI SDK](https://sdk.vercel.ai), and TypeScript 5+. Install `typescript` as a dev dependency:

```bash
bun add zod ai
bun add -D typescript
```
```bash
npm install zod ai
npm install --save-dev typescript
```
```bash
yarn add zod ai
yarn add -D typescript
```
```bash
pnpm add zod ai
pnpm add -D typescript
```
## Provider SDKs

The SDK supports all providers supported by the [Vercel AI SDK](https://ai-sdk.dev/providers/ai-sdk-providers#provider-support). Install the AI provider SDK(s) your prompts use - only the providers configured in your CMS prompts need to be installed.

```bash
# Anthropic (Claude models)
bun add @ai-sdk/anthropic

# OpenAI (GPT / o-series models)
bun add @ai-sdk/openai

# Google (Gemini models)
bun add @ai-sdk/google

# Mistral (Mistral / Mixtral models)
bun add @ai-sdk/mistral
```
```bash
# Anthropic (Claude models)
npm install @ai-sdk/anthropic

# OpenAI (GPT / o-series models)
npm install @ai-sdk/openai

# Google (Gemini models)
npm install @ai-sdk/google

# Mistral (Mistral / Mixtral models)
npm install @ai-sdk/mistral
```
```bash
# Anthropic (Claude models)
yarn add @ai-sdk/anthropic

# OpenAI (GPT / o-series models)
yarn add @ai-sdk/openai

# Google (Gemini models)
yarn add @ai-sdk/google

# Mistral (Mistral / Mixtral models)
yarn add @ai-sdk/mistral
```
```bash
# Anthropic (Claude models)
pnpm add @ai-sdk/anthropic

# OpenAI (GPT / o-series models)
pnpm add @ai-sdk/openai

# Google (Gemini models)
pnpm add @ai-sdk/google

# Mistral (Mistral / Mixtral models)
pnpm add @ai-sdk/mistral
```
**Note:** Install only the providers your prompts use. The SDK dynamically imports provider packages at runtime, so unused providers won't be loaded or bundled.

## Version compatibility

| Package | Required version |
|---------|-----------------|
| `zod` | `^4.0.0` |
| `ai` | `^4.0 \|\| ^5.0 \|\| ^6.0` |
| `typescript` | `^5.0.0 \|\| ^6.0.0` |
| `@ai-sdk/anthropic` | `^3.0` |
| `@ai-sdk/openai` | `^3.0` |
| `@ai-sdk/google` | `^3.0` |
| `@ai-sdk/mistral` | `^3.0` |

## Next steps

Once installed, follow the [Quick Start](https://docs.promptlycms.com/getting-started/quick-start/) guide to create your first client and fetch a prompt. If you haven't already, [create a free account on Promptly CMS](https://promptlycms.com) to start managing your prompts.