Setting up SonAgent¶

📋 Requirements:

Choose an environment to run SonAgent in (pick one):

• Docker (opens in a new tab) (coming soon)

• Python 3.11 or later (opens in a new tab)

🗝️ Getting an API key:

Get your OpenAI API key from: OpenAI (opens in a new tab)

⚠️ Attention:

To use the OpenAI API with SonAgent, we strongly recommend setting up billing (AKA paid account). Free accounts are limited to 3 API calls per minute, which can cause the application to crash. You can set up a paid account at Manage account > Billing > Overview

Quick Start¶

1. Install Dependencies¶

pip install sonagent

2. Run agent¶

2.1 create user_data folder that will save agent skill, and user database

sonagent init

2.2 Please fill in the API key of openai, telegram, and github if you want the agent to create a pull request in the user_data/config.json file
2.3 run agent with file path param from step 2.1

sonagent run \
--config ./user_data/config.json \
--agentdb sqlite:///user_data/agentdb.sqlite \
--memory-url ./user_data/memory \
--datadir ./user_data/ \
--user-data-dir ./user_data/

🚀 Important:

It’s highly recommended that you keep keep track of your API costs on the Usage page. You can also set limits on how much you spend on the Usage limits page.

Configuration¶

To install the latest version and understand more about installation details. follow step bellow

Clone the SonAgent repository from GitHub using the command:
```
git clone https://github.com/sonnhfit/SonAgent.git
```
Navigate to the cloned directory:
```
cd SonAgent
```
Create a new Python environment using conda with the specified version:
```
conda create --name SonAgentenv python=3.11
```
Activate the newly created environment:
```
conda activate SonAgentenv
```
Install the package manager pip within the conda environment:
```
conda install pip
```
Install all the required dependencies listed in the requirements.txt file:

pip install -r requirements.txt

Install the SonAgent package in editable mode to allow changes:

pip install --editable .

To run SonAgent, use the following command with the appropriate configurations:

sonagent run --config /path/to/user_data/config.json --agentdb sqlite:///user_data/myagentdb.sqlite --memory-url /path/to/user_data/memory --datadir /path/to/user_data/  --user-data-dir /path/to/user_data/

Remember to replace placeholder text such as path/to with your actual path to the SonAgent folder you clone from git.

🛠️ Setup the configuration file:

To get the agent up and run, you need to insert OpenAi key and the chatbot key in order to communicate with the agent. In this case, we recommend BotFather from telegram for easier adoption:

Navigate to the user_data folder within your SonAgent project directory.
Locate the config.json file. If it does not exist, create a new text file and name it config.json.
Open the config.json file in a text editor of your choice.
Copy and paste the provided JSON structure into your config.json file:

    "initial_state": "running",
    "api_server": {
        "enabled": true,
        "listen_ip_address": "0.0.0.0",
        "listen_port": 8080,
        "verbosity": "error",
        "enable_openapi": true,
        "jwt_secret_key": "secret",
        "ws_token": "4IvjuMcs3MsVRYcMcl-3UXfZuWX3oNvbrQ",
        "CORS_origins": [],
        "username": "admin",
        "password": "admin"
    },
    "internals": {
        "sd_notify": true
    },
    "telegram": {
        "enabled": true,
        "token": " your_telegram_bot_token_here",
        "chat_id": " your_telegram_user_id_here"
    },
    "openai": {
        "enabled": true,
        "api_type": "openai",
        "api_key": " your_openai_api_key_here"
    },
    "skills_file_path": "skills/skills.yaml",
    "github": {
        "enabled": false,
        "username": "sonnhfit",
        "repo_name": "SonAgent",
        "token": "",
        "local_repo_path": ""
    }
}

By following these steps, your config.json file should be properly set up with your OpenAI API key and Telegram bot information. Remember to replace placeholder text such as your_openai_api_key_here, your_telegram_bot_token_here, and your_telegram_user_id_here with your actual credentials.

🎊 Running SonAgent:

Simply run the startup script in your terminal. This will install any necessary Python packages and launch SonAgent.

Navigate to the cloned directory:

 cd SonAgent

Activate the newly created environment:

 conda activate SonAgentenv

Init SonAgent:

sonagent run \
--config /path/to/user_data/config.json \
--agentdb sqlite:///user_data/myagentdb.sqlite \
--memory-url /path/to/user_data/memory \
--datadir /path/to/user_data/  \
--user-data-dir /path/to/user_data/ 

Make sure you have a compatible Python version installed. See also the requirements