Best practices applied to all remaining files

Author: jkthysse

launch.sh

@@ -1,5 +1,10 @@
 #!/bin/bash
 
+############################################################
+# launch.sh - Bootstrap script for LiteLLM Service
+# Launches the main interactive menu.
+############################################################
+
 # Minimal bootstrap, defer to menu script
 if [ -f src/menu.sh ]; then
 	source src/menu.sh

src/common.sh

@@ -3,28 +3,36 @@
 set -Eeuo pipefail
 IFS=$'\n\t'
 
-# Load environment if present
+############################################################
+# common.sh - Shared functions and environment setup for LiteLLM Service
+# This script loads environment variables, sets defaults, and provides utility functions.
+############################################################
+
+# Load environment variables from .env if not already loaded
 if [ -z "${COMMON_ENV_LOADED:-}" ]; then
     if [ -f src/config/.env ]; then
         source src/config/.env
     fi
     export COMMON_ENV_LOADED=1
 fi
 
-# Defaults
+# Default values for key variables
 : "${CUSTOM_MODEL_NAME:=elon}"
 : "${CUSTOM_MODEL_FILE:=src/model/developer}"
 : "${LITELLM_HOST:=127.0.0.1}"
 : "${LITELLM_PORT:=4000}"
 : "${OLLAMA_API_BASE:=http://localhost:11434}"
 
-# Directories
+# Directory for logs
 LOG_DIR="./.log"
 
+# Ensure the log directory exists
 function ensure_log_dir() {
     mkdir -p "$LOG_DIR"
 }
 
+# Prompt for a required value if not set
+# Usage: require_value VAR_NAME PROMPT [DEFAULT]
 function require_value() {
     local var_name="$1"
     local prompt="$2"
@@ -33,9 +41,10 @@ function require_value() {
     local current_value="${!var_name:-}"
 
     if [ -z "$current_value" ]; then
+        local input
         if [ -n "$default_value" ]; then
             read -p "$prompt [$default_value]: " input
-            if [ -z "${input:-}" ]; then input="$default_value"; fi
+            if [ -z "$input" ]; then input="$default_value"; fi
         else
             read -p "$prompt: " input
         fi

src/cursor.sh

@@ -1,38 +1,43 @@
 #!/bin/bash
 
-function cursor_start(){
-    # Start cursor after running the proxy
+
+############################################################
+# cursor.sh - Functions for integrating Cursor editor with LiteLLM Service
+# Provides automation and health-check utilities for Cursor.
+############################################################
+
+# Start Cursor after running the LiteLLM proxy
+function cursor_start() {
     source ./src/common.sh
     source ./src/litellm.sh
     class_LiteLLMProxy proxy
 
-    proxy.check_status "$customModelName" || proxy.start_bg "$customModelName"
+    local model_name="$CUSTOM_MODEL_NAME"
+    proxy.check_status "$model_name" || proxy.start_bg "$model_name"
 
-    # Launch Cursor
+    # Launch Cursor editor
     "C:\Users\<you>\AppData\Local\Programs\cursor\Cursor.exe"
 }
 
-function cursor_scheduler(){
-    # Create a scheduled task that runs at user login
-    $PATH_TO_PROJECT="C:\path\to\your\project"
-    bash -lc 'cd $PATH_TO_PROJECT && ./src/menu.sh --auto-start'
+# Create a scheduled task that runs at user login to auto-start the service
+function cursor_scheduler() {
+    local PATH_TO_PROJECT="C:\path\to\your\project"
+    bash -lc "cd $PATH_TO_PROJECT && ./src/menu.sh --auto-start"
 }
 
 # Proxy health-check in Cursor
-function cursor_health_check(){
+function cursor_health_check() {
     source ./src/common.sh
     source ./src/litellm.sh
-
     class_LiteLLMProxy proxy
 
-    proxy.check_status "$customModelName" || proxy.start_bg "$customModelName"
+    local model_name="$CUSTOM_MODEL_NAME"
+    proxy.check_status "$model_name" || proxy.start_bg "$model_name"
 
-    # Launch Cursor
+    # Launch Cursor editor
     "C:\Users\<you>\AppData\Local\Programs\cursor\Cursor.exe"
 }
+
 # Note: Cursor does not support custom ports or hosts for LLM API.
 # It always calls localhost:4000.
-
-# To change the port, you must modify the LiteLLM proxy to listen on port 4000.
-# This can be done by changing the LITELLM_PORT variable in src/common.sh to 4000
-# and restarting the proxy.
+# To change the port, modify LITELLM_PORT in src/common.sh and restart the proxy.

src/litellm.sh

@@ -1,20 +1,28 @@
 #!/bin/bash
 
+############################################################
+# litellm.sh - Functions for managing LiteLLM proxy lifecycle
+# Includes install, upgrade, start, and background start utilities.
+############################################################
+
 source "$(dirname "$0")/common.sh"
 
-function litellm_install(){
+# Install LiteLLM proxy
+function litellm_install() {
     need_cmd pip
     info "Installing LiteLLM proxy..."
     pip install "litellm[proxy]"
 }
 
-function litellm_upgrade(){
+# Upgrade LiteLLM proxy
+function litellm_upgrade() {
     need_cmd pip
     info "Upgrading LiteLLM proxy..."
     pip install --upgrade "litellm[proxy]"
 }
 
-function litellm_start(){
+# Start LiteLLM proxy for the selected Ollama model
+function litellm_start() {
     need_cmd litellm
     require_value CUSTOM_MODEL_NAME "Enter model name" "$CUSTOM_MODEL_NAME"
 
@@ -23,7 +31,8 @@ function litellm_start(){
         --model "ollama/$CUSTOM_MODEL_NAME" --api_base "$OLLAMA_API_BASE"
 }
 
-function litellm_start_bg(){
+# Start LiteLLM proxy in the background and log output
+function litellm_start_bg() {
     need_cmd litellm
     require_value CUSTOM_MODEL_NAME "Enter model name" "$CUSTOM_MODEL_NAME"
 
@@ -37,7 +46,7 @@ function litellm_start_bg(){
         --model "ollama/$CUSTOM_MODEL_NAME" --api_base "$OLLAMA_API_BASE" \
         > "$logfile" 2>&1 &
     echo $! > "${LOG_DIR}/litellm_${CUSTOM_MODEL_NAME}.pid"
-    info "LiteLLM proxy started with PID $(cat ${LOG_DIR}/litellm_${CUSTOM_MODEL_NAME}.pid)"
+    info "LiteLLM proxy started with PID $(cat "${LOG_DIR}/litellm_${CUSTOM_MODEL_NAME}.pid")"
 }
 
 function litellm_stop(){

src/menu.sh

@@ -1,10 +1,16 @@
 #!/bin/bash
 
+############################################################
+# menu.sh - Main interactive menu for LiteLLM Service
+# Presents options for model management, proxy control, and integrations.
+############################################################
+
 source "$(dirname "$0")/common.sh"
 source "$(dirname "$0")/model.sh"
 source "$(dirname "$0")/litellm.sh"
 source "$(dirname "$0")/cursor.sh"
 
+# Display the main menu and handle user selection
 function main_menu() {
     while true; do
         clear
@@ -26,7 +32,7 @@ function main_menu() {
         echo "================================="
         read -p "Select an option: " choice
 
-        case $choice in
+        case "$choice" in
             1) model_select ;;
             2) model_create ;;
             3) model_test ;;