{"id":19516770,"url":"https://github.com/freref/fancy-cat","last_synced_at":"2025-05-15T18:07:16.853Z","repository":{"id":260847153,"uuid":"882471344","full_name":"freref/fancy-cat","owner":"freref","description":"PDF reader for terminal emulators using the Kitty image protocol","archived":false,"fork":false,"pushed_at":"2025-03-17T19:39:03.000Z","size":151,"stargazers_count":326,"open_issues_count":16,"forks_count":10,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-03T05:09:42.205Z","etag":null,"topics":["zig","zig-package"],"latest_commit_sha":null,"homepage":"","language":"Zig","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/freref.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-02T21:31:32.000Z","updated_at":"2025-03-29T23:04:52.000Z","dependencies_parsed_at":"2024-12-23T20:10:28.709Z","dependency_job_id":"2a3a403c-9dd2-4904-aa27-a5c4c2727001","html_url":"https://github.com/freref/fancy-cat","commit_stats":{"total_commits":92,"total_committers":2,"mean_commits":46.0,"dds":"0.021739130434782594","last_synced_commit":"bd751ae9f4a5169ed19723deb3778ffdccad97e6"},"previous_names":["freref/fancy-cat"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/freref%2Ffancy-cat","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/freref%2Ffancy-cat/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/freref%2Ffancy-cat/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/freref%2Ffancy-cat/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/freref","download_url":"https://codeload.github.com/freref/fancy-cat/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248489272,"owners_count":21112539,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["zig","zig-package"],"created_at":"2024-11-11T00:00:49.590Z","updated_at":"2025-04-11T22:29:35.546Z","avatar_url":"https://github.com/freref.png","language":"Zig","readme":"\u003ch1\u003e\n\u003cp align=\"center\"\u003e\n  📑\n  \u003cbr\u003efancy-cat\n\u003c/h1\u003e\n  \u003cp align=\"center\"\u003e\n    PDF viewer for terminals using the Kitty image protocol\n    \u003cbr /\u003e\n  \u003c/p\u003e\n\u003c/p\u003e\n\n![demo](https://github.com/user-attachments/assets/b1edc9d2-3b1f-437d-9b48-c196d22fcbbd)\n\n## Usage\n\n```sh\nfancy-cat \u003cpath-to-pdf\u003e \u003coptional-page-number\u003e\n```\n\n### Commands\n\nfancy-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)\n\n#### Available Commands\n\n- `:\u003cpage-number\u003e` - jump to the specified page number\n- `:q` - quit the application\n\n### Configuration\n\nfancy-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.\n\nThe default `config.json` can be found [here](./src/config/config.json) and documentation on the config options can be found [here](./docs/config.md)\n\n## Installation\n\n`fancy-cat` is available in the following repositories:\n\n[![Packaging status](https://repology.org/badge/vertical-allrepos/fancy-cat.svg?columns=3\u0026header=fancy-cat)](https://repology.org/project/fancy-cat/versions)\n\n### Nix\n\nAvailable as a Nix package [here](https://github.com/freref/fancy-cat-nix).\n\n## Build Instructions\n\n### Requirements\n\n- Zig version `0.14.0`\n- Terminal emulator with the Kitty image protocol (e.g. Kitty, Ghostty, WezTerm, etc.)\n\n### Build\n\n1. Fetch submodules:\n\n```\ngit submodule update --init --recursive\n```\n\n2. Build the project:\n\n```sh\nzig build --release=small\n```\n\n\u003e [!NOTE]\n\u003e There is a [known issue](https://github.com/freref/fancy-cat/issues/18) 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:\n\u003e\n\u003e ```sh\n\u003e zig build -Dcpu=\"skylake\" --release=small\n\u003e ```\n\n3. Install:\n\n```sh\n# Add to your PATH\n# Linux\nmv zig-out/bin/fancy-cat ~/.local/bin/\n\n# macOS\nmv zig-out/bin/fancy-cat /usr/local/bin/\n```\n\n### Run\n\n```sh\nzig build run -- \u003cpath-to-pdf\u003e \u003coptional-page-number\u003e\n```\n\n## Features\n\n- ✅ Filewatch (hot-reload)\n- ✅ Runtime config\n- ✅ Custom keymappings\n- ✅ Modal interface\n- ✅ Commands\n- ✅ Colorize mode (dark-mode)\n- ✅ Status bar\n- ✅ Page navigation (zoom, prev, next, etc.)\n\n## License\n\n[AGPL-3.0-or-later](https://spdx.org/licenses/AGPL-3.0-or-later.html)\n\n## Contributing\n\nContributions are welcome.\n","funding_links":[],"categories":["Multimedia \u0026 Graphics","Zig","Recently Updated","\u003ca name=\"viewers\"\u003e\u003c/a\u003eViewers","Table of Contents"],"sub_categories":["Image and Video Processing","[Jul 27, 2025](/content/2025/07/27/README.md)"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffreref%2Ffancy-cat","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffreref%2Ffancy-cat","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffreref%2Ffancy-cat/lists"}