main: add reverse linking (LM Studio -> ollama) (#156)

Co-authored-by: Sam <[email protected]>

README.md

@@ -141,14 +141,18 @@ Inspect (`i`)
 
 #### Link
 
-Link (`l`) and Link All (`L`)
+Link (`l`), Link All (`L`) and Link in the reverse direction: (`link-lmstudio`)
 
-Note: Requires Admin privileges if you're running Windows.
+When linking models to LM Studio, Gollama creates a Modelfile with the template from LM-Studio and a set of default parameters that you can adjust.
+
+Note: Linking requires admin privileges if you're running Windows.
 
 #### Command-line Options
 
 - `-l`: List all available Ollama models and exit
 - `-L`: Link all available Ollama models to LM Studio and exit
+- `-link-lmstudio`: Link all available LM Studio models to Ollama and exit
+- `--dry-run`: Show what would be linked without making any changes (use with -link-lmstudio or -L)
 - `-s <search term>`: Search for models by name
   - OR operator (`'term1|term2'`) returns models that match either term
   - AND operator (`'term1&term2'`) returns models that match both terms

app_model.go

@@ -594,7 +594,7 @@ func (m *AppModel) handleLinkModelKey() (tea.Model, tea.Cmd) {
 		return m, nil
 	}
 	if item, ok := m.list.SelectedItem().(Model); ok {
-		message, err := linkModel(item.Name, m.lmStudioModelsDir, m.noCleanup, m.client)
+		message, err := linkModel(item.Name, m.lmStudioModelsDir, m.noCleanup, false, m.client)
 		if err != nil {
 			m.message = fmt.Sprintf("Error linking model: %v", err)
 		} else if message != "" {
@@ -615,7 +615,7 @@ func (m *AppModel) handleLinkAllModelsKey() (tea.Model, tea.Cmd) {
 	}
 	var messages []string
 	for _, model := range m.models {
-		message, err := linkModel(model.Name, m.lmStudioModelsDir, m.noCleanup, m.client)
+		message, err := linkModel(model.Name, m.lmStudioModelsDir, m.noCleanup, false, m.client)
 		if err != nil {
 			messages = append(messages, fmt.Sprintf("Error linking model %s: %v", model.Name, err))
 		} else if message != "" {

lmstudio/link.go

@@ -0,0 +1,246 @@
+package lmstudio
+
+import (
+	"fmt"
+	"os"
+	"os/exec"
+	"path/filepath"
+	"runtime"
+	"strings"
+	"text/template"
+
+	"github.com/sammcj/gollama/logging"
+	"github.com/sammcj/gollama/utils"
+)
+
+type Model struct {
+	Name     string
+	Path     string
+	FileType string // e.g., "gguf", "bin", etc.
+}
+
+// ModelfileTemplate contains the default template for creating Modelfiles
+// TODO: Make the default Modelfile template configurable
+const ModelfileTemplate = `### MODEL IMPORTED FROM LM-STUDIO BY GOLLAMA ###
+
+# Tune the below inference, model load parameters and template to your needs
+# The template and stop parameters are currently set to the default for models that use the ChatML format
+# If required update these match the prompt format your model expects
+# You can look at existing similar models on the Ollama model hub for examples
+# See https://github.com/ollama/ollama/blob/main/docs/modelfile.md for a complete reference
+
+FROM {{.ModelPath}}
+
+### Model Load Parameters ###
+PARAMETER num_ctx 4096
+
+### Inference Parameters ####
+PARAMETER temperature 0.4
+PARAMETER top_p 0.6
+
+### Chat Template Parameters ###
+
+TEMPLATE """
+{{.Prompt}}
+"""
+
+PARAMETER stop "<|im_start|>"
+PARAMETER stop "<|im_end|>"
+`
+
+type ModelfileData struct {
+	ModelPath string
+  Prompt string
+}
+
+// ScanModels scans the given directory for LM Studio model files
+func ScanModels(dirPath string) ([]Model, error) {
+	var models []Model
+
+	// First check if directory exists
+	if _, err := os.Stat(dirPath); os.IsNotExist(err) {
+		return nil, fmt.Errorf("LM Studio models directory does not exist: %s", dirPath)
+	}
+
+	err := filepath.Walk(dirPath, func(path string, info os.FileInfo, walkErr error) error {
+		// Handle walk errors immediately
+		if walkErr != nil {
+			logging.ErrorLogger.Printf("Error accessing path %s: %v", path, walkErr)
+			return walkErr
+		}
+
+		// Skip directories and symlinks
+		if info.IsDir() || info.Mode()&os.ModeSymlink != 0 {
+			if info.Mode()&os.ModeSymlink != 0 {
+				logging.DebugLogger.Printf("Skipping symlinked model: %s\n", path)
+			}
+			return nil
+		}
+
+		// Check for model file extensions
+		ext := strings.ToLower(filepath.Ext(path))
+		if ext == ".gguf" || ext == ".bin" {
+			name := strings.TrimSuffix(filepath.Base(path), ext)
+
+			// Basic name validation
+			if strings.ContainsAny(name, "/\\:*?\"<>|") {
+				logging.ErrorLogger.Printf("Skipping model with invalid characters in name: %s", name)
+				return nil
+			}
+
+			model := Model{
+				Name:     name,
+				Path:     path,
+				FileType: strings.TrimPrefix(ext, "."),
+			}
+
+			logging.DebugLogger.Printf("Found model: %s (%s)", model.Name, model.FileType)
+			models = append(models, model)
+		}
+
+		return nil
+	})
+
+	if err != nil {
+		return nil, fmt.Errorf("error scanning directory %s: %w", dirPath, err)
+	}
+
+	if len(models) == 0 {
+		logging.InfoLogger.Printf("No models found in directory: %s", dirPath)
+	} else {
+		logging.InfoLogger.Printf("Found %d models in directory: %s", len(models), dirPath)
+	}
+
+	return models, nil
+}
+
+// GetOllamaModelDir returns the default Ollama models directory for the current OS
+func GetOllamaModelDir() string {
+	homeDir := utils.GetHomeDir()
+	if runtime.GOOS == "darwin" {
+		return filepath.Join(homeDir, ".ollama", "models")
+	} else if runtime.GOOS == "linux" {
+		return "/usr/share/ollama/models"
+	}
+	// Add Windows path if needed
+	return filepath.Join(homeDir, ".ollama", "models")
+}
+
+// modelExists checks if a model is already registered with Ollama
+func modelExists(modelName string) bool {
+	cmd := exec.Command("ollama", "list")
+	output, err := cmd.CombinedOutput()
+	if err != nil {
+		return false
+	}
+	return strings.Contains(string(output), modelName)
+}
+
+// createModelfile creates a Modelfile for the given model
+func createModelfile(modelName string, modelPath string) error {
+	modelfilePath := filepath.Join(filepath.Dir(modelPath), fmt.Sprintf("Modelfile.%s", modelName))
+
+	// Check if Modelfile already exists
+	if _, err := os.Stat(modelfilePath); err == nil {
+		logging.InfoLogger.Printf("Modelfile already exists for %s, skipping creation", modelName)
+		return nil
+	}
+
+	tmpl, err := template.New("modelfile").Parse(ModelfileTemplate)
+	if err != nil {
+		return fmt.Errorf("failed to parse Modelfile template: %w", err)
+	}
+
+	data := ModelfileData{
+		ModelPath: modelPath, // Use full path instead of just the base name
+    Prompt: "{{.Prompt}}", // Preserve this as a template variable for Ollama
+	}
+
+	file, err := os.OpenFile(modelfilePath, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0644)
+	if err != nil {
+		return fmt.Errorf("failed to create Modelfile: %w", err)
+	}
+	defer file.Close()
+
+	logging.DebugLogger.Printf("Creating Modelfile at: %s with model path: %s", modelfilePath, data.ModelPath)
+
+	if err := tmpl.Execute(file, data); err != nil {
+		return fmt.Errorf("failed to write Modelfile template: %w", err)
+	}
+
+	// Log the content of the created Modelfile for debugging
+	content, err := os.ReadFile(modelfilePath)
+	if err != nil {
+		logging.ErrorLogger.Printf("Warning: Could not read back Modelfile for verification: %v", err)
+	} else {
+		logging.DebugLogger.Printf("Created Modelfile content:\n%s", string(content))
+	}
+
+	return nil
+}
+
+// LinkModelToOllama links an LM Studio model to Ollama
+// If dryRun is true, it will only print what would happen without making any changes
+func LinkModelToOllama(model Model, dryRun bool, ollamaHost string) error {
+	// Check if we're connecting to a local Ollama instance
+	if !utils.IsLocalhost(ollamaHost) {
+		return fmt.Errorf("linking LM Studio models to Ollama is only supported when connecting to a local Ollama instance (got %s)", ollamaHost)
+	}
+
+	ollamaDir := GetOllamaModelDir()
+
+	if dryRun {
+		logging.InfoLogger.Printf("[DRY RUN] Would create Ollama models directory at: %s", ollamaDir)
+	} else if err := os.MkdirAll(ollamaDir, 0755); err != nil {
+		return fmt.Errorf("failed to create Ollama models directory: %w", err)
+	}
+
+	targetPath := filepath.Join(ollamaDir, filepath.Base(model.Path))
+
+	if dryRun {
+		logging.InfoLogger.Printf("[DRY RUN] Would create symlink from %s to %s", model.Path, targetPath)
+	} else if err := os.Symlink(model.Path, targetPath); err != nil {
+		if os.IsExist(err) {
+			logging.InfoLogger.Printf("Symlink already exists for %s at %s", model.Name, targetPath)
+		} else {
+			return fmt.Errorf("failed to create symlink for %s to %s: %w", model.Name, targetPath, err)
+		}
+	}
+
+	// Check if model is already registered with Ollama
+	if !dryRun && modelExists(model.Name) {
+		return nil
+	}
+
+	// Create model-specific Modelfile
+	modelfilePath := filepath.Join(filepath.Dir(targetPath), fmt.Sprintf("Modelfile.%s", model.Name))
+	if dryRun {
+		logging.InfoLogger.Printf("[DRY RUN] Would create Modelfile at: %s", modelfilePath)
+		logging.InfoLogger.Printf("[DRY RUN] Would create Ollama model: %s using Modelfile", model.Name)
+		return nil
+	}
+
+	if err := createModelfile(model.Name, targetPath); err != nil {
+		return fmt.Errorf("failed to create Modelfile for %s: %w", model.Name, err)
+	}
+
+	// Create the model in Ollama
+	logging.DebugLogger.Printf("Creating Ollama model %s using Modelfile at: %s", model.Name, modelfilePath)
+	cmd := exec.Command("ollama", "create", model.Name, "-f", modelfilePath)
+	output, err := cmd.CombinedOutput()
+	if err != nil {
+		// Log the error output for debugging
+		logging.ErrorLogger.Printf("Ollama create command output: %s", string(output))
+		// Clean up Modelfile on failure
+		os.Remove(modelfilePath)
+		return fmt.Errorf("failed to create Ollama model %s: %s - %w", model.Name, string(output), err)
+	}
+	logging.DebugLogger.Printf("Successfully created Ollama model %s", model.Name)
+
+	// Clean up the Modelfile after successful creation
+	if err := os.Remove(modelfilePath); err != nil {
+		logging.ErrorLogger.Printf("Warning: Could not remove temporary Modelfile %s: %v", modelfilePath, err)
+	}
+
+	return nil
+}