Skip to main content

​
Requirements

Node.js

Node.js LTS (20+) required

TypeScript

TypeScript 5.0+ recommended
DeepAgents is designed for modern Node.js environments with native TypeScript support. All packages are ESM-only.

​
Core Packages

​
@deepagents/agent

The core agent framework for building multi-agent systems. 
npm install @deepagents/agent ai zod

npm install @deepagents/agent ai zod
Peer Dependencies:
  • zod ^3.25.76 || ^4.0.0 - Schema validation
  • ai (automatically installed) - Vercel AI SDK

​
Model Provider SDKs

Install the model provider you want to use: 
npm install @ai-sdk/openai

import { openai } from '@ai-sdk/openai';
const model = openai('gpt-4o');

​
@deepagents/context

Context management with multiple rendering formats. 
npm install @deepagents/context
For browser environments, use the browser-specific export to avoid server-only dependencies:
import { term, hint, XmlRenderer } from '@deepagents/context/browser';

​
@deepagents/text2sql

Natural language to SQL with database adapters. 
npm install @deepagents/text2sql
Database-Specific Peer Dependencies: 
npm install pg @types/pg

import { Postgres } from '@deepagents/text2sql/postgres';

​
@deepagents/retrieval

Local-first RAG with embeddings and vector search. 
npm install @deepagents/retrieval
Built-in Dependencies:
  • FastEmbed for local embeddings
  • SQLite-vec for vector storage
  • Multiple connectors (GitHub, RSS, PDF, etc.)

​
@deepagents/evals

LLM evaluation framework with scoring and persistence. 
npm install @deepagents/evals
Includes:
  • Dataset loading (JSON, JSONL, CSV)
  • Deterministic and LLM-based scorers
  • SQLite persistence
  • Console and file reporters

​
@deepagents/orchestrator

High-level orchestration patterns for complex workflows. 
npm install @deepagents/orchestrator
Dependencies:
  • @deepagents/agent
  • @deepagents/context
  • @deepagents/retrieval
  • @deepagents/toolbox

​
@deepagents/toolbox

Pre-built tools for common tasks. 
npm install @deepagents/toolbox
Includes:
  • DuckDuckGo search
  • Web scraping
  • Filesystem operations
  • HackerNews search
  • Weather data

​
Complete Installation

For a full-featured setup with all packages: 
npm install \
  @deepagents/agent \
  @deepagents/context \
  @deepagents/text2sql \
  @deepagents/retrieval \
  @deepagents/evals \
  @deepagents/orchestrator \
  @deepagents/toolbox \
  @ai-sdk/openai \
  ai \
  zod

​
Environment Configuration

​
API Keys

Set up environment variables for your model providers:
.env
# OpenAI
OPENAI_API_KEY=sk-...

# Anthropic
ANTHROPIC_API_KEY=sk-ant-...

# Google
GOOGLE_GENERATIVE_AI_API_KEY=...

# Groq
GROQ_API_KEY=gsk_...

# Database (if using text2sql)
DATABASE_URL=postgresql://user:pass@localhost:5432/db

​
TypeScript Configuration

Recommended tsconfig.json settings:
tsconfig.json
{
  "compilerOptions": {
    "target": "ES2022",
    "module": "ESNext",
    "moduleResolution": "bundler",
    "lib": ["ES2022"],
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "resolveJsonModule": true,
    "isolatedModules": true
  }
}
DeepAgents uses Node.js native TypeScript execution. When importing files, always include the .ts extension:
import { helper } from './utils.ts'; // ✅ Correct
import { helper } from './utils';    // ❌ Wrong

​
Package Versions

All DeepAgents packages follow synchronized versioning:

@deepagents/agent v0.23.0

@deepagents/context v0.23.0

@deepagents/text2sql v0.23.0

@deepagents/retrieval v0.23.0

@deepagents/evals v0.23.0

@deepagents/orchestrator v0.23.0

@deepagents/toolbox v0.23.0

​
Verification

Verify your installation:
verify.ts
import { agent, execute } from '@deepagents/agent';
import { openai } from '@ai-sdk/openai';

const assistant = agent({
  name: 'assistant',
  model: openai('gpt-4o'),
  prompt: 'You are helpful.',
});

const stream = execute(assistant, 'Say hello', {});
console.log(await stream.text);

node verify.ts
Make sure your OPENAI_API_KEY (or other provider key) is set in your environment before running.

​
Building from Source

To build packages locally using the monorepo: 
git clone https://github.com/JanuaryLabs/deepagents.git
cd deepagents
npm install
Build a specific package: 
nx run agent:build
nx run text2sql:build
Build all packages: 
nx run-many --target=build --all

​
Next Steps

Quick Start Guide

Build your first agent in 5 minutes

Core Concepts

Learn about agent architecture

Build docs developers (and LLMs) love

Get started for freeTalk to us