mirror of
https://github.com/tcsenpai/screenshot_assistant.git
synced 2025-06-06 11:15:29 +00:00
53 lines
1.1 KiB
Markdown
53 lines
1.1 KiB
Markdown
# Screenshot Assistant
|
|
|
|
A Wayland screenshot assistant with LLM integration. Capture screenshots and analyze them using Ollama's LLaVA model.
|
|
|
|
## Installation
|
|
|
|
If using uv, skip the pip install step or use `uv pip install -r requirements.txt`.
|
|
|
|
```bash
|
|
git clone https://github.com/tcsenpai/screenshot-assistant.git
|
|
cd screenshot-assistant
|
|
pip install -r requirements.txt
|
|
```
|
|
|
|
## Requirements
|
|
|
|
- Wayland compositor (Sway, Hyprland, or other wlroots-based)
|
|
- grim (screenshot utility)
|
|
- slurp (area selection)
|
|
- imv (image viewer)
|
|
- Ollama with LLaVA model installed
|
|
|
|
You can install the requirements (except for Ollama) using the provided install script:
|
|
|
|
```bash
|
|
./ubuntu_deps.sh
|
|
```
|
|
|
|
## Pulling Ollama models
|
|
|
|
```bash
|
|
ollama pull llava-llama3 # or whatever model you want to use
|
|
```
|
|
|
|
## Usage
|
|
|
|
You can run the assistant using the provided run script:
|
|
|
|
```bash
|
|
./run
|
|
```
|
|
|
|
## Configuration
|
|
|
|
Create a `.env` file with the following options:
|
|
|
|
```env
|
|
OLLAMA_URL=http://localhost:11434/api/generate
|
|
OLLAMA_MODEL=llava
|
|
WINDOW_TITLE=Screenshot Assistant
|
|
SCREENSHOT_MODE=active # Options: all, active, select
|
|
```
|