MAOS TypeScript Library

Introduction

MAOS (Multi-Agent Operating System) is designed to provide infrastructure for AI agents to manage shared resources efficiently. This TypeScript library is a binding of MAOS, offering a robust interface for system administrators to handle all management tasks through an intuitive admin UI.

Table of Contents

• Installation
• Usage
• API Documentation
• Examples

Installation

To install the MAOS TypeScript library, use the following command:

npm install maos-ts

Usage

Initialization

First, import and initialize the MAOS library in your TypeScript project:

import { MAOS } from 'maos-ts'

const maos = new MAOS({
  apiKey: 'YOUR_API_KEY',
  coreUrl: 'https://api.maos.example.com',
})

apiKey and coreUrl are all optional. maos-ts gets them from environment variable APIKEY and CORE_URL by defualt.

Basic Operations

Get Config

To list all available resources:

maos
  .getConfig()
  .then(resources => console.log(resources))
  .catch(error => console.error(error))

API Documentation

The full API documentation is available at API Docs.

Examples

For detailed examples, refer to the examples directory.

Feel free to open an issue or pull request if you have any questions or suggestions. Happy managing! 🚀