aboutsummarylogtreecommitdiffstats
path: root/ditana-koboldcpp.1
blob: 475717479bbb389e0903e5bc6d98ed3e254eb042 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
.TH DITANA-KOBOLDCPP 1 "January 2025" "Version 1.81" "Ditana KoboldCpp User Manual"

.SH NAME
ditana-koboldcpp \- local AI chat service using KoboldCpp and Gemma language model

.SH SYNOPSIS
.B ditana-koboldcpp

.SH DESCRIPTION
Ditana KoboldCpp is a systemd service that runs KoboldCpp with the Gemma language model locally, providing you with private AI chat capabilities on your PC.

.SH FEATURES
.IP \[bu] 2
Installs and configures KoboldCpp with the Gemma 2-2b-it model
.IP \[bu]
Includes a custom logical_sampler_gemma_instruct.json for optimal performance
.IP \[bu]
Provides a desktop icon for easy access
.IP \[bu]
Runs as a background service, eliminating the need for manual management
.IP \[bu]
Automatic service management, including updates
.IP \[bu]
Low resource usage, suitable for systems without dedicated GPUs
.IP \[bu]
Requires SSE4.2 support

.SH INSTALLATION
This package is available in the Arch User Repository (AUR). You can install it using an AUR helper like pikaur:

.B pikaur -S ditana-koboldcpp

The service will be automatically enabled and started after installation.

.SH USAGE
After installation, the KoboldCpp service should be running automatically. You can:

.IP 1. 4
Check the service status:
.B systemctl status koboldcpp.service

.IP 2. 4
Access the KoboldCpp interface by opening your web browser and navigating to:
.B http://localhost:5001

Alternatively, you can use the desktop icon installed in your applications menu.

.SH TECHNICAL DETAILS
.IP \[bu] 2
Based on KoboldCpp
.IP \[bu]
Uses the Gemma 2-2b-it model (Q6_K quantization)
.IP \[bu]
Includes a systemd service for automatic management
.IP \[bu]
Desktop entry for easy access
.IP \[bu]
Custom icon for better integration with your desktop environment
.IP \[bu]
Automatic service management script for handling installation, upgrades, and removal

.SH LICENSE
This project is licensed under the AGPL-3.0-only License.

.SH ACKNOWLEDGEMENTS
.IP \[bu] 2
KoboldCpp by LostRuins Concedo
.IP \[bu]
Gemma model by Google, converted by Bartowski (Hugging Face)
.IP \[bu]
Systemd service and packaging by Stefan Zipproth

.SH SUPPORT
For issues, feature requests, or contributions, please use the GitHub issue tracker or submit a pull request.

.SH SEE ALSO
.BR systemctl (1),
.BR koboldcpp (1)

.SH AUTHOR
Stefan Zipproth <s.zipproth@ditana.org>

.SH BUGS
Report bugs to <https://github.com/acrion/ditana-koboldcpp/issues>

.SH COPYRIGHT
Copyright \(co 2024, 2025 Stefan Zipproth. License AGPLv3+: GNU AGPL version 3 or later <https://www.gnu.org/licenses/agpl-3.0.html>.
This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law.