mirror of
https://github.com/lone-cloud/gerbil
synced 2026-06-03 19:54:44 -07:00
minor readme updates, dep upgrades
This commit is contained in:
parent
22ad6be966
commit
07c3d4c9af
3 changed files with 263 additions and 265 deletions
10
README.md
10
README.md
|
|
@ -17,7 +17,7 @@
|
||||||
|
|
||||||
<!-- markdownlint-enable MD033 -->
|
<!-- markdownlint-enable MD033 -->
|
||||||
|
|
||||||
Gerbil provides a graphical interface for running Large Language Models locally. It handles the technical complexity of managing backends, model downloads, and hardware acceleration - letting you focus on using AI rather than configuring it.
|
Gerbil is a GUI for running Large Language Models locally.
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
|
|
@ -29,14 +29,14 @@ Gerbil provides a graphical interface for running Large Language Models locally.
|
||||||
- **Integrated HuggingFace search** - Browse models, view model cards, and download GGUF files directly from the app
|
- **Integrated HuggingFace search** - Browse models, view model cards, and download GGUF files directly from the app
|
||||||
- **SillyTavern integration** - Launch SillyTavern for advanced character interactions (requires [Node.js](https://nodejs.org/))
|
- **SillyTavern integration** - Launch SillyTavern for advanced character interactions (requires [Node.js](https://nodejs.org/))
|
||||||
- **OpenWebUI integration** - Launch OpenWebUI for a modern web-based chat interface (requires [uv](https://docs.astral.sh/uv/getting-started/installation/))
|
- **OpenWebUI integration** - Launch OpenWebUI for a modern web-based chat interface (requires [uv](https://docs.astral.sh/uv/getting-started/installation/))
|
||||||
- **Privacy-focused** - Everything runs locally with no external data transmission or telemetry
|
- **Privacy-focused** - No telemetry, no external servers, no accounts
|
||||||
|
|
||||||
## Quick Start
|
## Quick Start
|
||||||
|
|
||||||
1. **[Download Gerbil](https://github.com/lone-cloud/gerbil/releases/latest)** for your platform
|
1. **[Download Gerbil](https://github.com/lone-cloud/gerbil/releases/latest)** for your platform
|
||||||
2. **Launch the app** - No installation needed for portable versions
|
2. **Launch the app** - No installation needed for portable versions
|
||||||
3. **Download a model** - Use the default model, use the built-in HuggingFace search by clicking on the looking glass icon, or import your own
|
3. **Download a model** - Use the default model, use the built-in HuggingFace search by clicking on the looking glass icon, or import your own
|
||||||
4. **Start generating** - Text and image generation is supported
|
4. **Start chatting** - Text and image generation both work out of the box
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
|
|
@ -132,14 +132,12 @@ https://github.com/user-attachments/assets/9e7ecfb3-3576-443c-8cef-a14e06ab5b60
|
||||||
|
|
||||||
## Advanced Configuration
|
## Advanced Configuration
|
||||||
|
|
||||||
Gerbil provides access to 80 KoboldCpp command line arguments through a built-in modal. While the GUI covers common settings, the command line arguments modal exposes 70+ additional advanced options.
|
The Launch screen's Advanced tab exposes 80+ KoboldCpp arguments with descriptions, defaults, and examples — for when you need more than the GUI covers.
|
||||||
|
|
||||||
<div align="center">
|
<div align="center">
|
||||||
<img src="assets/screenshot-cli-args.webp" alt="Command Line Arguments Modal" width="800">
|
<img src="assets/screenshot-cli-args.webp" alt="Command Line Arguments Modal" width="800">
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Access the modal from the Launch screen's Advanced tab -"Additional Arguments" field to browse all available options with descriptions, default values, and usage examples organized by category.
|
|
||||||
|
|
||||||
## CLI Mode
|
## CLI Mode
|
||||||
|
|
||||||
The `--cli` argument allows you to run Gerbil in the terminal without the UI. This will run the same backend that the GUI was using.
|
The `--cli` argument allows you to run Gerbil in the terminal without the UI. This will run the same backend that the GUI was using.
|
||||||
|
|
|
||||||
14
package.json
14
package.json
|
|
@ -44,8 +44,8 @@
|
||||||
"@codemirror/view": "^6.41.0",
|
"@codemirror/view": "^6.41.0",
|
||||||
"@fontsource/geist": "^5.2.8",
|
"@fontsource/geist": "^5.2.8",
|
||||||
"@huggingface/gguf": "^0.4.2",
|
"@huggingface/gguf": "^0.4.2",
|
||||||
"@mantine/core": "^9.0.1",
|
"@mantine/core": "^9.0.2",
|
||||||
"@mantine/hooks": "^9.0.1",
|
"@mantine/hooks": "^9.0.2",
|
||||||
"@types/mime-types": "^3.0.1",
|
"@types/mime-types": "^3.0.1",
|
||||||
"@types/node": "^25.6.0",
|
"@types/node": "^25.6.0",
|
||||||
"@types/react": "^19.2.14",
|
"@types/react": "^19.2.14",
|
||||||
|
|
@ -54,14 +54,14 @@
|
||||||
"@uiw/react-codemirror": "^4.25.9",
|
"@uiw/react-codemirror": "^4.25.9",
|
||||||
"@vitejs/plugin-react": "^6.0.1",
|
"@vitejs/plugin-react": "^6.0.1",
|
||||||
"cross-env": "^10.1.0",
|
"cross-env": "^10.1.0",
|
||||||
"electron": "^41.2.0",
|
"electron": "^41.2.1",
|
||||||
"electron-builder": "^26.8.1",
|
"electron-builder": "^26.8.1",
|
||||||
"electron-vite": "^5.0.0",
|
"electron-vite": "^5.0.0",
|
||||||
"jiti": "^2.6.1",
|
"jiti": "^2.6.1",
|
||||||
"lucide-react": "^1.8.0",
|
"lucide-react": "^1.8.0",
|
||||||
"oxfmt": "^0.44.0",
|
"oxfmt": "^0.45.0",
|
||||||
"oxlint": "^1.59.0",
|
"oxlint": "^1.60.0",
|
||||||
"oxlint-tsgolint": "^0.20.0",
|
"oxlint-tsgolint": "^0.21.1",
|
||||||
"react": "^19.2.5",
|
"react": "^19.2.5",
|
||||||
"react-dom": "^19.2.5",
|
"react-dom": "^19.2.5",
|
||||||
"react-error-boundary": "^6.1.1",
|
"react-error-boundary": "^6.1.1",
|
||||||
|
|
@ -71,7 +71,7 @@
|
||||||
"rehype-sanitize": "^6.0.0",
|
"rehype-sanitize": "^6.0.0",
|
||||||
"remark-gfm": "^4.0.1",
|
"remark-gfm": "^4.0.1",
|
||||||
"rollup-plugin-visualizer": "^7.0.1",
|
"rollup-plugin-visualizer": "^7.0.1",
|
||||||
"typescript": "^6.0.2",
|
"typescript": "^6.0.3",
|
||||||
"vite": "^8.0.8",
|
"vite": "^8.0.8",
|
||||||
"zustand": "^5.0.12"
|
"zustand": "^5.0.12"
|
||||||
},
|
},
|
||||||
|
|
|
||||||
504
pnpm-lock.yaml
generated
504
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load diff
Loading…
Add table
Reference in a new issue