These requirements apply to all setup methods.

• Linux, Mac, or Windows computer capable of running an LLM model for the AI backend.
• Fully configured llamafile API endpoint.
  • This is automatically downloaded and configured by the setup script.

The optional Docker container can be built to include all requirements.

• Install Docker

To build the standalone Go binary, you will need the build requirements.

• Install Go
• Go Dependencies
  • github.com/thoj/go-ircevent

Follow these detailed steps to get Nisaba running quickly using the pre-built scripts included with the releases:

1. Download the Pre-Built Binary Archive

   • Visit the Releases page on GitHub.
   • Download the appropriate archive for your operating system:
     • nisaba-linux.tar.gz for Linux
     • nisaba-mac.tar.gz for Mac
     • nisaba-windows.zip for Windows

2. Prepare the Setup Script

   • For Linux or Mac:
     • Extract the contents of the .tar.gz archive.
     • Open a terminal and navigate to the extracted directory.
     • Make the setup script executable:

       chmod +x setup.sh

   • For Windows:
     • Extract the contents of the .zip archive.
     • Open Command Prompt and navigate to the extracted directory.

3. Run the Setup Script

   • For Linux or Mac:
     • In your terminal, execute the script by running:

       ./setup.sh

   • For Windows:
     • In Command Prompt, execute the script by running:

       setup.bat

   • Follow the on-screen prompts to configure your setup. The script will guide you through several steps:
     • Download llamafile Binary: The script will ask if you want to download the llamafile binary required for the API endpoint. Answer y for yes.
     • Configure Requried Settings: You will be prompted to configure required settings to create a config.json file. Answer y to proceed.
     • Enter Configuration Details: The script will then prompt you to enter various configuration details such as nickname, server, port, etc. Press 'Enter' to accept default values or enter your custom settings.
     • Choose API Endpoint Options: You'll have the option to select a default options preset for the API endpoint. Answer y and choose between provided presets like "LLaMA Precise" or "Divine Intellect".
     • Make the Binaries Executable: You will be prompted to make the binaries for Nisaba and llamafile executable. Answer y to proceed.
     • Model Download: Finally, the script will ask if you want to download a model and save it as model.gguf. Answer y and select the LLM model to download.

4. Run Nisaba and Llamafile

   • After configuration, start the services:
     • For Linux:
       • Run the llamafile binary first to start the endpoint:

         ./llamafile -m model.gguf -ngl 0

       • Then run the Nisaba binary:

         ./nisaba-linux-amd64.bin

     • For Mac:
       • Run the llamafile binary first to start the endpoint:

         ./llamafile -m model.gguf -ngl 0

       • Then run the Nisaba binary:

         ./nisaba-mac-amd64.bin

     • For Windows:
       • Run the llamafile binary first to start the endpoint:

         .\llamafile.exe -m model.gguf -ngl 0

       • Then run the Nisaba binary:

         .\nisaba-windows-amd64.exe

1. Install Go

   • If you haven't already, follow the instructions on the official Go website.

2. Install Dependencies

   • Install the IRC event package:

     go get github.com/thoj/go-ircevent
     

3. Configure the Bot

   • Manually create a config directory in your project root and place your config.json file within this directory. Optionally, add an options.json for API parameters.
     • Use the setup.sh or setup.bat script to generate these files automatically.
   • Example config.json and options.json files are provided under config/ for reference including popular API presets:
     • config.json.example to reference required settings file
     • options.precise.json.example for "LLaMA Precise"
     • options.divine.json.example for "Divine Intellect"
     • options.json.example to reference all available options
   • Rename the relevant example file to options.json if you wish to use it.

4. Build the Bot:

   • Navigate to the project directory and run:

     go build -o nisaba.bin .
     

5. Run the Bot:

   • Ensure that you have a llamafile API endpoint running.
   • Start the bot by running the binary:

     ./nisaba.bin
     

1. Prepare Configurations

   • Place config.json, options.json (if used), and model.gguf in a directory named config in the same directory as your docker-compose.yml.
   • Example config.json and options.json files are provided under config/ for reference including popular API presets:
     • config.json.example to reference required settings file
     • options.precise.json.example for "LLaMA Precise"
     • options.divine.json.example for "Divine Intellect"
     • options.json.example to reference all available options

2. Build and Run with Docker Compose

   • Ensure the Docker Compose file is set to mount the config directory correctly:

     version: '3.8'
     services:
       nisaba:
         build: .
         volumes:
           - ./model.gguf:/app/model.gguf
           - ./config:/app/config

   • Run the following command in the directory containing docker-compose.yml:

     docker-compose up --build
     

• config.json: Required main configuration for the IRC bot, specifying connection details and API settings.
• options.json: Optional parameters file designed to adjust llamafile's behavior, with settings like temperature, top_k, etc.
• systemprompt.txt: System prompt for Nisaba sent to the llamafile endpoint.
• blocklist.txt: Blocks specific IRC nicknames from interacting with Nisaba.
• history.txt: Stores message context dynamically; should not be edited manually.
• llamafile_args.txt (Docker only): Custom arguments to replace default llamafile settings under Docker.

To get a response from Nisaba, simply prefix your message with the bot's name, followed by your query.

For example: Nisaba, how are you?

After you send a message or command, Nisaba will use the API endpoint to generate a response, and then send that response back to you in the designated IRC channel.

Nisaba supports several commands that can be used to control the bot or modify its behavior dynamically.

These commands should be prefixed with the bot's name, optionally followed by a comma or colon, and the command:

• !clear: Clears the message history stored by the bot. Useful for resetting the context in "chat" mode.
  • Nisaba, !clear
• !options [filename]: Loads specific option settings from a file named options.[filename].json if present in the config directory. This allows you to dynamically change how Nisaba interacts with the llamafile API without restarting the bot.
  • Nisaba, !options precise
• !system [message]: Attaches a system prompt to the next message that Nisaba sends to the llamafile endpoint, affecting how responses are generated.
  • Nisaba, !system You will respond using 100 words or less.

The code in this repository is provided "as-is" without any warranty of any kind, either expressed or implied. It is intended for research and educational purposes only. The authors and contributors make no representations about the suitability of this software for any purpose and accept no liability for any consequences resulting directly or indirectly from the use of this software.

By using this software, you acknowledge and agree to assume all risks associated with its use, understanding that you are solely responsible for any damage to your computer system or loss of data that results from such activities. You also acknowledge that this software is not intended for use in production environments or for commercial purposes.