Quickstart

🚀 Quickstart for UltraAgent

Welcome to UltraAgent! This quickstart guide will help you set up and start using UltraAgent in no time. Keep in mind that this is for the default configuration; you may need to adjust the setup based on your specific requirements.

✅ Prerequisites

Before you begin, ensure you have the following prerequisites. An unchecked box indicates that the item is optional.

• Python 3.10+

  • Python is a versatile programming language that is widely used for various applications.
  • We recommend using Python 3.13 for optimal performance, but we've tested UltraAgent on Python 3.10 and above.

• Windows 10+ / MacOS / Linux

  • This program was built on Windows 11 with versatility in mind.
  • We've tested it on MacOS and Linux as well, and it should work fine on those platforms.

• An OpenAI API key

  • An API key is required to access OpenAI's GPT-4o model (default model) for text generation.
  • OpenAI's platform is what we build our functions upon, so you'll need an API key to use the bot.
  • If you are planning to use a different bot, please navigate to the respective documentation for setup instructions.

• An ElevenLabs API key

  • ElevenLabs is the default TTS engine used by the bot. If you don't have an API key, you can use the legacy TTS engine instead.
  • Technically, this is optional if you are using the legacy TTS engine, but it is required for the default setup.

• Git

  • Git is a version control system that allows you to track changes in your codebase.
  • This is optional, but recommended. If you do not want to use Git, you can download the repository as a ZIP file instead and extract it.

📥 Installation

Follow these steps to install UltraAgent on your system:

1. Get the source code:

   • You may download & extract the repository or use Git to clone it. You may download & extract the repository or use Git to clone it.

     git clone https://github.com/4934tech/ultraagent.git
     cd ultraagent

   • If you don't have Git installed, you can download the repository as a ZIP file from the GitHub page and then extract it.

2. Configure your credentials:

   • Navigate to the project directory and copy the example environment file.
   • When adding your API keys, remember that you only need to add the ones which you will be using.
   • The required ones which we'll be using are the OPENAI_API_KEY and ELEVENLABS_API_KEY for this basic setup.

   cd src\config
   cp .env.example .env
   # Open the .env file in a text editor and add your API keys
   cd .. # Go back to the project root for the next step

3. Create a virtual environment:

   We recommend using a virtual environment to manage dependencies.

   python -m venv venv
   source venv/bin/activate

4. Install the required dependencies:

   If using a virtual environment, make sure it's activated, as shown in the previous step.

   pip install -r requirements.txt

5. Run the agent:

   This will use your default sound devices.

    python main.py