You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
PDF viewer for terminals using the Kitty image protocol
Usage
fancy-cat <path-to-pdf><optional-page-number>
Commands
fancy-cat uses a modal interface similar to Neovim. There are two modes: view mode and command mode. To enter command mode you type : by default (this can be changed in the config file)
Documentation on the available commands can be found here
Configuration
fancy-cat can be configured through a JSON config file located at ~/.config/fancy-cat/config.json. The file is automatically created on the first run with default settings.
The default config.json can be found here and documentation on the config options can be found here
Installation
fancy-cat is available in the following repositories:
Build Instructions
Requirements
Zig version 0.14.0
Terminal emulator with the Kitty image protocol (e.g. Kitty, Ghostty, WezTerm, etc.)
Build
Fetch submodules:
git submodule update --init --recursive
Build the project:
zig build --release=small
Note
There is a known issue with some processors; if the build fails on step 7/10 with the error LLVM ERROR: Do not know how to expand the result of this operator! then try the command below instead:
zig build -Dcpu="skylake" --release=small
Install:
# Add to your PATH# Linux
mv zig-out/bin/fancy-cat ~/.local/bin/
# macOS
mv zig-out/bin/fancy-cat /usr/local/bin/
Run
zig build run -- <path-to-pdf><optional-page-number>