Installation

Package Installation

# npm
npm install assistme-agent-sdk

# pnpm
pnpm add assistme-agent-sdk

# yarn
yarn add assistme-agent-sdk

# bun
bun add assistme-agent-sdk

Provider Setup

The SDK is model-agnostic. Install the provider for the model you want to use:

# Use Claude (Anthropic)
npm install assistme-agent-sdk-provider-claude

# Use GPT (OpenAI)
npm install assistme-agent-sdk-provider-openai

# Use Gemini (Google)
npm install assistme-agent-sdk-provider-gemini

# Use open-source models (Ollama, vLLM, etc.)
npm install assistme-agent-sdk-provider-openai-compatible

Environment Variables

Set the API key for your chosen provider:

# For Claude
export ANTHROPIC_API_KEY=sk-ant-...

# For OpenAI
export OPENAI_API_KEY=sk-...

# For Gemini
export GOOGLE_API_KEY=AIza...

# For local models (Ollama)
export OLLAMA_BASE_URL=http://localhost:11434

TypeScript Configuration

The SDK requires TypeScript 5.0+ and uses Zod for schema validation:

npm install zod

Recommended tsconfig.json settings:

{
  "compilerOptions": {
    "target": "ES2022",
    "module": "ESNext",
    "moduleResolution": "bundler",
    "strict": true,
    "esModuleInterop": true
  }
}

Python Installation

pip install assistme-agent-sdk

# With provider extras
pip install assistme-agent-sdk[claude]
pip install assistme-agent-sdk[openai]
pip install assistme-agent-sdk[gemini]

Verify Installation

import { Agent, Runner } from 'assistme-agent-sdk'
import { claude } from 'assistme-agent-sdk-provider-claude'

const agent = new Agent({
  name: 'hello',
  model: claude('claude-sonnet-4-6'),
  instructions: 'You are a helpful assistant. Reply with a short greeting.',
})

const result = await Runner.run(agent, {
  messages: [{ role: 'user', content: 'Hello!' }],
})

console.log(result.output)
// → "Hello! How can I help you today?"

Next Steps

Quick Start — Build a complete agent with tools and guardrails
Providers — Configure and switch between model providers

Installation

On this page