Pull and Switch Model Revised (#142 )

* Update: pull-model only runnable by admins now * Update: switch-model cannot pull models anymore * Update: less technical responses * Update: version increment
Code Owners File (#140 )
2025-12-12 11:56:06 -05:00 · 2024-12-04 21:29:01 -08:00 · 2024-11-23 14:51:17 -08:00 · 2024-11-08 20:09:01 -08:00 · 2024-11-08 10:13:16 -08:00 · 2024-10-19 16:46:51 -07:00
46 changed files with 1341 additions and 756 deletions
--- a/.env.sample
+++ b/.env.sample
@@ -1,12 +1,6 @@
 # Discord token for the bot
 CLIENT_TOKEN = BOT_TOKEN

-# model for the bot to query from (i.e. llama2 [llama2:13b], mistral, codellama, etc... )
-MODEL = MODEL_NAME
-
-# discord bot user id for mentions
-CLIENT_UID = BOT_USER_ID
-
 # ip/port address of docker container, I use 172.18.0.3 for docker, 127.0.0.1 for local
 OLLAMA_IP = IP_ADDRESS
 OLLAMA_PORT = PORT
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -1,31 +1,39 @@
 <!-- 
-    Author: Kevin Dang 
-    Date: 1-30-2024    
+  Author: Kevin Dang 
+  Date: 1-30-2024    
+  Changes:
+    10-01-2024 - Jonathan Smoley
 -->
+
+## Naming Conventions
+* Branches
+  * prefix your branch name with the type of contribution:
+    * features: `'feature/**'`
+    * releases: `'releases/**'`
+    * bugs: `'bug/**'`
+    * docs: `'docs/**'`
+
 ## Run the Bot
 * Refer to all sections below before running the bot.
 * You should now have `Ollama`, `NodeJS`, ran `npm install`.
 * You will also need a discord bot to run. Refer to the [developer portal](https://discord.com/developers/) to learn how to set one up and invite it to your server. If that does not help then look up a YouTube video like this [one](https://www.youtube.com/watch?v=KZ3tIGHU314&ab_channel=UnderCtrl).
-* Now run `npm run start` to run the client and ollama at the same time (this must be one in wsl or a Linux distro)
-
+* Now run `npm run client` to run the client (this must be done in wsl or a Linux distro)

 ## Set up (Development-side)
 * Pull the repository using `https://github.com/kevinthedang/discord-ollama.git`.
-* Refer to `Ollama Setup` in the readme to set up Ollama.
+* Refer to `Environment Setup` in the readme to set up Ollama.
  * This must be set up in a Linux environment or wsl2.
 * Install NodeJS `v18.18.2`
-  * You can check out `Resources` and `To Run` in the readme for a bit of help.
+  * You can check out `Resources` in the readme for a bit of help.
  * You can also reference [NodeJS Setup](#nodejs-setup)
 * When you have the project pulled from github, open up a terminal and run `npm i` or `npm install` to get all of the packages for the project.
 * In some kind of terminal (`git bash` is good) to run the client. You can run Ollama but opening up wsl2 and typing `ollama serve`.
  * Refer to `Ollama Setup` if there are any issues.

 ## Environment
-* You will need two environment files:
+* You will need an environment file:
  * `.env`: for running the bot
    * Please refer to `.env.sample` for all environment variables to include
-  * `.env.dev.local`: also runs the bot, but with development variables
-    * Currently there are no differences between the two, but when needed, you may add environment variables as needed.

 ## NodeJS Setup
 * Install [nvm](https://github.com/nvm-sh/nvm?tab=readme-ov-file#installing-and-updating) using `curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash`
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -31,8 +31,6 @@ jobs:
        run: |
          touch .env
          echo CLIENT_TOKEN = ${{ secrets.BOT_TOKEN }} >> .env
-          echo MODEL = ${{ secrets.MODEL }} >> .env
-          echo CLIENT_UID = ${{ secrets.CLIENT_UID }} >> .env
          echo OLLAMA_IP = ${{ secrets.OLLAMA_IP }} >> .env
          echo OLLAMA_PORT = ${{ secrets.OLLAMA_PORT }} >> .env

@@ -59,8 +57,6 @@ jobs:
        run: |
          touch .env
          echo CLIENT_TOKEN = ${{ secrets.BOT_TOKEN }} >> .env
-          echo MODEL = ${{ secrets.MODEL }} >> .env
-          echo CLIENT_UID = ${{ secrets.CLIENT_UID }} >> .env
          echo OLLAMA_IP = ${{ secrets.OLLAMA_IP }} >> .env
          echo OLLAMA_PORT = ${{ secrets.OLLAMA_PORT }} >> .env

--- a/.github/workflows/coverage.yml
+++ b/.github/workflows/coverage.yml
@@ -0,0 +1,49 @@
+name: Coverage
+run-name: Code Coverage
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  Discord-Node-Coverage:
+    runs-on: ubuntu-latest
+    environment: coverage
+    timeout-minutes: 2
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: Set up Node Environment lts/hydrogen
+        uses: actions/setup-node@v4
+        with:
+          node-version: lts/hydrogen
+          cache: "npm"
+
+      - name: Install Project Dependencies
+        run: |
+          npm install
+
+      - name: Create Environment Variables
+        run: |
+          touch .env
+          echo CLIENT_TOKEN = ${{ secrets.BOT_TOKEN }} >> .env
+          echo OLLAMA_IP = ${{ secrets.OLLAMA_IP }} >> .env
+          echo OLLAMA_PORT = ${{ secrets.OLLAMA_PORT }} >> .env
+
+      - name: Collect Code Coverage
+        run: |
+          LINE_PCT=$(npm run test:coverage | tail -2 | head -1 | awk '{print $3}')
+          echo "COVERAGE=$LINE_PCT" >> $GITHUB_ENV
+      
+      - name: Upload Code Coverage
+        uses: schneegans/dynamic-badges-action@v1.7.0
+        with:
+          auth: ${{ secrets.GIST_SECRET }}
+          gistID: ${{ vars.GIST_ID }}
+          filename: coverage.json
+          label: Coverage
+          message: ${{ env.COVERAGE }}
+          valColorRange: ${{ env.COVERAGE }}
+          maxColorRange: 100
+          minColorRange: 0
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -24,8 +24,6 @@ jobs:
        run: |
          touch .env
          echo CLIENT_TOKEN = NOT_REAL_TOKEN >> .env
-          echo MODEL = ${{ secrets.MODEL }} >> .env
-          echo CLIENT_UID = ${{ secrets.CLIENT_UID }} >> .env
          echo OLLAMA_IP = ${{ secrets.OLLAMA_IP }} >> .env
          echo OLLAMA_PORT = ${{ secrets.OLLAMA_PORT }} >> .env

--- a/.github/workflows/test.yml
+++ b/.github/workflows/test.yml
@@ -39,8 +39,6 @@ jobs:
        run: |
          touch .env
          echo CLIENT_TOKEN = ${{ secrets.BOT_TOKEN }} >> .env
-          echo MODEL = ${{ secrets.MODEL }} >> .env
-          echo CLIENT_UID = ${{ secrets.CLIENT_UID }} >> .env
          echo OLLAMA_IP = ${{ secrets.OLLAMA_IP }} >> .env
          echo OLLAMA_PORT = ${{ secrets.OLLAMA_PORT }} >> .env

--- a/24
+++ b/24
@@ -0,0 +1,24 @@
+# The further along the ownership is, the more precedence it has.
+# This to make sure the right people look at certain changes.
+# Last Edited: 11/23/2024
+# Author: Kevin Dang
+
+# These owners will be the default owners 
+# for everything in the repo. However it's
+# only for the rest of the files not declared by the
+# following ownerships below.
+* @kevinthedang @JT2M0L3Y
+
+# Technical/Business Code Ownership
+/src/ @kevinthedang @JT2M0L3Y
+/tests/ @kevinthedang @JT2M0L3Y
+/.github/ @kevinthedang
+
+# Docker Ownership
+Dockerfile @kevinthedang
+docker-compose.yml @kevinthedang
+
+# Documentation Ownership
+/docs/ @kevinthedang
+/imgs/ @kevinthedang
+
--- a/README.md
+++ b/README.md
@@ -7,6 +7,7 @@
    <a href="#"></a><a href="https://github.com/kevinthedang/discord-ollama/actions/workflows/build.yml"><img alt="Build Status" src="https://github.com/kevinthedang/discord-ollama/actions/workflows/build.yml/badge.svg" /></a>
    <a href="#"></a><a href="https://github.com/kevinthedang/discord-ollama/actions/workflows/release.yml"><img alt="Release Status" src="https://github.com/kevinthedang/discord-ollama/actions/workflows/release.yml/badge.svg" /></a>
    <a href="#"></a><a href="https://github.com/kevinthedang/discord-ollama/actions/workflows/test.yml"><img alt="Testing Status" src="https://github.com/kevinthedang/discord-ollama/actions/workflows/test.yml/badge.svg" /></a>
+    <a href="#"></a><a href="https://github.com/kevinthedang/discord-ollama/actions/workflows/coverage.yml"><img alt="Code Coverage" src="https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/kevinthedang/bc7b5dcfa16561ab02bb3df67a99b22d/raw/coverage.json"></a>
 </div>

 ## About/Goals
@@ -24,12 +25,17 @@ The project aims to:
  * [x] User vs. Server Preferences
  * [ ] Redis Caching
  * [x] Administrator Role Compatible
-  * [x] Multi-User Chat Generation (Multiple users chatting at the same time) - This was built into from Ollama `v0.2.1+`
-  * [ ] Automatic and Manual model pulling through the Discord client
+  * [x] Multi-User Chat Generation (Multiple users chatting at the same time) - This was built in from Ollama `v0.2.1+`
+  * [x] Automatic and Manual model pulling through the Discord client
 * [ ] Allow others to create their own models personalized for their own servers!
  * [ ] Documentation on creating your own LLM
  * [ ] Documentation on web scrapping and cleaning

+## Documentation
+These are guides to the feature set included and the events triggered in this app.
+* [User Slash Commands](./docs/commands-guide.md)
+* [Client Events](./docs/events-guide.md)
+
 ## Environment Setup
 * Clone this repo using `git clone https://github.com/kevinthedang/discord-ollama.git` or just use [GitHub Desktop](https://desktop.github.com/) to clone the repo.
 * You will need a `.env` file in the root of the project directory with the bot's token. There is a `.env.sample` is provided for you as a reference for what environment variables.
@@ -40,6 +46,7 @@ The project aims to:
    * [Docker Setup for Servers and Local Machines](./docs/setup-docker.md)
        * Nvidia is recommended for now, but support for other GPUs should be development.
        * Local use is not recommended.
+
 ## Resources
 * [NodeJS](https://nodejs.org/en)
    * This project runs on `lts\hydrogen`. 
@@ -54,4 +61,4 @@ The project aims to:
 * [Kevin Dang](https://github.com/kevinthedang)
 * [Jonathan Smoley](https://github.com/JT2M0L3Y)

-[discord-ollama](https://github.com/kevinthedang/discord-ollama) © 2023 by [Kevin Dang](https://github.com/kevinthedang) is licensed under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)
+[discord-ollama](https://github.com/kevinthedang/discord-ollama) © 2023 by [Kevin Dang](https://github.com/kevinthedang) is licensed under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)
--- a/docker-compose.yml
+++ b/docker-compose.yml
@@ -7,11 +7,9 @@ services:
    build: ./                     # find docker file in designated path
    container_name: discord
    restart: always               # rebuild container always
-    image: kevinthedang/discord-ollama:0.5.11
+    image: kevinthedang/discord-ollama:0.7.3
    environment:
      CLIENT_TOKEN: ${CLIENT_TOKEN}
-      MODEL: ${MODEL}
-      CLIENT_UID: ${CLIENT_UID}
      OLLAMA_IP: ${OLLAMA_IP}
      OLLAMA_PORT: ${OLLAMA_PORT}
    networks:
--- a/docs/commands-guide.md
+++ b/docs/commands-guide.md
@@ -0,0 +1,105 @@
+## Commands Guide
+This is a guide to all of the slash commands for the app.
+
+* Action Commands are commands that do not affect a user's `preference file`.
+* Guild Commands can also be considered action commands.
+
+> [!NOTE]
+> Administrator commands are only usable by actual administrators on the Discord server.
+
+### Guild Commands (Administrator)
+1. Disable (or Toggle Chat)  
+    This command will `enable` or `disable` whether or not the app will respond to users.  
+
+    ```
+    /toggle-chat enabled true
+    ```
+
+2. Shutoff  
+    This command will shutoff the app so no users can converse with it.  
+    The app must be manually restarted upon being shutoff.
+
+    Below shuts off the app by putting `true` in the `are-your-sure` field.
+
+    ```
+    /shutoff are-you-sure true
+    ```
+
+### Action Commands
+1. Clear Channel (Message) History  
+    This command will clear the history of the current channel for the user that calls it.  
+    Running the command in any channel will clear the message history.
+
+    ```
+    /clear-user-channel-history
+    ```
+
+2. Pull Model  
+    This command will pull a model that exists on the [Ollama Model Library](https://ollama.com/library). If it does not exist there, it will throw a hissy fit.
+
+    Below trys to pull the `codellama` model.
+
+    ```
+    /pull-model model-to-pull codellama
+    ```
+
+3. Thread Create  
+    This command creates a public thread to talk with the app instead of using a `GuildText` channel.
+
+    ```
+    /thread
+    ```
+
+4. (Private) Thread Create  
+    This command creates a private thread to talk with the bot privately.  
+    Invite others to the channel and they will be able to talk to the app as well.
+
+    ```
+    /private-thread
+    ```
+
+### User Preference Commands
+1. Capacity  
+    This command changes how much context it will keep in conversations with the app.  
+    This is applied for all of existing chats when interacting with the app.  
+
+    Below sets the message history capacity to at most 5 messages at once.
+
+    ```
+    /modify-capacity context-capacity 5
+    ```
+
+2. Message Stream  
+    This command will toggle whether or not the app will "stream" a response.  
+    (think of how ChatGPT and other interfaces do this)
+
+    Below sets the `stream` to true to make the app respond in increments.
+
+    ```
+    /message-stream stream true
+    ```
+    > [!NOTE]
+    > This is a very slow progress on Discord because "spamming" changes within 5 seconds is not allowed.
+
+3. Message Style  
+    This command allows a user to select whether to embed the app's response. 
+
+    ```
+    /message-style embed true
+    ```
+
+    This allows the app to respond as a user would normally respond.
+
+    ```
+    /message-style embed false
+    ```
+
+4. Switch Model  
+    This command will switch the user-preferred model so long as it exists in within the local ollama service or from the [Ollama Model Library](https://ollama.com/library).  
+    If it cannot be found locally, it will attempt to find it in the model library.
+
+    Below we are trying to switch to a specific model size. 
+
+    ```
+    /switch-model model-to-use llama3.2:1.3b
+    ```
--- a/docs/events-guide.md
+++ b/docs/events-guide.md
@@ -0,0 +1,27 @@
+## Events Guide
+This is a guide to all of the client events for the app.
+
+> [!NOTE] Each of these is logged to the console for a developer to track.
+
+1. ClientReady  
+    This event signifies that the Discord app is online.  
+    Here the app's activity is set and its commands are registered.
+
+2. InteractionCreate  
+    This event signifies that a user interacted from Discord in some way.  
+    Here commands are selected from a knowledge bank and executed if found.
+
+    > [!NOTE] Possible interactions include commands, buttons, menus, etc.
+
+3. MessageCreate  
+    This event signifies that a message was sent.  
+    Here user questions and comments for the LLM are processed.  
+    1. check message is from a user and mentions the app
+    2. check for interaction preferences
+    3. add the message to a queue
+    4. check the response for success
+    5.  send a response back to the user.
+
+4. ThreadDelete  
+    This event signifies that a Discord Thread was deleted.  
+    Here any preferences set for interaction within the thread are cleared away.
--- a/docs/setup-discord-app.md
+++ b/docs/setup-discord-app.md
@@ -18,10 +18,6 @@

 ![Token](../imgs/tutorial/token.png)

-* You will also need your App's **Client ID**, navigate to **OAuth2** and copy your id.
-
-![Client Id](../imgs/tutorial/client-id.png)
-
 * That should be all of the environment variables needed from Discord, now we need this app on your server.
 * Navigate to **Installation** and Copy the provided **Install Link** to allow your App to your server.
 * You should set the **Guild Install** permissions as you like, for this purpose we will allow admin priviledges for now. Ensure the **bot** scope is added to do this.
--- a/docs/setup-docker.md
+++ b/docs/setup-docker.md
@@ -2,7 +2,9 @@
 * Follow this guide to setup [Docker](https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-on-ubuntu-20-04)
    * If on Windows, download [Docker Desktop](https://docs.docker.com/desktop/install/windows-install/) to get the docker engine.
 * Please also install [Docker Compose](https://docs.docker.com/compose/install/linux/) for easy running. If not, there are [scripts](#manual-run-with-docker) to set everything up.
-* **IMPORTANT NOTE**: Currently, it seems like wsl does not like Nvidia Container Toolkit. It will work initially then reset it for some odd reason. For now, it is advised to use an actually Linux machine to run using Docker. If you do not care about utilizing your GPU or don't even have a Nvidia GPU then disregard this.
+
+> [!IMPORTANT]  
+> Currently, it seems like wsl does not like Nvidia Container Toolkit. It will work initially then reset it for some odd reason. For now, it is advised to use an actually Linux machine to run using Docker. If you do not care about utilizing your GPU or don't even have a Nvidia GPU then disregard this.

 ## Nvidia Container Toolkit Setup
 ### Installation with Apt
@@ -48,8 +50,6 @@ sudo systemctl restart docker
    * `SUBNET_ADDRESS = 172.18.0.0`
    * Don't understand any of this? watch a Networking video to understand subnetting.
    * You also need all environment variables shown in [`.env.sample`](../.env.sample)
-* You will need a model in the container for this to work properly, on Docker Desktop go to the `Containers` tab, select the `ollama` container, and select `Exec` to run as root on your container. Now, run `ollama pull [model name]` to get your model.
-    * For Linux Servers, you need another shell to pull the model, or if you run `docker compose build && docker compose up -d`, then it will run in the background to keep your shell. Run `docker exec -it ollama bash` to get into the container and run the samme pull command above.
 * Otherwise, there is no need to install any npm packages for this, you just need to run `npm run start` to pull the containers and spin them up.
 * For cleaning up on Linux (or Windows), run the following commands:
    * `docker compose stop`
--- a/docs/setup-local.md
+++ b/docs/setup-local.md
@@ -11,14 +11,17 @@
 * You can now interact with the model you just ran (it might take a second to startup).
    * Response time varies with processing power!

+> [!NOTE]  
+> You can now pull models directly from the Discord client using `/pull-model <model-name>` or `/switch-model <model-name>`. They must exist from your local model library or from the [Ollama Model Library](https://ollama.com/library)
+
 ## To Run Locally (without Docker)
 * Run `npm install` to install the npm packages.
 * Ensure that your [.env](../.env.sample) file's `OLLAMA_IP` is `127.0.0.1` to work properly.
-    * You only need your `CLIENT_TOKEN`, `MODEL`, `CLIENT_UID`, `OLLAMA_IP`, `OLLAMA_PORT`.
+    * You only need your `CLIENT_TOKEN`, `OLLAMA_IP`, `OLLAMA_PORT`.
    * The ollama ip and port should just use it's defaults by nature. If not, utilize `OLLAMA_IP = 127.0.0.1` and `OLLAMA_PORT = 11434`.
 * Now, you can run the bot by running `npm run client` which will build and run the decompiled typescript and run the setup for ollama.
    * **IMPORTANT**: This must be ran in the wsl/Linux instance to work properly! Using Command Prompt/Powershell/Git Bash/etc. will not work on Windows (at least in my experience).
    * Refer to the [resources](../README.md#resources) on what node version to use.
 * If you are using wsl, open up a separate terminal/shell to startup the ollama service. Again, if you are running an older ollama, you must run `ollama serve` in that shell.
    * If you are on an actual Linux machine/VM there is no need for another terminal (unless you have an older ollama version).
-    * If you do not have a model, you will need to run `ollama pull [model name]` in a separate terminal to get it.
+    * If you do not have a model, you **can optionally** run `ollama pull [model name]` in wsl prior to application start. You are not required as it can be pulled from the Discord client.
--- a/package-lock.json
+++ b/package-lock.json
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
  "name": "discord-ollama",
-  "version": "0.5.11",
+  "version": "0.7.3",
  "description": "Ollama Integration into discord",
  "main": "build/index.js",
  "exports": "./build/index.js",
@@ -26,17 +26,17 @@
  "author": "Kevin Dang",
  "license": "ISC",
  "dependencies": {
-    "discord.js": "^14.15.3",
+    "discord.js": "^14.16.3",
    "dotenv": "^16.4.5",
-    "ollama": "^0.5.8"
+    "ollama": "^0.5.9"
  },
  "devDependencies": {
-    "@types/node": "^22.5.1",
-    "@vitest/coverage-v8": "^2.0.5",
+    "@types/node": "^22.9.0",
+    "@vitest/coverage-v8": "^2.1.4",
    "ts-node": "^10.9.2",
-    "tsx": "^4.19.0",
-    "typescript": "^5.5.4",
-    "vitest": "^2.0.5"
+    "tsx": "^4.19.2",
+    "typescript": "^5.6.3",
+    "vitest": "^2.1.4"
  },
  "type": "module",
  "engines": {
--- a/src/client.ts
+++ b/src/client.ts
@@ -1,10 +1,8 @@
 import { Client, GatewayIntentBits } from 'discord.js'
-import { UserMessage, registerEvents } from './utils/events.js'
-import Events from './events/index.js'
 import { Ollama } from 'ollama'
 import { Queue } from './queues/queue.js'
-
-// Import keys/tokens
+import { UserMessage, registerEvents } from './utils/index.js'
+import Events from './events/index.js'
 import Keys from './keys.js'


@@ -19,21 +17,15 @@ const client = new Client({
 });

 // initialize connection to ollama container
-const ollama = new Ollama({
+export const ollama = new Ollama({
    host: `http://${Keys.ipAddress}:${Keys.portAddress}`,
 })

 // Create Queue managed by Events
 const messageHistory: Queue<UserMessage> = new Queue<UserMessage>

-/**
- * register events for bot to listen to in discord
- * @param messageHistory message history for the llm
- * @param Events events to register
- * @param client the bot reference
- * @param Keys tokens from .env files
- */
-registerEvents(client, Events, messageHistory, Keys, ollama)
+// register all events
+registerEvents(client, Events, messageHistory, ollama)

 // Try to log in the client
 await client.login(Keys.clientToken)
@@ -45,5 +37,6 @@ await client.login(Keys.clientToken)
 // queue up bots name
 messageHistory.enqueue({
    role: 'assistant',
-    content: `My name is ${client.user?.username}`
+    content: `My name is ${client.user?.username}`,
+    images: []
 })
--- a/src/commands/capacity.ts
+++ b/src/commands/capacity.ts
@@ -1,16 +1,15 @@
-import { ChannelType, Client, CommandInteraction, ApplicationCommandOptionType } from 'discord.js'
-import { SlashCommand } from '../utils/commands.js'
-import { openConfig } from '../utils/index.js'
+import { Client, CommandInteraction, ApplicationCommandOptionType } from 'discord.js'
+import { openConfig, SlashCommand, UserCommand } from '../utils/index.js'

 export const Capacity: SlashCommand = {
    name: 'modify-capacity',
-    description: 'number of messages bot will hold for context.',
+    description: 'maximum amount messages bot will hold for context.',

    // set available user options to pass to the command
    options: [
        {
            name: 'context-capacity',
-            description: 'a number to set capacity',
+            description: 'number of allowed messages to remember',
            type: ApplicationCommandOptionType.Number,
            required: true
        }
@@ -20,13 +19,13 @@ export const Capacity: SlashCommand = {
    run: async (client: Client, interaction: CommandInteraction) => {
        // fetch channel and message
        const channel = await client.channels.fetch(interaction.channelId)
-        if (!channel || channel.type !== (ChannelType.PrivateThread && ChannelType.PublicThread && ChannelType.GuildText)) return
+        if (!channel || !UserCommand.includes(channel.type)) return

        // set state of bot chat features
        openConfig(`${interaction.user.username}-config.json`, interaction.commandName, interaction.options.get('context-capacity')?.value)

        interaction.reply({
-            content: `Message History Capacity has been set to \`${interaction.options.get('context-capacity')?.value}\``,
+            content: `Max message history is now set to \`${interaction.options.get('context-capacity')?.value}\``,
            ephemeral: true
        })
    }
--- a/src/commands/cleanUserChannelHistory.ts
+++ b/src/commands/cleanUserChannelHistory.ts
@@ -1,18 +1,17 @@
-import { ChannelType, Client, CommandInteraction, TextChannel } from 'discord.js'
-import { SlashCommand } from '../utils/commands.js'
-import { clearChannelInfo } from '../utils/index.js'
+import { Channel, Client, CommandInteraction, TextChannel } from 'discord.js'
+import { clearChannelInfo, SlashCommand, UserCommand } from '../utils/index.js'

 export const ClearUserChannelHistory: SlashCommand = {
    name: 'clear-user-channel-history',
-    description: 'clears history for user running this command in current channel',
+    description: 'clears history for user in the current channel',

    // Clear channel history for intended user
    run: async (client: Client, interaction: CommandInteraction) => {
        // fetch current channel
-        const channel = await client.channels.fetch(interaction.channelId)
+        const channel: Channel | null = await client.channels.fetch(interaction.channelId)

        // if not an existing channel or a GuildText, fail command
-        if (!channel || channel.type !== ChannelType.GuildText) return
+        if (!channel || !UserCommand.includes(channel.type)) return

        // clear channel info for user
        const successfulWipe = await clearChannelInfo(interaction.channelId, 
@@ -22,12 +21,12 @@ export const ClearUserChannelHistory: SlashCommand = {
        // check result of clearing history
        if (successfulWipe)
            interaction.reply({ 
-                content: `Channel history in **${channel.name}** cleared for **${interaction.user.username}**.`, 
+                content: `History cleared in **this channel** cleared for **${interaction.user.username}**.`, 
                ephemeral: true
            })
        else
            interaction.reply({ 
-                content: `Channel history could not be found for **${interaction.user.username}** in **${channel.name}**.\n\nPlease chat with **${client.user?.username}** to start a chat history.`, 
+                content: `History was not be found for **${interaction.user.username}** in **this channel**.\n\nPlease chat with **${client.user?.username}** to start a chat history.`, 
                ephemeral: true
            })
    }
--- a/src/commands/disable.ts
+++ b/src/commands/disable.ts
@@ -1,10 +1,9 @@
-import { ChannelType, Client, CommandInteraction, ApplicationCommandOptionType } from 'discord.js'
-import { SlashCommand } from '../utils/commands.js'
-import { openConfig } from '../utils/index.js'
+import { Client, CommandInteraction, ApplicationCommandOptionType } from 'discord.js'
+import { AdminCommand, openConfig, SlashCommand } from '../utils/index.js'

 export const Disable: SlashCommand = {
    name: 'toggle-chat',
-    description: 'toggle all chat features, Adminstrator Only.',
+    description: 'toggle all chat features. Adminstrator Only.',

    // set available user options to pass to the command
    options: [
@@ -20,12 +19,12 @@ export const Disable: SlashCommand = {
    run: async (client: Client, interaction: CommandInteraction) => {
        // fetch channel and message
        const channel = await client.channels.fetch(interaction.channelId)
-        if (!channel || channel.type !== ChannelType.GuildText) return
+        if (!channel || !AdminCommand.includes(channel.type)) return

        // check if runner is an admin
        if (!interaction.memberPermissions?.has('Administrator')) {
            interaction.reply({
-                content: `${interaction.commandName} is an Administrator Command.\n\nYou, ${interaction.member?.user.username}, are not an Administrator in this server.\nPlease contact an admin to use this command.`,
+                content: `${interaction.commandName} is an admin command.\n\nPlease contact an admin to use this command for you.`,
                ephemeral: true
            })
            return
@@ -35,7 +34,7 @@ export const Disable: SlashCommand = {
        openConfig(`${interaction.guildId}-config.json`, interaction.commandName, interaction.options.get('enabled')?.value)

        interaction.reply({
-            content: `Chat features has been \`${interaction.options.get('enabled')?.value ?  "enabled" : "disabled" }\``,
+            content: `${client.user?.username} is now **${interaction.options.get('enabled')?.value ?  "enabled" : "disabled" }**.`,
            ephemeral: true
        })
    }
--- a/src/commands/index.ts
+++ b/src/commands/index.ts
@@ -7,6 +7,8 @@ import { Shutoff } from './shutoff.js'
 import { Capacity } from './capacity.js'
 import { PrivateThreadCreate } from './threadPrivateCreate.js'
 import { ClearUserChannelHistory } from './cleanUserChannelHistory.js'
+import { PullModel } from './pullModel.js'
+import { SwitchModel } from './switchModel.js'

 export default [
    ThreadCreate,
@@ -16,5 +18,7 @@ export default [
    Disable,
    Shutoff,
    Capacity,
-    ClearUserChannelHistory
+    ClearUserChannelHistory,
+    PullModel,
+    SwitchModel
 ] as SlashCommand[]
--- a/src/commands/messageStream.ts
+++ b/src/commands/messageStream.ts
@@ -1,16 +1,15 @@
-import { ApplicationCommandOptionType, ChannelType, Client, CommandInteraction } from 'discord.js'
-import { SlashCommand } from '../utils/commands.js'
-import { openConfig } from '../utils/index.js'
+import { ApplicationCommandOptionType, Client, CommandInteraction } from 'discord.js'
+import { openConfig, SlashCommand, UserCommand } from '../utils/index.js'

 export const MessageStream: SlashCommand = {
    name: 'message-stream',
-    description: 'change preference on message streaming from ollama. WARNING: can be very slow.',
+    description: 'change preference on message streaming from ollama. WARNING: can be very slow due to Discord limits.',

    // user option(s) for setting stream
    options: [
        {
            name: 'stream',
-            description: 'enable or disable stream preference',
+            description: 'enable or disable message streaming',
            type: ApplicationCommandOptionType.Boolean,
            required: true
        }
@@ -20,13 +19,13 @@ export const MessageStream: SlashCommand = {
    run: async (client: Client, interaction: CommandInteraction) => {
        // verify channel
        const channel = await client.channels.fetch(interaction.channelId)
-        if (!channel || channel.type !== (ChannelType.PrivateThread && ChannelType.PublicThread && ChannelType.GuildText)) return
+        if (!channel || !UserCommand.includes(channel.type)) return

        // save value to json and write to it
        openConfig(`${interaction.user.username}-config.json`, interaction.commandName, interaction.options.get('stream')?.value)

        interaction.reply({
-            content: `Message streaming preferences set to: \`${interaction.options.get('stream')?.value}\``,
+            content: `Message streaming is now set to: \`${interaction.options.get('stream')?.value}\``,
            ephemeral: true
        })
    }
--- a/src/commands/messageStyle.ts
+++ b/src/commands/messageStyle.ts
@@ -1,6 +1,5 @@
-import { ChannelType, Client, CommandInteraction, ApplicationCommandOptionType } from 'discord.js'
-import { SlashCommand } from '../utils/commands.js'
-import { openConfig } from '../utils/index.js'
+import { Client, CommandInteraction, ApplicationCommandOptionType } from 'discord.js'
+import { openConfig, SlashCommand, UserCommand } from '../utils/index.js'

 export const MessageStyle: SlashCommand = {
    name: 'message-style',
@@ -20,7 +19,7 @@ export const MessageStyle: SlashCommand = {
    run: async (client: Client, interaction: CommandInteraction) => {
        // fetch channel and message
        const channel = await client.channels.fetch(interaction.channelId)
-        if (!channel || channel.type !== (ChannelType.PrivateThread && ChannelType.PublicThread && ChannelType.GuildText)) return
+        if (!channel || !UserCommand.includes(channel.type)) return

        // set the message style
        openConfig(`${interaction.user.username}-config.json`, interaction.commandName, interaction.options.get('embed')?.value)
--- a/src/commands/pullModel.ts
+++ b/src/commands/pullModel.ts
@@ -0,0 +1,70 @@
+import { ApplicationCommandOptionType, Client, CommandInteraction } from "discord.js";
+import { SlashCommand } from "../utils/commands.js";
+import { ollama } from "../client.js";
+import { ModelResponse } from "ollama";
+import { UserCommand } from "../utils/index.js";
+
+export const PullModel: SlashCommand = {
+    name: 'pull-model',
+    description: 'pulls a model from the ollama model library. Administrator Only',
+
+    // set available user options to pass to the command
+    options: [
+        {
+            name: 'model-to-pull',
+            description: 'the name of the model to pull',
+            type: ApplicationCommandOptionType.String,
+            required: true
+        }
+    ],
+
+    // Pull for model from Ollama library
+    run: async (client: Client, interaction: CommandInteraction) => {
+        // defer reply to avoid timeout
+        await interaction.deferReply()
+        const modelInput: string = interaction.options.get('model-to-pull')!!.value as string
+
+        // fetch channel and message
+        const channel = await client.channels.fetch(interaction.channelId)
+        if (!channel || !UserCommand.includes(channel.type)) return
+
+        // Admin Command
+        if (!interaction.memberPermissions?.has('Administrator')) {
+            interaction.reply({
+                content: `${interaction.commandName} is an admin command.\n\nPlease contact a server admin to pull the model you want.`,
+                ephemeral: true
+            })
+            return
+        }
+
+        // check if model was already pulled
+        const modelExists: boolean = await ollama.list()
+            .then(response => response.models.some((model: ModelResponse) => model.name.startsWith(modelInput)))
+
+        try {
+            // call ollama to pull desired model
+            if (!modelExists) {
+                interaction.editReply({
+                    content: `**${modelInput}** could not be found. Please wait patiently as I try to retrieve it...`
+                })
+                await ollama.pull({ model: modelInput })
+            }
+        } catch (error) {
+            // could not resolve pull or model unfound
+            interaction.editReply({
+                content: `Could not retrieve the **${modelInput}** model. You can find models at [Ollama Model Library](https://ollama.com/library).\n\nPlease check the model library and try again.`
+            })
+            return
+        }
+
+        // successful interaction
+        if (modelExists)
+            interaction.editReply({
+                content: `**${modelInput}** is already available.`
+            })
+        else
+            interaction.editReply({
+                content: `Successfully added **${modelInput}**.`
+            })
+    }
+}
--- a/src/commands/shutoff.ts
+++ b/src/commands/shutoff.ts
@@ -1,28 +1,19 @@
-import { ChannelType, Client, CommandInteraction, ApplicationCommandOptionType } from 'discord.js'
+import { Client, CommandInteraction, ApplicationCommandOptionType } from 'discord.js'
 import { SlashCommand } from '../utils/commands.js'
+import { AdminCommand } from '../utils/index.js'

 export const Shutoff: SlashCommand = {
    name: 'shutoff',
    description: 'shutdown the bot. You will need to manually bring it online again. Administrator Only.',

-    // set available user options to pass to the command
-    options: [
-        {
-            name: 'are-you-sure',
-            description: 'true = yes, false = I\'m scared',
-            type: ApplicationCommandOptionType.Boolean,
-            required: true
-        }
-    ],
-
    // Query for message information and set the style
    run: async (client: Client, interaction: CommandInteraction) => {
        // fetch channel and message
        const channel = await client.channels.fetch(interaction.channelId)
-        if (!channel || channel.type !== ChannelType.GuildText) return
+        if (!channel || !AdminCommand.includes(channel.type)) return

        // log this, this will probably be improtant for logging who did this
-        console.log(`User -> ${interaction.user.tag} attempting to shutdown ${client.user!!.tag}`)
+        console.log(`[Command: shutoff] User ${interaction.user.tag} attempting to shutdown ${client.user!!.tag}`)

        // check if admin or false on shutdown
        if (!interaction.memberPermissions?.has('Administrator')) {
@@ -31,19 +22,14 @@ export const Shutoff: SlashCommand = {
                ephemeral: true
            })
            return // stop from shutting down
-        } else if (!interaction.options.get('are-you-sure')?.value) {
-            interaction.reply({
-                content: `**Shutdown Aborted:**\n\n${interaction.user.tag}, You didn't want to shutoff **${client.user?.tag}**.`,
-                ephemeral: true
-            })
-            return // chickened out
        }

        // Shutoff cleared, do it
        interaction.reply({
-            content: `${client.user?.tag} is ${interaction.options.get('are-you-sure')?.value ?  "shutting down now." : "not shutting down." }`,
+            content: `${client.user?.tag} is shutting down.`,
            ephemeral: true
        })
+        console.log(`[Command: shutoff] ${client.user?.tag} is shutting down.`)

        // clean up client instance and stop
        client.destroy()
--- a/src/commands/switchModel.ts
+++ b/src/commands/switchModel.ts
@@ -0,0 +1,68 @@
+import { ApplicationCommandOptionType, Client, CommandInteraction } from "discord.js";
+import { SlashCommand } from "../utils/commands.js";
+import { ollama } from "../client.js";
+import { ModelResponse } from "ollama";
+import { openConfig, UserCommand } from "../utils/index.js";
+
+export const SwitchModel: SlashCommand = {
+    name: 'switch-model',
+    description: 'switches current model to use.',
+
+    // set available user options to pass to the command
+    options: [
+        {
+            name: 'model-to-use',
+            description: 'the name of the model to use',
+            type: ApplicationCommandOptionType.String,
+            required: true
+        }
+    ],
+
+    // Switch user preferred model if available in local library
+    run: async (client: Client, interaction: CommandInteraction) => {
+        await interaction.deferReply()
+
+        const modelInput: string = interaction.options.get('model-to-use')!!.value as string
+
+        // fetch channel and message
+        const channel = await client.channels.fetch(interaction.channelId)
+        if (!channel || !UserCommand.includes(channel.type)) return
+
+        try {
+            // Phase 1: Switch to the model
+            let switchSuccess = false
+            await ollama.list()
+            .then(response => {
+                for (const model in response.models) {
+                    const currentModel: ModelResponse = response.models[model]
+                    if (currentModel.name.startsWith(modelInput)) {
+                        openConfig(`${interaction.user.username}-config.json`, interaction.commandName, modelInput)
+
+                        // successful switch
+                        interaction.editReply({
+                            content: `Successfully switched to **${modelInput}** as the preferred model for ${interaction.user.username}.`
+                        })
+                        switchSuccess = true
+                    }
+                }
+            })
+            // todo: problem can be here if async messes up
+            if (switchSuccess) {
+                // set model now that it exists
+                openConfig(`${interaction.user.username}-config.json`, interaction.commandName, modelInput)
+                return
+            }
+
+            // Phase 2: Notify user of failure to find model.
+            interaction.editReply({
+                content: `Could not find **${modelInput}** in local model library.\n\nPlease contact an server admin for access to this model.`
+            })  
+        } catch (error) {
+            // could not resolve user model switch
+            interaction.editReply({
+                content: `Unable to switch user preferred model to **${modelInput}**.\n\n${error}\n\nPossible solution is to request an server admin run \`/pull-model ${modelInput}\` and try again.`
+            })
+            return
+        }
+    }
+}
--- a/src/commands/threadCreate.ts
+++ b/src/commands/threadCreate.ts
@@ -1,6 +1,5 @@
 import { ChannelType, Client, CommandInteraction, TextChannel, ThreadChannel } from 'discord.js'
-import { SlashCommand } from '../utils/commands.js'
-import { openChannelInfo } from '../utils/index.js'
+import { AdminCommand, openChannelInfo, SlashCommand } from '../utils/index.js'

 export const ThreadCreate: SlashCommand = {
    name: 'thread',
@@ -10,7 +9,7 @@ export const ThreadCreate: SlashCommand = {
    run: async (client: Client, interaction: CommandInteraction) => {
        // fetch the channel
        const channel = await client.channels.fetch(interaction.channelId)
-        if (!channel || channel.type !== ChannelType.GuildText) return
+        if (!channel || !AdminCommand.includes(channel.type)) return

        const thread = await (channel as TextChannel).threads.create({
            name: `${client.user?.username}-support-${Date.now()}`,
@@ -19,7 +18,7 @@ export const ThreadCreate: SlashCommand = {
        })

        // Send a message in the thread
-        thread.send(`Hello ${interaction.user} and others! \n\nIt's nice to meet you. Please talk to me by typing **@${client.user?.username}** with your prompt.`)
+        thread.send(`Hello ${interaction.user} and others! \n\nIt's nice to meet you. Please talk to me by typing **@${client.user?.username}** with your message.`)

        // handle storing this chat channel
        openChannelInfo(thread.id, 
@@ -28,7 +27,7 @@ export const ThreadCreate: SlashCommand = {

        // user only reply
        return interaction.reply({
-            content: `I can help you in thread **${thread.id}** below.`,
+            content: `I can help you in <#${thread.id}> below.`,
            ephemeral: true
        })
    }
--- a/src/commands/threadPrivateCreate.ts
+++ b/src/commands/threadPrivateCreate.ts
@@ -1,6 +1,5 @@
 import { ChannelType, Client, CommandInteraction, TextChannel, ThreadChannel } from 'discord.js'
-import { SlashCommand } from '../utils/commands.js'
-import { openChannelInfo } from '../utils/index.js'
+import { AdminCommand, openChannelInfo, SlashCommand } from '../utils/index.js'

 export const PrivateThreadCreate: SlashCommand = {
    name: 'private-thread',
@@ -10,7 +9,7 @@ export const PrivateThreadCreate: SlashCommand = {
    run: async (client: Client, interaction: CommandInteraction) => {
        // fetch the channel
        const channel = await client.channels.fetch(interaction.channelId)
-        if (!channel || channel.type !== ChannelType.GuildText) return
+        if (!channel || !AdminCommand.includes(channel.type)) return

        const thread = await (channel as TextChannel).threads.create({
            name: `${client.user?.username}-private-support-${Date.now()}`,
@@ -30,7 +29,7 @@ export const PrivateThreadCreate: SlashCommand = {

        // user only reply
        return interaction.reply({
-            content: `I can help you in thread **${thread.id}**. Please refer to the private channel below this one.`,
+            content: `I can help you in <#${thread.id}>.`,
            ephemeral: true
        })
    }
--- a/src/events/messageCreate.ts
+++ b/src/events/messageCreate.ts
@@ -1,7 +1,6 @@
-import { embedMessage, event, Events, normalMessage, UserMessage } from '../utils/index.js'
-import { getChannelInfo, getServerConfig, getUserConfig, openChannelInfo, openConfig, ServerConfig, UserConfig } from '../utils/index.js'
-import { clean } from '../utils/mentionClean.js'
 import { TextChannel } from 'discord.js'
+import { embedMessage, event, Events, normalMessage, UserMessage, clean } from '../utils/index.js'
+import { getChannelInfo, getServerConfig, getUserConfig, openChannelInfo, openConfig, UserConfig, getAttachmentData } from '../utils/index.js'

 /** 
 * Max Message length for free users is 2000 characters (bot or not).
@@ -9,14 +8,16 @@ import { TextChannel } from 'discord.js'
 * 
 * @param message the message received from the channel
 */
-export default event(Events.MessageCreate, async ({ log, msgHist, tokens, ollama }, message) => {
-    log(`Message \"${clean(message.content)}\" from ${message.author.tag} in channel/thread ${message.channelId}.`)
+export default event(Events.MessageCreate, async ({ log, msgHist, ollama, client }, message) => {
+    const clientId = client.user!!.id
+    const cleanedMessage = clean(message.content, clientId)
+    log(`Message \"${cleanedMessage}\" from ${message.author.tag} in channel/thread ${message.channelId}.`)

    // Do not respond if bot talks in the chat
    if (message.author.username === message.client.user.username) return

    // Only respond if message mentions the bot
-    if (!message.mentions.has(tokens.clientUid)) return
+    if (!message.mentions.has(clientId)) return

    // default stream to false
    let shouldStream = false
@@ -48,7 +49,7 @@ export default event(Events.MessageCreate, async ({ log, msgHist, tokens, ollama
            getUserConfig(`${message.author.username}-config.json`, (config) => {
                if (config === undefined) {
                    openConfig(`${message.author.username}-config.json`, 'message-style', false)
-                    reject(new Error('No User Preferences is set up.\n\nCreating preferences file with \`message-style\` set as \`false\` for regular messages.\nPlease try chatting again.'))
+                    reject(new Error('No User Preferences is set up.\n\nCreating preferences file with \`message-style\` set as \`false\` for regular message style.\nPlease try chatting again.'))
                    return
                }
    
@@ -64,6 +65,9 @@ export default event(Events.MessageCreate, async ({ log, msgHist, tokens, ollama
    
                // set stream state
                shouldStream = config.options['message-stream'] as boolean || false
+
+                if (typeof config.options['switch-model'] !== 'string')
+                    reject(new Error(`No Model was set. Please set a model by running \`/switch-model <model of choice>\`.\n\nIf you do not have any models. Run \`/pull-model <model name>\`.`))
    
                resolve(config)
            })
@@ -102,6 +106,10 @@ export default event(Events.MessageCreate, async ({ log, msgHist, tokens, ollama
        // response string for ollama to put its response
        let response: string

+        // get message attachment if exists
+        const messageAttachment: string[] = await getAttachmentData(message.attachments.first())
+        const model: string = userConfig.options['switch-model']
+
        // set up new queue
        msgHist.setQueue(chatMessages)

@@ -111,14 +119,15 @@ export default event(Events.MessageCreate, async ({ log, msgHist, tokens, ollama
        // push user response before ollama query
        msgHist.enqueue({
            role: 'user',
-            content: clean(message.content)
+            content: cleanedMessage,
+            images: messageAttachment || []
        })
        
        // undefined or false, use normal, otherwise use embed
        if (userConfig.options['message-style'])
-            response = await embedMessage(message, ollama, tokens, msgHist, shouldStream)
+            response = await embedMessage(message, ollama, model, msgHist, shouldStream)
        else
-            response = await normalMessage(message, ollama, tokens, msgHist, shouldStream)
+            response = await normalMessage(message, ollama, model, msgHist, shouldStream)

        // If something bad happened, remove user query and stop
        if (response == undefined) { msgHist.pop(); return }
@@ -129,7 +138,8 @@ export default event(Events.MessageCreate, async ({ log, msgHist, tokens, ollama
        // successful query, save it in context history
        msgHist.enqueue({ 
            role: 'assistant', 
-            content: response
+            content: response,
+            images: messageAttachment || []
        })

        // only update the json on success
--- a/src/events/ready.ts
+++ b/src/events/ready.ts
@@ -1,5 +1,5 @@
-import { event, Events, registerCommands } from '../utils/index.js'
 import { ActivityType } from 'discord.js'
+import { event, Events, registerCommands } from '../utils/index.js'
 import commands from '../commands/index.js'

 // Log when the bot successfully logs in and export it
--- a/src/keys.ts
+++ b/src/keys.ts
@@ -1,11 +1,9 @@
-import { getEnvVar } from './utils/env.js'
+import { getEnvVar } from './utils/index.js'

 export const Keys = {
    clientToken: getEnvVar('CLIENT_TOKEN'),
-    model: getEnvVar('MODEL'),
-    clientUid: getEnvVar('CLIENT_UID'),
-    ipAddress: getEnvVar('OLLAMA_IP'),
-    portAddress: getEnvVar('OLLAMA_PORT'),
+    ipAddress: getEnvVar('OLLAMA_IP', '127.0.0.1'), // default ollama ip if none
+    portAddress: getEnvVar('OLLAMA_PORT', '11434'), // default ollama port if none
 } as const // readonly keys

 export default Keys
--- a/src/utils/configInterfaces.ts
+++ b/src/utils/configInterfaces.ts
@@ -1,9 +1,11 @@
-import { UserMessage } from './events.js'
+import { ChannelType } from 'discord.js'
+import { UserMessage } from './index.js'

 export interface UserConfiguration {
    'message-stream'?: boolean,
    'message-style'?: boolean,
-    'modify-capacity': number
+    'modify-capacity': number,
+    'switch-model': string
 }

 export interface ServerConfiguration {
@@ -41,6 +43,21 @@ export interface Channel {
    messages: UserMessage[]
 }

+/**
+ * The following 2 types is allow for better readability in commands
+ * Admin Command -> Don't run in Threads
+ * User Command -> Used anywhere
+ */
+export const AdminCommand = [
+    ChannelType.GuildText
+]
+
+export const UserCommand = [
+    ChannelType.GuildText,
+    ChannelType.PublicThread,
+    ChannelType.PrivateThread
+]
+
 /**
 * Check if the configuration we are editing/taking from is a Server Config
 * @param key name of command we ran
--- a/src/utils/env.ts
+++ b/src/utils/env.ts
@@ -1,21 +1,35 @@
 import { resolve } from 'path'
 import { config } from 'dotenv'

-// Find config - ONLY WORKS WITH NODEMON
-const envFile = process.env.NODE_ENV === 'development' ? '.env.dev.local' : '.env'
-
 // resolve config file
-const envFilePath = resolve(process.cwd(), envFile)
+const envFilePath = resolve(process.cwd(), '.env')
+const ipValidate: RegExp = /^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)\.?\b){4}$/

 // set current environment variable file
 config({ path: envFilePath })

-// Getter for environment variables
+/**
+ * Method to validate if environment variables found in file utils/env.ts
+ * 
+ * @param name Name of the environment variable in .env
+ * @param fallback fallback value to set if environment variable is not set (used manually in src/keys.ts)
+ * @returns environment variable value
+ */
 export function getEnvVar(name: string, fallback?: string): string {
    const value = process.env[name] ?? fallback
-    if (value == undefined)
+    if (!value)
        throw new Error(`Environment variable ${name} is not set.`)

+    // validate User-Generated Discord Application Tokens 
+    if (name === "CLIENT_TOKEN")
+        if (value.length < 72) throw new Error(`The "CLIENT_TOKEN" provided is not of at least length 72. 
+            This is probably an invalid token unless Discord updated their token policy. Please provide a valid token.`)
+
+    // validate IPv4 address found in environment variables
+    if (name.endsWith("_IP") || name.endsWith("_ADDRESS"))
+        if (!ipValidate.test(value))
+            throw new Error(`Environment variable ${name} does not follow IPv4 formatting.`)
+
    // return env variable
    return value
 }
--- a/src/utils/events.ts
+++ b/src/utils/events.ts
@@ -1,4 +1,4 @@
-import type { ClientEvents, Awaitable, Client, User } from 'discord.js'
+import type { ClientEvents, Awaitable, Client } from 'discord.js'
 import { Ollama } from 'ollama'
 import { Queue } from '../queues/queue.js'

@@ -8,17 +8,6 @@ export { Events } from 'discord.js'
 export type LogMethod = (...args: unknown[]) => void
 export type EventKeys = keyof ClientEvents // only wants keys of ClientEvents object

-/**
- * Tokens to run the bot as intended
- * @param channel the channel where the bot will respond to queries
- * @param model chosen model for the ollama to utilize
- * @param clientUid the discord id for the bot
- */
-export type Tokens = {
-    model: string,
-    clientUid: string
-}
-
 /**
 * Parameters to run the chat query
 * @param model the model to run
@@ -38,7 +27,8 @@ export type ChatParams = {
 */
 export type UserMessage = {
    role: string,
-    content: string
+    content: string,
+    images: string[] // May or may not have images in message
 }

 // Event properties
@@ -46,7 +36,6 @@ export interface EventProps {
    client: Client
    log: LogMethod
    msgHist: Queue<UserMessage>
-    tokens: Tokens,
    ollama: Ollama
 }
 export type EventCallback<T extends EventKeys> = (
@@ -69,14 +58,12 @@ export function event<T extends EventKeys>(key: T, callback: EventCallback<T>):
 * @param client initialized bot client
 * @param events all the exported events from the index.ts in the events dir
 * @param msgHist The message history of the bot
- * @param tokens the passed in environment tokens for the service
 * @param ollama the initialized ollama instance
 */
 export function registerEvents(
    client: Client, 
    events: Event[], 
    msgHist: Queue<UserMessage>,
-    tokens: Tokens,
    ollama: Ollama
 ): void {
    for (const { key, callback } of events) {
@@ -86,7 +73,7 @@ export function registerEvents(

            // Handle Errors, call callback, log errors as needed
            try {
-                callback({ client, log, msgHist, tokens, ollama }, ...args)
+                callback({ client, log, msgHist, ollama }, ...args)
            } catch (error) {
                log('[Uncaught Error]', error)
            }
--- a/src/utils/handlers/bufferHandler.ts
+++ b/src/utils/handlers/bufferHandler.ts
@@ -0,0 +1,57 @@
+import { Attachment } from "discord.js"
+
+/**
+ * Method to convert a Discord attachment url to an array buffer
+ * 
+ * @param url Discord Attachment Url
+ * @returns array buffer from Attachment Url
+ */
+async function getAttachmentBuffer(url: string): Promise<ArrayBuffer> {
+    // Get the data from the image
+    const response = await fetch(url)
+
+    // Validate the image came in fine
+    if (!response.ok)
+        throw new Error('Failed to fetch the attachment.')
+
+    // Return image as Buffer
+    return await response.arrayBuffer()
+}
+
+/**
+ * Method to convert an array buffer to a Base64 String
+ * 
+ * @param buffer Array Buffer from attachment
+ * @returns converted Base64 string
+ */
+function arrayBufferToBase64(buffer: ArrayBuffer): string {
+    // Converting to Uint8Array
+    const uint8Array = new Uint8Array(buffer)
+    let binary = ''
+    const len = uint8Array.byteLength;
+    for (let i = 0; i < len; i++) {
+        binary += String.fromCharCode(uint8Array[i])
+    }
+
+    // Return as Base64
+    return Buffer.from(binary, 'binary').toString('base64')
+}
+
+/**
+ * Method to retrieve the Base64 Array of provided Message Attachment
+ * 
+ * @param attachment Message Attachment from Discord
+ * @returns Base64 string array
+ */
+export async function getAttachmentData(attachment: Attachment | undefined): Promise<string[]> {
+    const url: string = attachment !== undefined ? attachment.url : "Missing Url"
+
+    // case of no attachment
+    if (url === "Missing Url")
+        return []
+
+    // Convert data to base64
+    const buffer = await getAttachmentBuffer(url)
+    const base64String = arrayBufferToBase64(buffer)
+    return [base64String]
+}
--- a/src/utils/handlers/chatHistoryHandler.ts
+++ b/src/utils/handlers/chatHistoryHandler.ts
@@ -53,7 +53,6 @@ export async function clearChannelInfo(filename: string, channel: TextChannel, u
            }
        })
    })
-    console.log(cleanedHistory)
    return cleanedHistory
 }

--- a/src/utils/index.ts
+++ b/src/utils/index.ts
@@ -5,8 +5,10 @@ export * from './messageEmbed.js'
 export * from './messageNormal.js'
 export * from './commands.js'
 export * from './configInterfaces.js'
+export * from './mentionClean.js'

 // handler imports
 export * from './handlers/chatHistoryHandler.js'
 export * from './handlers/configHandler.js'
 export * from './handlers/streamHandler.js'
+export * from './handlers/bufferHandler.js'
--- a/src/utils/mentionClean.ts
+++ b/src/utils/mentionClean.ts
@@ -8,9 +8,9 @@ import Keys from "../keys.js"
 *  - replace function works well for this
 * 
 * @param message 
- * @returns 
+ * @returns message without client id
 */
-export function clean(message: string): string {
-    const cleanedMessage: string = message.replace(`<@${Keys.clientUid}>`, '').trim()
+export function clean(message: string, clientId: string): string {
+    const cleanedMessage: string = message.replace(`<@${clientId}>`, '').trim()
    return cleanedMessage
 }
--- a/src/utils/messageEmbed.ts
+++ b/src/utils/messageEmbed.ts
@@ -1,4 +1,4 @@
-import { EmbedBuilder, Message } from 'discord.js'
+import { EmbedBuilder, Message, SendableChannels } from 'discord.js'
 import { ChatResponse, Ollama } from 'ollama'
 import { ChatParams, UserMessage, streamResponse, blockResponse } from './index.js'
 import { Queue } from '../queues/queue.js'
@@ -7,15 +7,13 @@ import { AbortableAsyncIterator } from 'ollama/src/utils.js'
 /**
 * Method to send replies as normal text on discord like any other user
 * @param message message sent by the user
- * @param tokens tokens to run query
+ * @param model name of model to run query
 * @param msgHist message history between user and model
 */
 export async function embedMessage(
    message: Message,
    ollama: Ollama,
-    tokens: {
-        model: string
-    },
+    model: string,
    msgHist: Queue<UserMessage>,
    stream: boolean
 ): Promise<string> {
@@ -30,11 +28,12 @@ export async function embedMessage(
    .setColor('#00FF00')

    // send the message
-    const sentMessage = await message.channel.send({ embeds: [botMessage] })
+    const channel = message.channel as SendableChannels
+    const sentMessage = await channel.send({ embeds: [botMessage] })

    // create params
    const params: ChatParams = {
-        model: tokens.model,
+        model: model,
        ollama: ollama,
        msgHist: msgHist.getItems()
    }
@@ -50,12 +49,12 @@ export async function embedMessage(
                // exceeds handled length
                if (result.length > 5000) {
                    const errorEmbed = new EmbedBuilder()
-                    .setTitle(`Responding to ${message.author.tag}`)
-                    .setDescription(`Response length ${result.length} has exceeded Discord maximum.\n\nLong Stream messages not supported.`)
-                    .setColor('#00FF00')
+                        .setTitle(`Responding to ${message.author.tag}`)
+                        .setDescription(`Response length ${result.length} has exceeded Discord maximum.\n\nLong Stream messages not supported.`)
+                        .setColor('#00FF00')

                    // send error
-                    message.channel.send({ embeds: [errorEmbed] })
+                    channel.send({ embeds: [errorEmbed] })
                    break // cancel loop and stop
                }

@@ -92,7 +91,7 @@ export async function embedMessage(
                    .setDescription(result.slice(0, 5000) || 'No Content to Provide...')
                    .setColor('#00FF00')

-                    message.channel.send({ embeds: [whileEmbed] })
+                    channel.send({ embeds: [whileEmbed] })
                    result = result.slice(5000)
                }

@@ -102,7 +101,7 @@ export async function embedMessage(
                .setColor('#00FF00')

                // rest of the response
-                message.channel.send({ embeds: [lastEmbed] })
+                channel.send({ embeds: [lastEmbed] })
            } else {
                // only need to create 1 embed, handles 6000 characters
                const newEmbed = new EmbedBuilder()
--- a/src/utils/messageNormal.ts
+++ b/src/utils/messageNormal.ts
@@ -1,4 +1,4 @@
-import { Message } from 'discord.js'
+import { Message, SendableChannels } from 'discord.js'
 import { ChatResponse, Ollama } from 'ollama'
 import { ChatParams, UserMessage, streamResponse, blockResponse } from './index.js'
 import { Queue } from '../queues/queue.js'
@@ -7,26 +7,25 @@ import { AbortableAsyncIterator } from 'ollama/src/utils.js'
 /**
 * Method to send replies as normal text on discord like any other user
 * @param message message sent by the user
- * @param tokens tokens to run query
+ * @param model name of model to run query
 * @param msgHist message history between user and model
 */
 export async function normalMessage(
    message: Message,
    ollama: Ollama,
-    tokens: {
-        model: string
-    },
+    model: string,
    msgHist: Queue<UserMessage>,
    stream: boolean
 ): Promise<string> {
    // bot's respnse
    let response: ChatResponse | AbortableAsyncIterator<ChatResponse>
    let result: string = ''
+    const channel = message.channel as SendableChannels

-    await message.channel.send('Generating Response . . .').then(async sentMessage => {
+    await channel.send('Generating Response . . .').then(async sentMessage => {
        try {
            const params: ChatParams = {
-                model: tokens.model,
+                model: model,
                ollama: ollama,
                msgHist: msgHist.getItems()
            } 
@@ -41,7 +40,7 @@ export async function normalMessage(
                        result = portion.message.content

                        // new message block, wait for it to send and assign new block to respond.
-                        await message.channel.send("Creating new stream block...").then(sentMessage => { messageBlock = sentMessage })
+                        await channel.send("Creating new stream block...").then(sentMessage => { messageBlock = sentMessage })
                    } else {
                        result += portion.message.content
                        
@@ -63,12 +62,12 @@ export async function normalMessage(

                    // handle for rest of message that is >2000
                    while (result.length > 2000) {
-                        message.channel.send(result.slice(0, 2000))
+                        channel.send(result.slice(0, 2000))
                        result = result.slice(2000)
                    }

                    // last part of message
-                    message.channel.send(result)
+                    channel.send(result)
                } else // edit the 'generic' response to new message since <2000
                    sentMessage.edit(result)
            }            
--- a/tests/commands.test.ts
+++ b/tests/commands.test.ts
@@ -2,7 +2,7 @@
 // expect takes a value from an expression
 // it marks a test case
 import { describe, expect, it } from 'vitest'
-import commands from '../src/commands'
+import commands from '../src/commands/index.js'

 /**
 * Commands test suite, tests the commands object
@@ -12,7 +12,7 @@ import commands from '../src/commands'
 * @param name name of the test suite
 * @param fn function holding tests to run
 */
-describe('#commands', () => {
+describe('Commands Existence', () => {
    // test definition of commands object
    it('references defined object', () => {
        // toBe compares the value to the expected value
@@ -22,6 +22,51 @@ describe('#commands', () => {
    // test specific commands in the object
    it('references specific commands', () => {
        const commandsString = commands.map(e => e.name).join(', ')
-        expect(commandsString).toBe('thread, private-thread, message-style, message-stream, toggle-chat, shutoff, modify-capacity, clear-user-channel-history')
+        expect(commandsString).toBe('thread, private-thread, message-style, message-stream, toggle-chat, shutoff, modify-capacity, clear-user-channel-history, pull-model, switch-model')
+    })
+})
+
+/**
+ * User Commands Test suite for testing out commands
+ * that would be run by users when using the application.
+ */
+describe('User Command Tests', () => {
+    // test capacity command
+    it('run modify-capacity command', () => {
+
+    })
+
+    it('run clear-user-channel-history command', () => {
+        
+    })
+
+    it('run message-stream command', () => {
+        
+    })
+
+    it('run message-style command', () => {
+        
+    })
+    
+    it('run thread command', () => {
+        
+    })
+
+    it('run private-thread command', () => {
+        
+    })
+})
+
+/**
+ * Admin Commands Test suite for running administrative 
+ * commands with the application.
+ */
+describe('Admin Command Tests', () => {
+    it('run shutoff command', () => {
+        
+    })
+
+    it('run toggle-chat command', () => {
+        
    })
 })
--- a/tests/events.test.ts
+++ b/tests/events.test.ts
@@ -1,15 +1,23 @@
-import { describe, expect, it } from 'vitest'
-import events from '../src/events'
+import { describe, expect, it, vi } from 'vitest'
+import events from '../src/events/index.js'
+
+/**
+ * Mocking ollama found in client.ts because pullModel.ts
+ * relies on the existence on ollama. To prevent the mock,
+ * we will have to pass through ollama to the commands somehow.
+ */
+vi.mock('../src/client.js', () => ({
+    ollama: {
+        pull: vi.fn() // Mock the pull method found with ollama
+    }
+}))

 /**
 * Events test suite, tests the events object
 * Each event is to be tested elsewhere, this file
 * is to ensure that the events object is defined.
- * 
- * @param name name of the test suite
- * @param fn function holding tests to run
 */
-describe('#events', () => {
+describe('Events Existence', () => {
    // test definition of events object
    it('references defined object', () => {
        expect(typeof events).toBe('object')
--- a/tests/getEnvVar.test.ts
+++ b/tests/getEnvVar.test.ts
@@ -1,5 +1,5 @@
 import { describe, expect, it } from 'vitest'
-import { getEnvVar } from '../src/utils'
+import { getEnvVar } from '../src/utils/index.js'

 /**
 * getEnvVar test suite, tests the getEnvVar function
@@ -7,7 +7,7 @@ import { getEnvVar } from '../src/utils'
 * @param name name of the test suite
 * @param fn function holding tests to run
 */
-describe('#getEnvVar', () => {
+describe('Environment Setup', () => {
    // dummy set of keys
    const keys = {
        clientToken: 'CLIENT_TOKEN',
--- a/tests/mentionClean.test.ts
+++ b/tests/mentionClean.test.ts
@@ -1,6 +1,8 @@
 import { describe, expect, it } from 'vitest'
-import { clean } from '../src/utils/mentionClean'
-import { getEnvVar } from '../src/utils'
+import { clean } from '../src/utils/index.js'
+
+// Sample UID for testing
+const sampleId = '123456789'

 /**
 * MentionClean test suite, tests the clean function
@@ -8,10 +10,10 @@ import { getEnvVar } from '../src/utils'
 * @param name name of the test suite
 * @param fn function holding tests to run
 */
-describe('#clean', () => {
+describe('Mentions Cleaned', () => {
    // test for id removal from message
    it('removes the mention from a message', () => {
-        const message = `<@${getEnvVar('CLIENT_UID')}> Hello, World!`
-        expect(clean(message)).toBe('Hello, World!')
+        const message = `<@${sampleId}> Hello, World!`
+        expect(clean(message, sampleId)).toBe('Hello, World!')
    })
 })
--- a/tests/queue.test.ts
+++ b/tests/queue.test.ts
@@ -1,5 +1,5 @@
 import { describe, expect, it } from 'vitest'
-import { Queue } from '../src/queues/queue'
+import { Queue } from '../src/queues/queue.js'

 /**
 * Queue test suite, tests the Queue class
@@ -7,7 +7,7 @@ import { Queue } from '../src/queues/queue'
 * @param name name of the test suite
 * @param fn function holding tests to run
 */
-describe('#queue', () => {
+describe('Queue Structure', () => {
    let queue= new Queue<string>()

    // test for queue creation
--- a/vitest.config.ts
+++ b/vitest.config.ts
@@ -4,9 +4,10 @@ import { defineConfig, configDefaults } from 'vitest/config'
 export default defineConfig({
    test: {
        globals: true, // <-- reduces test file imports
+        reporters: ['verbose'], // <-- verbose output
        coverage: {
            exclude: [...configDefaults.exclude, 'build/*', 'tests/*'], // <-- exclude JS build
-            reporter: ['text', 'html'] // <-- reports in text, html
+            reporter: ['text-summary'] // <-- report in text-summary
        }
    }
 })
Author	SHA1	Message	Date
Kevin Dang	d570a50d46	Pull and Switch Model Revised (#142 ) * Update: pull-model only runnable by admins now * Update: switch-model cannot pull models anymore * Update: less technical responses * Update: version increment	2024-12-04 21:29:01 -08:00
Kevin Dang	1c8449d578	Code Owners File (#140 ) * Add: codeowners file * Fix: Spelling error	2024-11-23 14:51:17 -08:00
Kevin Dang	33152b33f3	Pull/Switch Model Commands Fix (#137 ) * Update: Channel checker and channel name gone * Add: note of where problem can be * Update: Check if model already exists for Pull Command * Add: User/Admin Command Constants * Update: version increment	2024-11-08 20:09:01 -08:00
Jonathan Smoley	1ccd1a012e	Roll NPM Dependencies Forward (#136 ) * update channel as sendable * Update: Casting SendableChannels Once * Remove: another semicolon * Update: version increment --------- Co-authored-by: kevinthedang <kevinthedang_1@outlook.com>	2024-11-08 10:13:16 -08:00
Jonathan Smoley	68a5e097fe	Feature Set Documentation (#130 ) * added client events documentation * wording updated	2024-10-19 16:46:51 -07:00
Kevin Dang	624ff2e5c8	Add: Slash Commands Guide (#128 )	2024-10-16 10:07:40 -07:00
Kevin Dang	9f61f6bc6c	Switch Model Command (#126 )	2024-10-12 22:03:31 -07:00
Kevin Dang	5d02800c3f	Pull Model Command (#125 ) * Add: Pull Model Command * Fix: Missing ollama mock for PullModel	2024-10-12 17:53:34 -07:00
Kevin Dang	5061dab335	Remove CLIENT_UID Environment Variable (#123 ) * Remove: Client UID References * Update: version increment	2024-10-06 18:57:39 -07:00
Kevin Dang	947ff89958	Environment Variable Validation (#122 ) * Update: env validation and discord token validation * Add: IPv4 Address Validation * Update: version increment	2024-10-05 19:29:01 -07:00
Jonathan Smoley	6a9ee2d6d0	Code Coverage and Clean References (#120 ) * Add: skeleton suite for command tests (#119) * test naming updated * fix imports, remove old references * added code coverage badge * Add: coverage environment * Fix: Readme hyperlink to coverage workflow * grab coverage pct from env * Update: gist hyperlink * color range on coverage * fix contributing, simplify coverage assessment * lmiit coverage to master, add branch naming conventions --------- Co-authored-by: Kevin Dang <77701718+kevinthedang@users.noreply.github.com>	2024-10-01 10:11:23 -07:00
Kevin Dang	e3b0c9abe4	Message Attachment Image Recognition (#118 ) * Add: Image recognition * Fix: Non-Attachment Query * Update: version increment * Remove: Debugging logs from buffer file * Add: comments for bufferHandler	2024-09-18 20:28:23 -07:00