DocsIntentforgegetting started

Tutorial: Getting Started with IntentForge v2

This tutorial will guide you through setting up IntentForge v2 on your local machine and performing your first intent-based search.

Prerequisites

Before you begin, ensure you have the following installed:

  • Docker and Docker Compose
  • Rust (latest stable version)
  • Git

Step 1: Clone the Repository

Clone the project from our primary repository on Codeberg:

git clone https://codeberg.org/oxiverse/intentforge.git
cd intentforge

Step 2: Launch Infrastructure

IntentForge requires Meilisearch for indexing and Redis for caching. We provide a pre-configured Docker Compose file for development.

docker-compose -f docker-compose.dev.yml up -d

Verify that the containers are running:

docker ps

You should see meilisearch, redis, and several microservices (query_layer, trafilatura, youtube-unified) running.

Step 3: Initialize the Index

Run the initialization script to set up Meilisearch with optimized vector settings and ranking rules:

./scripts/init_meilisearch.sh

Step 4: Run IntentForge

Now, start the core engine. We'll enable the tor feature to allow the meta-search aggregator to communicate through the Tor network.

cargo run --features tor

The engine is ready when you see: HTTP API listening on http://0.0.0.0:9100

Step 5: Perform Your First Search

Open your browser or use curl to perform a search query. Notice how the engine identifies the intent of your query.

curl "http://localhost:9100/search?q=how+to+build+a+rust+api"

Next Steps

Congratulations! You have successfully set up and run IntentForge v2.