Skip to main content

A Wayland screenshot assistant with LLM integration

Project description

Screenshot Assistant

A Wayland screenshot assistant with LLM integration. Capture screenshots and analyze them using Ollama's LLaVA model.

Installation

pip install screenshot-assistant

Requirements

  • Wayland compositor (Sway, Hyprland, or other wlroots-based)
  • grim (screenshot utility)
  • slurp (area selection)
  • imv (image viewer)
  • Ollama with LLaVA model installed

Usage

You can run the assistant in two ways:

  1. As a command:
screenshot-assistant
  1. Using the provided run script:
./run

Configuration

Create a .env file with the following options:

OLLAMA_URL=http://localhost:11434/api/generate
OLLAMA_MODEL=llava
WINDOW_TITLE=Screenshot Assistant
SCREENSHOT_MODE=active  # Options: all, active, select

Development

To set up for development:

git clone https://github.com/tcsenpai/screenshot-assistant.git
cd screenshot-assistant
uv venv .venv
uv pip install -e .

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

screenshot_assistant-0.1.0.tar.gz (26.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

screenshot_assistant-0.1.0-py3-none-any.whl (1.8 kB view details)

Uploaded Python 3

File details

Details for the file screenshot_assistant-0.1.0.tar.gz.

File metadata

  • Download URL: screenshot_assistant-0.1.0.tar.gz
  • Upload date:
  • Size: 26.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.7

File hashes

Hashes for screenshot_assistant-0.1.0.tar.gz
Algorithm Hash digest
SHA256 ce0d6e070853dc56085878c4fd90c53854d17abbe216938c7b064411423f1860
MD5 f2137b6498308acd301ecb9eb3cd7d6d
BLAKE2b-256 a75f4d95d8e349165abc6312da96946fe639b98546c108ce222b806ee24c4a33

See more details on using hashes here.

File details

Details for the file screenshot_assistant-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for screenshot_assistant-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c3d78fb890737bd56238409eb1b2b0157b5f61c6ff91bfdd20384de5f5e7ba3d
MD5 f7a46abc6b16f824aa34b90cddd4b619
BLAKE2b-256 32c8d999e3f7bb1a37c8573ef7618171504464a103e62d7214300d86f264f5a9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page