Alpaca/README.md

55 lines
2.3 KiB
Markdown
Raw Normal View History

2024-05-12 23:55:36 -06:00
<img src="https://jeffser.com/images/alpaca/logo.svg">
2024-05-12 18:58:50 -06:00
# Alpaca
2024-05-12 18:18:25 -06:00
2024-05-12 18:58:50 -06:00
An [Ollama](https://github.com/ollama/ollama) client made with GTK4 and Adwaita.
2024-05-12 21:53:58 -06:00
2024-05-12 18:58:50 -06:00
2024-05-12 23:55:36 -06:00
---
> [!WARNING]
> 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 models.
> [!important]
> This is my first GTK4 / Adwaita / Python app, so it might crash and some features are still under development, please report any errors if you can, thank you!
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
- Code highlighting
2024-05-19 00:36:11 -06:00
- Multiple conversations
- Notifications
2024-05-12 18:58:50 -06:00
## Future features!
2024-05-18 16:23:04 -06:00
- Document recognition
2024-05-19 00:36:11 -06:00
- Import / Export chats
2024-05-20 14:46:23 -06:00
- Delete / Edit messages
2024-05-20 19:02:51 -06:00
- Snap Package (maybe)
2024-05-12 18:58:50 -06:00
2024-05-12 20:03:30 -06:00
## Screenies
2024-05-12 23:55:36 -06:00
Login to Ollama instance | Chatting with models | Managing models
:-------------------------:|:-------------------------:|:-------------------------:
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
## Usage
- You'll need an Ollama instance, I recommend using the [Docker image](https://ollama.com/blog/ollama-is-now-available-as-an-official-docker-image)
- Once you open Alpaca it will ask you for a url, if you are using the same computer as the Ollama instance and didn't change the ports you can use the default url.
- You might need a model, you can get one using the box icon at the top of the app, I recommend using phi3 because it is very lightweight but you can use whatever you want (I haven't actually tested all so your mileage may vary).
- Then just start talking! you can mix different models, they all share the same conversation, it's really cool in my opinion.
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)