https://github.com/nearai/nearai

https://github.com/nearai/nearai

Last synced: 17 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/nearai/nearai
• Owner: nearai
• Created: 2024-05-08T00:22:09.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-12-02T16:43:59.000Z (24 days ago)
• Last Synced: 2024-12-02T17:26:39.704Z (24 days ago)
• Language: Python
• Homepage: https://app.near.ai
• Size: 12.6 MB
• Stars: 19
• Watchers: 15
• Forks: 4
• Open Issues: 117
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: docs/contributing.md

Awesome Lists containing this project

README

        
# NearAI

NearAI is a project with the goal of making open source and user-owned AGI.

## Setup

Requirements: [python](https://www.python.org/downloads/), [git](https://github.com/git-guides/install-git)

One line installation with a venv virtual env:

```shell

git clone [email protected]:nearai/nearai.git && cd nearai && ./install.sh;

```



Or, install nearai by running:


```shell

git clone [email protected]:nearai/nearai.git

cd nearai

python3 -m pip install -e .

```

Check that `nearai` was installed as a command line tool:

```shell

nearai version

```



Or, to install to a virtual environment with poetry, use the following command:


```bash

python3 -m poetry install --no-root --with dev

```

Check the installation worked with

```

poetry run nearai version

```

## Usage

To perform write operations you will need to log in with your Near account.

```

nearai login

```

To learn how to use NearAI, please read the [documentation](https://docs.near.ai/).

## Update

To update nearai run:

```

cd nearai

git pull # Pull the latest changes

# The next step is only required in case some dependencies were added or updated, otherwise pulling new changes is enough

python3 -m pip install -e .

```

## Contributing

To contribute to NearAI, please read the [contributing guide](https://docs.near.ai/contributing/).