Skip to main content
LibreChat is joining ClickHouse to power the open-source Agentic Data Stack 🎉 Learn more
LibreChat

npm

How to install LibreChat locally using npm

For most scenarios, Docker Compose is the recommended installation method due to its simplicity, ease of use, and reliability. If you prefer using npm, you can follow these instructions.

Prerequisites

If you use nvm, install and select the recommended Node.js version, then update npm:

nvm install 24.16.0
nvm use 24.16.0
npm install -g [email protected]
node -v
npm -v

You should see v24.16.0 for Node.js and 11.16.0 for npm before installing LibreChat dependencies.

Installation Steps

Preparation

Run the following commands in your terminal:

git clone https://github.com/danny-avila/LibreChat.git
cd LibreChat
cp .env.example .env

Note: If you're using Windows 10, you might need to use copy instead of cp.

Important: Edit the newly created `.env` file to update the `MONGO_URI` with your own MongoDB instance URI.

Update the MONGO_URI

Edit the newly created .env file to update the MONGO_URI with your own

Build and Start

Once you've completed the preparation steps, run the following commands:

npm run reinstall

npm run reinstall performs a clean dependency install and builds LibreChat. Use it after changing Node.js or npm versions so native packages are rebuilt against the active runtime.

npm run backend

Access LibreChat!

Tip

  • Next time you want to start LibreChat, you only need to execute npm run backend

Update LibreChat

To update LibreChat to the latest version, run the following commands:

First, stop LibreChat (if you haven't already).

git pull
npm run smart-reinstall

If you changed Node.js or npm versions during the update, run npm run reinstall instead.

npm run backend

Additional Setup

Unlock additional features by exploring our configuration guides to learn how to set up:

  • Meilisearch integration
  • RAG API connectivity
  • Custom endpoints
  • Other advanced configuration options
  • And more

This will enable you to customize your LibreChat experience with optional features.

see also:

How is this guide?