Skip to content

Latest commit

 

History

History
89 lines (58 loc) · 2.49 KB

GEMINI.md

File metadata and controls

89 lines (58 loc) · 2.49 KB

Gemini Code Assistant Context

This document provides context for the Gemini Code Assistant to understand the Inkeep Agents project.

Project Overview

Inkeep Agents is a multi-agent framework that enables multiple specialized AI agents to collaborate and solve complex problems through a graph-based architecture. It provides two ways to build agents:

  1. Visual Builder: A no-code interface for designing and managing agent workflows.
  2. TypeScript SDK: A code-first approach for building and managing agent workflows.

The project is a TypeScript monorepo managed with pnpm and turbo.

Key Technologies

  • TypeScript: The primary programming language.
  • Node.js: The runtime environment.
  • pnpm: The package manager.
  • turbo: The monorepo build system.
  • React: Used in the agents-manage-ui and agents-ui packages.
  • Next.js: Used in the agents-docs and agents-manage-ui packages.
  • Vite: Used in the agents-manage-api, agents-run-api, and agents-ui packages.
  • Vitest: The testing framework.
  • Biome: The code formatter and linter.
  • Drizzle: The ORM for the agents-core package.

Project Structure

The project is a monorepo with the following packages:

  • agents-cli: A command-line interface for interacting with the agent framework.
  • agents-docs: The documentation website.
  • agents-manage-api: The API for managing agents.
  • agents-manage-ui: The UI for the visual builder.
  • agents-run-api: The API for running agents.
  • agents-ui: The UI for the chat widget.
  • examples: Example agent graphs.
  • packages/agents-core: Core functionality of the agent framework.
  • packages/agents-sdk: The TypeScript SDK for building agents.

Building and Running

Installation

Install the dependencies:

pnpm install

Database Setup

Set the DB schema:

pnpm --dir ./packages/agents-core db:push

Running the Development Server

At the root directory:

pnpm dev

Running the test suite

pnpm test

Development Conventions

Code Style

The project uses Biome for code formatting and linting. The configuration is in the biome.json file.

Testing

The project uses Vitest for testing. Test files are located in __tests__ directories and have the .test.ts or .spec.ts extension.

Committing

The project uses a pre-push hook to run tests.

Versioning and Releasing

The project uses Changesets for versioning and releasing.