Installation and Setup

This guide will walk you through the process of installing Warden and setting up its dependencies to ensure a smooth development experience.

Prerequisites

Before installing Warden, ensure you have the following installed and ready:

1. Go Programming Language:

   • Install Go (version 1.16 or later is recommended).
   • Visit the official Go installation guide for instructions specific to your operating system.

2. Git:

   • Git is required to clone the Warden repository.
   • Install Git from the official Git website.

3. API Keys:

   • Obtain the necessary API keys for the LLMs you intend to use (e.g., OpenAI, GPT-4-Free, Claude).
   • Store these API keys securely as they will be needed for integrating the models.

Installation Steps

Step 1: Clone the Warden Repository

To begin, clone the Warden repository from GitHub and navigate into its directory:

git clone https://github.com/LorenaShardin/Warden.git
cd Warden

Step 2: Install Dependencies

Next, resolve and install all required Go modules:

go mod tidy

This command ensures that all dependencies are fetched and set up properly.

Step 3: Start a Supported API (e.g., GPT-4-Free)

If you plan to use GPT-4-Free or another specific API, follow these steps to set it up:

1. Install the GPT-4-Free API package from its source (refer to its official documentation).
2. Start the service:

   g4f api
   

Make sure the API service is running before continuing.

Step 4: Run the Warden Framework

Once the dependencies and API are set up, you can start Warden in one of the following modes:

4.1. Start the Full Application

To run the entire framework, execute:

go run main.go

This launches an interactive interface that lets you choose between different platforms (CLI, Discord, Twitter) and interact with AI agents.

4.2. Configure and Start the Discord Bot

To run Warden as a Discord bot, perform these steps:

1. Set the Discord bot token as an environment variable:

   export DISCORD_BOT_TOKEN=your_discord_bot_token
   

2. Start the application:

   go run main.go
   

Your bot will now be ready to respond in your Discord server.

4.3. Run the CLI Chatbot

To use Warden as a CLI chatbot, run:

go run main.go

When prompted, select CLI Chatbot from the menu to begin interacting with your AI agent.

Verification

After completing the setup, verify your installation by interacting with the agents. Test responses in the CLI or platforms like Discord to ensure Warden is functioning as expected.

Troubleshooting

If you encounter issues during setup:

1. Dependencies: Verify that Go and Git are correctly installed.
2. API Keys: Double-check that your API keys are valid and have been properly configured.
3. API Services: Ensure the necessary APIs (e.g., GPT-4-Free) are running and accessible.

For additional support, refer to the GitHub Issues Page to seek help or report a problem.

Congratulations! Warden is now installed and ready for use. Move on to the next section of this documentation to learn more about Warden's architecture and core features.