From 6981172c405db6eef7cd1d5efd3a903bd63d3cd0 Mon Sep 17 00:00:00 2001 From: Egor Date: Fri, 22 Aug 2025 18:20:24 -0700 Subject: [PATCH] test another build --- .cspell/project-terms.txt | 2 ++ README.md | 75 +++++++++++++++++++++++++++++---------- package.json | 14 +++++--- 3 files changed, 68 insertions(+), 23 deletions(-) diff --git a/.cspell/project-terms.txt b/.cspell/project-terms.txt index 92f6aa7..da0dcae 100644 --- a/.cspell/project-terms.txt +++ b/.cspell/project-terms.txt @@ -32,6 +32,7 @@ KOBOLDCPP lora lowvram Lowvram +makepkg maximizable minimizable MMAP @@ -49,6 +50,7 @@ nvidia oldpc OLDPC opencl +paru pkexec quantmatmul radeon diff --git a/README.md b/README.md index 45f5472..470dadf 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,68 @@ # Friendly Kobold -A koboldcpp manager. +A modern desktop app for running Large Language Models locally. FriendlyKobold Icon ## Core Features -- modern UI for [koboldcpp](https://github.com/LostRuins/koboldcpp) with full support for Linux Wayland -- download and keep up-to-date your [koboldcpp](https://github.com/LostRuins/koboldcpp/releases) binary -- manage the koboldcpp binary to prevent it from running in the background indefinitely -- automatically unpack all downloaded koboldcpp binaries for significantly faster operation and reduced RAM+HDD utilization (up to ~4GB less RAM usage for ROCm) -- added presets for a basic flux or chroma image generation setup +- **Run LLMs locally** with a modern, intuitive interface powered by [KoboldCpp](https://github.com/LostRuins/koboldcpp) +- **Full Linux Wayland support** for seamless integration with modern Linux desktops +- **Automatic updates** - Download and keep your KoboldCpp binary up-to-date effortlessly +- **Smart process management** - Prevents runaway background processes and system resource waste +- **Optimized performance** - Automatically unpacks binaries for faster operation and reduced memory usage (up to ~4GB less RAM) +- **Image generation support** - Built-in presets for Flux and Chroma image generation workflows +- **Privacy-focused** - Everything runs locally on your machine, no data sent to external servers + +### Windows ROCm Support + +There is ROCm Windows support maintained by YellowRoseCx in a separate fork. +Unfortunately it does not properly support unpacking, which would greatly diminish its performance and provide a poor UX when used alongside this app. +For Friendly Kobold to work with this fork, [this issue must be fixed first](https://github.com/YellowRoseCx/koboldcpp-rocm/issues/129). + +Note that this build is not important as modern day Vulkan matches or even surpasses ROCm in terms of LLM performance for most cases. + +### Future features + +Not all koboldcpp features have currently been ported over the UI. As a workaround one may use the "Additional arguments" on the "Advanced" tab of the launcher to provide additional command line arguments if you know them. + +## Installation + +### Pre-built Binaries (Recommended) + +Download the latest release for your platform from the [GitHub Releases page](https://github.com/lone-cloud/friendly-kobold/releases/latest): + +- **Windows**: `Friendly-Kobold-X.X.X.exe` (portable executable) +- **macOS**: `Friendly-Kobold-X.X.X.dmg` (disk image) +- **Linux**: `Friendly-Kobold-X.X.X.AppImage` (portable application) + +#### Linux - AppImage + +1. Download the `.AppImage` file +2. Make it executable: `chmod +x Friendly-Kobold-X.X.X.AppImage` +3. Run it: `./Friendly-Kobold-X.X.X.AppImage` + +#### Linux - AUR (Arch Linux) + +For Arch Linux users, install from the AUR using your preferred AUR helper: + +```bash +# Using yay +yay -S friendly-kobold + +# Using paru +paru -S friendly-kobold + +# Manual installation +git clone https://aur.archlinux.org/friendly-kobold.git +cd friendly-kobold +makepkg -si +``` + +The AUR package automatically handles installation, desktop integration, and system updates. This is the ideal way to run Friendly Kobold on Linux. + +## For Local Dev ### Prerequisites @@ -38,18 +89,6 @@ A koboldcpp manager. yarn dev ``` -### Windows ROCm Support - -There is ROCm Windows support maintained by YellowRoseCx in a separate fork. -Unfortunately it does not properly support unpacking, which would greatly diminish its performance and provide a poor UX when used alongside this app. -For Friendly Kobold to work with this fork, [this issue must be fixed first](https://github.com/YellowRoseCx/koboldcpp-rocm/issues/129). - -Note that this build is not important as modern day Vulkan matches or even surpasses ROCm in terms of LLM performance for most cases. - -### Future features - -Not all koboldcpp features have currently been ported over the UI. As a workaround one may use the "Additional arguments" on the "Advanced" tab of the launcher to provide additional command line arguments if you know them. - ### Future considerations It would make a lot of sense to transition this project to Tauri from Electron. The app size should drop from ~110MB to ~10MB; however, users on obsolete OSes (with outdated WebViews) will very likely encounter issues. In addition, I would need to learn Rust to rewrite the BE (Electron main code), but at least we can re-use all the React code. The app would be much smaller, faster and memory efficient, but not work for some users. I think it's a worthy tradeoff. diff --git a/package.json b/package.json index e787864..9f52433 100644 --- a/package.json +++ b/package.json @@ -1,8 +1,8 @@ { "name": "friendly-kobold", "productName": "Friendly Kobold", - "version": "0.5.3", - "description": "A modern Electron shell for KoboldCpp", + "version": "0.5.4", + "description": "A modern desktop app for running Large Language Models locally", "main": "out/main/index.js", "homepage": "./", "engines": { @@ -41,10 +41,14 @@ ] }, "keywords": [ - "electron", - "koboldcpp", + "llm", "ai", - "llm" + "local-ai", + "language-model", + "koboldcpp", + "electron", + "privacy", + "offline" ], "author": { "name": "lone-cloud",