xeen 0.1.12

Screenshot capture → edit → crop → publish. One command: xeen

xeen

Screenshot capture → edit → crop → publish. One command.

pip install -e .
xeen

Problem

Chcesz szybko stworzyć krótki film ze screenshotów — demo produktu, tutorial, changelog. Ale Canva to za dużo kroków. xeen robi to w terminalu + przeglądarce.

Jak działa

┌─────────┐     ┌──────────┐     ┌──────────┐     ┌──────────┐     ┌──────────┐
│ Capture │ ──→ │  Select  │ ──→ │  Center  │ ──→ │   Crop   │ ──→ │ Publish  │
│ xeen    │     │  Tab 1   │     │  Tab 2   │     │  Tab 3-4 │     │  Tab 5   │
└─────────┘     └──────────┘     └──────────┘     └──────────┘     └──────────┘
 screenshoty     wybór klatek     środek uwagi     przycinanie       eksport
 + metadane      grid view        click = center   presety SM        MP4/GIF/ZIP
 kursor/kb       max 15           auto z kursora   multi-wersje      social links

Instalacja

# Z repozytorium
git clone https://github.com/softreck/xeen.git
cd xeen
pip install -e .

# Wymagania systemowe
# Linux/Mac: ffmpeg
sudo apt install ffmpeg   # Ubuntu/Debian
brew install ffmpeg        # macOS

# Capture wymaga środowiska GUI:
# - Lokalne środowisko z desktopem (nie headless)
# - SSH z przekierowaniem X11: ssh -X user@host
# - Ustawiona zmienna DISPLAY (np. export DISPLAY=:0)

Użycie

1. Nagrywanie

# Domyślne (10s, co 1s, max 15 klatek) - komenda 'xeen' sama robi capture
xeen

# Lub jawnie
xeen capture

# Krótkie demo (5s)
xeen capture -d 5

# Gęstsze klatki
xeen capture -d 10 -i 0.5

# Nazwana sesja
xeen capture -n "ksefin-demo-v2"

# Konkretny monitor
xeen capture --monitor 1

Co zbiera xeen capture:

• Screenshoty z inteligentnym interwałem (pomija identyczne klatki)
• Pozycja myszy co 100ms — używana jako sugestia "środka uwagi"
• Klawisze — log co zostało wciśnięte (kontekst)
• % zmiany ekranu — między klatkami

2. Edycja w przeglądarce

# Uruchom serwer (otwiera przeglądarkę)
xeen

# Lub jawnie
xeen server -p 8080
xeen server --no-browser

5 zakładek:

Tab	Funkcja
1. Wybór klatek	Grid wszystkich klatek, kliknij aby wybrać/odrzucić
2. Środek	Kliknij na obrazie = punkt centralny. Auto-sugestia z pozycji kursora
3. Przycinanie	Wybierz preset (Instagram, Twitter, LinkedIn...) → podgląd przycięcia wg środka
4. Wersje	Generuj kilka formatów naraz, porównaj obok siebie
5. Publikacja	Eksport MP4/GIF/ZIP + linki do social media

3. Upload zewnętrznych screenshotów

Gdy xeen capture nie działa (środowisko headless, brak GUI), możesz użyć przeglądarki:

# Uruchom serwer edycji
xeen server

W przeglądarze (Tab 1):

• Przeciągnij pliki PNG/JPG bezpośrednio na stronę
• Kliknij "Wybierz pliki" aby wybrać screenshoty z komputera
• Zrób screenshoty ręcznie (np. PrintScreen, zrzuty ekranu systemowe) i prześlij

To idealna alternatywa dla:

• Serwerów bez GUI (headless)
• Połączeń SSH bez przekierowania X11
• Środowisk wirtualnych i kontenerów

4. Lista sesji

xeen list

Presety przycinania

Preset	Rozmiar	Użycie
instagram_post	1080×1080	Post IG (kwadrat)
instagram_story	1080×1920	Story IG (9:16)
twitter_post	1200×675	Post Twitter/X
linkedin_post	1200×627	Post LinkedIn
facebook_post	1200×630	Post Facebook
youtube_thumb	1280×720	Miniatura YT
widescreen	1920×1080	16:9

Deploy na VPS (Docker + TLS)

# 1. Sklonuj na VPS
git clone https://github.com/softreck/xeen.git
cd xeen

# 2. Deploy z domeną
make deploy DOMAIN=xeen.twoja-domena.pl

# Lub ręcznie:
bash deploy.sh xeen.twoja-domena.pl

Skrypt automatycznie:

• Instaluje Docker + certbot
• Generuje cert TLS (Let's Encrypt lub self-signed)
• Buduje i uruchamia kontenery
• Konfiguruje auto-renewal

Docker ręcznie

# Dev z self-signed cert
make dev-certs
docker-compose up -d

# Logi
docker-compose logs -f

# Stop
docker-compose down

Struktura Docker

┌─────────────┐     ┌───────────┐
│   nginx     │────→│  xeen app │
│  :80/:443   │     │   :7600   │
│  TLS term.  │     │  FastAPI  │
└─────────────┘     └───────────┘
       │                   │
       │              ┌────┴────┐
       │              │  /data  │
       │              │ volume  │
       └──────────────┴─────────┘

Metadane

Każda sesja zapisuje session.json z:

{
  "name": "20250219_143022",
  "frames": [
    {
      "index": 0,
      "timestamp": 0.0,
      "filename": "frame_0000.png",
      "change_pct": 100.0,
      "mouse_x": 960,
      "mouse_y": 540,
      "suggested_center_x": 960,
      "suggested_center_y": 540,
      "input_events": [
        {"ts": 0.1, "kind": "mouse_move", "x": 955, "y": 538},
        {"ts": 0.2, "kind": "key_press", "key": "a", "x": 955, "y": 538},
        {"ts": 0.3, "kind": "mouse_click", "x": 960, "y": 540, "button": "Button.left"}
      ]
    }
  ],
  "input_log": [ ... ]  
}

API

Endpoint	Metoda	Opis
/api/sessions	GET	Lista sesji
/api/sessions/{name}	GET	Szczegóły sesji
/api/sessions/upload	POST	Upload screenshotów
/api/sessions/{name}/select	POST	Zapisz wybór klatek
/api/sessions/{name}/centers	POST	Zapisz środki
/api/sessions/{name}/crop-preview	POST	Podgląd przycinania
/api/sessions/{name}/generate-versions	POST	Multi-format
/api/sessions/{name}/export	POST	Eksport MP4/GIF/ZIP
/api/presets	GET	Presety formatów
/api/social-links	GET	Linki social media

Licencja

MIT — Softreck

License

Apache License 2.0 - see LICENSE for details.

Author

Created by Tom Sapletta - [e-mail]