Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
jbarnes850 committed Jan 16, 2025
1 parent 6e52221 commit f012fe8
Showing 1 changed file with 14 additions and 29 deletions.
43 changes: 14 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

A production-ready starter kit for building AI agents and multi-agent swarms on NEAR. This template provides the essential building blocks for creating autonomous agents that can interact with the NEAR blockchain, make decisions using LLMs, and collaborate in swarms. The NEAR AI Agent Studio is an educational and interactive starter kit designed for developers looking to build AI agents and agentic applications on NEAR.

<div align="center">

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![NEAR](https://img.shields.io/badge/NEAR-Protocol-blue.svg)](https://near.org)
[![Tests](https://img.shields.io/badge/Tests-Passing-brightgreen.svg)](https://github.com/near/near-ai-agent-template/actions)
Expand All @@ -10,16 +12,18 @@ A production-ready starter kit for building AI agents and multi-agent swarms on
[![Hyperbolic](https://img.shields.io/badge/LLM-Hyperbolic-purple.svg)](https://hyperbolic.xyz)
[![Lava Network](https://img.shields.io/badge/RPC-Lava%20Network-orange.svg)](https://www.lavanet.xyz/get-started/near)


![NEAR AI Agent Studio](./public/near-agent-studio.png)

</div>

## ⚡️ Getting Started

### Prerequisites

Before you begin, ensure you have:

#### System Requirements

- Python 3.12 or higher
- Git
- Operating System:
Expand All @@ -28,18 +32,21 @@ Before you begin, ensure you have:
- Windows 10/11 with WSL2

#### NEAR Account

- NEAR testnet account (created automatically by [quickstart](./scripts/quickstart.sh) script)
- Or existing account with:
- Account ID
- Full access key
- Test NEAR tokens (available from [NEAR Faucet](https://near-faucet.io))

#### API Keys

- Hyperbolic API key for LLM capabilities
- Sign up at [hyperbolic.xyz](https://hyperbolic.xyz)
- Free tier available for development

### Quick Start

```bash
# Clone the repository
git clone https://github.com/jbarnes850/near-ai-agent-studio
Expand All @@ -58,26 +65,31 @@ chmod +x scripts/quickstart.sh # Make script executable
```

The quickstart script will:

1. Set up your development environment
2. Create a NEAR testnet account
3. Install example agents
4. Launch an interactive chat assistant to help you create your first agent

### Interactive Chat

After setup, you'll enter an interactive chat session where you can:

- Create new agents with `/create agent <name>`
- Configure agents with `/config agent <name>`
- Run multiple agents together with `/run-agents`
- List available agents with `/list`
- Get help anytime with `/help`

Start the chat manually anytime:

```bash
near-swarm chat # Regular mode
near-swarm chat --tutorial create-first-agent # Guided tutorial
```

### Environment Setup

```bash
# Copy environment template
cp .env.example .env
Expand Down Expand Up @@ -164,12 +176,6 @@ graph TB
SwarmAgent --> Evaluation
```


The architecture combines a flexible agent framework with swarm intelligence capabilities:

1. **Agent Framework Core**
- Agent Registry for managing available agents

The architecture combines a flexible agent system with swarm intelligence capabilities:

1. **Agent Framework Core**
Expand All @@ -192,14 +198,8 @@ The architecture combines a flexible agent system with swarm intelligence capabi
- Consensus building through multi-agent voting
- Role-based evaluation with LLM reasoning

This architecture enables:
- Easy extension through agent plugins
- Coordinated decision-making via swarm intelligence
- Secure transaction handling
- Market-aware operations
- LLM-powered reasoning

### Project Structure

```bash
near-swarm-intelligence/
├── near_swarm/
Expand All @@ -221,21 +221,6 @@ near-swarm-intelligence/

## 🛠️ Development Guide

### Running Demos
```bash
# Run all demos
python near_swarm/examples/demo.py all

# Run specific components
python near_swarm/examples/demo.py voice # Voice assistant
python near_swarm/examples/demo.py strategy # Multi-agent strategy
python near_swarm/examples/demo.py chat # Interactive chat

# Create your first agent
near-swarm create agent my-agent
near-swarm plugins list # View available plugins
```

### Creating Your First Agent

```python
Expand Down

0 comments on commit f012fe8

Please sign in to comment.