sucher — a fast terminal viewer for awkward-in-a-browser files

Markdown, spreadsheets, PDF, images, SVG, video, docx, pptx, Keynote,
archives, and binary — one command that picks a viewer by extension and
renders in place using the terminal graphics protocol, plus a two-pane
directory browser with live previews.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01SWpEyKSkEuE2v5NPouLMbP

Author: john-athan

.github/workflows/ci.yml

@@ -0,0 +1,27 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+        with:
+          components: clippy, rustfmt
+      - uses: Swatinem/rust-cache@v2
+      - name: Format
+        run: cargo fmt --check
+      - name: Clippy
+        run: cargo clippy -- -D warnings
+      - name: Test
+        run: cargo test
+      - name: Build (release)
+        run: cargo build --release

.gitignore

@@ -0,0 +1,9 @@
+# Rust build output
+/target
+
+# Local sample / scratch files used for manual testing
+/sample.*
+/*.tmp
+
+# macOS
+.DS_Store

CONTRIBUTING.md

@@ -0,0 +1,40 @@
+# Contributing
+
+Thanks for your interest in sucher.
+
+## Development
+
+```sh
+cargo build            # debug build
+cargo test             # unit tests (markdown, docx, xlsx)
+cargo clippy           # lints
+cargo fmt              # format
+make run               # run against samples/sample.md
+```
+
+CI runs `fmt --check`, `clippy -D warnings`, `test`, and a release build, so
+please run those locally before opening a PR.
+
+## Adding a format
+
+Each format lives in its own module under `src/` and exposes:
+
+- `run(title, path)` — the interactive TUI (TTY), and
+- a non-interactive `dump`/`to_markdown` for piped output.
+
+Classification has a single source of truth (see `docs/adr/0001`): add the
+variant to the `Format` enum and its extension mapping in `src/format.rs` —
+that one registry drives both which viewer opens a file and how the directory
+browser colours and previews it. Then dispatch the new variant in `src/main.rs`
+(the `main()` match for TTY vs. pipe, and `open_interactive` for previews).
+
+## Runtime dependencies
+
+PDF needs poppler (`pdftocairo`, `pdfinfo`, `pdftotext`); video needs `ffmpeg`
+and `ffprobe`. Keep these optional — the tool should degrade gracefully when a
+backend is missing.
+
+## Scope
+
+sucher aims to be a fast, good-looking terminal viewer for awkward-in-a-browser
+files. Keep dependencies lean and the startup path quick.