chaz

Chaz is chaz.

This is a Matrix bot that connects to AIChat to provide access to "10+ AI platforms, including OpenAI, Gemini, Claude, Mistral, LocalAI, Ollama, VertexAI, Ernie, Qianwen..." all from within Matrix.

You do NOT need to be running your own Matrix homeserver to use this. It is a bot that should be usable with any homeserver, you'll just need to create an account for it.

You will need your own API keys or your own local AI already configured.

This is built using headjack, a Matrix bot framework developed alongside it.

Announcement Blog Post: Chaz: An LLM <-> Matrix Chatbot

Usage

Chaz will automatically accept Room invites for any user in the allow_list.

When it's in a room, it will watch for commands that are prefixed by ., and any other messages will be sent to the configured backend.

The commands that it recognizes are:

Available commands:

- .print - Print the conversation
- .send - <message> - Send this message without context
- .model - <model> - Select the model to use
- .list - List available models
- .clear - Ignore all messages before this point
- .rename - Rename the room and set the topic based on the chat content
- .help - Show this message

Install

chaz is only packaged on crates.io, but it's recommended that you run from git HEAD for now.

For Nix users, this repo contains a Nix flake. See the setup section for details on configuring.

Setup

First, setup an account on any Matrix server for the bot to use.

Create a config file for the bot with its login info.

IMPORTANT: Make sure that you setup your allow_list or the bot will not respond

The defaults are configured in src/defaults.rs

homeserver_url: https://matrix.org
username: "chaz"
password: "" # Optional, if not given it will ask for it on first run
allow_list: "" # Regex for allowed accounts.
message_limit: 0 # Set a per-account message limit. 0 = Unlimited.
room_size_limit: 0 # Set a room size limit to respond in. 0 = Unlimited
state_dir: "$XDG_STATE_HOME/chaz" # Optional, for setting the chaz state directory
aichat_config_dir: "$AICHAT_CONFIG_DIR" # Optional, for using a separate aichat config
chat_summary_model: "" # Optional, set a different model than the default to use for summarizing the chat
role: chaz # Optionally set a role, AKA system prompt. Set to `chaz` for the full chaz experience, or `cave-chaz` for even more chaz
roles: # Optional, define your own roles
  - name: chaz # This one is predefined
    description: Chaz is Chaz
    prompt: "Your name is Chaz, you are an AI assistant, and you refer to yourself in the third person."
    example: # Optionally define example messages.
      - user: User
        message: "Are you ready?"
      - user: Assistant
        message: "Chaz is ready."
  - name: bash
    description: Get a single shell command
    prompt: >
      Based on the following user description, generate a corresponding Bash shell command.
      Focus solely on interpreting the requirements and translating them into a single, executable Bash command.
      Ensure accuracy and relevance to the user's description.
      The output should be a valid Bash command that directly aligns with the user's intent, ready for execution in a command-line environment.
      Do not output anything except for the command.
      No code block, no English explanation, no newlines, and no start/end tags.

Nix

Development is being done using a Nix flake. The easiest way to install chaz is to use nix flakes.

❯ nix run github:arcuru/chaz

The flake contains an overlay to make it easier to import into your own flake config. To use, add it to your inputs:

    inputs.chaz.url = "github:arcuru/chaz";

And then add the overlay inputs.chaz.overlays.default to your pkgs.

The flake also contains a home-manager module for installing chaz as a service. Import the module into your home-manager config and you can configure chaz all from within nix:

{inputs, ... }: {
  imports = [ inputs.chaz.homeManagerModules.default ];
  services.chaz = {
    enable = true;
    settings = {
        homeserver_url = "https://matrix.jackson.dev";
        username = "chaz";
        password = "hunter2";
        allow_list = "@me:matrix.org|@myfriend:matrix.org";
    };
  };
}

Running

To run it, simply:

1. Install chaz and setup its config.
2. Install AIChat.
3. Configure AIChat with the models and defaults that you want.
4. Create a config file for chaz with login details.
5. Run the bot and specify it's config file location chaz --config config.yaml.

The bot will not respond to older messages sent while it wasn't running to prevent overwhelming the backend.