srxy 1.3.1

Find files by what you mean — from the terminal or Python.

Srxy

Find files by what you mean — terminal or Python.

Fuzzy, phonetic, and semantic matching across filenames, documents, photos, audio, video, and OS tags. On a TTY, srxy opens a full-screen TUI by default; use --no-tui for scripts and pipes.

Installation

Needs Python 3.11+. pipx install 'srxy[semantic]' recommended; pip install srxy for core-only. Windows: add [windows] for Explorer tags. macOS: system python3 may be too old — Installation.

Platform setup (ffmpeg, tesseract): docs/installation.md

Quick start

TUI (default on a TTY):

srxy                          # empty query/path
srxy "registry" ./src         # pre-filled; auto-starts
srxy "transform" ./docs --ocr

Live scan progress, sortable results, preview pane, option chips, clipboard copy. Full walkthrough: docs/tui.md.

Plain CLI:

srxy "registry" ./src --no-tui
srxy "revenue" ./docs --json
srxy "dog at the beach" ~/Pictures --semantic-image --content-only
srxy "revenue" ./docs --semantic-all --content-only

Boolean queries (|, &), scope flags, format table: docs/cli.md.

Python:

from pathlib import Path
from srxy import magic_file_search, magic_search

magic_file_search(Path("./src"), "registry", threshold=0.3)
magic_search([{"name": "salad"}], "salat", fields=["name"])

API reference: docs/python-api.md.

Documentation

Guide	Contents
Installation	pipx/pip, macOS/Linux/Windows, ffmpeg, tesseract
TUI	Layout, keybindings, clipboard, release checklist
CLI reference	Flags, formats, boolean queries, exit codes
Power-ups	OCR, semantic, CLIP, transcription, models
Python API	magic_file_search, search, Q, match types
Development	Quality gate, --full, fixtures, pytest

Development

pip install -e ".[dev,semantic]"
./scripts/quality/checks.sh --fix
./scripts/quality/checks.sh              # day-to-day
./scripts/quality/checks.sh --full       # before release
./scripts/quality/checks.sh --full+cpu   # + forced-CPU transcribe matrix

CI runs unit tests only (unit marker, excluding semantic and transcribe). Details: docs/development.md.

Try fixtures: srxy "axolotl" ./tests/fixtures/file_search

License

MIT — see LICENSE.