@exulu/backend 1.4.0 → 1.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@exulu/backend",
3
3
  "author": "Qventu Bv.",
4
- "version": "1.4.0",
4
+ "version": "1.5.0",
5
5
  "main": "./dist/index.js",
6
6
  "private": false,
7
7
  "publishConfig": {
package/README.md DELETED
@@ -1,176 +0,0 @@
1
- # Exulu - AI Agent Management Platform
2
-
3
- <div align="center">
4
-
5
- ![Exulu Logo](frontend/public/exulu_logo.svg)
6
-
7
- **A powerful platform for creating, managing, and orchestrating AI agents with enterprise-grade features**
8
-
9
- [![Node.js](https://img.shields.io/badge/Node.js-20.10.0-green.svg)](https://nodejs.org/)
10
- [![TypeScript](https://img.shields.io/badge/TypeScript-5.8.3-blue.svg)](https://www.typescriptlang.org/)
11
- [![License](https://img.shields.io/badge/License-Private-red.svg)](LICENSE)
12
-
13
- </div>
14
-
15
- ## 🚀 Overview
16
-
17
- Exulu is a comprehensive AI agent management platform that enables you to create, deploy, and orchestrate intelligent agents with enterprise-grade features. Built with TypeScript, it provides a robust backend infrastructure and modern frontend interface for seamless agent management and interaction.
18
-
19
- ### Key Features
20
-
21
- - 🤖 **AI Agent Management**: Create and manage multiple AI agents with different capabilities
22
- - 🔧 **Tool Integration**: Extend agent capabilities with custom tools and workflows
23
- - 🗄️ **Vector Database**: PostgreSQL with pgvector for semantic search and RAG
24
- - 📊 **Queue Management**: BullMQ for background job processing
25
- - 🔐 **Authentication**: JWT and NextAuth support with role-based access
26
- - 📝 **GraphQL API**: Flexible API with Apollo Server integration
27
- - 🎯 **Agent Evaluation**: Built-in evaluation framework for agent performance
28
- - 🔄 **Workflow Orchestration**: Create complex multi-agent workflows
29
- - 📦 **File Management**: S3-compatible storage with Uppy integration
30
- - 🎨 **Modern UI**: Next.js frontend.
31
-
32
- ## 🏗️ Architecture
33
-
34
- The overall project is organized into 5 main repositories:
35
-
36
-
37
- 1. Backend: Express.js server with endpoints for agents, contexts, jobs, users, roles and workflows.
38
- 2. Frontend: Next.js application.
39
- 3. Example: example Exulu implementation with example agents, contexts and tools.
40
- 4. CLI: command-line interface tools.
41
- 5. Tools: catalogue of ExuluTools that can be installed and added to agents.
42
- 6. Agents: catalogue of template agents you can install and add to your Exulu instance.
43
-
44
- ### Core Components
45
-
46
- - **ExuluApp**: Main application class that initializes the platform
47
- - **Agents**: AI agent definitions with configurable capabilities
48
- - **Tools**: Available actions and utilities for agents
49
- - **Contexts**: Vectorized knowledge sources agents can search through and use in their reasoning and response
50
- - **Workflows**: Predefined agent interaction patterns
51
- - **Embedders**: Text embedding models for semantic search
52
-
53
- ## 🛠️ Prerequisites
54
-
55
- - **Node.js** (v20.10.0 or higher)
56
- - **PostgreSQL** with pgvector extension
57
- - **Redis** (optional, for BullMQ workers)
58
- - **Docker** (optional, for containerized deployment)
59
-
60
- ## 📚 Usage Examples
61
-
62
- ### Creating an Agent
63
-
64
- ```typescript
65
- import { ExuluApp, ExuluAgent } from "@exulu/backend";
66
-
67
- const exulu = new ExuluApp();
68
-
69
- const myAgent = new ExuluAgent({
70
- id: "my-custom-agent",
71
- name: "My Custom Agent",
72
- description: "A custom AI agent for specific tasks",
73
- type: "agent",
74
- capabilities: {
75
- tools: true,
76
- images: [],
77
- files: [],
78
- audio: [],
79
- video: []
80
- },
81
- config: {
82
- model: "gpt-4",
83
- // ... other configuration
84
- }
85
- });
86
-
87
- const server = await exulu.create({
88
- config: {
89
- workers: { enabled: false },
90
- MCP: { enabled: true }
91
- },
92
- contexts: [],
93
- tools: [],
94
- agents: [myAgent],
95
- workflows: []
96
- });
97
- ```
98
-
99
- ### Using the CLI
100
-
101
- ```bash
102
- # Install CLI globally
103
- npm install -g @exulu/cli
104
-
105
- # Run CLI
106
- exulu
107
-
108
- # Available commands:
109
- # - Start Claude Code
110
- # - List agents
111
- # - List contexts
112
- ```
113
-
114
- ## 🔧 Configuration
115
-
116
- ### Environment Variables
117
-
118
- Create `.env` files in both `frontend/` and `backend/` directories. Use the `.env.preview` files for reference.
119
-
120
- #### Backend Environment Variables
121
-
122
- ```env
123
- # Database
124
- DATABASE_URL=postgresql://username:password@localhost:5432/exulu
125
- REDIS_URL=redis://localhost:6379
126
-
127
- # Authentication
128
- JWT_SECRET=your-jwt-secret
129
- NEXTAUTH_SECRET=your-nextauth-secret
130
-
131
- # AI Providers
132
- OPENAI_API_KEY=your-openai-key
133
- ANTHROPIC_API_KEY=your-anthropic-key
134
-
135
- # File Storage
136
- S3_BUCKET=your-s3-bucket
137
- S3_REGION=your-s3-region
138
- AWS_ACCESS_KEY_ID=your-aws-key
139
- AWS_SECRET_ACCESS_KEY=your-aws-secret
140
- ```
141
-
142
- #### Frontend Environment Variables
143
-
144
- ```env
145
- # API Configuration
146
- NEXT_PUBLIC_API_URL=http://localhost:9001
147
- NEXT_PUBLIC_GRAPHQL_URL=http://localhost:9001/graphql
148
-
149
- # Authentication
150
- NEXTAUTH_URL=http://localhost:3020
151
- NEXTAUTH_SECRET=your-nextauth-secret
152
- ```
153
-
154
- ### Development Guidelines
155
-
156
- - Follow TypeScript best practices
157
- - Use conventional commits
158
- - Write comprehensive tests
159
- - Update documentation
160
- - Follow the existing code style
161
-
162
- ## 📄 License
163
-
164
- This project is licensed under a private license - see the [LICENSE](LICENSE) file for details.
165
-
166
- ## 👥 Authors
167
-
168
- - **Qventu Bv.** - *Initial work*
169
-
170
- ---
171
-
172
- <div align="center">
173
-
174
- **Exulu** - Intelligence Management Platform
175
-
176
- </div>