Alpaca/README.md

68 lines
3.4 KiB
Markdown
Raw Normal View History

2024-05-22 21:51:31 -06:00
<p align="center"><img src="https://jeffser.com/images/alpaca/logo.svg"></p>
2024-05-12 23:55:36 -06:00
2024-05-12 18:58:50 -06:00
# Alpaca
2024-05-12 18:18:25 -06:00
2024-05-22 21:51:31 -06:00
<a href='https://flathub.org/apps/com.jeffser.Alpaca'><img width='240' alt='Download on Flathub' src='https://flathub.org/api/badge?locale=en'/></a>
2024-05-12 18:58:50 -06:00
2024-05-22 21:51:31 -06:00
Alpaca is an [Ollama](https://github.com/ollama/ollama) client where you can manage and chat with multiple models, Alpaca provides an easy and begginer friendly way of interacting with local AI, everything is open source and powered by Ollama.
2024-05-12 23:55:36 -06:00
---
> [!WARNING]
2024-05-22 21:51:31 -06:00
> This project is not affiliated at all with Ollama, I'm not responsible for any damages to your device or software caused by running code given by any AI models.
2024-05-12 18:58:50 -06:00
## Features!
- Talk to multiple models in the same conversation
- Pull and delete models from the app
2024-05-18 16:23:04 -06:00
- Image recognition
2024-06-04 12:11:36 -06:00
- Document recognition (plain text files)
2024-05-18 16:23:04 -06:00
- Code highlighting
2024-05-19 00:36:11 -06:00
- Multiple conversations
- Notifications
2024-05-21 23:16:05 -06:00
- Import / Export chats
2024-07-04 18:26:25 -06:00
- Delete / Edit messages
2024-05-26 00:36:41 -06:00
- YouTube recognition (Ask questions about a YouTube video using the transcript)
2024-08-01 00:40:45 -06:00
- Website recognition (Ask questions about a certain website by parsing the url)
2024-05-12 18:58:50 -06:00
2024-05-12 20:03:30 -06:00
## Screenies
2024-07-22 22:54:57 -06:00
Chatting with a model | Image recognition | Code highlighting
:--------------------:|:-----------------:|:----------------------:
2024-05-15 23:03:14 -06:00
![Screenshot from 2024-05-12 19-58-28](https://jeffser.com/images/alpaca/screenie1.png) | ![Screenshot from 2024-05-12 20-01-08](https://jeffser.com/images/alpaca/screenie2.png) | ![Screenshot from 2024-05-12 20-01-31](https://jeffser.com/images/alpaca/screenie3.png)
2024-05-12 20:03:30 -06:00
2024-05-12 18:58:50 -06:00
## Preview
1. Clone repo using Gnome Builder
2. Press the `run` button
## Instalation
2024-05-15 23:05:06 -06:00
1. Go to the `releases` page
2. Download the latest flatpak package
3. Open it
2024-05-12 18:58:50 -06:00
2024-05-26 14:37:17 -06:00
## Ollama session tips
### Change the port of the integrated Ollama instance
Go to `~/.var/app/com.jeffser.Alpaca/config/server.json` and change the `"local_port"` value, by default it is `11435`.
### Backup all the chats
2024-06-04 12:11:36 -06:00
The chat data is located in `~/.var/app/com.jeffser.Alpaca/data/chats` you can copy that directory wherever you want to.
2024-05-26 14:37:17 -06:00
### Force showing the welcome dialog
To do that you just need to delete the file `~/.var/app/com.jeffser.Alpaca/config/server.json`, this won't affect your saved chats or models.
2024-06-03 16:34:35 -06:00
### Add/Change environment variables for Ollama
You can change anything except `$HOME` and `$OLLAMA_HOST`, to do this go to `~/.var/app/com.jeffser.Alpaca/config/server.json` and change `ollama_overrides` accordingly, some overrides are available to change on the GUI.
2024-06-03 16:34:35 -06:00
---
## Thanks
- [not-a-dev-stein](https://github.com/not-a-dev-stein) for their help with requesting a new icon, bug reports and the translation to Brazilian Portuguese
- [TylerLaBree](https://github.com/TylerLaBree) for their requests and ideas
- [Alexkdeveloper](https://github.com/alexkdeveloper) for their help translating the app to Russian
- [Imbev](https://github.com/imbev) for their reports and suggestions
2024-08-01 14:02:28 -06:00
- [Nokse](https://github.com/Nokse22) for their contributions to the UI and table rendering
2024-05-28 10:36:08 -06:00
- [Louis Chauvet-Villaret](https://github.com/loulou64490) for their suggestions and help translating the app to French
2024-07-04 18:27:49 -06:00
- [CounterFlow64](https://github.com/CounterFlow64) for their help translating the app to Norwegian
2024-05-12 19:08:25 -06:00
## About forks
If you want to fork this... I mean, I think it would be better if you start from scratch, my code isn't well documented at all, but if you really want to, please give me some credit, that's all I ask for... And maybe a donation (joke)