| .github | ||
| .husky | ||
| .vscode | ||
| assets | ||
| build | ||
| src | ||
| .gitignore | ||
| .prettierignore | ||
| .prettierrc | ||
| cspell.json | ||
| electron.vite.config.ts | ||
| eslint.config.ts | ||
| index.html | ||
| LICENSE | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| tsconfig.json | ||
| tsconfig.main.json | ||
| tsconfig.node.json | ||
FriendlyKobold
A koboldcpp manager.
Core Features
- modern UI with full support for Linux Wayland
- download and keep up-to-date your koboldcpp binary
- better surface the ROCm-specific builds of koboldcpp from YellowRoseCx and from koboldai.org
- manage the koboldcpp binary to prevent it from running in the background indefinitely
Prerequisites
- Node.js 18+
- npm
Setup
-
Clone the repository
-
Install dependencies:
npm install -
Start the development server:
npm run dev
Linux Wayland support
Additional configurations have been written to help with ideal Wayland support, but as per current Electron guidelines, the user should set ELECTRON_OZONE_PLATFORM_HINT to wayland in their environment variable according to the Electron Environment Variables documentation.
Future considerations
It would make a lot of sense to transition this project to Tauri from Electron. The app size should drop from ~80MB 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.
License
AGPL v3 License - see LICENSE file for details