Near AI CLI
Project description
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 git@github.com: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, you can create one here.
Currently supported NEAR wallets:
- My NEAR Wallet
- Sender
- Meteor
- Bitte
nearai login
Useful Commands
- Create an agent:
nearai agent create
- Run agent locally:
nearai agent interactive
- Deploy to NEAR AI Developer Hub:
nearai registry upload <path-to-agent>
Documentation
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file nearai-0.1.16.tar.gz.
File metadata
- Download URL: nearai-0.1.16.tar.gz
- Upload date:
- Size: 5.4 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.6.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
773a1f53cf08572cd821f0f21af76dafec4b0cde1181c0e69733b8c357d1f3d7
|
|
| MD5 |
e45592540f141a6b012a8abe6107db19
|
|
| BLAKE2b-256 |
eedb3f6336e5f77b93e54064b59b2d4026f0a1ff2613323b9e922612e8d5aff6
|
File details
Details for the file nearai-0.1.16-py3-none-any.whl.
File metadata
- Download URL: nearai-0.1.16-py3-none-any.whl
- Upload date:
- Size: 231.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.6.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
dfd20656de6b8eeb0c5df3fb4ad48f5516797f9905e0f09211718c80911edbe7
|
|
| MD5 |
fe6e228bcc3ecfc1b45a4928fde5aa76
|
|
| BLAKE2b-256 |
6782afb2cc079b9db84d96ec91038a386f6751d54fe06eddd850e0ba3e415e5a
|