| Name | nearai JSON |
| Version |
0.1.13
JSON |
| download |
| home_page | None |
| Summary | Near AI CLI |
| upload_time | 2025-02-21 04:12:55 |
| maintainer | None |
| docs_url | None |
| author | Support |
| requires_python | <3.12,>=3.9 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# NEAR AI
[](https://opensource.org/licenses/MIT)
[](https://github.com/nearai/nearai/actions)
[](https://github.com/nearai/nearai/releases)
[](https://docs.near.ai/contributing)
[](https://t.me/nearaialpha)
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**](./hub/README.md): Central hub for model serving, agent registry, and running agents
- [**TEE Runner**](https://github.com/nearai/private-ml-sdk): Confidential execution environment for NEAR AI agents and inference
- [**AWS Runner**](./aws_runner/README.md): 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](https://www.python.org/downloads/) _(3.12+ currently not supported)_
- [Git](https://github.com/git-guides/install-git)
- [Docker](https://docs.docker.com/get-docker/) (for local agent testing)
---
### Installation
<details>
<summary>pip</summary>
```bash
python3 -m pip install nearai
```
Verify installation:
```bash
nearai version
```
</details>
<details>
<summary>local</summary>
```bash
git clone git@github.com:nearai/nearai.git && cd nearai && ./install.sh
```
Or, to install to a virtual environment with poetry:
```bash
python3 -m poetry install --no-root --with dev
poetry run nearai version
```
Verify installation:
```bash
nearai version
```
</details>
---
### Log In
Login to NEAR AI with your NEAR Account. If you don't have one, you can create one [here](https://wallet.near.org/).
Currently supported NEAR wallets:
- My NEAR Wallet
- Sender
- Meteor
- Bitte
```bash
nearai login
```
---
### Useful Commands
1. Create an agent:
```bash
nearai agent create
```
2. Run agent locally:
```bash
nearai agent interactive
```
3. Deploy to [NEAR AI Developer Hub](https://hub.near.ai):
```bash
nearai registry upload <path-to-agent>
```
## Documentation
- [Official Documentation](https://docs.near.ai)
- [Agent Development Guide](https://docs.near.ai/agents/quickstart)
## Updating
```bash
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](https://github.com/nearai/nearai/issues)
- 💻 [Submit pull requests](https://github.com/nearai/nearai/pulls)
- 📖 [Improve documentation](https://docs.near.ai/contributing/#contribute-documentation)
- 🤝 [Help other users in the community](https://t.me/nearaialpha)
- 🌟 [Star our repository](https://github.com/nearai/nearai)
Check out our [contributing guide](https://docs.near.ai/contributing) to get started.
Raw data
{
"_id": null,
"home_page": null,
"name": "nearai",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.12,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Support",
"author_email": "support@near.ai",
"download_url": "https://files.pythonhosted.org/packages/8d/4a/b0b5c421bf92753a0b96ea11e60ebe14d541279efac1d00989db5f605390/nearai-0.1.13.tar.gz",
"platform": null,
"description": "# NEAR AI\n\n[](https://opensource.org/licenses/MIT)\n[](https://github.com/nearai/nearai/actions)\n[](https://github.com/nearai/nearai/releases)\n[](https://docs.near.ai/contributing)\n[](https://t.me/nearaialpha)\n\nNEAR AI is a distributed system for building, deploying, and managing AI agents with the goal of making open source and user-owned AGI.\n\n## NEAR AI Components\n\n- [**NEAR AI Hub**](./hub/README.md): Central hub for model serving, agent registry, and running agents\n- [**TEE Runner**](https://github.com/nearai/private-ml-sdk): Confidential execution environment for NEAR AI agents and inference\n- [**AWS Runner**](./aws_runner/README.md): Lambda-based execution environment for NEAR AI agents\n- **Agent System**: Build and run AI agents with built-in tools and environment isolation\n- **Worker System**: Distributed job execution and scheduling\n- **Model Fine-tuning**: Support for fine-tuning LLMs\n\n\n## Directory Structure\n\n```\nnearai/\n\u251c\u2500\u2500 aws_runner/ # Lambda-based AI agent execution\n\u2502 \u251c\u2500\u2500 Dockerfile # Container for running agents\n\u2502 \u2514\u2500\u2500 frameworks/ # Framework-specific requirements\n\u251c\u2500\u2500 hub/ # Central hub for registering and running agents and models\n\u2502 \u251c\u2500\u2500 alembic/ # Database migrations\n\u2502 \u2514\u2500\u2500 api/ # API endpoints\n\u251c\u2500\u2500 nearai/ # Core library\n\u2502 \u251c\u2500\u2500 agents/ # Agent system implementation\n\u2502 \u2502 \u251c\u2500\u2500 agent.py # Base agent class\n\u2502 \u2502 \u2514\u2500\u2500 environment.py # Agent environment\n\u2502 \u251c\u2500\u2500 cli.py # Command-line interface\n\u2502 \u2514\u2500\u2500 config.py # Configuration management\n\u251c\u2500\u2500 worker/ # Distributed job execution\n\u251c\u2500\u2500 etc/ # Configuration and setup\n\u2502 \u251c\u2500\u2500 finetune/ # Model fine-tuning configs\n\u2502 \u2514\u2500\u2500 hosts_lambda.txt # Cluster configuration\n\u2514\u2500\u2500 e2e/ # End-to-end tests\n```\n\n## Agent Creation Quick Start\n\n### Requirements\n\n- [Python 3.11](https://www.python.org/downloads/) _(3.12+ currently not supported)_\n- [Git](https://github.com/git-guides/install-git)\n- [Docker](https://docs.docker.com/get-docker/) (for local agent testing)\n\n---\n\n### Installation\n\n<details>\n<summary>pip</summary>\n\n```bash\npython3 -m pip install nearai\n```\n\nVerify installation:\n\n```bash\nnearai version\n```\n\n</details>\n\n<details>\n<summary>local</summary>\n\n```bash\ngit clone git@github.com:nearai/nearai.git && cd nearai && ./install.sh\n```\nOr, to install to a virtual environment with poetry:\n\n```bash\npython3 -m poetry install --no-root --with dev\npoetry run nearai version\n```\n\nVerify installation:\n\n```bash\nnearai version\n```\n\n</details>\n\n---\n\n### Log In\n\nLogin to NEAR AI with your NEAR Account. If you don't have one, you can create one [here](https://wallet.near.org/).\n\nCurrently supported NEAR wallets:\n- My NEAR Wallet\n- Sender\n- Meteor\n- Bitte\n\n```bash\nnearai login \n```\n\n---\n\n### Useful Commands\n\n1. Create an agent:\n\n```bash\nnearai agent create\n```\n\n2. Run agent locally:\n\n```bash\nnearai agent interactive\n```\n\n3. Deploy to [NEAR AI Developer Hub](https://hub.near.ai):\n\n```bash\nnearai registry upload <path-to-agent>\n```\n\n## Documentation\n\n- [Official Documentation](https://docs.near.ai)\n- [Agent Development Guide](https://docs.near.ai/agents/quickstart)\n\n## Updating\n\n```bash\ncd nearai\ngit pull\npython3 -m pip install -e . # If dependencies changed\n```\n\n## Contributing\n\nWant to help shape the future of AI? Join our community and contribute! \ud83d\ude80\n\n- \ud83d\udc1b [Report bugs and suggest features](https://github.com/nearai/nearai/issues)\n- \ud83d\udcbb [Submit pull requests](https://github.com/nearai/nearai/pulls)\n- \ud83d\udcd6 [Improve documentation](https://docs.near.ai/contributing/#contribute-documentation)\n- \ud83e\udd1d [Help other users in the community](https://t.me/nearaialpha)\n- \ud83c\udf1f [Star our repository](https://github.com/nearai/nearai)\n\nCheck out our [contributing guide](https://docs.near.ai/contributing) to get started.\n",
"bugtrack_url": null,
"license": null,
"summary": "Near AI CLI",
"version": "0.1.13",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6525be62a6de26ed508571e4a22a5867b9391821c38cacb91316803297248182",
"md5": "3977f9505b5ee8ef5a224f082631f9c7",
"sha256": "56956185ef70b5073c2c65cb1834d9a4ee4aca48ae7a2cbfafe7baa8e9cff8c1"
},
"downloads": -1,
"filename": "nearai-0.1.13-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3977f9505b5ee8ef5a224f082631f9c7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.12,>=3.9",
"size": 219945,
"upload_time": "2025-02-21T04:12:53",
"upload_time_iso_8601": "2025-02-21T04:12:53.715270Z",
"url": "https://files.pythonhosted.org/packages/65/25/be62a6de26ed508571e4a22a5867b9391821c38cacb91316803297248182/nearai-0.1.13-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8d4ab0b5c421bf92753a0b96ea11e60ebe14d541279efac1d00989db5f605390",
"md5": "f80aa74299dbc7a838fc719c4577e7ae",
"sha256": "52bfd036ccac05e0373cd66acc8b4ce6b20dde3f7145a2396bcdb230b23d99ec"
},
"downloads": -1,
"filename": "nearai-0.1.13.tar.gz",
"has_sig": false,
"md5_digest": "f80aa74299dbc7a838fc719c4577e7ae",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12,>=3.9",
"size": 131070,
"upload_time": "2025-02-21T04:12:55",
"upload_time_iso_8601": "2025-02-21T04:12:55.178853Z",
"url": "https://files.pythonhosted.org/packages/8d/4a/b0b5c421bf92753a0b96ea11e60ebe14d541279efac1d00989db5f605390/nearai-0.1.13.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-21 04:12:55",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "nearai"
}
