pg-smart-search
Getting Started

Installation

How to install pg-smart-search in your Node.js or TypeScript project using npm, yarn, or pnpm.

Installation

Before installing pg-smart-search, ensure your environment meets the prerequisites.

Prerequisites

  • Node.js 18.x or later
  • PostgreSQL 12.x or later
  • An existing PostgreSQL adapter (e.g., pg, postgres, drizzle-orm)

Install the Package

Install Package
$npm install pg-smart-search

Install Peer Dependencies

If you haven't already, install your database driver:

Install Package
$npm install pg

Next, proceed to the Quick Start to configure your first search engine.

Introduction

Why pg-smart-search exists and when to use it. Compare search tiers and understand the core philosophy.

Quick Start

Set up pg-smart-search in 3 minutes. Install the package, run the interactive CLI, and execute your first search.

On this page

InstallationPrerequisitesInstall the PackageInstall Peer Dependencies