Ragfish Logo
Get In Touch
Ragfish Logo

Book a Demo

Installation

Before building your first AI assistant, you need to install the Ragfish framework and its required packages.

Ragfish follows a modular architecture, allowing you to install only the packages your application requires.

System Requirements

Before installing Ragfish, ensure your development environment meets the following requirements.

Requirement
Version
Node.js
20.x or later
npm
10.x or later
pnpm
9.x or later (Optional)
TypeScript
5.x
Operating System
Windows, macOS, or Linux

Note

Ragfish is developed using modern TypeScript and requires Node.js 20 or later.

Create a New Project

Create a new Node.js project.

mkdir my-ragfish-app
cd my-ragfish-app
npm init -y

If you're using TypeScript, install the required dependencies.

npm install -D typescript tsx @types/node

Initialize the TypeScript configuration.

npx tsc --init

Install Ragfish Core

The @ragfish/core package contains the core framework APIs, including chat, assistant management, retrieval, ingestion, and configuration.

Install it using npm.

npm install @ragfish/core

Install an AI Provider

Choose the AI provider you want to use.

For OpenAI:

npm install @ragfish/openai

Additional providers will be available in future releases.

    1. Anthropic (Coming Soon)

    2. Gemini (Coming Soon)

    3. Ollama (Coming Soon)

    4. Azure OpenAI (Coming Soon)

    5. AWS Bedrock (Coming Soon)

Install a Connector

Connectors allow Ragfish to import knowledge from different data sources.

For spreadsheet support:

npm install @ragfish/spreadsheet

Future connector packages include:

    1. PDF

    2. Website

    3. Documentation

    4. Database

    5. Notion

    6. SharePoint

    7. Google Drive

A minimal  Because Ragfish is modular, you only install the packages required by your application. 

Verify the Installation

Create a file named index.ts.

import { Chat } from "@ragfish/core";

console.log("Ragfish installed successfully.");

Run the application.

npx tsx index.ts

If the message is displayed successfully, your development environment is ready.

What's Installed?

 After installation, your project is ready to:

  1. Configure an AI provider

  2. Configure an embedding model

  3. Connect a vector database

  4. Import documents

  5. Build AI assistants

At this stage, no AI model has been configured yet. That will be covered in the next guide.

Next Steps

has been Now that Ragfish is installed, continue to Quick Start,where you'll configure your first AI provider, connect a vector store, and build your first AI assistant in just a few minutes.