Installation

Install the package

bun add @promptlycms/prompts

npm install @promptlycms/prompts

yarn add @promptlycms/prompts

pnpm add @promptlycms/prompts

Peer dependencies

The SDK requires Zod v4, the Vercel AI SDK, and TypeScript 5+. Install typescript as a dev dependency:

bun add zod ai
bun add -D typescript

npm install zod ai
npm install --save-dev typescript

yarn add zod ai
yarn add -D typescript

pnpm add zod ai
pnpm add -D typescript

Provider SDKs

The SDK supports all providers supported by the Vercel AI SDK. Install the AI provider SDK(s) your prompts use - only the providers configured in your CMS prompts need to be installed.

# 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

# 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

# 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

# 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

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 guide to create your first client and fetch a prompt. If you haven’t already, create a free account on Promptly CMS to start managing your prompts.