Aigne Framework

](https://star-history.com/#AIGNE-io/aigne-framework) [ ](https://codecov.io/gh/AIGNE-io/aigne-framework) [ [](https://github.com/AIGNE-io/aigne-framework/blob/main/LICENSE.md)

What is AIGNE Framework

AIGNE Framework \[ ˈei dʒən ] is a functional AI application development framework designed to simplify and accelerate the process of building modern applications. It combines functional programming features, powerful artificial intelligence capabilities, and modular design principles to help developers easily create scalable solutions. AIGNE Framework is also deeply integrated with the Blocklet ecosystem, providing developers with a wealth of tools and resources.

Key Features

• Modular Design: With a clear modular structure, developers can easily organize code, improve development efficiency, and simplify maintenance.
• TypeScript Support: Comprehensive TypeScript type definitions are provided, ensuring type safety and enhancing the developer experience.
• Multiple AI Model Support: Built-in support for OpenAI, Gemini, Claude, Nova and other mainstream AI models, easily extensible to support additional models.
• Flexible Workflow Patterns: Support for sequential, concurrent, routing, handoff and other workflow patterns to meet various complex application requirements.
• Agentic File System (AFS): A virtual file system abstraction that provides AI agents with unified access to various storage backends, including local files, conversation history, and user profiles. See AFS Documentation for details.
• MCP Protocol Integration: Seamless integration with external systems and services through the Model Context Protocol.
• Code Execution Capabilities: Support for executing dynamically generated code in a secure sandbox, enabling more powerful automation capabilities.
• Blocklet Ecosystem Integration: Closely integrated with ArcBlock's Blocklet ecosystem, providing developers with a one-stop solution for development and deployment.

Quick Start

Environment Requirements

• Node.js version 20.0 or higher

Installation

#### Using npm

npm install @aigne/core

#### Using yarn

yarn add @aigne/core

#### Using pnpm

pnpm add @aigne/core

Usage Example

import { AIAgent, AIGNE } from "@aigne/core";
import { OpenAIChatModel } from "@aigne/openai";

const { OPENAI_API_KEY } = process.env;

const model = new OpenAIChatModel({
  apiKey: OPENAI_API_KEY,
});

function transferToB() {
  return agentB;
}

const agentA = AIAgent.from({
  name: "AgentA",
  instructions: "You are a helpful agent.",
  outputKey: "A",
  skills: [transferToB],
  inputKey: "message",
});

const agentB = AIAgent.from({
  name: "AgentB",
  instructions: "Only speak in Haikus.",
  outputKey: "B",
  inputKey: "message",
});