Skip to main content

Installation

info

Updating from <0.0.52? See this section for instructions.

Supported Environments​

LangChain is written in TypeScript and can be used in:

  • Node.js (ESM and CommonJS) - 18.x, 19.x, 20.x
  • Cloudflare Workers
  • Vercel / Next.js (Browser, Serverless and Edge functions)
  • Supabase Edge Functions
  • Browser
  • Deno
  • Bun

Installation​

To get started, install LangChain with the following command:

npm install -S langchain

TypeScript​

LangChain is written in TypeScript and provides type definitions for all of its public APIs.

Loading the library​

ESM​

LangChain provides an ESM build targeting Node.js environments. You can import it using the following syntax:

import { OpenAI } from "langchain/llms/openai";

If you are using TypeScript in an ESM project we suggest updating your tsconfig.json to include the following:

tsconfig.json
{
  "compilerOptions": {
    ...
    "target": "ES2020", // or higher
    "module": "nodenext",
  }
}

CommonJS​

LangChain provides a CommonJS build targeting Node.js environments. You can import it using the following syntax:

const { OpenAI } = require("langchain/llms/openai");

Cloudflare Workers​

LangChain can be used in Cloudflare Workers. You can import it using the following syntax:

import { OpenAI } from "langchain/llms/openai";

Vercel / Next.js​

LangChain can be used in Vercel / Next.js. We support using LangChain in frontend components, in Serverless functions and in Edge functions. You can import it using the following syntax:

import { OpenAI } from "langchain/llms/openai";

Deno / Supabase Edge Functions​

LangChain can be used in Deno / Supabase Edge Functions. You can import it using the following syntax:

import { OpenAI } from "https://esm.sh/langchain/llms/openai";

We recommend looking at our Supabase Template for an example of how to use LangChain in Supabase Edge Functions.

Browser​

LangChain can be used in the browser. In our CI we test bundling LangChain with Webpack and Vite, but other bundlers should work too. You can import it using the following syntax:

import { OpenAI } from "langchain/llms/openai";

Installing integration packages​

LangChain supports packages that contain specific module integrations with third-party providers. They can be as specific as @langchain/google-genai, which contains integrations just for Google AI Studio models, or as broad as @langchain/community, which contains broader variety of community contributed integrations.

These packages, as well as the main LangChain package, all depend on @langchain/core, which contains the base abstractions that these integration packages extend.

To ensure that all integrations and their types interact with each other properly, it is important that they all use the same version of @langchain/core. The best way to guarantee this is to add a "resolutions" or "overrides" field like the following in your project's package.json. The name will depend on your package manager:

If you are using yarn:

yarn package.json
{
  "name": "your-project",
  "version": "0.0.0",
  "private": true,
  "engines": {
    "node": ">=18"
  },
  "dependencies": {
    "@langchain/google-genai": "^0.0.2",
    "langchain": "0.0.207"
  },
  "resolutions": {
    "@langchain/core": "0.1.1"
  }
}

Or for npm:

npm package.json
{
  "name": "your-project",
  "version": "0.0.0",
  "private": true,
  "engines": {
    "node": ">=18"
  },
  "dependencies": {
    "@langchain/google-genai": "^0.0.2",
    "langchain": "0.0.207"
  },
  "overrides": {
    "@langchain/core": "0.1.1"
  }
}

Or for pnpm:

pnpm package.json
{
  "name": "your-project",
  "version": "0.0.0",
  "private": true,
  "engines": {
    "node": ">=18"
  },
  "dependencies": {
    "@langchain/google-genai": "^0.0.2",
    "langchain": "0.0.207"
  },
  "pnpm": {
    "overrides": {
      "@langchain/core": "0.1.1"
    }
  }
}

Unsupported: Node.js 16​

We do not support Node.js 16, but if you still want to run LangChain on Node.js 16, you will need to follow the instructions in this section. We do not guarantee that these instructions will continue to work in the future.

You will have to make fetch available globally, either:

  • run your application with NODE_OPTIONS='--experimental-fetch' node ..., or
  • install node-fetch and follow the instructions here

You'll also need to polyfill ReadableStream by installing:

npm i web-streams-polyfill

And then adding it to the global namespace in your main entrypoint:

import "web-streams-polyfill/es6";

Additionally you'll have to polyfill structuredClone, eg. by installing core-js and following the instructions here.

If you are running Node.js 18+, you do not need to do anything.