Skip to content

Getting Started

Welcome to the Bluefly LLM ecosystem! This guide will help you get started with our tools and services.

Prerequisites

Before you begin, make sure you have the following installed:

  • Node.js 18 or newer
  • Python 3.10 or newer (for ML components)
  • Docker (optional, for containerized development)
  • Git

Installation

1. Clone the Repositories

# Clone the main repositories
git clone https://gitlab.com/bluefly/bfapi.git
git clone https://gitlab.com/bluefly/bfcli.git
git clone https://gitlab.com/bluefly/bfllm.git

2. Install Dependencies

# Install dependencies for BFAPI
cd bfapi
npm install

# Install dependencies for BFCLI
cd ../bfcli
npm install

# Install dependencies for BFLLM
cd ../bfllm
npm install
python -m pip install -r scripts/requirements.txt

3. Configure Environment

Each project requires configuration through environment variables. Copy the example files:

# Configure BFAPI
cd ../bfapi
cp .env.example .env

# Configure BFCLI
cd ../bfcli
cp .env.example .env

# Configure BFLLM
cd ../bfllm
cp .env.example .env

Edit each .env file to set the necessary configuration values.

Starting the Services

Start BFAPI

cd ../bfapi
npm run dev

Start BFLLM

cd ../bfllm
npm run dev

Using BFCLI

cd ../bfcli
npm link  # Make the CLI available globally
bfcli setup  # Run the setup wizard

Verifying Installation

Test your installation by making a simple request:

bfcli model list  # List available models
bfcli analyze text "Hello, world!"  # Test analysis endpoint

Next Steps

Now that you have the Bluefly LLM ecosystem up and running, you can: