DocsGetting StartedInstallation

Installation Guide

Get started with Cleo by installing and configuring your environment.

Installation Guide

Prerequisites

  • Node.js 14 or later
  • Redis server
  • TypeScript (for TypeScript projects)

Basic Installation

# Install Cleo
npm install @cleotasks/core

Basic Configuration

import { Cleo } from "@cleotasks/core";
import { TaskPriority } from "@cleotasks/core/types/enums";
 
const cleo = Cleo.getInstance();
 
cleo.configure({
  redis: {
    host: "localhost",
    port: 6379,
    password: "cleosecret",
  },
  worker: {
    concurrency: 4,
    queues: [
      {
        name: "default",
        priority: TaskPriority.NORMAL,
      },
    ],
  },
});

Environment Variables

REDIS_HOST=localhost
REDIS_PORT=6379
REDIS_PASSWORD=cleosecret

Next Steps

IntroductionQuick Start