nearai 0.1.17

Near AI CLI

NEAR AI

NEAR AI is a distributed system for building, deploying, and managing AI agents with the goal of making open source and user-owned AGI.

NEAR AI Components

• NEAR AI Hub: Central hub for model serving, agent registry, and running agents
• TEE Runner: Confidential execution environment for NEAR AI agents and inference
• AWS Runner: Lambda-based execution environment for NEAR AI agents
• Agent System: Build and run AI agents with built-in tools and environment isolation
• Worker System: Distributed job execution and scheduling
• Model Fine-tuning: Support for fine-tuning LLMs

Directory Structure

nearai/
├── aws_runner/          # Lambda-based AI agent execution
│   ├── Dockerfile         # Container for running agents
│   └── frameworks/        # Framework-specific requirements
├── hub/                 # Central hub for registering and running agents and models
│   ├── alembic/           # Database migrations
│   └── api/               # API endpoints
├── nearai/              # Core library
│   ├── agents/            # Agent system implementation
│   │   ├── agent.py         # Base agent class
│   │   └── environment.py   # Agent environment
│   ├── cli.py             # Command-line interface
│   └── config.py          # Configuration management
├── worker/              # Distributed job execution
├── etc/                 # Configuration and setup
│   ├── finetune/          # Model fine-tuning configs
│   └── hosts_lambda.txt   # Cluster configuration
└── e2e/                 # End-to-end tests

Agent Creation Quick Start

Requirements

• Python 3.11 (3.12+ currently not supported)
• Git
• Docker (for local agent testing)

---

Installation

pip

python3 -m pip install nearai

Verify installation:

nearai version

local

git clone [e-mail]:nearai/nearai.git && cd nearai && ./install.sh

Or, to install to a virtual environment with poetry:

python3 -m uv sync
uv run nearai version

Or you can use pip:

python3 -m pip install -e .

Verify installation:

nearai version

---

Log In

Login to NEAR AI with your NEAR Account. If you don't have one, we recommend creating a free account with Meteor Wallet.

nearai login 

---

Useful Commands

1. Create an agent:

nearai agent create

2. Run agent locally:

nearai agent interactive

3. Deploy to NEAR AI Developer Hub:

nearai registry upload <path-to-agent>

Documentation

• Official Documentation
• Agent Development Guide

Updating

cd nearai
git pull
python3 -m pip install -e .  # If dependencies changed

Contributing

Want to help shape the future of AI? Join our community and contribute! 🚀

• 🐛 Report bugs and suggest features
• 💻 Submit pull requests
• 📖 Improve documentation
• 🤝 Help other users in the community
• 🌟 Star our repository

Check out our contributing guide to get started.